Package software.amazon.awssdk.services.pinpoint.model

Interface SendOTPMessageRequestParameters.Builder

All Superinterfaces:
Buildable, CopyableBuilder<SendOTPMessageRequestParameters.Builder,SendOTPMessageRequestParameters>, SdkBuilder<SendOTPMessageRequestParameters.Builder,SendOTPMessageRequestParameters>, SdkPojo
Enclosing class:
SendOTPMessageRequestParameters
public static interface SendOTPMessageRequestParameters.Builder extends SdkPojo, CopyableBuilder<SendOTPMessageRequestParameters.Builder,SendOTPMessageRequestParameters>

  • Method Details

    • allowedAttempts

      SendOTPMessageRequestParameters.Builder allowedAttempts(Integer allowedAttempts)

      The attempts allowed to validate an OTP.

      Parameters:
      allowedAttempts - The attempts allowed to validate an OTP.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • brandName

      SendOTPMessageRequestParameters.Builder brandName(String brandName)

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

      Parameters:
      brandName - The brand name that will be substituted into the OTP message body. Should be owned by calling AWS account.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • channel

      SendOTPMessageRequestParameters.Builder channel(String channel)

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

      Parameters:
      channel - Channel type for the OTP message. Supported values: [SMS].
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • codeLength

      SendOTPMessageRequestParameters.Builder codeLength(Integer codeLength)

      The number of characters in the generated OTP.

      Parameters:
      codeLength - The number of characters in the generated OTP.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • destinationIdentity

      SendOTPMessageRequestParameters.Builder destinationIdentity(String destinationIdentity)

      The destination identity to send OTP to.

      Parameters:
      destinationIdentity - The destination identity to send OTP to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • entityId

      SendOTPMessageRequestParameters.Builder entityId(String entityId)

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

      Parameters:
      entityId - A unique Entity ID received from DLT after entity registration is approved.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • language

      SendOTPMessageRequestParameters.Builder language(String language)

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

      Parameters:
      language - The language to be used for the outgoing message body containing the OTP.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • originationIdentity

      SendOTPMessageRequestParameters.Builder originationIdentity(String originationIdentity)

      The origination identity used to send OTP from.

      Parameters:
      originationIdentity - The origination identity used to send OTP from.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • referenceId

      SendOTPMessageRequestParameters.Builder referenceId(String referenceId)

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

      Parameters:
      referenceId - Developer-specified reference identifier. Required to match during OTP verification.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • templateId

      SendOTPMessageRequestParameters.Builder templateId(String templateId)

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

      Parameters:
      templateId - A unique Template ID received from DLT after entity registration is approved.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • validityPeriod

      SendOTPMessageRequestParameters.Builder validityPeriod(Integer validityPeriod)

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

      Parameters:
      validityPeriod - The time in minutes before the OTP is no longer valid.
      Returns:
      Returns a reference to this object so that method calls can be chained together.