Class DescribeBotRecommendationResponse
- java.lang.Object
-
- software.amazon.awssdk.core.SdkResponse
-
- software.amazon.awssdk.awscore.AwsResponse
-
- software.amazon.awssdk.services.lexmodelsv2.model.LexModelsV2Response
-
- software.amazon.awssdk.services.lexmodelsv2.model.DescribeBotRecommendationResponse
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<DescribeBotRecommendationResponse.Builder,DescribeBotRecommendationResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeBotRecommendationResponse extends LexModelsV2Response implements ToCopyableBuilder<DescribeBotRecommendationResponse.Builder,DescribeBotRecommendationResponse>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDescribeBotRecommendationResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description StringbotId()The identifier of the bot associated with the bot recommendation.StringbotRecommendationId()The identifier of the bot recommendation being described.BotRecommendationResultsbotRecommendationResults()The object representing the URL of the bot definition, the URL of the associated transcript and a statistical summary of the bot recommendation results.BotRecommendationStatusbotRecommendationStatus()The status of the bot recommendation.StringbotRecommendationStatusAsString()The status of the bot recommendation.StringbotVersion()The version of the bot associated with the bot recommendation.static DescribeBotRecommendationResponse.Builderbuilder()InstantcreationDateTime()The date and time that the bot recommendation was created.EncryptionSettingencryptionSetting()The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<String>failureReasons()If botRecommendationStatus is Failed, Amazon Lex explains why.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasFailureReasons()For responses, this returns true if the service returned a value for the FailureReasons property.inthashCode()InstantlastUpdatedDateTime()The date and time that the bot recommendation was last updated.StringlocaleId()The identifier of the language and locale of the bot recommendation to describe.List<SdkField<?>>sdkFields()static Class<? extends DescribeBotRecommendationResponse.Builder>serializableBuilderClass()DescribeBotRecommendationResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.TranscriptSourceSettingtranscriptSourceSetting()The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.-
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 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
-
botId
public final String botId()
The identifier of the bot associated with the bot recommendation.
- Returns:
- The identifier of the bot associated with the bot recommendation.
-
botVersion
public final String botVersion()
The version of the bot associated with the bot recommendation.
- Returns:
- The version of the bot associated with the bot recommendation.
-
localeId
public final String localeId()
The identifier of the language and locale of the bot recommendation to describe.
- Returns:
- The identifier of the language and locale of the bot recommendation to describe.
-
botRecommendationStatus
public final BotRecommendationStatus botRecommendationStatus()
The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
If the service returns an enum value that is not available in the current SDK version,
botRecommendationStatuswill returnBotRecommendationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frombotRecommendationStatusAsString().- Returns:
- The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
- See Also:
BotRecommendationStatus
-
botRecommendationStatusAsString
public final String botRecommendationStatusAsString()
The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
If the service returns an enum value that is not available in the current SDK version,
botRecommendationStatuswill returnBotRecommendationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available frombotRecommendationStatusAsString().- Returns:
- The status of the bot recommendation. If the status is Failed, then the reasons for the failure are listed in the failureReasons field.
- See Also:
BotRecommendationStatus
-
botRecommendationId
public final String botRecommendationId()
The identifier of the bot recommendation being described.
- Returns:
- The identifier of the bot recommendation being described.
-
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
public final List<String> failureReasons()
If botRecommendationStatus is Failed, Amazon Lex explains why.
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 botRecommendationStatus is Failed, Amazon Lex explains why.
-
creationDateTime
public final Instant creationDateTime()
The date and time that the bot recommendation was created.
- Returns:
- The date and time that the bot recommendation was created.
-
lastUpdatedDateTime
public final Instant lastUpdatedDateTime()
The date and time that the bot recommendation was last updated.
- Returns:
- The date and time that the bot recommendation was last updated.
-
transcriptSourceSetting
public final TranscriptSourceSetting transcriptSourceSetting()
The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
- Returns:
- The object representing the Amazon S3 bucket containing the transcript, as well as the associated metadata.
-
encryptionSetting
public final EncryptionSetting encryptionSetting()
The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
- Returns:
- The object representing the passwords that were used to encrypt the data related to the bot recommendation results, as well as the KMS key ARN used to encrypt the associated metadata.
-
botRecommendationResults
public final BotRecommendationResults botRecommendationResults()
The object representing the URL of the bot definition, the URL of the associated transcript and a statistical summary of the bot recommendation results.
- Returns:
- The object representing the URL of the bot definition, the URL of the associated transcript and a statistical summary of the bot recommendation results.
-
toBuilder
public DescribeBotRecommendationResponse.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DescribeBotRecommendationResponse.Builder,DescribeBotRecommendationResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static DescribeBotRecommendationResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends DescribeBotRecommendationResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
-