Class CreateNotifyCodeConfigurationRequest

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

  • Method Details

    • notifyCodeConfigurationName

      public final String notifyCodeConfigurationName()

      The name of the notify code configuration.

      Returns:
      The name of the notify code configuration.

    • codeConfigurationParameters

      public final CodeConfigurationParameters codeConfigurationParameters()

      The passcode policy parameters, including the code type, length, validity period, and maximum number of attempts. Each member is optional. When you omit a member, no value is applied at create time and the default is applied when a passcode is sent.

      Returns:
      The passcode policy parameters, including the code type, length, validity period, and maximum number of attempts. Each member is optional. When you omit a member, no value is applied at create time and the default is applied when a passcode is sent.

    • channelParameters

      public final ChannelParameters channelParameters()

      The channel-specific parameters used to render and deliver the one-time passcode. Provide parameters for any subset of channels. Each member configures one delivery route, and the route that is selected at send time uses the matching channel.

      Returns:
      The channel-specific parameters used to render and deliver the one-time passcode. Provide parameters for any subset of channels. Each member configures one delivery route, and the route that is selected at send time uses the matching channel.

    • deletionProtectionEnabled

      public final Boolean deletionProtectionEnabled()

      Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.

      Returns:
      Specifies whether deletion protection is enabled. When enabled, the resource cannot be deleted until deletion protection is turned off.

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.

      Returns:
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you do not specify a client token, the AWS SDK automatically generates one.

    • 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()

      An array of key and value pair tags that are associated with the resource.

      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:
      An array of key and value pair tags that are associated with the resource.

    • toBuilder

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

    • builder

      public static CreateNotifyCodeConfigurationRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.