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

Class DescribeBotLocaleResponse

    • Method Detail

      • botId

        public final String botId()

        The identifier of the bot associated with the locale.

        Returns:
        The identifier of the bot associated with the locale.

      • botVersion

        public final String botVersion()

        The version of the bot associated with the locale.

        Returns:
        The version of the bot associated with the locale.

      • localeId

        public final String localeId()

        The unique identifier of the described locale.

        Returns:
        The unique identifier of the described locale.

      • localeName

        public final String localeName()

        The name of the locale.

        Returns:
        The name of the locale.

      • description

        public final String description()

        The description of the locale.

        Returns:
        The description of the locale.

      • nluIntentConfidenceThreshold

        public final Double nluIntentConfidenceThreshold()

        The confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.

        Returns:
        The confidence threshold where Amazon Lex inserts the AMAZON.FallbackIntent and AMAZON.KendraSearchIntent intents in the list of possible intents for an utterance.

      • voiceSettings

        public final VoiceSettings 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

        public final Integer intentsCount()

        The number of intents defined for the locale.

        Returns:
        The number of intents defined for the locale.

      • slotTypesCount

        public final Integer slotTypesCount()

        The number of slot types defined for the locale.

        Returns:
        The number of slot types defined for the locale.

      • botLocaleStatus

        public final BotLocaleStatus botLocaleStatus()

        The status of the bot. If the status is Failed, 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, botLocaleStatus will return BotLocaleStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from botLocaleStatusAsString().

        Returns:
        The status of the bot. If the status is Failed, the reasons for the failure are listed in the failureReasons field.
        See Also:
        BotLocaleStatus

      • botLocaleStatusAsString

        public final String botLocaleStatusAsString()

        The status of the bot. If the status is Failed, 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, botLocaleStatus will return BotLocaleStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from botLocaleStatusAsString().

        Returns:
        The status of the bot. If the status is Failed, the reasons for the failure are listed in the failureReasons field.
        See Also:
        BotLocaleStatus

      • 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 botLocaleStatus is Failed, 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 is Failed, Amazon Lex explains why it failed to build the bot.

      • creationDateTime

        public final Instant creationDateTime()

        The date and time that the locale was created.

        Returns:
        The date and time that the locale was created.

      • lastUpdatedDateTime

        public final Instant lastUpdatedDateTime()

        The date and time that the locale was last updated.

        Returns:
        The date and time that the locale was last updated.

      • lastBuildSubmittedDateTime

        public final Instant 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 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.

      • botLocaleHistoryEvents

        public final List<BotLocaleHistoryEvent> 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 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.

      • recommendedActions

        public final List<String> 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

        public final GenerativeAISettings 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.

      • 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