Class CreateBotVersionResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateBotVersionResponse.Builder,
CreateBotVersionResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Statement
The message that Amazon Lex uses to cancel a conversation.builder()
final String
checksum()
Checksum identifying the version of the bot that was created.final Boolean
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 specifyingtrue
orfalse
in thechildDirected
field.final Prompt
The message that Amazon Lex uses when it doesn't understand the user's request.final Instant
The date when the bot version was created.final String
A description of the bot.final Boolean
Indicates whether utterances entered by the user should be sent to Amazon Comprehend for sentiment analysis.final Boolean
Indicates whether the bot uses accuracy improvements.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
Ifstatus
isFAILED
, Amazon Lex provides the reason that it failed to build the bot.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the Intents property.final Integer
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation.intents()
An array ofIntent
objects.final Instant
The date when the$LATEST
version of this bot was updated.final Locale
locale()
Specifies the target locale for the bot.final String
Specifies the target locale for the bot.final String
name()
The name of the bot.static Class
<? extends CreateBotVersionResponse.Builder> final Status
status()
When you send a request to create or update a bot, Amazon Lex sets thestatus
response element toBUILDING
.final String
When you send a request to create or update a bot, Amazon Lex sets thestatus
response element toBUILDING
.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
version()
The version of the bot.final String
voiceId()
The Amazon Polly voice ID that Amazon Lex uses for voice interactions 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 interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the bot.
- Returns:
- The name of the bot.
-
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 theisEmpty()
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
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.
-
clarificationPrompt
The message that Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.
- Returns:
- The message that Amazon Lex uses when it doesn't understand the user's request. For more information, see PutBot.
-
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
When you send a request to create or update a bot, Amazon Lex sets the
status
response element toBUILDING
. After Amazon Lex builds the bot, it setsstatus
toREADY
. If Amazon Lex can't build the bot, it setsstatus
toFAILED
. Amazon Lex returns the reason for the failure in thefailureReason
response element.If the service returns an enum value that is not available in the current SDK version,
status
will returnStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- When you send a request to create or update a bot, Amazon Lex sets the
status
response element toBUILDING
. After Amazon Lex builds the bot, it setsstatus
toREADY
. If Amazon Lex can't build the bot, it setsstatus
toFAILED
. Amazon Lex returns the reason for the failure in thefailureReason
response element. - See Also:
-
statusAsString
When you send a request to create or update a bot, Amazon Lex sets the
status
response element toBUILDING
. After Amazon Lex builds the bot, it setsstatus
toREADY
. If Amazon Lex can't build the bot, it setsstatus
toFAILED
. Amazon Lex returns the reason for the failure in thefailureReason
response element.If the service returns an enum value that is not available in the current SDK version,
status
will returnStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- When you send a request to create or update a bot, Amazon Lex sets the
status
response element toBUILDING
. After Amazon Lex builds the bot, it setsstatus
toREADY
. If Amazon Lex can't build the bot, it setsstatus
toFAILED
. Amazon Lex returns the reason for the failure in thefailureReason
response element. - See Also:
-
failureReason
If
status
isFAILED
, Amazon Lex provides the reason that it failed to build the bot.- Returns:
- If
status
isFAILED
, Amazon Lex provides the reason that it failed to build the bot.
-
lastUpdatedDate
The date when the
$LATEST
version of this bot was updated.- Returns:
- The date when the
$LATEST
version of this bot was updated.
-
createdDate
The date when the bot version was created.
- Returns:
- The date when the bot version was created.
-
idleSessionTTLInSeconds
The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
- Returns:
- The maximum time in seconds that Amazon Lex retains the data gathered in a conversation. For more information, see PutBot.
-
voiceId
The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the user.
- Returns:
- The Amazon Polly voice ID that Amazon Lex uses for voice interactions with the user.
-
checksum
Checksum identifying the version of the bot that was created.
- Returns:
- Checksum identifying the version of the bot that was created.
-
version
The version of the bot.
- Returns:
- The version of the bot.
-
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 returnLocale.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlocaleAsString()
.- Returns:
- Specifies the target locale for the bot.
- See Also:
-
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 returnLocale.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlocaleAsString()
.- Returns:
- Specifies the target locale for the bot.
- See Also:
-
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
orfalse
in thechildDirected
field. By specifyingtrue
in thechildDirected
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 specifyingfalse
in thechildDirected
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 thechildDirected
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
orfalse
in thechildDirected
field. By specifyingtrue
in thechildDirected
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 specifyingfalse
in thechildDirected
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 thechildDirected
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.
-
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
.
-
detectSentiment
Indicates whether utterances entered by the user should be sent to Amazon Comprehend for sentiment analysis.
- Returns:
- Indicates whether utterances entered by the user should be sent to Amazon Comprehend for sentiment analysis.
-
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 interfaceToCopyableBuilder<CreateBotVersionResponse.Builder,
CreateBotVersionResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-