Class DeletePoolResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.pinpointsmsvoicev2.model.PinpointSmsVoiceV2Response
software.amazon.awssdk.services.pinpointsmsvoicev2.model.DeletePoolResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DeletePoolResponse.Builder,DeletePoolResponse>
@Generated("software.amazon.awssdk:codegen") public final class DeletePoolResponse extends PinpointSmsVoiceV2Response implements ToCopyableBuilder<DeletePoolResponse.Builder,DeletePoolResponse>

  • Method Details

    • poolArn

      public final String poolArn()

      The Amazon Resource Name (ARN) of the pool that was deleted.

      Returns:
      The Amazon Resource Name (ARN) of the pool that was deleted.

    • poolId

      public final String poolId()

      The PoolId of the pool that was deleted.

      Returns:
      The PoolId of the pool that was deleted.

    • status

      public final PoolStatus status()

      The current status of the pool.

      • CREATING: The pool is currently being created and isn't yet available for use.

      • ACTIVE: The pool is active and available for use.

      • DELETING: The pool is being deleted.

      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.

      • CREATING: The pool is currently being created and isn't yet available for use.

      • ACTIVE: The pool is active and available for use.

      • DELETING: The pool is being deleted.

      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the pool.

      • CREATING: The pool is currently being created and isn't yet available for use.

      • ACTIVE: The pool is active and available for use.

      • DELETING: The pool is being deleted.

      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.

      • CREATING: The pool is currently being created and isn't yet available for use.

      • ACTIVE: The pool is active and available for use.

      • DELETING: The pool is being deleted.

      See Also:

    • messageType

      public final MessageType messageType()

      The message type that was associated with the deleted pool.

      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 message type that was associated with the deleted pool.
      See Also:

    • messageTypeAsString

      public final String messageTypeAsString()

      The message type that was associated with the deleted pool.

      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 message type that was associated with the deleted pool.
      See Also:

    • twoWayEnabled

      public final Boolean twoWayEnabled()

      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.

    • twoWayChannelArn

      public final String twoWayChannelArn()

      The Amazon Resource Name (ARN) of the TwoWayChannel.

      Returns:
      The Amazon Resource Name (ARN) of the TwoWayChannel.

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

      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.

    • optOutListName

      public final String optOutListName()

      The name of the OptOutList that was associated with the deleted pool.

      Returns:
      The name of the OptOutList that was associated with the deleted pool.

    • sharedRoutesEnabled

      public final Boolean sharedRoutesEnabled()

      Indicates whether shared routes are enabled for the pool.

      Returns:
      Indicates whether shared routes are enabled for the pool.

    • 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 DeletePoolResponse.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<DeletePoolResponse.Builder,DeletePoolResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DeletePoolResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.