@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SendVoiceMessageRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
SendVoiceMessageRequest() |
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.
|
String |
getProtectConfigurationId()
The unique identifier for the protect configuration.
|
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 |
setProtectConfigurationId(String protectConfigurationId)
The unique identifier for the protect configuration.
|
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 |
withProtectConfigurationId(String protectConfigurationId)
The unique identifier for the protect configuration.
|
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.
|
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
public void setDestinationPhoneNumber(String destinationPhoneNumber)
The destination phone number in E.164 format.
destinationPhoneNumber
- The destination phone number in E.164 format.public String getDestinationPhoneNumber()
The destination phone number in E.164 format.
public SendVoiceMessageRequest withDestinationPhoneNumber(String destinationPhoneNumber)
The destination phone number in E.164 format.
destinationPhoneNumber
- The destination phone number in E.164 format.public void setOriginationIdentity(String originationIdentity)
The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
originationIdentity
- The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId,
PhoneNumberArn, PoolId, or PoolArn.public String getOriginationIdentity()
The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
public SendVoiceMessageRequest withOriginationIdentity(String originationIdentity)
The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId, PhoneNumberArn, PoolId, or PoolArn.
originationIdentity
- The origination identity to use for the voice call. This can be the PhoneNumber, PhoneNumberId,
PhoneNumberArn, PoolId, or PoolArn.public void setMessageBody(String messageBody)
The text to convert to a voice message.
messageBody
- The text to convert to a voice message.public String getMessageBody()
The text to convert to a voice message.
public SendVoiceMessageRequest withMessageBody(String messageBody)
The text to convert to a voice message.
messageBody
- The text to convert to a voice message.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.
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.
VoiceMessageBodyTextType
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.
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.
VoiceMessageBodyTextType
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.
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.
VoiceMessageBodyTextType
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.
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.
VoiceMessageBodyTextType
public void setVoiceId(String voiceId)
The voice for the Amazon Polly service to use. By default this is set to "MATTHEW".
voiceId
- The voice for the Amazon Polly
service to use. By default this is set to "MATTHEW".VoiceId
public String getVoiceId()
The voice for the Amazon Polly service to use. By default this is set to "MATTHEW".
VoiceId
public SendVoiceMessageRequest withVoiceId(String voiceId)
The voice for the Amazon Polly service to use. By default this is set to "MATTHEW".
voiceId
- The voice for the Amazon Polly
service to use. By default this is set to "MATTHEW".VoiceId
public SendVoiceMessageRequest withVoiceId(VoiceId voiceId)
The voice for the Amazon Polly service to use. By default this is set to "MATTHEW".
voiceId
- The voice for the Amazon Polly
service to use. By default this is set to "MATTHEW".VoiceId
public void setConfigurationSetName(String configurationSetName)
The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
configurationSetName
- The name of the configuration set to use. This can be either the ConfigurationSetName or
ConfigurationSetArn.public String getConfigurationSetName()
The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
public SendVoiceMessageRequest withConfigurationSetName(String configurationSetName)
The name of the configuration set to use. This can be either the ConfigurationSetName or ConfigurationSetArn.
configurationSetName
- The name of the configuration set to use. This can be either the ConfigurationSetName or
ConfigurationSetArn.public void setMaxPricePerMinute(String maxPricePerMinute)
The maximum amount to spend per voice message, in US dollars.
maxPricePerMinute
- The maximum amount to spend per voice message, in US dollars.public String getMaxPricePerMinute()
The maximum amount to spend per voice message, in US dollars.
public SendVoiceMessageRequest withMaxPricePerMinute(String maxPricePerMinute)
The maximum amount to spend per voice message, in US dollars.
maxPricePerMinute
- The maximum amount to spend per voice message, in US dollars.public void setTimeToLive(Integer timeToLive)
How long the voice message is valid for. By default this is 72 hours.
timeToLive
- How long the voice message is valid for. By default this is 72 hours.public Integer getTimeToLive()
How long the voice message is valid for. By default this is 72 hours.
public SendVoiceMessageRequest withTimeToLive(Integer timeToLive)
How long the voice message is valid for. By default this is 72 hours.
timeToLive
- How long the voice message is valid for. By default this is 72 hours.public Map<String,String> getContext()
You can specify custom data in this field. If you do, that data is logged to the event destination.
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.
context
- You can specify custom data in this field. If you do, that data is logged to the event destination.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.
context
- You can specify custom data in this field. If you do, that data is logged to the event destination.public SendVoiceMessageRequest addContextEntry(String key, String value)
public SendVoiceMessageRequest clearContextEntries()
public void setDryRun(Boolean dryRun)
When set to true, the message is checked and validated, but isn't sent to the end recipient.
dryRun
- When set to true, the message is checked and validated, but isn't sent to the end recipient.public Boolean getDryRun()
When set to true, the message is checked and validated, but isn't sent to the end recipient.
public SendVoiceMessageRequest withDryRun(Boolean dryRun)
When set to true, the message is checked and validated, but isn't sent to the end recipient.
dryRun
- When set to true, the message is checked and validated, but isn't sent to the end recipient.public Boolean isDryRun()
When set to true, the message is checked and validated, but isn't sent to the end recipient.
public void setProtectConfigurationId(String protectConfigurationId)
The unique identifier for the protect configuration.
protectConfigurationId
- The unique identifier for the protect configuration.public String getProtectConfigurationId()
The unique identifier for the protect configuration.
public SendVoiceMessageRequest withProtectConfigurationId(String protectConfigurationId)
The unique identifier for the protect configuration.
protectConfigurationId
- The unique identifier for the protect configuration.public String toString()
toString
in class Object
Object.toString()
public SendVoiceMessageRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()