com.amazonaws.services.pinpointsmsvoicev2.model

Class CreatePoolRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.pinpointsmsvoicev2.model.CreatePoolRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreatePoolRequest
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
CreatePoolRequest()

Method Summary

Modifier and Type	Method and Description
CreatePoolRequest	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 new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.
String	getMessageType() The type of message.
String	getOriginationIdentity() The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn.
List<Tag>	getTags() An array of tags (key and value pairs) associated with the pool.
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 new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.
void	setMessageType(String messageType) The type of message.
void	setOriginationIdentity(String originationIdentity) The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn.
void	setTags(Collection<Tag> tags) An array of tags (key and value pairs) associated with the pool.
String	toString() Returns a string representation of this object.
CreatePoolRequest	withClientToken(String clientToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreatePoolRequest	withDeletionProtectionEnabled(Boolean deletionProtectionEnabled) By default this is set to false.
CreatePoolRequest	withIsoCountryCode(String isoCountryCode) The new two-character code, in ISO 3166-1 alpha-2 format, for the country or region of the new pool.
CreatePoolRequest	withMessageType(MessageType messageType) The type of message.
CreatePoolRequest	withMessageType(String messageType) The type of message.
CreatePoolRequest	withOriginationIdentity(String originationIdentity) The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn.
CreatePoolRequest	withTags(Collection<Tag> tags) An array of tags (key and value pairs) associated with the pool.
CreatePoolRequest	withTags(Tag... tags) An array of tags (key and value pairs) associated with the pool.

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

CreatePoolRequest

public CreatePoolRequest()

Method Detail

setOriginationIdentity

public void setOriginationIdentity(String originationIdentity)

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

After the pool is created you can add more origination identities to the pool by using AssociateOriginationIdentity.

Parameters:

originationIdentity - The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

After the pool is created you can add more origination identities to the pool by using AssociateOriginationIdentity.

getOriginationIdentity

public String getOriginationIdentity()

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

After the pool is created you can add more origination identities to the pool by using AssociateOriginationIdentity.

Returns:

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

After the pool is created you can add more origination identities to the pool by using AssociateOriginationIdentity.

withOriginationIdentity

public CreatePoolRequest withOriginationIdentity(String originationIdentity)

The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

After the pool is created you can add more origination identities to the pool by using AssociateOriginationIdentity.

Parameters:

originationIdentity - The origination identity to use such as a PhoneNumberId, PhoneNumberArn, SenderId or SenderIdArn. You can use DescribePhoneNumbers to find the values for PhoneNumberId and PhoneNumberArn while DescribeSenderIds can be used to get the values for SenderId and SenderIdArn.

After the pool is created you can add more origination identities to the pool by using AssociateOriginationIdentity.

Returns:

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

setIsoCountryCode

public void setIsoCountryCode(String isoCountryCode)

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

Parameters:

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

getIsoCountryCode

public String getIsoCountryCode()

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

Returns:

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

withIsoCountryCode

public CreatePoolRequest withIsoCountryCode(String isoCountryCode)

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

Parameters:

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

Returns:

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

setMessageType

public void setMessageType(String messageType)

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. After the pool is created the MessageType can't be changed.

Parameters:

messageType - 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. After the pool is created the MessageType can't be changed.

See Also:

MessageType

getMessageType

public String getMessageType()

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. After the pool is created the MessageType can't be changed.

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. After the pool is created the MessageType can't be changed.

See Also:

MessageType

withMessageType

public CreatePoolRequest withMessageType(String messageType)

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. After the pool is created the MessageType can't be changed.

Parameters:

messageType - 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. After the pool is created the MessageType can't be changed.

Returns:

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

See Also:

MessageType

withMessageType

public CreatePoolRequest withMessageType(MessageType messageType)

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. After the pool is created the MessageType can't be changed.

Parameters:

messageType - 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. After the pool is created the MessageType can't be changed.

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 pool can't be deleted. You can change this value using the UpdatePool action.

Parameters:

deletionProtectionEnabled - By default this is set to false. When set to true the pool can't be deleted. You can change this value using the UpdatePool action.

getDeletionProtectionEnabled

public Boolean getDeletionProtectionEnabled()

By default this is set to false. When set to true the pool can't be deleted. You can change this value using the UpdatePool action.

Returns:

By default this is set to false. When set to true the pool can't be deleted. You can change this value using the UpdatePool action.

withDeletionProtectionEnabled

public CreatePoolRequest withDeletionProtectionEnabled(Boolean deletionProtectionEnabled)

By default this is set to false. When set to true the pool can't be deleted. You can change this value using the UpdatePool action.

Parameters:

deletionProtectionEnabled - By default this is set to false. When set to true the pool can't be deleted. You can change this value using the UpdatePool action.

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 pool can't be deleted. You can change this value using the UpdatePool action.

Returns:

By default this is set to false. When set to true the pool can't be deleted. You can change this value using the UpdatePool action.

getTags

public List<Tag> getTags()

An array of tags (key and value pairs) associated with the pool.

Returns:

An array of tags (key and value pairs) associated with the pool.

setTags

public void setTags(Collection<Tag> tags)

An array of tags (key and value pairs) associated with the pool.

Parameters:

tags - An array of tags (key and value pairs) associated with the pool.

withTags

public CreatePoolRequest withTags(Tag... tags)

An array of tags (key and value pairs) associated with the pool.

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) associated with the pool.

Returns:

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

withTags

public CreatePoolRequest withTags(Collection<Tag> tags)

An array of tags (key and value pairs) associated with the pool.

Parameters:

tags - An array of tags (key and value pairs) associated with the pool.

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 CreatePoolRequest 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 CreatePoolRequest 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()