Class DescribeBotLocaleResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribeBotLocaleResponse.Builder,
DescribeBotLocaleResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
botId()
The identifier of the bot associated with the locale.final List
<BotLocaleHistoryEvent> History of changes, such as when a locale is used in an alias, that have taken place for the locale.final BotLocaleStatus
The status of the bot.final String
The status of the bot.final String
The version of the bot associated with the locale.builder()
final Instant
The date and time that the locale was created.final String
The description of the locale.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.ifbotLocaleStatus
isFailed
, Amazon Lex explains why it failed to build the bot.final GenerativeAISettings
Contains settings for Amazon Bedrock's generative AI features for your bot locale.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final boolean
For responses, this returns true if the service returned a value for the BotLocaleHistoryEvents property.final boolean
For responses, this returns true if the service returned a value for the FailureReasons property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RecommendedActions property.final Integer
The number of intents defined for the locale.final Instant
The date and time that the locale was last submitted for building.final Instant
The date and time that the locale was last updated.final String
localeId()
The unique identifier of the described locale.final String
The name of the locale.final Double
The confidence threshold where Amazon Lex inserts theAMAZON.FallbackIntent
andAMAZON.KendraSearchIntent
intents in the list of possible intents for an utterance.Recommended actions to take to resolve an error in thefailureReasons
field.static Class
<? extends DescribeBotLocaleResponse.Builder> final Integer
The number of slot types defined for the locale.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 VoiceSettings
The Amazon Polly voice Amazon Lex uses for voice interaction with the user.Methods inherited from class software.amazon.awssdk.services.lexmodelsv2.model.LexModelsV2Response
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
botId
The identifier of the bot associated with the locale.
- Returns:
- The identifier of the bot associated with the locale.
-
botVersion
The version of the bot associated with the locale.
- Returns:
- The version of the bot associated with the locale.
-
localeId
The unique identifier of the described locale.
- Returns:
- The unique identifier of the described locale.
-
localeName
The name of the locale.
- Returns:
- The name of the locale.
-
description
The description of the locale.
- Returns:
- The description of the locale.
-
nluIntentConfidenceThreshold
The confidence threshold where Amazon Lex inserts the
AMAZON.FallbackIntent
andAMAZON.KendraSearchIntent
intents in the list of possible intents for an utterance.- Returns:
- The confidence threshold where Amazon Lex inserts the
AMAZON.FallbackIntent
andAMAZON.KendraSearchIntent
intents in the list of possible intents for an utterance.
-
voiceSettings
The Amazon Polly voice Amazon Lex uses for voice interaction with the user.
- Returns:
- The Amazon Polly voice Amazon Lex uses for voice interaction with the user.
-
intentsCount
The number of intents defined for the locale.
- Returns:
- The number of intents defined for the locale.
-
slotTypesCount
The number of slot types defined for the locale.
- Returns:
- The number of slot types defined for the locale.
-
botLocaleStatus
The status of the bot. If the status is
Failed
, the reasons for the failure are listed in thefailureReasons
field.If the service returns an enum value that is not available in the current SDK version,
botLocaleStatus
will returnBotLocaleStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombotLocaleStatusAsString()
.- Returns:
- The status of the bot. If the status is
Failed
, the reasons for the failure are listed in thefailureReasons
field. - See Also:
-
botLocaleStatusAsString
The status of the bot. If the status is
Failed
, the reasons for the failure are listed in thefailureReasons
field.If the service returns an enum value that is not available in the current SDK version,
botLocaleStatus
will returnBotLocaleStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frombotLocaleStatusAsString()
.- Returns:
- The status of the bot. If the status is
Failed
, the reasons for the failure are listed in thefailureReasons
field. - See Also:
-
hasFailureReasons
public final boolean hasFailureReasons()For responses, this returns true if the service returned a value for the FailureReasons 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. -
failureReasons
if
botLocaleStatus
isFailed
, Amazon Lex explains why it failed to build 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
hasFailureReasons()
method.- Returns:
- if
botLocaleStatus
isFailed
, Amazon Lex explains why it failed to build the bot.
-
creationDateTime
The date and time that the locale was created.
- Returns:
- The date and time that the locale was created.
-
lastUpdatedDateTime
The date and time that the locale was last updated.
- Returns:
- The date and time that the locale was last updated.
-
lastBuildSubmittedDateTime
The date and time that the locale was last submitted for building.
- Returns:
- The date and time that the locale was last submitted for building.
-
hasBotLocaleHistoryEvents
public final boolean hasBotLocaleHistoryEvents()For responses, this returns true if the service returned a value for the BotLocaleHistoryEvents 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. -
botLocaleHistoryEvents
History of changes, such as when a locale is used in an alias, that have taken place for the locale.
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
hasBotLocaleHistoryEvents()
method.- Returns:
- History of changes, such as when a locale is used in an alias, that have taken place for the locale.
-
hasRecommendedActions
public final boolean hasRecommendedActions()For responses, this returns true if the service returned a value for the RecommendedActions 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. -
recommendedActions
Recommended actions to take to resolve an error in the
failureReasons
field.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
hasRecommendedActions()
method.- Returns:
- Recommended actions to take to resolve an error in the
failureReasons
field.
-
generativeAISettings
Contains settings for Amazon Bedrock's generative AI features for your bot locale.
- Returns:
- Contains settings for Amazon Bedrock's generative AI features for your bot locale.
-
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<DescribeBotLocaleResponse.Builder,
DescribeBotLocaleResponse> - 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
-