PutBotResponse (AWS Java SDK :: Services :: Amazon Lex Model Building 2.16.102 API)

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(value="software.amazon.awssdk:codegen")
public final class PutBotResponse
extends LexModelBuildingResponse
implements ToCopyableBuilder<PutBotResponse.Builder,PutBotResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PutBotResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PutBotResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Statement`	`abortStatement()` The message that Amazon Lex uses to cancel a conversation.
`static PutBotResponse.Builder`	`builder()`
`String`	`checksum()` Checksum of the bot that you created.
`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.
`Prompt`	`clarificationPrompt()` The prompts that Amazon Lex uses when it doesn't understand the user's intent.
`Instant`	`createdDate()` The date that the bot was created.
`Boolean`	`createVersion()` `True` if a new version of the bot was created.
`String`	`description()` A description of the bot.
`Boolean`	`detectSentiment()` `true` if the bot is configured to send user utterances to Amazon Comprehend for sentiment analysis.
`Boolean`	`enableModelImprovements()` Indicates whether the bot uses accuracy improvements.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`failureReason()` If `status` is `FAILED`, Amazon Lex provides the reason that it failed to build the bot.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasIntents()` Returns true if the Intents property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`Integer`	`idleSessionTTLInSeconds()` The maximum length of time that Amazon Lex retains the data gathered in a conversation.
`List<Intent>`	`intents()` An array of `Intent` objects.
`Instant`	`lastUpdatedDate()` The date that the bot was updated.
`Locale`	`locale()` The target locale for the bot.
`String`	`localeAsString()` The target locale for the bot.
`String`	`name()` The name of the bot.
`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.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PutBotResponse.Builder>`	`serializableBuilderClass()`
`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`.
`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`.
`List<Tag>`	`tags()` A list of tags associated with the bot.
`PutBotResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`version()` The version of the bot.
`String`	`voiceId()` The Amazon Polly voice ID that Amazon Lex uses for voice interaction with the user.

Methods inherited from class software.amazon.awssdk.services.lexmodelbuilding.model.LexModelBuildingResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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()
```
    Returns true if the Intents property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasIntents() to see if a value was sent in this field.
    
    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:
    
    Status
  - 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:
    
    Status
  - 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:
    
    Locale
  - 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:
    
    Locale
  - 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()
```
    Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - 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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    A list of tags associated with the bot.
  - toBuilder
```
public PutBotResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PutBotResponse.Builder,PutBotResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class PutBotResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.lexmodelbuilding.model.LexModelBuildingResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

description

hasIntents

intents

enableModelImprovements

nluIntentConfidenceThreshold

clarificationPrompt

abortStatement

status

statusAsString

failureReason

lastUpdatedDate

createdDate

idleSessionTTLInSeconds

voiceId

checksum

version

locale

localeAsString

childDirected

createVersion

detectSentiment

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields