software.amazon.awssdk.services.pinpointsmsvoicev2.model

Interface SendVoiceMessageRequest.Builder

All Superinterfaces:

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

Enclosing class:

SendVoiceMessageRequest

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

Method Summary

Modifier and Type	Method and Description
SendVoiceMessageRequest.Builder	configurationSetName(String configurationSetName) The name of the configuration set to use.
SendVoiceMessageRequest.Builder	context(Map<String,String> context) You can specify custom data in this field.
SendVoiceMessageRequest.Builder	destinationPhoneNumber(String destinationPhoneNumber) The destination phone number in E.164 format.
SendVoiceMessageRequest.Builder	dryRun(Boolean dryRun) When set to true, the message is checked and validated, but isn't sent to the end recipient.
SendVoiceMessageRequest.Builder	maxPricePerMinute(String maxPricePerMinute) The maximum amount to spend per voice message, in US dollars.
SendVoiceMessageRequest.Builder	messageBody(String messageBody) The text to convert to a voice message.
SendVoiceMessageRequest.Builder	messageBodyTextType(String messageBodyTextType) Specifies if the MessageBody field contains text or speech synthesis markup language (SSML).
SendVoiceMessageRequest.Builder	messageBodyTextType(VoiceMessageBodyTextType messageBodyTextType) Specifies if the MessageBody field contains text or speech synthesis markup language (SSML).
SendVoiceMessageRequest.Builder	originationIdentity(String originationIdentity) The origination identity to use for the voice call.
SendVoiceMessageRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
SendVoiceMessageRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
SendVoiceMessageRequest.Builder	timeToLive(Integer timeToLive) How long the voice message is valid for.
SendVoiceMessageRequest.Builder	voiceId(String voiceId) The voice for the Amazon Polly service to use.
SendVoiceMessageRequest.Builder	voiceId(VoiceId voiceId) The voice for the Amazon Polly service to use.

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

destinationPhoneNumber

SendVoiceMessageRequest.Builder destinationPhoneNumber(String destinationPhoneNumber)

The destination phone number in E.164 format.

Parameters:

destinationPhoneNumber - The destination phone number in E.164 format.

Returns:

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

originationIdentity

SendVoiceMessageRequest.Builder originationIdentity(String originationIdentity)

The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.

Parameters:

originationIdentity - The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.

Returns:

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

messageBody

SendVoiceMessageRequest.Builder messageBody(String messageBody)

The text to convert to a voice message.

Parameters:

messageBody - The text to convert to a voice message.

Returns:

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

messageBodyTextType

SendVoiceMessageRequest.Builder messageBodyTextType(String messageBodyTextType)

Specifies if the MessageBody field contains text or speech synthesis markup language (SSML).

• TEXT: This is the default value. When used the maximum character limit is 3000.

• SSML: When used the maximum character limit is 6000 including SSML tagging.

Parameters:

messageBodyTextType - Specifies if the MessageBody field contains text or speech synthesis markup language (SSML).

• TEXT: This is the default value. When used the maximum character limit is 3000.

• SSML: When used the maximum character limit is 6000 including SSML tagging.

Returns:

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

See Also:

VoiceMessageBodyTextType, VoiceMessageBodyTextType

messageBodyTextType

SendVoiceMessageRequest.Builder messageBodyTextType(VoiceMessageBodyTextType messageBodyTextType)

Specifies if the MessageBody field contains text or speech synthesis markup language (SSML).

• TEXT: This is the default value. When used the maximum character limit is 3000.

• SSML: When used the maximum character limit is 6000 including SSML tagging.

Parameters:

messageBodyTextType - Specifies if the MessageBody field contains text or speech synthesis markup language (SSML).

• TEXT: This is the default value. When used the maximum character limit is 3000.

• SSML: When used the maximum character limit is 6000 including SSML tagging.

Returns:

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

See Also:

VoiceMessageBodyTextType, VoiceMessageBodyTextType

voiceId

SendVoiceMessageRequest.Builder voiceId(String voiceId)

The voice for the Amazon Polly service to use. By default this is set to "MATTHEW".

Parameters:

voiceId - The voice for the Amazon Polly service to use. By default this is set to "MATTHEW".

Returns:

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

See Also:

VoiceId, VoiceId

voiceId

SendVoiceMessageRequest.Builder voiceId(VoiceId voiceId)

The voice for the Amazon Polly service to use. By default this is set to "MATTHEW".

Parameters:

voiceId - The voice for the Amazon Polly service to use. By default this is set to "MATTHEW".

Returns:

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

See Also:

VoiceId, VoiceId

configurationSetName

SendVoiceMessageRequest.Builder configurationSetName(String configurationSetName)

The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

Parameters:

configurationSetName - The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.

Returns:

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

maxPricePerMinute

SendVoiceMessageRequest.Builder maxPricePerMinute(String maxPricePerMinute)

The maximum amount to spend per voice message, in US dollars.

Parameters:

maxPricePerMinute - The maximum amount to spend per voice message, in US dollars.

Returns:

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

timeToLive

SendVoiceMessageRequest.Builder timeToLive(Integer timeToLive)

How long the voice message is valid for. By default this is 72 hours.

Parameters:

timeToLive - How long the voice message is valid for. By default this is 72 hours.

Returns:

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

context

SendVoiceMessageRequest.Builder context(Map<String,String> context)

You can specify custom data in this field. If you do, that data is logged to the event destination.

Parameters:

context - You can specify custom data in this field. If you do, that data is logged to the event destination.

Returns:

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

dryRun

SendVoiceMessageRequest.Builder dryRun(Boolean dryRun)

When set to true, the message is checked and validated, but isn't sent to the end recipient.

Parameters:

dryRun - When set to true, the message is checked and validated, but isn't sent to the end recipient.

Returns:

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

overrideConfiguration

SendVoiceMessageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder