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 Summary
Modifier and TypeMethodDescriptionallowedAttempts
(Integer allowedAttempts) The attempts allowed to validate an OTP.The brand name that will be substituted into the OTP message body.Channel type for the OTP message.codeLength
(Integer codeLength) The number of characters in the generated OTP.destinationIdentity
(String destinationIdentity) The destination identity to send OTP to.A unique Entity ID received from DLT after entity registration is approved.The language to be used for the outgoing message body containing the OTP.originationIdentity
(String originationIdentity) The origination identity used to send OTP from.referenceId
(String referenceId) Developer-specified reference identifier.templateId
(String templateId) A unique Template ID received from DLT after entity registration is approved.validityPeriod
(Integer validityPeriod) The time in minutes before the OTP is no longer valid.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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
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
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
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
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
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
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
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
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
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
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.
-