Package software.amazon.awssdk.services.lexmodelsv2.model

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>

  • Method Details

    • 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, botRecommendationStatus will return BotRecommendationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from botRecommendationStatusAsString().

      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:

    • 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, botRecommendationStatus will return BotRecommendationStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from botRecommendationStatusAsString().

      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:

    • 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 the 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.

    • 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()
      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 interface ToCopyableBuilder<DescribeBotRecommendationResponse.Builder,DescribeBotRecommendationResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeBotRecommendationResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeBotRecommendationResponse.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)
      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 an SdkPojo 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.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.