com.amazonaws.services.pinpoint.model

Class SendOTPMessageRequestParameters

java.lang.Object

com.amazonaws.services.pinpoint.model.SendOTPMessageRequestParameters

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SendOTPMessageRequestParameters
extends Object
implements Serializable, Cloneable, StructuredPojo

Send OTP message request parameters.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SendOTPMessageRequestParameters()

Method Summary

Modifier and Type	Method and Description
SendOTPMessageRequestParameters	clone()
boolean	equals(Object obj)
Integer	getAllowedAttempts() The attempts allowed to validate an OTP.
String	getBrandName() The brand name that will be substituted into the OTP message body.
String	getChannel() Channel type for the OTP message.
Integer	getCodeLength() The number of characters in the generated OTP.
String	getDestinationIdentity() The destination identity to send OTP to.
String	getEntityId() A unique Entity ID received from DLT after entity registration is approved.
String	getLanguage() The language to be used for the outgoing message body containing the OTP.
String	getOriginationIdentity() The origination identity used to send OTP from.
String	getReferenceId() Developer-specified reference identifier.
String	getTemplateId() A unique Template ID received from DLT after entity registration is approved.
Integer	getValidityPeriod() The time in minutes before the OTP is no longer valid.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setAllowedAttempts(Integer allowedAttempts) The attempts allowed to validate an OTP.
void	setBrandName(String brandName) The brand name that will be substituted into the OTP message body.
void	setChannel(String channel) Channel type for the OTP message.
void	setCodeLength(Integer codeLength) The number of characters in the generated OTP.
void	setDestinationIdentity(String destinationIdentity) The destination identity to send OTP to.
void	setEntityId(String entityId) A unique Entity ID received from DLT after entity registration is approved.
void	setLanguage(String language) The language to be used for the outgoing message body containing the OTP.
void	setOriginationIdentity(String originationIdentity) The origination identity used to send OTP from.
void	setReferenceId(String referenceId) Developer-specified reference identifier.
void	setTemplateId(String templateId) A unique Template ID received from DLT after entity registration is approved.
void	setValidityPeriod(Integer validityPeriod) The time in minutes before the OTP is no longer valid.
String	toString() Returns a string representation of this object.
SendOTPMessageRequestParameters	withAllowedAttempts(Integer allowedAttempts) The attempts allowed to validate an OTP.
SendOTPMessageRequestParameters	withBrandName(String brandName) The brand name that will be substituted into the OTP message body.
SendOTPMessageRequestParameters	withChannel(String channel) Channel type for the OTP message.
SendOTPMessageRequestParameters	withCodeLength(Integer codeLength) The number of characters in the generated OTP.
SendOTPMessageRequestParameters	withDestinationIdentity(String destinationIdentity) The destination identity to send OTP to.
SendOTPMessageRequestParameters	withEntityId(String entityId) A unique Entity ID received from DLT after entity registration is approved.
SendOTPMessageRequestParameters	withLanguage(String language) The language to be used for the outgoing message body containing the OTP.
SendOTPMessageRequestParameters	withOriginationIdentity(String originationIdentity) The origination identity used to send OTP from.
SendOTPMessageRequestParameters	withReferenceId(String referenceId) Developer-specified reference identifier.
SendOTPMessageRequestParameters	withTemplateId(String templateId) A unique Template ID received from DLT after entity registration is approved.
SendOTPMessageRequestParameters	withValidityPeriod(Integer validityPeriod) The time in minutes before the OTP is no longer valid.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SendOTPMessageRequestParameters

public SendOTPMessageRequestParameters()

Method Detail

setAllowedAttempts

public void setAllowedAttempts(Integer allowedAttempts)

The attempts allowed to validate an OTP.

Parameters:

allowedAttempts - The attempts allowed to validate an OTP.

getAllowedAttempts

public Integer getAllowedAttempts()

The attempts allowed to validate an OTP.

Returns:

The attempts allowed to validate an OTP.

withAllowedAttempts

public SendOTPMessageRequestParameters withAllowedAttempts(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.

setBrandName

public void setBrandName(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.

getBrandName

public String getBrandName()

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.

withBrandName

public SendOTPMessageRequestParameters withBrandName(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.

setChannel

public void setChannel(String channel)

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

Parameters:

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

getChannel

public String getChannel()

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

Returns:

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

withChannel

public SendOTPMessageRequestParameters withChannel(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.

setCodeLength

public void setCodeLength(Integer codeLength)

The number of characters in the generated OTP.

Parameters:

codeLength - The number of characters in the generated OTP.

getCodeLength

public Integer getCodeLength()

The number of characters in the generated OTP.

Returns:

The number of characters in the generated OTP.

withCodeLength

public SendOTPMessageRequestParameters withCodeLength(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.

setDestinationIdentity

public void setDestinationIdentity(String destinationIdentity)

The destination identity to send OTP to.

Parameters:

destinationIdentity - The destination identity to send OTP to.

getDestinationIdentity

public String getDestinationIdentity()

The destination identity to send OTP to.

Returns:

The destination identity to send OTP to.

withDestinationIdentity

public SendOTPMessageRequestParameters withDestinationIdentity(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.

setEntityId

public void setEntityId(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.

getEntityId

public String getEntityId()

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.

withEntityId

public SendOTPMessageRequestParameters withEntityId(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.

setLanguage

public void setLanguage(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.

getLanguage

public String getLanguage()

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.

withLanguage

public SendOTPMessageRequestParameters withLanguage(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.

setOriginationIdentity

public void setOriginationIdentity(String originationIdentity)

The origination identity used to send OTP from.

Parameters:

originationIdentity - The origination identity used to send OTP from.

getOriginationIdentity

public String getOriginationIdentity()

The origination identity used to send OTP from.

Returns:

The origination identity used to send OTP from.

withOriginationIdentity

public SendOTPMessageRequestParameters withOriginationIdentity(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.

setReferenceId

public void setReferenceId(String referenceId)

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

Parameters:

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

getReferenceId

public String getReferenceId()

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

Returns:

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

withReferenceId

public SendOTPMessageRequestParameters withReferenceId(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.

setTemplateId

public void setTemplateId(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.

getTemplateId

public String getTemplateId()

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.

withTemplateId

public SendOTPMessageRequestParameters withTemplateId(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.

setValidityPeriod

public void setValidityPeriod(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.

getValidityPeriod

public Integer getValidityPeriod()

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

Returns:

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

withValidityPeriod

public SendOTPMessageRequestParameters withValidityPeriod(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SendOTPMessageRequestParameters clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo