software.amazon.awssdk.services.pinpointsmsvoicev2.model

Interface CreatePoolResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<CreatePoolResponse.Builder,CreatePoolResponse>, PinpointSmsVoiceV2Response.Builder, SdkBuilder<CreatePoolResponse.Builder,CreatePoolResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

CreatePoolResponse

public static interface CreatePoolResponse.Builder
extends PinpointSmsVoiceV2Response.Builder, SdkPojo, CopyableBuilder<CreatePoolResponse.Builder,CreatePoolResponse>

Method Summary

Modifier and Type	Method and Description
CreatePoolResponse.Builder	createdTimestamp(Instant createdTimestamp) The time when the pool was created, in UNIX epoch time format.
CreatePoolResponse.Builder	deletionProtectionEnabled(Boolean deletionProtectionEnabled) When set to true deletion protection is enabled.
CreatePoolResponse.Builder	messageType(MessageType messageType) The type of message for the pool to use.
CreatePoolResponse.Builder	messageType(String messageType) The type of message for the pool to use.
CreatePoolResponse.Builder	optOutListName(String optOutListName) The name of the OptOutList associated with the pool.
CreatePoolResponse.Builder	poolArn(String poolArn) The Amazon Resource Name (ARN) for the pool.
CreatePoolResponse.Builder	poolId(String poolId) The unique identifier for the pool.
CreatePoolResponse.Builder	selfManagedOptOutsEnabled(Boolean selfManagedOptOutsEnabled) By default this is set to false.
CreatePoolResponse.Builder	sharedRoutesEnabled(Boolean sharedRoutesEnabled) Indicates whether shared routes are enabled for the pool.
CreatePoolResponse.Builder	status(PoolStatus status) The current status of the pool.
CreatePoolResponse.Builder	status(String status) The current status of the pool.
CreatePoolResponse.Builder	tags(Collection<Tag> tags) An array of tags (key and value pairs) associated with the pool.
CreatePoolResponse.Builder	tags(Consumer<Tag.Builder>... tags) An array of tags (key and value pairs) associated with the pool.
CreatePoolResponse.Builder	tags(Tag... tags) An array of tags (key and value pairs) associated with the pool.
CreatePoolResponse.Builder	twoWayChannelArn(String twoWayChannelArn) The Amazon Resource Name (ARN) of the two way channel.
CreatePoolResponse.Builder	twoWayEnabled(Boolean twoWayEnabled) By default this is set to false.

Methods inherited from interface software.amazon.awssdk.services.pinpointsmsvoicev2.model.PinpointSmsVoiceV2Response.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

poolArn

CreatePoolResponse.Builder poolArn(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.

poolId

CreatePoolResponse.Builder poolId(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.

status

CreatePoolResponse.Builder status(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, PoolStatus

status

CreatePoolResponse.Builder status(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, PoolStatus

messageType

CreatePoolResponse.Builder messageType(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, MessageType

messageType

CreatePoolResponse.Builder messageType(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, MessageType

twoWayEnabled

CreatePoolResponse.Builder twoWayEnabled(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.

twoWayChannelArn

CreatePoolResponse.Builder twoWayChannelArn(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.

selfManagedOptOutsEnabled

CreatePoolResponse.Builder selfManagedOptOutsEnabled(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, Amazon Pinpoint 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, Amazon Pinpoint 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.

optOutListName

CreatePoolResponse.Builder optOutListName(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.

sharedRoutesEnabled

CreatePoolResponse.Builder sharedRoutesEnabled(Boolean sharedRoutesEnabled)

Indicates whether shared routes are enabled for the pool.

Parameters:

sharedRoutesEnabled - Indicates whether shared routes are enabled for the pool.

Returns:

Returns a reference to this object so that method calls can be chained together.

deletionProtectionEnabled

CreatePoolResponse.Builder deletionProtectionEnabled(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.

tags

CreatePoolResponse.Builder tags(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.

tags

CreatePoolResponse.Builder tags(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.

tags

CreatePoolResponse.Builder tags(Consumer<Tag.Builder>... tags)

An array of tags (key and value pairs) associated with the pool.

This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).

Parameters:

tags - a consumer that will call methods on Tag.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#tags(java.util.Collection)

createdTimestamp

CreatePoolResponse.Builder createdTimestamp(Instant 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.