Class DescribeBotRecommendationResponse

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