Interface SendMediaMessageRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<SendMediaMessageRequest.Builder,SendMediaMessageRequest>,PinpointSmsVoiceV2Request.Builder,SdkBuilder<SendMediaMessageRequest.Builder,SendMediaMessageRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- SendMediaMessageRequest
public static interface SendMediaMessageRequest.Builder extends PinpointSmsVoiceV2Request.Builder, SdkPojo, CopyableBuilder<SendMediaMessageRequest.Builder,SendMediaMessageRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description SendMediaMessageRequest.BuilderconfigurationSetName(String configurationSetName)The name of the configuration set to use.SendMediaMessageRequest.Buildercontext(Map<String,String> context)You can specify custom data in this field.SendMediaMessageRequest.BuilderdestinationPhoneNumber(String destinationPhoneNumber)The destination phone number in E.164 format.SendMediaMessageRequest.BuilderdryRun(Boolean dryRun)When set to true, the message is checked and validated, but isn't sent to the end recipient.SendMediaMessageRequest.BuildermaxPrice(String maxPrice)The maximum amount that you want to spend, in US dollars, per each MMS message.SendMediaMessageRequest.BuildermediaUrls(String... mediaUrls)An array of URLs to each media file to send.SendMediaMessageRequest.BuildermediaUrls(Collection<String> mediaUrls)An array of URLs to each media file to send.SendMediaMessageRequest.BuildermessageBody(String messageBody)The text body of the message.SendMediaMessageRequest.BuilderoriginationIdentity(String originationIdentity)The origination identity of the message.SendMediaMessageRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)SendMediaMessageRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)SendMediaMessageRequest.BuilderprotectConfigurationId(String protectConfigurationId)The unique identifier of the protect configuration to use.SendMediaMessageRequest.BuildertimeToLive(Integer timeToLive)How long the text message is valid for.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.pinpointsmsvoicev2.model.PinpointSmsVoiceV2Request.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
destinationPhoneNumber
SendMediaMessageRequest.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
SendMediaMessageRequest.Builder originationIdentity(String originationIdentity)
The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.
- Parameters:
originationIdentity- The origination identity of the message. This can be either the PhoneNumber, PhoneNumberId, PhoneNumberArn, SenderId, SenderIdArn, PoolId, or PoolArn.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
messageBody
SendMediaMessageRequest.Builder messageBody(String messageBody)
The text body of the message.
- Parameters:
messageBody- The text body of the message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mediaUrls
SendMediaMessageRequest.Builder mediaUrls(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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mediaUrls
SendMediaMessageRequest.Builder mediaUrls(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.
- Parameters:
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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
configurationSetName
SendMediaMessageRequest.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.
-
maxPrice
SendMediaMessageRequest.Builder maxPrice(String maxPrice)
The maximum amount that you want to spend, in US dollars, per each MMS message.
- Parameters:
maxPrice- The maximum amount that you want to spend, in US dollars, per each MMS message.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
timeToLive
SendMediaMessageRequest.Builder timeToLive(Integer timeToLive)
How long the text message is valid for. By default this is 72 hours.
- Parameters:
timeToLive- How long the text 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
SendMediaMessageRequest.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
SendMediaMessageRequest.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.
-
protectConfigurationId
SendMediaMessageRequest.Builder protectConfigurationId(String protectConfigurationId)
The unique identifier of the protect configuration to use.
- Parameters:
protectConfigurationId- The unique identifier of the protect configuration to use.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
SendMediaMessageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
SendMediaMessageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-