@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SendMediaMessageRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP | Constructor and Description |
|---|
SendMediaMessageRequest () |
| Modifier and Type | Method and Description |
|---|---|
SendMediaMessageRequest |
addContextEntry (String key,
String value)
Add a single Context entry
|
SendMediaMessageRequest |
clearContextEntries ()
Removes all the entries added into Context.
|
SendMediaMessageRequest |
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 |
getMaxPrice ()
The maximum amount that you want to spend, in US dollars, per each MMS message.
|
List<String> |
getMediaUrls ()
An array of URLs to each media file to send.
|
String |
getMessageBody ()
The text body of the message.
|
String |
getOriginationIdentity ()
The origination identity of the message.
|
String |
getProtectConfigurationId ()
The unique identifier of the protect configuration to use.
|
Integer |
getTimeToLive ()
How long the text message is valid for.
|
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 |
setMaxPrice (String maxPrice)
The maximum amount that you want to spend, in US dollars, per each MMS message.
|
void |
setMediaUrls (Collection<String> mediaUrls)
An array of URLs to each media file to send.
|
void |
setMessageBody (String messageBody)
The text body of the message.
|
void |
setOriginationIdentity (String originationIdentity)
The origination identity of the message.
|
void |
setProtectConfigurationId (String protectConfigurationId)
The unique identifier of the protect configuration to use.
|
void |
setTimeToLive (Integer timeToLive)
How long the text message is valid for.
|
String |
toString ()
Returns a string representation of this object.
|
SendMediaMessageRequest |
withConfigurationSetName (String configurationSetName)
The name of the configuration set to use.
|
SendMediaMessageRequest |
withContext (Map<String,String> context)
You can specify custom data in this field.
|
SendMediaMessageRequest |
withDestinationPhoneNumber (String destinationPhoneNumber)
The destination phone number in E.164 format.
|
SendMediaMessageRequest |
withDryRun (Boolean dryRun)
When set to true, the message is checked and validated, but isn't sent to the end recipient.
|
SendMediaMessageRequest |
withMaxPrice (String maxPrice)
The maximum amount that you want to spend, in US dollars, per each MMS message.
|
SendMediaMessageRequest |
withMediaUrls (Collection<String> mediaUrls)
An array of URLs to each media file to send.
|
SendMediaMessageRequest |
withMediaUrls (String... mediaUrls)
An array of URLs to each media file to send.
|
SendMediaMessageRequest |
withMessageBody (String messageBody)
The text body of the message.
|
SendMediaMessageRequest |
withOriginationIdentity (String originationIdentity)
The origination identity of the message.
|
SendMediaMessageRequest |
withProtectConfigurationId (String protectConfigurationId)
The unique identifier of the protect configuration to use.
|
SendMediaMessageRequest |
withTimeToLive (Integer timeToLive)
How long the text message is valid for.
|
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 SendMediaMessageRequest()
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 SendMediaMessageRequest 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 of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
originationIdentity - The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId,
PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.public String getOriginationIdentity()
The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
public SendMediaMessageRequest withOriginationIdentity(String originationIdentity)
The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
originationIdentity - The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId,
PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.public void setMessageBody(String messageBody)
The text body of the message.
messageBody - The text body of the message.public String getMessageBody()
The text body of the message.
public SendMediaMessageRequest withMessageBody(String messageBody)
The text body of the message.
messageBody - The text body of the message.public List<String> getMediaUrls()
An array of URLs to each media file to send.
The media files have to be stored in a publicly available S3 bucket. Supported media file formats are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing objects, see Creating a bucket and Uploading objects in the S3 user guide.
The media files have to be stored in a publicly available S3 bucket. Supported media file formats are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing objects, see Creating a bucket and Uploading objects in the S3 user guide.
public void setMediaUrls(Collection<String> mediaUrls)
An array of URLs to each media file to send.
The media files have to be stored in a publicly available S3 bucket. Supported media file formats are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing objects, see Creating a bucket and Uploading objects in the S3 user guide.
mediaUrls - An array of URLs to each media file to send.
The media files have to be stored in a publicly available S3 bucket. Supported media file formats are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing objects, see Creating a bucket and Uploading objects in the S3 user guide.
public SendMediaMessageRequest withMediaUrls(String... mediaUrls)
An array of URLs to each media file to send.
The media files have to be stored in a publicly available S3 bucket. Supported media file formats are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing objects, see Creating a bucket and Uploading objects in the S3 user guide.
NOTE: This method appends the values to the existing list (if any). Use
setMediaUrls(java.util.Collection) or withMediaUrls(java.util.Collection) if you want to
override the existing values.
mediaUrls - An array of URLs to each media file to send.
The media files have to be stored in a publicly available S3 bucket. Supported media file formats are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing objects, see Creating a bucket and Uploading objects in the S3 user guide.
public SendMediaMessageRequest withMediaUrls(Collection<String> mediaUrls)
An array of URLs to each media file to send.
The media files have to be stored in a publicly available S3 bucket. Supported media file formats are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing objects, see Creating a bucket and Uploading objects in the S3 user guide.
mediaUrls - An array of URLs to each media file to send.
The media files have to be stored in a publicly available S3 bucket. Supported media file formats are listed in MMS file types, size and character limits. For more information on creating an S3 bucket and managing objects, see Creating a bucket and Uploading objects in the S3 user guide.
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 SendMediaMessageRequest 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 setMaxPrice(String maxPrice)
The maximum amount that you want to spend, in US dollars, per each MMS message.
maxPrice - The maximum amount that you want to spend, in US dollars, per each MMS message.public String getMaxPrice()
The maximum amount that you want to spend, in US dollars, per each MMS message.
public SendMediaMessageRequest withMaxPrice(String maxPrice)
The maximum amount that you want to spend, in US dollars, per each MMS message.
maxPrice - The maximum amount that you want to spend, in US dollars, per each MMS message.public void setTimeToLive(Integer timeToLive)
How long the text message is valid for. By default this is 72 hours.
timeToLive - How long the text message is valid for. By default this is 72 hours.public Integer getTimeToLive()
How long the text message is valid for. By default this is 72 hours.
public SendMediaMessageRequest withTimeToLive(Integer timeToLive)
How long the text message is valid for. By default this is 72 hours.
timeToLive - How long the text 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 SendMediaMessageRequest 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 SendMediaMessageRequest addContextEntry(String key, String value)
public SendMediaMessageRequest 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 SendMediaMessageRequest 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 of the protect configuration to use.
protectConfigurationId - The unique identifier of the protect configuration to use.public String getProtectConfigurationId()
The unique identifier of the protect configuration to use.
public SendMediaMessageRequest withProtectConfigurationId(String protectConfigurationId)
The unique identifier of the protect configuration to use.
protectConfigurationId - The unique identifier of the protect configuration to use.public String toString()
toString in class Object Object.toString() public SendMediaMessageRequest clone()
AmazonWebServiceRequest clone in class AmazonWebServiceRequest Object.clone()