Class PoolInformation

java.lang.Object
software.amazon.awssdk.services.pinpointsmsvoicev2.model.PoolInformation
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PoolInformation.Builder,PoolInformation>
@Generated("software.amazon.awssdk:codegen") public final class PoolInformation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PoolInformation.Builder,PoolInformation>

The information for a pool in an Amazon Web Services account.

See Also:

  • Method Details

    • poolArn

      public final String poolArn()

      The Amazon Resource Name (ARN) for the pool.

      Returns:
      The Amazon Resource Name (ARN) for the pool.

    • poolId

      public final String poolId()

      The unique identifier for the pool.

      Returns:
      The unique identifier for the pool.

    • status

      public final PoolStatus 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 return PoolStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the pool.
      See Also:

    • statusAsString

      public final String 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 return PoolStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

      Returns:
      The current status of the pool.
      See Also:

    • messageType

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, messageType will return MessageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageTypeAsString().

      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

      public final String 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 return MessageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageTypeAsString().

      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

      public final Boolean 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

      public final String twoWayChannelArn()

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

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

    • twoWayChannelRole

      public final String 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

      public final 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

      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

      public final String optOutListName()

      The name of the OptOutList associated with the pool.

      Returns:
      The name of the OptOutList associated with the pool.

    • sharedRoutesEnabled

      public final 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.

      Returns:
      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.

    • deletionProtectionEnabled

      public final Boolean deletionProtectionEnabled()

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

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

    • createdTimestamp

      public final Instant 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

      public PoolInformation.Builder 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 interface ToCopyableBuilder<PoolInformation.Builder,PoolInformation>
      Returns:
      a builder for type T

    • builder

      public static PoolInformation.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PoolInformation.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.