CreatePoolResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.pinpointsmsvoicev2.model.CreatePoolResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreatePoolResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreatePoolResult()

Constructors
Constructor and Description
`CreatePoolResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreatePoolResult`	`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 deletion protection is enabled.
`String`	`getMessageType()` The type of message for the pool to use.
`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()` By default this is set to false.
`Boolean`	`getSharedRoutesEnabled()` Indicates whether shared routes are enabled for the pool.
`String`	`getStatus()` The current status of the pool.
`List<Tag>`	`getTags()` An array of tags (key and value pairs) associated with 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 deletion protection is enabled.
`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`	`setCreatedTimestamp(Date createdTimestamp)` The time when the pool was created, in UNIX epoch time format.
`void`	`setDeletionProtectionEnabled(Boolean deletionProtectionEnabled)` When set to true deletion protection is enabled.
`void`	`setMessageType(String messageType)` The type of message for the pool to use.
`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)` By default this is set to false.
`void`	`setSharedRoutesEnabled(Boolean sharedRoutesEnabled)` Indicates whether shared routes are enabled for the pool.
`void`	`setStatus(String status)` The current status of the pool.
`void`	`setTags(Collection<Tag> tags)` An array of tags (key and value pairs) associated with 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.
`CreatePoolResult`	`withCreatedTimestamp(Date createdTimestamp)` The time when the pool was created, in UNIX epoch time format.
`CreatePoolResult`	`withDeletionProtectionEnabled(Boolean deletionProtectionEnabled)` When set to true deletion protection is enabled.
`CreatePoolResult`	`withMessageType(MessageType messageType)` The type of message for the pool to use.
`CreatePoolResult`	`withMessageType(String messageType)` The type of message for the pool to use.
`CreatePoolResult`	`withOptOutListName(String optOutListName)` The name of the OptOutList associated with the pool.
`CreatePoolResult`	`withPoolArn(String poolArn)` The Amazon Resource Name (ARN) for the pool.
`CreatePoolResult`	`withPoolId(String poolId)` The unique identifier for the pool.
`CreatePoolResult`	`withSelfManagedOptOutsEnabled(Boolean selfManagedOptOutsEnabled)` By default this is set to false.
`CreatePoolResult`	`withSharedRoutesEnabled(Boolean sharedRoutesEnabled)` Indicates whether shared routes are enabled for the pool.
`CreatePoolResult`	`withStatus(PoolStatus status)` The current status of the pool.
`CreatePoolResult`	`withStatus(String status)` The current status of the pool.
`CreatePoolResult`	`withTags(Collection<Tag> tags)` An array of tags (key and value pairs) associated with the pool.
`CreatePoolResult`	`withTags(Tag... tags)` An array of tags (key and value pairs) associated with the pool.
`CreatePoolResult`	`withTwoWayChannelArn(String twoWayChannelArn)` The Amazon Resource Name (ARN) of the two way channel.
`CreatePoolResult`	`withTwoWayChannelRole(String twoWayChannelRole)` An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
`CreatePoolResult`	`withTwoWayEnabled(Boolean twoWayEnabled)` By default this is set to false.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreatePoolResult
```
public CreatePoolResult()
```
- Method Detail
  - setPoolArn
```
public void setPoolArn(String poolArn)
```
    The Amazon Resource Name (ARN) for the pool.
    
    Parameters:
    
    poolArn - The Amazon Resource Name (ARN) for the pool.
  - getPoolArn
```
public String getPoolArn()
```
    The Amazon Resource Name (ARN) for the pool.
    
    Returns:
    
    The Amazon Resource Name (ARN) for the pool.
  - withPoolArn
```
public CreatePoolResult withPoolArn(String poolArn)
```
    The Amazon Resource Name (ARN) for the pool.
    
    Parameters:
    
    poolArn - The Amazon Resource Name (ARN) for the pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPoolId
```
public void setPoolId(String poolId)
```
    The unique identifier for the pool.
    
    Parameters:
    
    poolId - The unique identifier for the pool.
  - getPoolId
```
public String getPoolId()
```
    The unique identifier for the pool.
    
    Returns:
    
    The unique identifier for the pool.
  - withPoolId
```
public CreatePoolResult withPoolId(String poolId)
```
    The unique identifier for the pool.
    
    Parameters:
    
    poolId - The unique identifier for the pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String 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.
    Parameters:
    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.
    See Also:
    
    PoolStatus
  - getStatus
```
public String getStatus()
```
    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.
    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:
    
    PoolStatus
  - withStatus
```
public CreatePoolResult withStatus(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PoolStatus
  - withStatus
```
public CreatePoolResult withStatus(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PoolStatus
  - setMessageType
```
public void setMessageType(String messageType)
```
    The type of message for the pool to use.
    
    Parameters:
    
    messageType - The type of message for the pool to use.
    
    See Also:
    
    MessageType
  - getMessageType
```
public String getMessageType()
```
    The type of message for the pool to use.
    
    Returns:
    
    The type of message for the pool to use.
    
    See Also:
    
    MessageType
  - withMessageType
```
public CreatePoolResult withMessageType(String messageType)
```
    The type of message for the pool to use.
    
    Parameters:
    
    messageType - The type of message for the pool to use.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MessageType
  - withMessageType
```
public CreatePoolResult withMessageType(MessageType messageType)
```
    The type of message for the pool to use.
    
    Parameters:
    
    messageType - The type of message for the pool to use.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MessageType
  - 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 CreatePoolResult 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 CreatePoolResult 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 CreatePoolResult 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 CreatePoolResult 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 name of the OptOutList associated with the pool.
    
    Parameters:
    
    optOutListName - The name of the OptOutList associated with the pool.
  - getOptOutListName
```
public String getOptOutListName()
```
    The name of the OptOutList associated with the pool.
    
    Returns:
    
    The name of the OptOutList associated with the pool.
  - withOptOutListName
```
public CreatePoolResult withOptOutListName(String optOutListName)
```
    The name of the OptOutList associated with the pool.
    
    Parameters:
    
    optOutListName - The name of the OptOutList associated with the pool.
    
    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. Set to false and only origination identities in this pool are used to send messages.
    
    Parameters:
    
    sharedRoutesEnabled - Indicates whether shared routes are enabled for the pool. Set to false and only origination identities in this pool are used to send messages.
  - getSharedRoutesEnabled
```
public Boolean getSharedRoutesEnabled()
```
    Indicates whether shared routes are enabled for the pool. Set to false and only origination identities in this pool are used to send messages.
    
    Returns:
    
    Indicates whether shared routes are enabled for the pool. Set to false and only origination identities in this pool are used to send messages.
  - withSharedRoutesEnabled
```
public CreatePoolResult withSharedRoutesEnabled(Boolean sharedRoutesEnabled)
```
    Indicates whether shared routes are enabled for the pool. Set to false and only origination identities in this pool are used to send messages.
    
    Parameters:
    
    sharedRoutesEnabled - Indicates whether shared routes are enabled for the pool. Set to false and only origination identities in this pool are used to send messages.
    
    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. Set to false and only origination identities in this pool are used to send messages.
    
    Returns:
    
    Indicates whether shared routes are enabled for the pool. Set to false and only origination identities in this pool are used to send messages.
  - setDeletionProtectionEnabled
```
public void setDeletionProtectionEnabled(Boolean deletionProtectionEnabled)
```
    When set to true deletion protection is enabled. By default this is set to false.
    
    Parameters:
    
    deletionProtectionEnabled - When set to true deletion protection is enabled. By default this is set to false.
  - getDeletionProtectionEnabled
```
public Boolean getDeletionProtectionEnabled()
```
    When set to true deletion protection is enabled. By default this is set to false.
    
    Returns:
    
    When set to true deletion protection is enabled. By default this is set to false.
  - withDeletionProtectionEnabled
```
public CreatePoolResult withDeletionProtectionEnabled(Boolean deletionProtectionEnabled)
```
    When set to true deletion protection is enabled. By default this is set to false.
    
    Parameters:
    
    deletionProtectionEnabled - When set to true deletion protection is enabled. By default this is set to false.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isDeletionProtectionEnabled
```
public Boolean isDeletionProtectionEnabled()
```
    When set to true deletion protection is enabled. By default this is set to false.
    
    Returns:
    
    When set to true deletion protection is enabled. By default this is set to false.
  - getTags
```
public List<Tag> getTags()
```
    An array of tags (key and value pairs) associated with the pool.
    
    Returns:
    
    An array of tags (key and value pairs) associated with the pool.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    An array of tags (key and value pairs) associated with the pool.
    
    Parameters:
    
    tags - An array of tags (key and value pairs) associated with the pool.
  - withTags
```
public CreatePoolResult withTags(Tag... tags)
```
    An array of tags (key and value pairs) associated with the pool.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - An array of tags (key and value pairs) associated with the pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public CreatePoolResult withTags(Collection<Tag> tags)
```
    An array of tags (key and value pairs) associated with the pool.
    
    Parameters:
    
    tags - An array of tags (key and value pairs) associated with the pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedTimestamp
```
public void setCreatedTimestamp(Date createdTimestamp)
```
    The time when the pool was created, in UNIX epoch time format.
    
    Parameters:
    
    createdTimestamp - The time when the pool was created, in UNIX epoch time format.
  - getCreatedTimestamp
```
public Date getCreatedTimestamp()
```
    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.
  - withCreatedTimestamp
```
public CreatePoolResult withCreatedTimestamp(Date createdTimestamp)
```
    The time when the pool was created, in UNIX epoch time format.
    
    Parameters:
    
    createdTimestamp - The time when the pool was created, in UNIX epoch time format.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 CreatePoolResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.780

Class CreatePoolResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

CreatePoolResult

Method Detail

setPoolArn

getPoolArn

withPoolArn

setPoolId

getPoolId

withPoolId

setStatus

getStatus

withStatus

withStatus

setMessageType

getMessageType

withMessageType

withMessageType

setTwoWayEnabled

getTwoWayEnabled

withTwoWayEnabled

isTwoWayEnabled

setTwoWayChannelArn

getTwoWayChannelArn

withTwoWayChannelArn

setTwoWayChannelRole

getTwoWayChannelRole

withTwoWayChannelRole

setSelfManagedOptOutsEnabled

getSelfManagedOptOutsEnabled

withSelfManagedOptOutsEnabled

isSelfManagedOptOutsEnabled

setOptOutListName

getOptOutListName

withOptOutListName

setSharedRoutesEnabled

getSharedRoutesEnabled

withSharedRoutesEnabled

isSharedRoutesEnabled

setDeletionProtectionEnabled

getDeletionProtectionEnabled

withDeletionProtectionEnabled

isDeletionProtectionEnabled

getTags

setTags

withTags

withTags

setCreatedTimestamp

getCreatedTimestamp

withCreatedTimestamp

toString

equals

hashCode

clone