Interface SendWhatsAppMessageRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<SendWhatsAppMessageRequest.Builder,SendWhatsAppMessageRequest>, SdkBuilder<SendWhatsAppMessageRequest.Builder,SendWhatsAppMessageRequest>, SdkPojo, SdkRequest.Builder, SocialMessagingRequest.Builder

Enclosing class:

SendWhatsAppMessageRequest

@Mutable
@NotThreadSafe
public static interface SendWhatsAppMessageRequest.Builder
extends SocialMessagingRequest.Builder, SdkPojo, CopyableBuilder<SendWhatsAppMessageRequest.Builder,SendWhatsAppMessageRequest>

Method Summary

Modifier and Type	Method	Description
SendWhatsAppMessageRequest.Builder	message(SdkBytes message)	The message to send through WhatsApp.
SendWhatsAppMessageRequest.Builder	metaApiVersion(String metaApiVersion)	The API version for the request formatted as v{VersionNumber}.
SendWhatsAppMessageRequest.Builder	originationPhoneNumberId(String originationPhoneNumberId)	The ID of the phone number used to send the WhatsApp message.
SendWhatsAppMessageRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SendWhatsAppMessageRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.

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.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.services.socialmessaging.model.SocialMessagingRequest.Builder

build

Method Details

originationPhoneNumberId

SendWhatsAppMessageRequest.Builder originationPhoneNumberId(String originationPhoneNumberId)

The ID of the phone number used to send the WhatsApp message. If you are sending a media file only the originationPhoneNumberId used to upload the file can be used. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number's id.

Parameters:

originationPhoneNumberId - The ID of the phone number used to send the WhatsApp message. If you are sending a media file only the originationPhoneNumberId used to upload the file can be used. Phone number identifiers are formatted as phone-number-id-01234567890123456789012345678901. Use GetLinkedWhatsAppBusinessAccount to find a phone number's id.

Returns:

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

message

SendWhatsAppMessageRequest.Builder message(SdkBytes message)

The message to send through WhatsApp. The length is in KB. The message field passes through a WhatsApp Message object, see Messages in the WhatsApp Business Platform Cloud API Reference.

Parameters:

message - The message to send through WhatsApp. The length is in KB. The message field passes through a WhatsApp Message object, see Messages in the WhatsApp Business Platform Cloud API Reference.

Returns:

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

metaApiVersion

SendWhatsAppMessageRequest.Builder metaApiVersion(String metaApiVersion)

The API version for the request formatted as v{VersionNumber}. For a list of supported API versions and Amazon Web Services Regions, see Amazon Web Services End User Messaging Social API Service Endpoints in the Amazon Web Services General Reference.

Parameters:

metaApiVersion - The API version for the request formatted as v{VersionNumber}. For a list of supported API versions and Amazon Web Services Regions, see Amazon Web Services End User Messaging Social API Service Endpoints in the Amazon Web Services General Reference.

Returns:

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

overrideConfiguration

SendWhatsAppMessageRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

SendWhatsAppMessageRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.