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

Class CreateBotAliasRequest

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

  • Method Details

    • botAliasName

      public final String botAliasName()

      The alias to create. The name must be unique for the bot.

      Returns:
      The alias to create. The name must be unique for the bot.

    • description

      public final String description()

      A description of the alias. Use this description to help identify the alias.

      Returns:
      A description of the alias. Use this description to help identify the alias.

    • botVersion

      public final String botVersion()

      The version of the bot that this alias points to. You can use the UpdateBotAlias operation to change the bot version associated with the alias.

      Returns:
      The version of the bot that this alias points to. You can use the UpdateBotAlias operation to change the bot version associated with the 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()

      Maps configuration information to a specific locale. You can use this parameter to specify a specific Lambda function to run different functions in different locales.

      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:
      Maps configuration information to a specific locale. You can use this parameter to specify a specific Lambda function to run different functions in different locales.

    • conversationLogSettings

      public final ConversationLogSettings conversationLogSettings()

      Specifies whether Amazon Lex logs text and audio for a conversation with the bot. When you enable conversation logs, text logs store text input, transcripts of audio input, and associated metadata in Amazon CloudWatch Logs. Audio logs store audio input in Amazon S3.

      Returns:
      Specifies whether Amazon Lex logs text and audio for a conversation with the bot. When you enable conversation logs, text logs store text input, transcripts of audio input, and associated metadata in Amazon CloudWatch Logs. Audio logs store audio input in Amazon S3.

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

    • botId

      public final String botId()

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

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

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

    • toBuilder

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

    • builder

      public static CreateBotAliasRequest.Builder builder()

    • serializableBuilderClass

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