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

Class DescribeBotAliasResponse

    • Method Detail

      • botAliasId

        public final String botAliasId()

        The identifier of the bot alias.

        Returns:
        The identifier of the bot alias.

      • botAliasName

        public final String botAliasName()

        The name of the bot alias.

        Returns:
        The name of the bot alias.

      • description

        public final String description()

        The description of the bot alias.

        Returns:
        The description of the bot alias.

      • botVersion

        public final String botVersion()

        The version of the bot associated with the bot alias.

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

      • hasBotAliasLocaleSettings

        public final boolean hasBotAliasLocaleSettings()
        For responses, this returns true if the service returned a value for the BotAliasLocaleSettings 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.

      • botAliasLocaleSettings

        public final Map<String,​BotAliasLocaleSettings> botAliasLocaleSettings()

        The locale settings that are unique to the alias.

        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 hasBotAliasLocaleSettings() method.

        Returns:
        The locale settings that are unique to the alias.

      • conversationLogSettings

        public final ConversationLogSettings conversationLogSettings()

        Specifics of how Amazon Lex logs text and audio conversations with the bot associated with the alias.

        Returns:
        Specifics of how Amazon Lex logs text and audio conversations with the bot associated with the alias.

      • sentimentAnalysisSettings

        public final SentimentAnalysisSettings sentimentAnalysisSettings()
        Returns the value of the SentimentAnalysisSettings property for this object.
        Returns:
        The value of the SentimentAnalysisSettings property for this object.

      • hasBotAliasHistoryEvents

        public final boolean hasBotAliasHistoryEvents()
        For responses, this returns true if the service returned a value for the BotAliasHistoryEvents 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.

      • botAliasHistoryEvents

        public final List<BotAliasHistoryEvent> botAliasHistoryEvents()

        A list of events that affect a bot alias. For example, an event is recorded when the version that the alias points to changes.

        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 hasBotAliasHistoryEvents() method.

        Returns:
        A list of events that affect a bot alias. For example, an event is recorded when the version that the alias points to changes.

      • botAliasStatus

        public final BotAliasStatus botAliasStatus()

        The current status of the alias. When the alias is Available, the alias is ready for use with your bot.

        If the service returns an enum value that is not available in the current SDK version, botAliasStatus will return BotAliasStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from botAliasStatusAsString().

        Returns:
        The current status of the alias. When the alias is Available, the alias is ready for use with your bot.
        See Also:
        BotAliasStatus

      • botAliasStatusAsString

        public final String botAliasStatusAsString()

        The current status of the alias. When the alias is Available, the alias is ready for use with your bot.

        If the service returns an enum value that is not available in the current SDK version, botAliasStatus will return BotAliasStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from botAliasStatusAsString().

        Returns:
        The current status of the alias. When the alias is Available, the alias is ready for use with your bot.
        See Also:
        BotAliasStatus

      • botId

        public final String botId()

        The identifier of the bot associated with the bot alias.

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

      • creationDateTime

        public final Instant creationDateTime()

        A timestamp of the date and time that the alias was created.

        Returns:
        A timestamp of the date and time that the alias was created.

      • lastUpdatedDateTime

        public final Instant lastUpdatedDateTime()

        A timestamp of the date and time that the alias was last updated.

        Returns:
        A timestamp of the date and time that the alias was last updated.

      • hasParentBotNetworks

        public final boolean hasParentBotNetworks()
        For responses, this returns true if the service returned a value for the ParentBotNetworks 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.

      • parentBotNetworks

        public final List<ParentBotNetwork> parentBotNetworks()

        A list of the networks to which the bot alias you described belongs.

        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 hasParentBotNetworks() method.

        Returns:
        A list of the networks to which the bot alias you described belongs.

      • 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