Interface GetWhatsAppMessageMediaRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<GetWhatsAppMessageMediaRequest.Builder,
,GetWhatsAppMessageMediaRequest> SdkBuilder<GetWhatsAppMessageMediaRequest.Builder,
,GetWhatsAppMessageMediaRequest> SdkPojo
,SdkRequest.Builder
,SocialMessagingRequest.Builder
- Enclosing class:
GetWhatsAppMessageMediaRequest
-
Method Summary
Modifier and TypeMethodDescriptiondestinationS3File
(Consumer<S3File.Builder> destinationS3File) ThebucketName
andkey
of the S3 media file.destinationS3File
(S3File destinationS3File) ThebucketName
andkey
of the S3 media file.destinationS3PresignedUrl
(Consumer<S3PresignedUrl.Builder> destinationS3PresignedUrl) The presign url of the media file.destinationS3PresignedUrl
(S3PresignedUrl destinationS3PresignedUrl) The presign url of the media file.The unique identifier for the media file.metadataOnly
(Boolean metadataOnly) Set toTrue
to get only the metadata for the file.originationPhoneNumberId
(String originationPhoneNumberId) The unique identifier of the originating phone number for the WhatsApp message media.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.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
-
mediaId
The unique identifier for the media file.
- Parameters:
mediaId
- The unique identifier for the media file.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
originationPhoneNumberId
The unique identifier of the originating phone number for the WhatsApp message media. The phone number identifiers are formatted as
phone-number-id-01234567890123456789012345678901
. Use GetLinkedWhatsAppBusinessAccount to find a phone number's id.- Parameters:
originationPhoneNumberId
- The unique identifier of the originating phone number for the WhatsApp message media. The phone number identifiers are formatted asphone-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.
-
metadataOnly
Set to
True
to get only the metadata for the file.- Parameters:
metadataOnly
- Set toTrue
to get only the metadata for the file.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
destinationS3PresignedUrl
GetWhatsAppMessageMediaRequest.Builder destinationS3PresignedUrl(S3PresignedUrl destinationS3PresignedUrl) The presign url of the media file.
- Parameters:
destinationS3PresignedUrl
- The presign url of the media file.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
destinationS3PresignedUrl
default GetWhatsAppMessageMediaRequest.Builder destinationS3PresignedUrl(Consumer<S3PresignedUrl.Builder> destinationS3PresignedUrl) The presign url of the media file.
This is a convenience method that creates an instance of theS3PresignedUrl.Builder
avoiding the need to create one manually viaS3PresignedUrl.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todestinationS3PresignedUrl(S3PresignedUrl)
.- Parameters:
destinationS3PresignedUrl
- a consumer that will call methods onS3PresignedUrl.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
destinationS3File
The
bucketName
andkey
of the S3 media file.- Parameters:
destinationS3File
- ThebucketName
andkey
of the S3 media file.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
destinationS3File
default GetWhatsAppMessageMediaRequest.Builder destinationS3File(Consumer<S3File.Builder> destinationS3File) The
This is a convenience method that creates an instance of thebucketName
andkey
of the S3 media file.S3File.Builder
avoiding the need to create one manually viaS3File.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed todestinationS3File(S3File)
.- Parameters:
destinationS3File
- a consumer that will call methods onS3File.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
GetWhatsAppMessageMediaRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
GetWhatsAppMessageMediaRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-