Class CreateBotAliasResponse

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

  • Method Details

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

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

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

    • toBuilder

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

    • builder

      public static CreateBotAliasResponse.Builder builder()

    • serializableBuilderClass

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