Class CreateBotAliasResponse

    • Method Detail

      • botAliasId

        public final String botAliasId()

        The unique identifier of the bot alias.

        Returns:
        The unique identifier of the bot alias.
      • botAliasName

        public final String botAliasName()

        The name specified for the bot alias.

        Returns:
        The name specified for the bot alias.
      • description

        public final String description()

        The description specified for the bot alias.

        Returns:
        The description specified for the bot alias.
      • botVersion

        public final String botVersion()

        The version of the bot associated with this alias.

        Returns:
        The version of the bot associated with this 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()

        Configuration information for a specific 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 hasBotAliasLocaleSettings() method.

        Returns:
        Configuration information for a specific locale.
      • conversationLogSettings

        public final ConversationLogSettings conversationLogSettings()

        The conversation log settings specified for the alias.

        Returns:
        The conversation log settings specified for 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.
      • botAliasStatus

        public final BotAliasStatus botAliasStatus()

        The current status of the alias. The alias is first put into the Creating state. When the alias is ready to be used, it is put into the Available state. You can use the DescribeBotAlias operation to get the current state of an alias.

        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. The alias is first put into the Creating state. When the alias is ready to be used, it is put into the Available state. You can use the DescribeBotAlias operation to get the current state of an alias.
        See Also:
        BotAliasStatus
      • botAliasStatusAsString

        public final String botAliasStatusAsString()

        The current status of the alias. The alias is first put into the Creating state. When the alias is ready to be used, it is put into the Available state. You can use the DescribeBotAlias operation to get the current state of an alias.

        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. The alias is first put into the Creating state. When the alias is ready to be used, it is put into the Available state. You can use the DescribeBotAlias operation to get the current state of an alias.
        See Also:
        BotAliasStatus
      • botId

        public final String botId()

        The unique identifier of the bot that this alias applies to.

        Returns:
        The unique identifier of the bot that this alias applies to.
      • creationDateTime

        public final Instant creationDateTime()

        A Unix timestamp indicating the date and time that the bot alias was created.

        Returns:
        A Unix timestamp indicating the date and time that the bot alias was created.
      • hasTags

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

        public final Map<String,​String> tags()

        A list of tags associated with the bot 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 hasTags() method.

        Returns:
        A list of tags associated with the bot alias.
      • 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