public static interface CreateMultipartUploadResponse.Builder extends S3Response.Builder, SdkPojo, CopyableBuilder<CreateMultipartUploadResponse.Builder,CreateMultipartUploadResponse>
Modifier and Type | Method and Description |
---|---|
CreateMultipartUploadResponse.Builder |
abortDate(Instant abortDate)
If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the
prefix in the lifecycle rule matches the object name in the request, the response includes this header.
|
CreateMultipartUploadResponse.Builder |
abortRuleId(String abortRuleId)
This header is returned along with the
x-amz-abort-date header. |
CreateMultipartUploadResponse.Builder |
bucket(String bucket)
The name of the bucket to which the multipart upload was initiated.
|
CreateMultipartUploadResponse.Builder |
bucketKeyEnabled(Boolean bucketKeyEnabled)
Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web
Services KMS (SSE-KMS).
|
CreateMultipartUploadResponse.Builder |
checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)
The algorithm that was used to create a checksum of the object.
|
CreateMultipartUploadResponse.Builder |
checksumAlgorithm(String checksumAlgorithm)
The algorithm that was used to create a checksum of the object.
|
CreateMultipartUploadResponse.Builder |
key(String key)
Object key for which the multipart upload was initiated.
|
CreateMultipartUploadResponse.Builder |
requestCharged(RequestCharged requestCharged)
Sets the value of the RequestCharged property for this object.
|
CreateMultipartUploadResponse.Builder |
requestCharged(String requestCharged)
Sets the value of the RequestCharged property for this object.
|
CreateMultipartUploadResponse.Builder |
serverSideEncryption(ServerSideEncryption serverSideEncryption)
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256,
aws:kms ). |
CreateMultipartUploadResponse.Builder |
serverSideEncryption(String serverSideEncryption)
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256,
aws:kms ). |
CreateMultipartUploadResponse.Builder |
sseCustomerAlgorithm(String sseCustomerAlgorithm)
If server-side encryption with a customer-provided encryption key was requested, the response will include
this header confirming the encryption algorithm used.
|
CreateMultipartUploadResponse.Builder |
sseCustomerKeyMD5(String sseCustomerKeyMD5)
If server-side encryption with a customer-provided encryption key was requested, the response will include
this header to provide round-trip message integrity verification of the customer-provided encryption key.
|
CreateMultipartUploadResponse.Builder |
ssekmsEncryptionContext(String ssekmsEncryptionContext)
If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption.
|
CreateMultipartUploadResponse.Builder |
ssekmsKeyId(String ssekmsKeyId)
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS)
symmetric encryption customer managed key that was used for the object.
|
CreateMultipartUploadResponse.Builder |
uploadId(String uploadId)
ID for the initiated multipart upload.
|
build, responseMetadata, responseMetadata
sdkHttpResponse, sdkHttpResponse
equalsBySdkFields, sdkFields
copy
applyMutation, build
CreateMultipartUploadResponse.Builder abortDate(Instant abortDate)
If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and the prefix in the lifecycle rule matches the object name in the request, the response includes this header. The header indicates when the initiated multipart upload becomes eligible for an abort operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.
The response also includes the x-amz-abort-rule-id
header that provides the ID of the lifecycle
configuration rule that defines this action.
abortDate
- If the bucket has a lifecycle rule configured with an action to abort incomplete multipart uploads and
the prefix in the lifecycle rule matches the object name in the request, the response includes this
header. The header indicates when the initiated multipart upload becomes eligible for an abort
operation. For more information, see Aborting Incomplete Multipart Uploads Using a Bucket Lifecycle Configuration.
The response also includes the x-amz-abort-rule-id
header that provides the ID of the
lifecycle configuration rule that defines this action.
CreateMultipartUploadResponse.Builder abortRuleId(String abortRuleId)
This header is returned along with the x-amz-abort-date
header. It identifies the applicable
lifecycle configuration rule that defines the action to abort incomplete multipart uploads.
abortRuleId
- This header is returned along with the x-amz-abort-date
header. It identifies the
applicable lifecycle configuration rule that defines the action to abort incomplete multipart uploads.CreateMultipartUploadResponse.Builder bucket(String bucket)
The name of the bucket to which the multipart upload was initiated. Does not return the access point ARN or access point alias if used.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname.
The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in
the Amazon S3 User Guide.
bucket
- The name of the bucket to which the multipart upload was initiated. Does not return the access point
ARN or access point alias if used.
When using this action with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using access points in the Amazon S3 User Guide.
When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts
hostname. The S3 on Outposts hostname takes the form
AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
. When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the
Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs,
see What is S3 on
Outposts in the Amazon S3 User Guide.
CreateMultipartUploadResponse.Builder key(String key)
Object key for which the multipart upload was initiated.
key
- Object key for which the multipart upload was initiated.CreateMultipartUploadResponse.Builder uploadId(String uploadId)
ID for the initiated multipart upload.
uploadId
- ID for the initiated multipart upload.CreateMultipartUploadResponse.Builder serverSideEncryption(String serverSideEncryption)
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256,
aws:kms
).
serverSideEncryption
- The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256,
aws:kms
).ServerSideEncryption
,
ServerSideEncryption
CreateMultipartUploadResponse.Builder serverSideEncryption(ServerSideEncryption serverSideEncryption)
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256,
aws:kms
).
serverSideEncryption
- The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256,
aws:kms
).ServerSideEncryption
,
ServerSideEncryption
CreateMultipartUploadResponse.Builder sseCustomerAlgorithm(String sseCustomerAlgorithm)
If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
sseCustomerAlgorithm
- If server-side encryption with a customer-provided encryption key was requested, the response will
include this header confirming the encryption algorithm used.CreateMultipartUploadResponse.Builder sseCustomerKeyMD5(String sseCustomerKeyMD5)
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.
sseCustomerKeyMD5
- If server-side encryption with a customer-provided encryption key was requested, the response will
include this header to provide round-trip message integrity verification of the customer-provided
encryption key.CreateMultipartUploadResponse.Builder ssekmsKeyId(String ssekmsKeyId)
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric encryption customer managed key that was used for the object.
ssekmsKeyId
- If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services
KMS) symmetric encryption customer managed key that was used for the object.CreateMultipartUploadResponse.Builder ssekmsEncryptionContext(String ssekmsEncryptionContext)
If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
ssekmsEncryptionContext
- If present, specifies the Amazon Web Services KMS Encryption Context to use for object encryption. The
value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context
key-value pairs.CreateMultipartUploadResponse.Builder bucketKeyEnabled(Boolean bucketKeyEnabled)
Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
bucketKeyEnabled
- Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Amazon
Web Services KMS (SSE-KMS).CreateMultipartUploadResponse.Builder requestCharged(String requestCharged)
requestCharged
- The new value for the RequestCharged property for this object.RequestCharged
,
RequestCharged
CreateMultipartUploadResponse.Builder requestCharged(RequestCharged requestCharged)
requestCharged
- The new value for the RequestCharged property for this object.RequestCharged
,
RequestCharged
CreateMultipartUploadResponse.Builder checksumAlgorithm(String checksumAlgorithm)
The algorithm that was used to create a checksum of the object.
checksumAlgorithm
- The algorithm that was used to create a checksum of the object.ChecksumAlgorithm
,
ChecksumAlgorithm
CreateMultipartUploadResponse.Builder checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)
The algorithm that was used to create a checksum of the object.
checksumAlgorithm
- The algorithm that was used to create a checksum of the object.ChecksumAlgorithm
,
ChecksumAlgorithm
Copyright © 2023. All rights reserved.