com.amazonaws.services.pinpointsmsvoicev2.model

Class SendVoiceMessageRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.pinpointsmsvoicev2.model.SendVoiceMessageRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SendVoiceMessageRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SendVoiceMessageRequest()

Method Summary

Modifier and Type	Method and Description
SendVoiceMessageRequest	addContextEntry(String key, String value) Add a single Context entry
SendVoiceMessageRequest	clearContextEntries() Removes all the entries added into Context.
SendVoiceMessageRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getConfigurationSetName() The name of the configuration set to use.
Map<String,String>	getContext() You can specify custom data in this field.
String	getDestinationPhoneNumber() The destination phone number in E.164 format.
Boolean	getDryRun() When set to true, the message is checked and validated, but isn't sent to the end recipient.
String	getMaxPricePerMinute() The maximum amount to spend per voice message, in US dollars.
String	getMessageBody() The text to convert to a voice message.
String	getMessageBodyTextType() Specifies if the MessageBody field contains text or speech synthesis markup language (SSML).
String	getOriginationIdentity() The origination identity to use for the voice call.
Integer	getTimeToLive() How long the voice message is valid for.
String	getVoiceId() The voice for the Amazon Polly service to use.
int	hashCode()
Boolean	isDryRun() When set to true, the message is checked and validated, but isn't sent to the end recipient.
void	setConfigurationSetName(String configurationSetName) The name of the configuration set to use.
void	setContext(Map<String,String> context) You can specify custom data in this field.
void	setDestinationPhoneNumber(String destinationPhoneNumber) The destination phone number in E.164 format.
void	setDryRun(Boolean dryRun) When set to true, the message is checked and validated, but isn't sent to the end recipient.
void	setMaxPricePerMinute(String maxPricePerMinute) The maximum amount to spend per voice message, in US dollars.
void	setMessageBody(String messageBody) The text to convert to a voice message.
void	setMessageBodyTextType(String messageBodyTextType) Specifies if the MessageBody field contains text or speech synthesis markup language (SSML).
void	setOriginationIdentity(String originationIdentity) The origination identity to use for the voice call.
void	setTimeToLive(Integer timeToLive) How long the voice message is valid for.
void	setVoiceId(String voiceId) The voice for the Amazon Polly service to use.
String	toString() Returns a string representation of this object.
SendVoiceMessageRequest	withConfigurationSetName(String configurationSetName) The name of the configuration set to use.
SendVoiceMessageRequest	withContext(Map<String,String> context) You can specify custom data in this field.
SendVoiceMessageRequest	withDestinationPhoneNumber(String destinationPhoneNumber) The destination phone number in E.164 format.
SendVoiceMessageRequest	withDryRun(Boolean dryRun) When set to true, the message is checked and validated, but isn't sent to the end recipient.
SendVoiceMessageRequest	withMaxPricePerMinute(String maxPricePerMinute) The maximum amount to spend per voice message, in US dollars.
SendVoiceMessageRequest	withMessageBody(String messageBody) The text to convert to a voice message.
SendVoiceMessageRequest	withMessageBodyTextType(String messageBodyTextType) Specifies if the MessageBody field contains text or speech synthesis markup language (SSML).
SendVoiceMessageRequest	withMessageBodyTextType(VoiceMessageBodyTextType messageBodyTextType) Specifies if the MessageBody field contains text or speech synthesis markup language (SSML).
SendVoiceMessageRequest	withOriginationIdentity(String originationIdentity) The origination identity to use for the voice call.
SendVoiceMessageRequest	withTimeToLive(Integer timeToLive) How long the voice message is valid for.
SendVoiceMessageRequest	withVoiceId(String voiceId) The voice for the Amazon Polly service to use.
SendVoiceMessageRequest	withVoiceId(VoiceId voiceId) The voice for the Amazon Polly service to use.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SendVoiceMessageRequest

public SendVoiceMessageRequest()

Method Detail

setDestinationPhoneNumber

public void setDestinationPhoneNumber(String destinationPhoneNumber)

The destination phone number in E.164 format.

Parameters:

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

getDestinationPhoneNumber

public String getDestinationPhoneNumber()

The destination phone number in E.164 format.

Returns:

The destination phone number in E.164 format.

withDestinationPhoneNumber

public SendVoiceMessageRequest withDestinationPhoneNumber(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.

setOriginationIdentity

public void setOriginationIdentity(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.

getOriginationIdentity

public String getOriginationIdentity()

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.

withOriginationIdentity

public SendVoiceMessageRequest withOriginationIdentity(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.

setMessageBody

public void setMessageBody(String messageBody)

The text to convert to a voice message.

Parameters:

messageBody - The text to convert to a voice message.

getMessageBody

public String getMessageBody()

The text to convert to a voice message.

Returns:

The text to convert to a voice message.

withMessageBody

public SendVoiceMessageRequest withMessageBody(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.

setMessageBodyTextType

public void setMessageBodyTextType(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.

See Also:

VoiceMessageBodyTextType

getMessageBodyTextType

public String getMessageBodyTextType()

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:

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

withMessageBodyTextType

public SendVoiceMessageRequest withMessageBodyTextType(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

withMessageBodyTextType

public SendVoiceMessageRequest withMessageBodyTextType(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

setVoiceId

public void setVoiceId(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".

See Also:

VoiceId

getVoiceId

public String getVoiceId()

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

Returns:

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

See Also:

VoiceId

withVoiceId

public SendVoiceMessageRequest withVoiceId(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

withVoiceId

public SendVoiceMessageRequest withVoiceId(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

setConfigurationSetName

public void setConfigurationSetName(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.

getConfigurationSetName

public String getConfigurationSetName()

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.

withConfigurationSetName

public SendVoiceMessageRequest withConfigurationSetName(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.

setMaxPricePerMinute

public void setMaxPricePerMinute(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.

getMaxPricePerMinute

public String getMaxPricePerMinute()

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

Returns:

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

withMaxPricePerMinute

public SendVoiceMessageRequest withMaxPricePerMinute(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.

setTimeToLive

public void setTimeToLive(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.

getTimeToLive

public Integer getTimeToLive()

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.

withTimeToLive

public SendVoiceMessageRequest withTimeToLive(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.

getContext

public Map<String,String> getContext()

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

Returns:

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

setContext

public void setContext(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.

withContext

public SendVoiceMessageRequest withContext(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.

addContextEntry

public SendVoiceMessageRequest addContextEntry(String key,
                                               String value)

Add a single Context entry

See Also:

withContext(java.util.Map<java.lang.String, java.lang.String>)

clearContextEntries

public SendVoiceMessageRequest clearContextEntries()

Removes all the entries added into Context.

Returns:

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

setDryRun

public void setDryRun(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.

getDryRun

public Boolean getDryRun()

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.

withDryRun

public SendVoiceMessageRequest withDryRun(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.

isDryRun

public Boolean isDryRun()

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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SendVoiceMessageRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()