Class SendOTPMessageRequestParameters

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

Send OTP message request parameters.

See Also:

  • Method Details

    • allowedAttempts

      public final Integer allowedAttempts()

      The attempts allowed to validate an OTP.

      Returns:
      The attempts allowed to validate an OTP.

    • brandName

      public final String brandName()

      The brand name that will be substituted into the OTP message body. Should be owned by calling AWS account.

      Returns:
      The brand name that will be substituted into the OTP message body. Should be owned by calling AWS account.

    • channel

      public final String channel()

      Channel type for the OTP message. Supported values: [SMS].

      Returns:
      Channel type for the OTP message. Supported values: [SMS].

    • codeLength

      public final Integer codeLength()

      The number of characters in the generated OTP.

      Returns:
      The number of characters in the generated OTP.

    • destinationIdentity

      public final String destinationIdentity()

      The destination identity to send OTP to.

      Returns:
      The destination identity to send OTP to.

    • entityId

      public final String entityId()

      A unique Entity ID received from DLT after entity registration is approved.

      Returns:
      A unique Entity ID received from DLT after entity registration is approved.

    • language

      public final String language()

      The language to be used for the outgoing message body containing the OTP.

      Returns:
      The language to be used for the outgoing message body containing the OTP.

    • originationIdentity

      public final String originationIdentity()

      The origination identity used to send OTP from.

      Returns:
      The origination identity used to send OTP from.

    • referenceId

      public final String referenceId()

      Developer-specified reference identifier. Required to match during OTP verification.

      Returns:
      Developer-specified reference identifier. Required to match during OTP verification.

    • templateId

      public final String templateId()

      A unique Template ID received from DLT after entity registration is approved.

      Returns:
      A unique Template ID received from DLT after entity registration is approved.

    • validityPeriod

      public final Integer validityPeriod()

      The time in minutes before the OTP is no longer valid.

      Returns:
      The time in minutes before the OTP is no longer valid.

    • toBuilder

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

    • builder

      public static SendOTPMessageRequestParameters.Builder builder()

    • serializableBuilderClass

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