@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class PoolInformation extends Object implements Serializable, Cloneable, StructuredPojo
The information for a pool in an Amazon Web Services account.
Constructor and Description |
---|
PoolInformation() |
Modifier and Type | Method and Description |
---|---|
PoolInformation |
clone() |
boolean |
equals(Object obj) |
Date |
getCreatedTimestamp()
The time when the pool was created, in UNIX epoch time format.
|
Boolean |
getDeletionProtectionEnabled()
When set to true the pool can't be deleted.
|
String |
getMessageType()
The type of message.
|
String |
getOptOutListName()
The name of the OptOutList associated with the pool.
|
String |
getPoolArn()
The Amazon Resource Name (ARN) for the pool.
|
String |
getPoolId()
The unique identifier for the pool.
|
Boolean |
getSelfManagedOptOutsEnabled()
When set to false, 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.
|
Boolean |
getSharedRoutesEnabled()
Allows you to enable shared routes on your pool.
|
String |
getStatus()
The current status of 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()
When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
|
int |
hashCode() |
Boolean |
isDeletionProtectionEnabled()
When set to true the pool can't be deleted.
|
Boolean |
isSelfManagedOptOutsEnabled()
When set to false, 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.
|
Boolean |
isSharedRoutesEnabled()
Allows you to enable shared routes on your pool.
|
Boolean |
isTwoWayEnabled()
When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setCreatedTimestamp(Date createdTimestamp)
The time when the pool was created, in UNIX epoch time format.
|
void |
setDeletionProtectionEnabled(Boolean deletionProtectionEnabled)
When set to true the pool can't be deleted.
|
void |
setMessageType(String messageType)
The type of message.
|
void |
setOptOutListName(String optOutListName)
The name of the OptOutList associated with the pool.
|
void |
setPoolArn(String poolArn)
The Amazon Resource Name (ARN) for the pool.
|
void |
setPoolId(String poolId)
The unique identifier for the pool.
|
void |
setSelfManagedOptOutsEnabled(Boolean selfManagedOptOutsEnabled)
When set to false, 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.
|
void |
setSharedRoutesEnabled(Boolean sharedRoutesEnabled)
Allows you to enable shared routes on your pool.
|
void |
setStatus(String status)
The current status of 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)
When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
|
String |
toString()
Returns a string representation of this object.
|
PoolInformation |
withCreatedTimestamp(Date createdTimestamp)
The time when the pool was created, in UNIX epoch time format.
|
PoolInformation |
withDeletionProtectionEnabled(Boolean deletionProtectionEnabled)
When set to true the pool can't be deleted.
|
PoolInformation |
withMessageType(MessageType messageType)
The type of message.
|
PoolInformation |
withMessageType(String messageType)
The type of message.
|
PoolInformation |
withOptOutListName(String optOutListName)
The name of the OptOutList associated with the pool.
|
PoolInformation |
withPoolArn(String poolArn)
The Amazon Resource Name (ARN) for the pool.
|
PoolInformation |
withPoolId(String poolId)
The unique identifier for the pool.
|
PoolInformation |
withSelfManagedOptOutsEnabled(Boolean selfManagedOptOutsEnabled)
When set to false, 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.
|
PoolInformation |
withSharedRoutesEnabled(Boolean sharedRoutesEnabled)
Allows you to enable shared routes on your pool.
|
PoolInformation |
withStatus(PoolStatus status)
The current status of the pool.
|
PoolInformation |
withStatus(String status)
The current status of the pool.
|
PoolInformation |
withTwoWayChannelArn(String twoWayChannelArn)
The Amazon Resource Name (ARN) of the two way channel.
|
PoolInformation |
withTwoWayChannelRole(String twoWayChannelRole)
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
|
PoolInformation |
withTwoWayEnabled(Boolean twoWayEnabled)
When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
|
public void setPoolArn(String poolArn)
The Amazon Resource Name (ARN) for the pool.
poolArn
- The Amazon Resource Name (ARN) for the pool.public String getPoolArn()
The Amazon Resource Name (ARN) for the pool.
public PoolInformation withPoolArn(String poolArn)
The Amazon Resource Name (ARN) for the pool.
poolArn
- The Amazon Resource Name (ARN) for the pool.public void setPoolId(String poolId)
The unique identifier for the pool.
poolId
- The unique identifier for the pool.public String getPoolId()
The unique identifier for the pool.
public PoolInformation withPoolId(String poolId)
The unique identifier for the pool.
poolId
- The unique identifier for the pool.public void setStatus(String status)
The current status of the pool.
status
- The current status of the pool.PoolStatus
public String getStatus()
The current status of the pool.
PoolStatus
public PoolInformation withStatus(String status)
The current status of the pool.
status
- The current status of the pool.PoolStatus
public PoolInformation withStatus(PoolStatus status)
The current status of the pool.
status
- The current status of the pool.PoolStatus
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.
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.MessageType
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.
MessageType
public PoolInformation 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.
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.MessageType
public PoolInformation 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.
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.MessageType
public void setTwoWayEnabled(Boolean twoWayEnabled)
When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
twoWayEnabled
- When set to true you can receive incoming text messages from your end recipients using the
TwoWayChannelArn.public Boolean getTwoWayEnabled()
When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
public PoolInformation withTwoWayEnabled(Boolean twoWayEnabled)
When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
twoWayEnabled
- When set to true you can receive incoming text messages from your end recipients using the
TwoWayChannelArn.public Boolean isTwoWayEnabled()
When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
public void setTwoWayChannelArn(String twoWayChannelArn)
The Amazon Resource Name (ARN) of the two way channel.
twoWayChannelArn
- The Amazon Resource Name (ARN) of the two way channel.public String getTwoWayChannelArn()
The Amazon Resource Name (ARN) of the two way channel.
public PoolInformation withTwoWayChannelArn(String twoWayChannelArn)
The Amazon Resource Name (ARN) of the two way channel.
twoWayChannelArn
- The Amazon Resource Name (ARN) of the two way channel.public void setTwoWayChannelRole(String twoWayChannelRole)
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
twoWayChannelRole
- An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.public String getTwoWayChannelRole()
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
public PoolInformation withTwoWayChannelRole(String twoWayChannelRole)
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
twoWayChannelRole
- An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.public void setSelfManagedOptOutsEnabled(Boolean selfManagedOptOutsEnabled)
When set to false, 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. For more information see Self-managed opt-outs
selfManagedOptOutsEnabled
- When set to false, 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. For more information see Self-managed opt-outspublic Boolean getSelfManagedOptOutsEnabled()
When set to false, 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. For more information see Self-managed opt-outs
public PoolInformation withSelfManagedOptOutsEnabled(Boolean selfManagedOptOutsEnabled)
When set to false, 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. For more information see Self-managed opt-outs
selfManagedOptOutsEnabled
- When set to false, 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. For more information see Self-managed opt-outspublic Boolean isSelfManagedOptOutsEnabled()
When set to false, 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. For more information see Self-managed opt-outs
public void setOptOutListName(String optOutListName)
The name of the OptOutList associated with the pool.
optOutListName
- The name of the OptOutList associated with the pool.public String getOptOutListName()
The name of the OptOutList associated with the pool.
public PoolInformation withOptOutListName(String optOutListName)
The name of the OptOutList associated with the pool.
optOutListName
- The name of the OptOutList associated with the pool.public void setSharedRoutesEnabled(Boolean sharedRoutesEnabled)
Allows you to enable shared routes on your pool.
By default, this is set to False
. If you set this value to True
, your messages are sent
using phone numbers or sender IDs (depending on the country) that are shared with other users. In some countries,
such as the United States, senders aren't allowed to use shared routes and must use a dedicated phone number or
short code.
sharedRoutesEnabled
- Allows you to enable shared routes on your pool.
By default, this is set to False
. If you set this value to True
, your messages
are sent using phone numbers or sender IDs (depending on the country) that are shared with other users. In
some countries, such as the United States, senders aren't allowed to use shared routes and must use a
dedicated phone number or short code.
public Boolean getSharedRoutesEnabled()
Allows you to enable shared routes on your pool.
By default, this is set to False
. If you set this value to True
, your messages are sent
using phone numbers or sender IDs (depending on the country) that are shared with other users. In some countries,
such as the United States, senders aren't allowed to use shared routes and must use a dedicated phone number or
short code.
By default, this is set to False
. If you set this value to True
, your messages
are sent using phone numbers or sender IDs (depending on the country) that are shared with other users.
In some countries, such as the United States, senders aren't allowed to use shared routes and must use a
dedicated phone number or short code.
public PoolInformation withSharedRoutesEnabled(Boolean sharedRoutesEnabled)
Allows you to enable shared routes on your pool.
By default, this is set to False
. If you set this value to True
, your messages are sent
using phone numbers or sender IDs (depending on the country) that are shared with other users. In some countries,
such as the United States, senders aren't allowed to use shared routes and must use a dedicated phone number or
short code.
sharedRoutesEnabled
- Allows you to enable shared routes on your pool.
By default, this is set to False
. If you set this value to True
, your messages
are sent using phone numbers or sender IDs (depending on the country) that are shared with other users. In
some countries, such as the United States, senders aren't allowed to use shared routes and must use a
dedicated phone number or short code.
public Boolean isSharedRoutesEnabled()
Allows you to enable shared routes on your pool.
By default, this is set to False
. If you set this value to True
, your messages are sent
using phone numbers or sender IDs (depending on the country) that are shared with other users. In some countries,
such as the United States, senders aren't allowed to use shared routes and must use a dedicated phone number or
short code.
By default, this is set to False
. If you set this value to True
, your messages
are sent using phone numbers or sender IDs (depending on the country) that are shared with other users.
In some countries, such as the United States, senders aren't allowed to use shared routes and must use a
dedicated phone number or short code.
public void setDeletionProtectionEnabled(Boolean deletionProtectionEnabled)
When set to true the pool can't be deleted.
deletionProtectionEnabled
- When set to true the pool can't be deleted.public Boolean getDeletionProtectionEnabled()
When set to true the pool can't be deleted.
public PoolInformation withDeletionProtectionEnabled(Boolean deletionProtectionEnabled)
When set to true the pool can't be deleted.
deletionProtectionEnabled
- When set to true the pool can't be deleted.public Boolean isDeletionProtectionEnabled()
When set to true the pool can't be deleted.
public void setCreatedTimestamp(Date createdTimestamp)
The time when the pool was created, in UNIX epoch time format.
createdTimestamp
- The time when the pool was created, in UNIX epoch time
format.public Date getCreatedTimestamp()
The time when the pool was created, in UNIX epoch time format.
public PoolInformation withCreatedTimestamp(Date createdTimestamp)
The time when the pool was created, in UNIX epoch time format.
createdTimestamp
- The time when the pool was created, in UNIX epoch time
format.public String toString()
toString
in class Object
Object.toString()
public PoolInformation clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.