@Generated(value="software.amazon.awssdk:codegen") public final class CreateBotVersionResponse extends LexModelBuildingResponse implements ToCopyableBuilder<CreateBotVersionResponse.Builder,CreateBotVersionResponse>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateBotVersionResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
Statement |
abortStatement()
The message that Amazon Lex uses to cancel a conversation.
|
static CreateBotVersionResponse.Builder |
builder() |
String |
checksum()
Checksum identifying the version of the bot that was 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 message that Amazon Lex uses when it doesn't understand the user's request.
|
Instant |
createdDate()
The date when the bot version was created.
|
String |
description()
A description of the bot.
|
Boolean |
detectSentiment()
Indicates whether utterances entered by the user should be sent to Amazon Comprehend for sentiment analysis.
|
Boolean |
enableModelImprovements()
Indicates whether the bot uses accuracy improvements.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
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)
Used to retrieve the value of a field from any class that extends
SdkResponse. |
int |
hashCode() |
boolean |
hasIntents()
For responses, this returns true if the service returned a value for the Intents property.
|
Integer |
idleSessionTTLInSeconds()
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.
|
List<Intent> |
intents()
An array of
Intent objects. |
Instant |
lastUpdatedDate()
The date when the
$LATEST version of this bot was updated. |
Locale |
locale()
Specifies the target locale for the bot.
|
String |
localeAsString()
Specifies the target locale for the bot.
|
String |
name()
The name of the bot.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateBotVersionResponse.Builder> |
serializableBuilderClass() |
Status |
status()
When you send a request to create or update a bot, Amazon Lex sets the
status response element to
BUILDING. |
String |
statusAsString()
When you send a request to create or update a bot, Amazon Lex sets the
status response element to
BUILDING. |
CreateBotVersionResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
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 interactions with the user.
|
responseMetadatasdkHttpResponsecopypublic final String name()
The name of the bot.
public final String description()
A description of the bot.
public final boolean hasIntents()
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.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.
Intent objects. For more information, see PutBot.public final Prompt clarificationPrompt()
The message that Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.
public final Statement abortStatement()
The message that Amazon Lex uses to cancel a conversation. For more information, see PutBot.
public final Status status()
When you send a request to create or update a bot, Amazon Lex sets the status response element to
BUILDING. After Amazon Lex builds the bot, it sets status to READY. If
Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex returns the reason
for the failure in the failureReason response element.
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().
status response
element to BUILDING. After Amazon Lex builds the bot, it sets status to
READY. If Amazon Lex can't build the bot, it sets status to FAILED
. Amazon Lex returns the reason for the failure in the failureReason response element.Statuspublic final String statusAsString()
When you send a request to create or update a bot, Amazon Lex sets the status response element to
BUILDING. After Amazon Lex builds the bot, it sets status to READY. If
Amazon Lex can't build the bot, it sets status to FAILED. Amazon Lex returns the reason
for the failure in the failureReason response element.
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().
status response
element to BUILDING. After Amazon Lex builds the bot, it sets status to
READY. If Amazon Lex can't build the bot, it sets status to FAILED
. Amazon Lex returns the reason for the failure in the failureReason response element.Statuspublic final String failureReason()
If status is FAILED, Amazon Lex provides the reason that it failed to build the bot.
status is FAILED, Amazon Lex provides the reason that it failed to build the
bot.public final Instant lastUpdatedDate()
The date when the $LATEST version of this bot was updated.
$LATEST version of this bot was updated.public final Instant createdDate()
The date when the bot version was created.
public final Integer idleSessionTTLInSeconds()
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
public final String voiceId()
The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the user.
public final String checksum()
Checksum identifying the version of the bot that was created.
public final String version()
The version of the bot.
public final Locale locale()
Specifies 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().
Localepublic final String localeAsString()
Specifies 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().
Localepublic 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.
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.
public final Boolean enableModelImprovements()
Indicates whether the bot uses accuracy improvements. true indicates that the bot is using the
improvements, otherwise, false.
true indicates that the bot is using
the improvements, otherwise, false.public final Boolean detectSentiment()
Indicates whether utterances entered by the user should be sent to Amazon Comprehend for sentiment analysis.
public CreateBotVersionResponse.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<CreateBotVersionResponse.Builder,CreateBotVersionResponse>toBuilder in class AwsResponsepublic static CreateBotVersionResponse.Builder builder()
public static Class<? extends CreateBotVersionResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo 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.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponseSdkResponse. 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.getValueForField in class SdkResponsefieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.