Package software.amazon.awssdk.services.pinpointsmsvoicev2.model

Class UpdatePoolResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdatePoolResponse.Builder,UpdatePoolResponse>

@Generated("software.amazon.awssdk:codegen")
public final class UpdatePoolResponse
extends PinpointSmsVoiceV2Response
implements ToCopyableBuilder<UpdatePoolResponse.Builder,UpdatePoolResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdatePoolResponse.Builder

Method Summary

Modifier and Type	Method	Description
static UpdatePoolResponse.Builder	builder()
Instant	createdTimestamp()	The time when the pool was created, in UNIX epoch time format.
Boolean	deletionProtectionEnabled()	When set to true the pool can't be deleted.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
MessageType	messageType()	The type of message for the pool to use.
String	messageTypeAsString()	The type of message for the pool to use.
String	optOutListName()	The name of the OptOutList associated with the pool.
String	poolArn()	The ARN of the pool.
String	poolId()	The unique identifier of the pool.
List<SdkField<?>>	sdkFields()
Boolean	selfManagedOptOutsEnabled()	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.
static Class<? extends UpdatePoolResponse.Builder>	serializableBuilderClass()
Boolean	sharedRoutesEnabled()	Indicates whether shared routes are enabled for the pool.
PoolStatus	status()	The current status of the pool update request.
String	statusAsString()	The current status of the pool update request.
UpdatePoolResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	twoWayChannelArn()	The Amazon Resource Name (ARN) of the two way channel.
String	twoWayChannelRole()	An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.
Boolean	twoWayEnabled()	By default this is set to false.

Methods inherited from class software.amazon.awssdk.services.pinpointsmsvoicev2.model.PinpointSmsVoiceV2Response

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

poolArn

public final String poolArn()

The ARN of the pool.

Returns:

The ARN of the pool.

poolId

public final String poolId()

The unique identifier of the pool.

Returns:

The unique identifier of the pool.

status

public final PoolStatus status()

The current status of the pool update request.

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 update request.

See Also:

PoolStatus

statusAsString

public final String statusAsString()

The current status of the pool update request.

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 update request.

See Also:

PoolStatus

messageType

public final MessageType messageType()

The type of message for the pool to use.

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 for the pool to use.

See Also:

MessageType

messageTypeAsString

public final String messageTypeAsString()

The type of message for the pool to use.

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 for the pool to use.

See Also:

MessageType

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

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.

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

Indicates whether shared routes are enabled for the pool.

Returns:

Indicates whether shared routes are enabled for the pool.

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 UpdatePoolResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdatePoolResponse.Builder,UpdatePoolResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static UpdatePoolResponse.Builder builder()

serializableBuilderClass

public static Class<? extends UpdatePoolResponse.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo