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

Class UpdatePhoneNumberRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.pinpointsmsvoicev2.model.PinpointSmsVoiceV2Request

software.amazon.awssdk.services.pinpointsmsvoicev2.model.UpdatePhoneNumberRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdatePhoneNumberRequest.Builder,UpdatePhoneNumberRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdatePhoneNumberRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdatePhoneNumberRequest.Builder	builder()
Boolean	deletionProtectionEnabled()	By default this is set to false.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	optOutListName()	The OptOutList to add the phone number to.
String	phoneNumberId()	The unique identifier of the phone number.
List<SdkField<?>>	sdkFields()
Boolean	selfManagedOptOutsEnabled()	By default this is set to false.
static Class<? extends UpdatePhoneNumberRequest.Builder>	serializableBuilderClass()
UpdatePhoneNumberRequest.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.awscore.AwsRequest

overrideConfiguration

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

phoneNumberId

public final String phoneNumberId()

The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.

Returns:

The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.

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

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 OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.

Returns:

The OptOutList to add the phone number to. Valid values for this field can be either the OutOutListName or OutOutListArn.

deletionProtectionEnabled

public final Boolean deletionProtectionEnabled()

By default this is set to false. When set to true the phone number can't be deleted.

Returns:

By default this is set to false. When set to true the phone number can't be deleted.

toBuilder

public UpdatePhoneNumberRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdatePhoneNumberRequest.Builder,UpdatePhoneNumberRequest>

Specified by:

toBuilder in class PinpointSmsVoiceV2Request

builder

public static UpdatePhoneNumberRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo