Class PutBotAliasRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.lexmodelbuilding.model.LexModelBuildingRequest
software.amazon.awssdk.services.lexmodelbuilding.model.PutBotAliasRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutBotAliasRequest.Builder,PutBotAliasRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutBotAliasRequest extends LexModelBuildingRequest implements ToCopyableBuilder<PutBotAliasRequest.Builder,PutBotAliasRequest>

  • Method Details

    • name

      public final String name()

      The name of the alias. The name is not case sensitive.

      Returns:
      The name of the alias. The name is not case sensitive.

    • description

      public final String description()

      A description of the alias.

      Returns:
      A description of the alias.

    • botVersion

      public final String botVersion()

      The version of the bot.

      Returns:
      The version of the bot.

    • botName

      public final String botName()

      The name of the bot.

      Returns:
      The name of the bot.

    • checksum

      public final String checksum()

      Identifies a specific revision of the $LATEST version.

      When you create a new bot alias, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

      When you want to update a bot alias, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.

      Returns:
      Identifies a specific revision of the $LATEST version.

      When you create a new bot alias, leave the checksum field blank. If you specify a checksum you get a BadRequestException exception.

      When you want to update a bot alias, set the checksum field to the checksum of the most recent revision of the $LATEST version. If you don't specify the checksum field, or if the checksum does not match the $LATEST version, you get a PreconditionFailedException exception.

    • conversationLogs

      public final ConversationLogsRequest conversationLogs()

      Settings for conversation logs for the alias.

      Returns:
      Settings for conversation logs for the alias.

    • 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 List<Tag> tags()

      A list of tags to add to the bot alias. You can only add tags when you create an alias, you can't use the PutBotAlias operation to update the tags on a bot alias. To update tags, use the TagResource operation.

      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 to add to the bot alias. You can only add tags when you create an alias, you can't use the PutBotAlias operation to update the tags on a bot alias. To update tags, use the TagResource operation.

    • toBuilder

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

    • builder

      public static PutBotAliasRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutBotAliasRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.