com.amazonaws.services.pinpointsmsvoicev2.model

Class UpdatePoolRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.pinpointsmsvoicev2.model.UpdatePoolRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Method Summary

Modifier and Type	Method and Description
UpdatePoolRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getDeletionProtectionEnabled() When set to true the pool can't be deleted.
String	getOptOutListName() The OptOutList to associate with the pool.
String	getPoolId() The unique identifier of the pool to update.
Boolean	getSelfManagedOptOutsEnabled() By default this is set to false.
Boolean	getSharedRoutesEnabled() Indicates whether shared routes are enabled for the pool.
String	getTwoWayChannelArn() The Amazon Resource Name (ARN) of the two way channel.
String	getTwoWayChannelRole() An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
Boolean	getTwoWayEnabled() By default this is set to false.
int	hashCode()
Boolean	isDeletionProtectionEnabled() When set to true the pool can't be deleted.
Boolean	isSelfManagedOptOutsEnabled() By default this is set to false.
Boolean	isSharedRoutesEnabled() Indicates whether shared routes are enabled for the pool.
Boolean	isTwoWayEnabled() By default this is set to false.
void	setDeletionProtectionEnabled(Boolean deletionProtectionEnabled) When set to true the pool can't be deleted.
void	setOptOutListName(String optOutListName) The OptOutList to associate with the pool.
void	setPoolId(String poolId) The unique identifier of the pool to update.
void	setSelfManagedOptOutsEnabled(Boolean selfManagedOptOutsEnabled) By default this is set to false.
void	setSharedRoutesEnabled(Boolean sharedRoutesEnabled) Indicates whether shared routes are enabled for the pool.
void	setTwoWayChannelArn(String twoWayChannelArn) The Amazon Resource Name (ARN) of the two way channel.
void	setTwoWayChannelRole(String twoWayChannelRole) An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
void	setTwoWayEnabled(Boolean twoWayEnabled) By default this is set to false.
String	toString() Returns a string representation of this object.
UpdatePoolRequest	withDeletionProtectionEnabled(Boolean deletionProtectionEnabled) When set to true the pool can't be deleted.
UpdatePoolRequest	withOptOutListName(String optOutListName) The OptOutList to associate with the pool.
UpdatePoolRequest	withPoolId(String poolId) The unique identifier of the pool to update.
UpdatePoolRequest	withSelfManagedOptOutsEnabled(Boolean selfManagedOptOutsEnabled) By default this is set to false.
UpdatePoolRequest	withSharedRoutesEnabled(Boolean sharedRoutesEnabled) Indicates whether shared routes are enabled for the pool.
UpdatePoolRequest	withTwoWayChannelArn(String twoWayChannelArn) The Amazon Resource Name (ARN) of the two way channel.
UpdatePoolRequest	withTwoWayChannelRole(String twoWayChannelRole) An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
UpdatePoolRequest	withTwoWayEnabled(Boolean twoWayEnabled) By default this is set to false.

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

UpdatePoolRequest

public UpdatePoolRequest()

Method Detail

setPoolId

public void setPoolId(String poolId)

The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.

Parameters:

poolId - The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.

getPoolId

public String getPoolId()

The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.

Returns:

The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.

withPoolId

public UpdatePoolRequest withPoolId(String poolId)

The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.

Parameters:

poolId - The unique identifier of the pool to update. Valid values are either the PoolId or PoolArn.

Returns:

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

setTwoWayEnabled

public void setTwoWayEnabled(Boolean twoWayEnabled)

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

Parameters:

twoWayEnabled - By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

getTwoWayEnabled

public Boolean getTwoWayEnabled()

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

Returns:

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

withTwoWayEnabled

public UpdatePoolRequest withTwoWayEnabled(Boolean twoWayEnabled)

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

Parameters:

twoWayEnabled - By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

Returns:

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

isTwoWayEnabled

public Boolean isTwoWayEnabled()

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

Returns:

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

setTwoWayChannelArn

public void setTwoWayChannelArn(String twoWayChannelArn)

The Amazon Resource Name (ARN) of the two way channel.

Parameters:

twoWayChannelArn - The Amazon Resource Name (ARN) of the two way channel.

getTwoWayChannelArn

public String getTwoWayChannelArn()

The Amazon Resource Name (ARN) of the two way channel.

Returns:

The Amazon Resource Name (ARN) of the two way channel.

withTwoWayChannelArn

public UpdatePoolRequest withTwoWayChannelArn(String twoWayChannelArn)

The Amazon Resource Name (ARN) of the two way channel.

Parameters:

twoWayChannelArn - The Amazon Resource Name (ARN) of the two way channel.

Returns:

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

setTwoWayChannelRole

public void setTwoWayChannelRole(String twoWayChannelRole)

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

Parameters:

twoWayChannelRole - An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

getTwoWayChannelRole

public String getTwoWayChannelRole()

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

Returns:

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

withTwoWayChannelRole

public UpdatePoolRequest withTwoWayChannelRole(String twoWayChannelRole)

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

Parameters:

twoWayChannelRole - An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

Returns:

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

setSelfManagedOptOutsEnabled

public void setSelfManagedOptOutsEnabled(Boolean selfManagedOptOutsEnabled)

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

Parameters:

selfManagedOptOutsEnabled - By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

getSelfManagedOptOutsEnabled

public Boolean getSelfManagedOptOutsEnabled()

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

Returns:

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

withSelfManagedOptOutsEnabled

public UpdatePoolRequest withSelfManagedOptOutsEnabled(Boolean selfManagedOptOutsEnabled)

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

Parameters:

selfManagedOptOutsEnabled - By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

Returns:

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

isSelfManagedOptOutsEnabled

public Boolean isSelfManagedOptOutsEnabled()

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

Returns:

By default this is set to false. When an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, AWS End User Messaging SMS and Voice automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

setOptOutListName

public void setOptOutListName(String optOutListName)

The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.

Parameters:

optOutListName - The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.

getOptOutListName

public String getOptOutListName()

The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.

Returns:

The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.

withOptOutListName

public UpdatePoolRequest withOptOutListName(String optOutListName)

The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.

Parameters:

optOutListName - The OptOutList to associate with the pool. Valid values are either OptOutListName or OptOutListArn.

Returns:

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

setSharedRoutesEnabled

public void setSharedRoutesEnabled(Boolean sharedRoutesEnabled)

Indicates whether shared routes are enabled for the pool.

Parameters:

sharedRoutesEnabled - Indicates whether shared routes are enabled for the pool.

getSharedRoutesEnabled

public Boolean getSharedRoutesEnabled()

Indicates whether shared routes are enabled for the pool.

Returns:

Indicates whether shared routes are enabled for the pool.

withSharedRoutesEnabled

public UpdatePoolRequest withSharedRoutesEnabled(Boolean sharedRoutesEnabled)

Indicates whether shared routes are enabled for the pool.

Parameters:

sharedRoutesEnabled - Indicates whether shared routes are enabled for the pool.

Returns:

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

isSharedRoutesEnabled

public Boolean isSharedRoutesEnabled()

Indicates whether shared routes are enabled for the pool.

Returns:

Indicates whether shared routes are enabled for the pool.

setDeletionProtectionEnabled

public void setDeletionProtectionEnabled(Boolean deletionProtectionEnabled)

When set to true the pool can't be deleted.

Parameters:

deletionProtectionEnabled - When set to true the pool can't be deleted.

getDeletionProtectionEnabled

public Boolean getDeletionProtectionEnabled()

When set to true the pool can't be deleted.

Returns:

When set to true the pool can't be deleted.

withDeletionProtectionEnabled

public UpdatePoolRequest withDeletionProtectionEnabled(Boolean deletionProtectionEnabled)

When set to true the pool can't be deleted.

Parameters:

deletionProtectionEnabled - When set to true the pool can't be deleted.

Returns:

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

isDeletionProtectionEnabled

public Boolean isDeletionProtectionEnabled()

When set to true the pool can't be deleted.

Returns:

When set to true the pool can't be deleted.

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