software.amazon.awssdk.services.pinpointsmsvoicev2.model

Interface UpdatePhoneNumberRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdatePhoneNumberRequest.Builder,UpdatePhoneNumberRequest>, PinpointSmsVoiceV2Request.Builder, SdkBuilder<UpdatePhoneNumberRequest.Builder,UpdatePhoneNumberRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdatePhoneNumberRequest

public static interface UpdatePhoneNumberRequest.Builder
extends PinpointSmsVoiceV2Request.Builder, SdkPojo, CopyableBuilder<UpdatePhoneNumberRequest.Builder,UpdatePhoneNumberRequest>

Method Summary

Modifier and Type	Method and Description
UpdatePhoneNumberRequest.Builder	deletionProtectionEnabled(Boolean deletionProtectionEnabled) By default this is set to false.
UpdatePhoneNumberRequest.Builder	optOutListName(String optOutListName) The OptOutList to add the phone number to.
UpdatePhoneNumberRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdatePhoneNumberRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdatePhoneNumberRequest.Builder	phoneNumberId(String phoneNumberId) The unique identifier of the phone number.
UpdatePhoneNumberRequest.Builder	selfManagedOptOutsEnabled(Boolean selfManagedOptOutsEnabled) By default this is set to false.
UpdatePhoneNumberRequest.Builder	twoWayChannelArn(String twoWayChannelArn) The Amazon Resource Name (ARN) of the two way channel.
UpdatePhoneNumberRequest.Builder	twoWayEnabled(Boolean twoWayEnabled) By default this is set to false.

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

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

phoneNumberId

UpdatePhoneNumberRequest.Builder phoneNumberId(String phoneNumberId)

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

Parameters:

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

Returns:

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

twoWayEnabled

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

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

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

UpdatePhoneNumberRequest.Builder optOutListName(String optOutListName)

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

Parameters:

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

Returns:

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

deletionProtectionEnabled

UpdatePhoneNumberRequest.Builder deletionProtectionEnabled(Boolean deletionProtectionEnabled)

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

Parameters:

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

Returns:

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

overrideConfiguration

UpdatePhoneNumberRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdatePhoneNumberRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder