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

Class SendVoiceMessageRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SendVoiceMessageRequest.Builder,SendVoiceMessageRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SendVoiceMessageRequest.Builder

Method Summary

Modifier and Type	Method	Description
static SendVoiceMessageRequest.Builder	builder()
String	configurationSetName()	The name of the configuration set to use.
Map<String,String>	context()	You can specify custom data in this field.
String	destinationPhoneNumber()	The destination phone number in E.164 format.
Boolean	dryRun()	When set to true, the message is checked and validated, but isn't sent to the end recipient.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasContext()	For responses, this returns true if the service returned a value for the Context property.
int	hashCode()
String	maxPricePerMinute()	The maximum amount to spend per voice message, in US dollars.
String	messageBody()	The text to convert to a voice message.
VoiceMessageBodyTextType	messageBodyTextType()	Specifies if the MessageBody field contains text or speech synthesis markup language (SSML).
String	messageBodyTextTypeAsString()	Specifies if the MessageBody field contains text or speech synthesis markup language (SSML).
String	originationIdentity()	The origination identity to use for the voice call.
List<SdkField<?>>	sdkFields()
static Class<? extends SendVoiceMessageRequest.Builder>	serializableBuilderClass()
Integer	timeToLive()	How long the voice message is valid for.
SendVoiceMessageRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
VoiceId	voiceId()	The voice for the Amazon Polly service to use.
String	voiceIdAsString()	The voice for the Amazon Polly service to use.

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

destinationPhoneNumber

public final String destinationPhoneNumber()

The destination phone number in E.164 format.

Returns:

The destination phone number in E.164 format.

originationIdentity

public final String originationIdentity()

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

Returns:

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

messageBody

public final String messageBody()

The text to convert to a voice message.

Returns:

The text to convert to a voice message.

messageBodyTextType

public final 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.

If the service returns an enum value that is not available in the current SDK version, messageBodyTextType will return VoiceMessageBodyTextType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageBodyTextTypeAsString().

Returns:

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.

See Also:

VoiceMessageBodyTextType

messageBodyTextTypeAsString

public final String messageBodyTextTypeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, messageBodyTextType will return VoiceMessageBodyTextType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from messageBodyTextTypeAsString().

Returns:

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.

See Also:

VoiceMessageBodyTextType

voiceId

public final VoiceId voiceId()

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

If the service returns an enum value that is not available in the current SDK version, voiceId will return VoiceId.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from voiceIdAsString().

Returns:

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

See Also:

VoiceId

voiceIdAsString

public final String voiceIdAsString()

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

If the service returns an enum value that is not available in the current SDK version, voiceId will return VoiceId.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from voiceIdAsString().

Returns:

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

See Also:

VoiceId

configurationSetName

public final String configurationSetName()

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

Returns:

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

maxPricePerMinute

public final String maxPricePerMinute()

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

Returns:

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

timeToLive

public final Integer timeToLive()

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

Returns:

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

hasContext

public final boolean hasContext()

For responses, this returns true if the service returned a value for the Context property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

context

public final Map<String,String> context()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContext() method.

Returns:

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

dryRun

public final Boolean dryRun()

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

Returns:

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

toBuilder

public SendVoiceMessageRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SendVoiceMessageRequest.Builder,SendVoiceMessageRequest>

Specified by:

toBuilder in class PinpointSmsVoiceV2Request

builder

public static SendVoiceMessageRequest.Builder builder()

serializableBuilderClass

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