Class PoolInformation
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<PoolInformation.Builder,
PoolInformation>
The information for a pool in an Amazon Web Services account.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic PoolInformation.Builder
builder()
final Instant
The time when the pool was created, in UNIX epoch time format.final Boolean
When set to true the pool can't be deleted.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final MessageType
The type of message.final String
The type of message.final String
The name of the OptOutList associated with the pool.final String
poolArn()
The Amazon Resource Name (ARN) for the pool.final String
poolId()
The unique identifier for the pool.final Boolean
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.static Class
<? extends PoolInformation.Builder> final Boolean
Allows you to enable shared routes on your pool.final PoolStatus
status()
The current status of the pool.final String
The current status of the pool.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
The Amazon Resource Name (ARN) of the two way channel.final String
An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.final Boolean
When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
poolArn
The Amazon Resource Name (ARN) for the pool.
- Returns:
- The Amazon Resource Name (ARN) for the pool.
-
poolId
The unique identifier for the pool.
- Returns:
- The unique identifier for the pool.
-
status
The current status of the pool.
If the service returns an enum value that is not available in the current SDK version,
status
will returnPoolStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the pool.
- See Also:
-
statusAsString
The current status of the pool.
If the service returns an enum value that is not available in the current SDK version,
status
will returnPoolStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The current status of the pool.
- See Also:
-
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.
If the service returns an enum value that is not available in the current SDK version,
messageType
will returnMessageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommessageTypeAsString()
.- 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:
-
messageTypeAsString
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.
If the service returns an enum value that is not available in the current SDK version,
messageType
will returnMessageType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommessageTypeAsString()
.- 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:
-
twoWayEnabled
When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
- Returns:
- When set to true you can receive incoming text messages from your end recipients using the TwoWayChannelArn.
-
twoWayChannelArn
The Amazon Resource Name (ARN) of the two way channel.
- Returns:
- The Amazon Resource Name (ARN) of the two way channel.
-
twoWayChannelRole
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.
-
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
- Returns:
- 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
-
optOutListName
The name of the OptOutList associated with the pool.
- Returns:
- The name of the OptOutList associated with the pool.
-
deletionProtectionEnabled
When set to true the pool can't be deleted.
- Returns:
- When set to true the pool can't be deleted.
-
createdTimestamp
The time when the pool was created, in UNIX epoch time format.
- Returns:
- The time when the pool was created, in UNIX epoch time format.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<PoolInformation.Builder,
PoolInformation> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-