Class CodeConfigurationParameters

java.lang.Object
software.amazon.awssdk.services.endusermessaging.model.CodeConfigurationParameters
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<CodeConfigurationParameters.Builder,CodeConfigurationParameters>
@Generated("software.amazon.awssdk:codegen") public final class CodeConfigurationParameters extends Object implements SdkPojo, Serializable, ToCopyableBuilder<CodeConfigurationParameters.Builder,CodeConfigurationParameters>

The passcode policy parameters that are grouped for reuse across a notify code configuration and its create request. Each member is optional. When you omit a member on a create request, no value is applied at create time and the default is applied when a passcode is sent.

See Also:

  • Method Details

    • codeType

      public final CodeType codeType()

      The character set used to generate the one-time passcode. Valid values are NUMERIC (digits only), ALPHA (uppercase letters only), and ALPHANUMERIC (uppercase letters and digits). When you do not specify a value, the default is applied when a passcode is sent.

      If the service returns an enum value that is not available in the current SDK version, codeType will return CodeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from codeTypeAsString().

      Returns:
      The character set used to generate the one-time passcode. Valid values are NUMERIC (digits only), ALPHA (uppercase letters only), and ALPHANUMERIC (uppercase letters and digits). When you do not specify a value, the default is applied when a passcode is sent.
      See Also:

    • codeTypeAsString

      public final String codeTypeAsString()

      The character set used to generate the one-time passcode. Valid values are NUMERIC (digits only), ALPHA (uppercase letters only), and ALPHANUMERIC (uppercase letters and digits). When you do not specify a value, the default is applied when a passcode is sent.

      If the service returns an enum value that is not available in the current SDK version, codeType will return CodeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from codeTypeAsString().

      Returns:
      The character set used to generate the one-time passcode. Valid values are NUMERIC (digits only), ALPHA (uppercase letters only), and ALPHANUMERIC (uppercase letters and digits). When you do not specify a value, the default is applied when a passcode is sent.
      See Also:

    • codeLength

      public final Integer codeLength()

      The number of characters in the one-time passcode. Valid values range from 4 through 8. When you do not specify a value, the default is applied when a passcode is sent.

      Returns:
      The number of characters in the one-time passcode. Valid values range from 4 through 8. When you do not specify a value, the default is applied when a passcode is sent.

    • validityPeriodMinutes

      public final Integer validityPeriodMinutes()

      The length of time, in minutes, that the one-time passcode remains valid. Valid values range from 1 through 60. When you do not specify a value, the default is applied when a passcode is sent.

      Returns:
      The length of time, in minutes, that the one-time passcode remains valid. Valid values range from 1 through 60. When you do not specify a value, the default is applied when a passcode is sent.

    • maxAttempts

      public final Integer maxAttempts()

      The maximum number of validation attempts that are allowed before the verification is locked. Valid values range from 1 through 5. When you do not specify a value, the default is applied when a passcode is sent.

      Returns:
      The maximum number of validation attempts that are allowed before the verification is locked. Valid values range from 1 through 5. When you do not specify a value, the default is applied when a passcode is sent.

    • toBuilder

      public CodeConfigurationParameters.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<CodeConfigurationParameters.Builder,CodeConfigurationParameters>
      Returns:
      a builder for type T

    • builder

      public static CodeConfigurationParameters.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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