com.amazonaws.services.pinpointsmsvoicev2.model

Class RequestSenderIdRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.pinpointsmsvoicev2.model.RequestSenderIdRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RequestSenderIdRequest()

Method Summary

Modifier and Type	Method and Description
RequestSenderIdRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Boolean	getDeletionProtectionEnabled() By default this is set to false.
String	getIsoCountryCode() The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
List<String>	getMessageTypes() The type of message.
String	getSenderId() The sender ID string to request.
List<Tag>	getTags() An array of tags (key and value pairs) to associate with the sender ID.
int	hashCode()
Boolean	isDeletionProtectionEnabled() By default this is set to false.
void	setClientToken(String clientToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
void	setDeletionProtectionEnabled(Boolean deletionProtectionEnabled) By default this is set to false.
void	setIsoCountryCode(String isoCountryCode) The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
void	setMessageTypes(Collection<String> messageTypes) The type of message.
void	setSenderId(String senderId) The sender ID string to request.
void	setTags(Collection<Tag> tags) An array of tags (key and value pairs) to associate with the sender ID.
String	toString() Returns a string representation of this object.
RequestSenderIdRequest	withClientToken(String clientToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
RequestSenderIdRequest	withDeletionProtectionEnabled(Boolean deletionProtectionEnabled) By default this is set to false.
RequestSenderIdRequest	withIsoCountryCode(String isoCountryCode) The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.
RequestSenderIdRequest	withMessageTypes(Collection<String> messageTypes) The type of message.
RequestSenderIdRequest	withMessageTypes(MessageType... messageTypes) The type of message.
RequestSenderIdRequest	withMessageTypes(String... messageTypes) The type of message.
RequestSenderIdRequest	withSenderId(String senderId) The sender ID string to request.
RequestSenderIdRequest	withTags(Collection<Tag> tags) An array of tags (key and value pairs) to associate with the sender ID.
RequestSenderIdRequest	withTags(Tag... tags) An array of tags (key and value pairs) to associate with the sender ID.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RequestSenderIdRequest

public RequestSenderIdRequest()

Method Detail

setSenderId

public void setSenderId(String senderId)

The sender ID string to request.

Parameters:

senderId - The sender ID string to request.

getSenderId

public String getSenderId()

The sender ID string to request.

Returns:

The sender ID string to request.

withSenderId

public RequestSenderIdRequest withSenderId(String senderId)

The sender ID string to request.

Parameters:

senderId - The sender ID string to request.

Returns:

Returns a reference to this object so that method calls can be chained together.

setIsoCountryCode

public void setIsoCountryCode(String isoCountryCode)

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

Parameters:

isoCountryCode - The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

getIsoCountryCode

public String getIsoCountryCode()

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

Returns:

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

withIsoCountryCode

public RequestSenderIdRequest withIsoCountryCode(String isoCountryCode)

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

Parameters:

isoCountryCode - The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

Returns:

Returns a reference to this object so that method calls can be chained together.

getMessageTypes

public List<String> getMessageTypes()

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

Returns:

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

See Also:

MessageType

setMessageTypes

public void setMessageTypes(Collection<String> messageTypes)

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

Parameters:

messageTypes - The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

See Also:

MessageType

withMessageTypes

public RequestSenderIdRequest withMessageTypes(String... messageTypes)

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

NOTE: This method appends the values to the existing list (if any). Use setMessageTypes(java.util.Collection) or withMessageTypes(java.util.Collection) if you want to override the existing values.

Parameters:

messageTypes - The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MessageType

withMessageTypes

public RequestSenderIdRequest withMessageTypes(Collection<String> messageTypes)

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

Parameters:

messageTypes - The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MessageType

withMessageTypes

public RequestSenderIdRequest withMessageTypes(MessageType... messageTypes)

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

Parameters:

messageTypes - The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MessageType

setDeletionProtectionEnabled

public void setDeletionProtectionEnabled(Boolean deletionProtectionEnabled)

By default this is set to false. When set to true the sender ID can't be deleted.

Parameters:

deletionProtectionEnabled - By default this is set to false. When set to true the sender ID can't be deleted.

getDeletionProtectionEnabled

public Boolean getDeletionProtectionEnabled()

By default this is set to false. When set to true the sender ID can't be deleted.

Returns:

By default this is set to false. When set to true the sender ID can't be deleted.

withDeletionProtectionEnabled

public RequestSenderIdRequest withDeletionProtectionEnabled(Boolean deletionProtectionEnabled)

By default this is set to false. When set to true the sender ID can't be deleted.

Parameters:

deletionProtectionEnabled - By default this is set to false. When set to true the sender ID can't be deleted.

Returns:

Returns a reference to this object so that method calls can be chained together.

isDeletionProtectionEnabled

public Boolean isDeletionProtectionEnabled()

By default this is set to false. When set to true the sender ID can't be deleted.

Returns:

By default this is set to false. When set to true the sender ID can't be deleted.

getTags

public List<Tag> getTags()

An array of tags (key and value pairs) to associate with the sender ID.

Returns:

An array of tags (key and value pairs) to associate with the sender ID.

setTags

public void setTags(Collection<Tag> tags)

An array of tags (key and value pairs) to associate with the sender ID.

Parameters:

tags - An array of tags (key and value pairs) to associate with the sender ID.

withTags

public RequestSenderIdRequest withTags(Tag... tags)

An array of tags (key and value pairs) to associate with the sender ID.

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags - An array of tags (key and value pairs) to associate with the sender ID.

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public RequestSenderIdRequest withTags(Collection<Tag> tags)

An array of tags (key and value pairs) to associate with the sender ID.

Parameters:

tags - An array of tags (key and value pairs) to associate with the sender ID.

Returns:

Returns a reference to this object so that method calls can be chained together.

setClientToken

public void setClientToken(String clientToken)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

Parameters:

clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

getClientToken

public String getClientToken()

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

Returns:

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

withClientToken

public RequestSenderIdRequest withClientToken(String clientToken)

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

Parameters:

clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

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 RequestSenderIdRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()