Class PutBotResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.lexmodelbuilding.model.LexModelBuildingResponse
software.amazon.awssdk.services.lexmodelbuilding.model.PutBotResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutBotResponse.Builder,PutBotResponse>
@Generated("software.amazon.awssdk:codegen") public final class PutBotResponse extends LexModelBuildingResponse implements ToCopyableBuilder<PutBotResponse.Builder,PutBotResponse>

  • Method Details

    • name

      public final String name()

      The name of the bot.

      Returns:
      The name of the bot.

    • description

      public final String description()

      A description of the bot.

      Returns:
      A description of the bot.

    • hasIntents

      public final boolean hasIntents()
      For responses, this returns true if the service returned a value for the Intents property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • intents

      public final List<Intent> intents()

      An array of Intent objects. For more information, see PutBot.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIntents() method.

      Returns:
      An array of Intent objects. For more information, see PutBot.

    • enableModelImprovements

      public final Boolean enableModelImprovements()

      Indicates whether the bot uses accuracy improvements. true indicates that the bot is using the improvements, otherwise, false.

      Returns:
      Indicates whether the bot uses accuracy improvements. true indicates that the bot is using the improvements, otherwise, false.

    • nluIntentConfidenceThreshold

      public final Double nluIntentConfidenceThreshold()

      The score that determines where Amazon Lex inserts the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a PostContent or PostText response. AMAZON.FallbackIntent is inserted if the confidence score for all intents is below this value. AMAZON.KendraSearchIntent is only inserted if it is configured for the bot.

      Returns:
      The score that determines where Amazon Lex inserts the AMAZON.FallbackIntent, AMAZON.KendraSearchIntent, or both when returning alternative intents in a PostContent or PostText response. AMAZON.FallbackIntent is inserted if the confidence score for all intents is below this value. AMAZON.KendraSearchIntent is only inserted if it is configured for the bot.

    • clarificationPrompt

      public final Prompt clarificationPrompt()

      The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, see PutBot.

      Returns:
      The prompts that Amazon Lex uses when it doesn't understand the user's intent. For more information, see PutBot.

    • abortStatement

      public final Statement abortStatement()

      The message that Amazon Lex uses to cancel a conversation. For more information, see PutBot.

      Returns:
      The message that Amazon Lex uses to cancel a conversation. For more information, see PutBot.

    • status

      public final Status status()

      When you send a request to create a bot with processBehavior set to BUILD, Amazon Lex sets the status response element to BUILDING.

      In the READY_BASIC_TESTING state you can test the bot with user inputs that exactly match the utterances configured for the bot's intents and values in the slot types.

      If Amazon Lex can't build the bot, Amazon Lex sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element.

      When you set processBehavior to SAVE, Amazon Lex sets the status code to NOT BUILT.

      When the bot is in the READY state you can test and publish the bot.

      If the service returns an enum value that is not available in the current SDK version, status will return Status.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      When you send a request to create a bot with processBehavior set to BUILD, Amazon Lex sets the status response element to BUILDING.

      In the READY_BASIC_TESTING state you can test the bot with user inputs that exactly match the utterances configured for the bot's intents and values in the slot types.

      If Amazon Lex can't build the bot, Amazon Lex sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element.

      When you set processBehavior to SAVE, Amazon Lex sets the status code to NOT BUILT.

      When the bot is in the READY state you can test and publish the bot.

      See Also:

    • statusAsString

      public final String statusAsString()

      When you send a request to create a bot with processBehavior set to BUILD, Amazon Lex sets the status response element to BUILDING.

      In the READY_BASIC_TESTING state you can test the bot with user inputs that exactly match the utterances configured for the bot's intents and values in the slot types.

      If Amazon Lex can't build the bot, Amazon Lex sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element.

      When you set processBehavior to SAVE, Amazon Lex sets the status code to NOT BUILT.

      When the bot is in the READY state you can test and publish the bot.

      If the service returns an enum value that is not available in the current SDK version, status will return Status.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      When you send a request to create a bot with processBehavior set to BUILD, Amazon Lex sets the status response element to BUILDING.

      In the READY_BASIC_TESTING state you can test the bot with user inputs that exactly match the utterances configured for the bot's intents and values in the slot types.

      If Amazon Lex can't build the bot, Amazon Lex sets status to FAILED. Amazon Lex returns the reason for the failure in the failureReason response element.

      When you set processBehavior to SAVE, Amazon Lex sets the status code to NOT BUILT.

      When the bot is in the READY state you can test and publish the bot.

      See Also:

    • failureReason

      public final String failureReason()

      If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.

      Returns:
      If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.

    • lastUpdatedDate

      public final Instant lastUpdatedDate()

      The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.

      Returns:
      The date that the bot was updated. When you create a resource, the creation date and last updated date are the same.

    • createdDate

      public final Instant createdDate()

      The date that the bot was created.

      Returns:
      The date that the bot was created.

    • idleSessionTTLInSeconds

      public final Integer idleSessionTTLInSeconds()

      The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.

      Returns:
      The maximum length of time that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.

    • voiceId

      public final String voiceId()

      The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.

      Returns:
      The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user. For more information, see PutBot.

    • checksum

      public final String checksum()

      Checksum of the bot that you created.

      Returns:
      Checksum of the bot that you created.

    • version

      public final String version()

      The version of the bot. For a new bot, the version is always $LATEST.

      Returns:
      The version of the bot. For a new bot, the version is always $LATEST.

    • locale

      public final Locale locale()

      The target locale for the bot.

      If the service returns an enum value that is not available in the current SDK version, locale will return Locale.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from localeAsString().

      Returns:
      The target locale for the bot.
      See Also:

    • localeAsString

      public final String localeAsString()

      The target locale for the bot.

      If the service returns an enum value that is not available in the current SDK version, locale will return Locale.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from localeAsString().

      Returns:
      The target locale for the bot.
      See Also:

    • childDirected

      public final Boolean childDirected()

      For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.

      If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

      Returns:
      For each Amazon Lex bot created with the Amazon Lex Model Building Service, you must specify whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to the Children's Online Privacy Protection Act (COPPA) by specifying true or false in the childDirected field. By specifying true in the childDirected field, you confirm that your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. By specifying false in the childDirected field, you confirm that your use of Amazon Lex is not related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA. You may not specify a default value for the childDirected field that does not accurately reflect whether your use of Amazon Lex is related to a website, program, or other application that is directed or targeted, in whole or in part, to children under age 13 and subject to COPPA.

      If your use of Amazon Lex relates to a website, program, or other application that is directed in whole or in part, to children under age 13, you must obtain any required verifiable parental consent under COPPA. For information regarding the use of Amazon Lex in connection with websites, programs, or other applications that are directed or targeted, in whole or in part, to children under age 13, see the Amazon Lex FAQ.

    • createVersion

      public final Boolean createVersion()

      True if a new version of the bot was created. If the createVersion field was not specified in the request, the createVersion field is set to false in the response.

      Returns:
      True if a new version of the bot was created. If the createVersion field was not specified in the request, the createVersion field is set to false in the response.

    • detectSentiment

      public final Boolean detectSentiment()

      true if the bot is configured to send user utterances to Amazon Comprehend for sentiment analysis. If the detectSentiment field was not specified in the request, the detectSentiment field is false in the response.

      Returns:
      true if the bot is configured to send user utterances to Amazon Comprehend for sentiment analysis. If the detectSentiment field was not specified in the request, the detectSentiment field is false in the response.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      A list of tags associated with the bot.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      A list of tags associated with the bot.

    • toBuilder

      public PutBotResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PutBotResponse.Builder,PutBotResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static PutBotResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutBotResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.