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

Class DescribeBotAliasResponse

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.DescribeBotAliasResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeBotAliasResponse.Builder,DescribeBotAliasResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeBotAliasResponse extends LexModelsV2Response implements ToCopyableBuilder<DescribeBotAliasResponse.Builder,DescribeBotAliasResponse>

  • Method Details

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

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

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

    • toBuilder

      public DescribeBotAliasResponse.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<DescribeBotAliasResponse.Builder,DescribeBotAliasResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeBotAliasResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeBotAliasResponse.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.