software.amazon.awssdk.services.s3.model

Interface CreateMultipartUploadResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<CreateMultipartUploadResponse.Builder,CreateMultipartUploadResponse>, S3Response.Builder, SdkBuilder<CreateMultipartUploadResponse.Builder,CreateMultipartUploadResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

CreateMultipartUploadResponse

public static interface CreateMultipartUploadResponse.Builder
extends S3Response.Builder, SdkPojo, CopyableBuilder<CreateMultipartUploadResponse.Builder,CreateMultipartUploadResponse>

Method Summary

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) Name of the bucket to which the multipart upload was initiated.
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 AWS KMS Encryption Context to use for object encryption.
CreateMultipartUploadResponse.Builder	ssekmsKeyId(String ssekmsKeyId) If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.
CreateMultipartUploadResponse.Builder	uploadId(String uploadId) ID for the initiated multipart upload.

Methods inherited from interface software.amazon.awssdk.services.s3.model.S3Response.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

abortDate

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 Policy.

The response also includes the x-amz-abort-rule-id header that provides the ID of the lifecycle configuration rule that defines this action.

Parameters:

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 Policy.

The response also includes the x-amz-abort-rule-id header that provides the ID of the lifecycle configuration rule that defines this action.

Returns:

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

abortRuleId

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.

Parameters:

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.

Returns:

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

bucket

CreateMultipartUploadResponse.Builder bucket(String bucket)

Name of the bucket to which the multipart upload was initiated.

When using this API 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 operation using an access point through the AWS 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 Simple Storage Service Developer Guide.

Parameters:

bucket - Name of the bucket to which the multipart upload was initiated.

When using this API 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 operation using an access point through the AWS 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 Simple Storage Service Developer Guide.

Returns:

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

key

CreateMultipartUploadResponse.Builder key(String key)

Object key for which the multipart upload was initiated.

Parameters:

key - Object key for which the multipart upload was initiated.

Returns:

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

uploadId

CreateMultipartUploadResponse.Builder uploadId(String uploadId)

ID for the initiated multipart upload.

Parameters:

uploadId - ID for the initiated multipart upload.

Returns:

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

serverSideEncryption

CreateMultipartUploadResponse.Builder serverSideEncryption(String serverSideEncryption)

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

Parameters:

serverSideEncryption - The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

Returns:

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

See Also:

ServerSideEncryption, 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).

Parameters:

serverSideEncryption - The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

Returns:

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

See Also:

ServerSideEncryption, ServerSideEncryption

sseCustomerAlgorithm

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.

Parameters:

sseCustomerAlgorithm - If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

Returns:

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

sseCustomerKeyMD5

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.

Parameters:

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.

Returns:

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

ssekmsKeyId

CreateMultipartUploadResponse.Builder ssekmsKeyId(String ssekmsKeyId)

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.

Parameters:

ssekmsKeyId - If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.

Returns:

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

ssekmsEncryptionContext

CreateMultipartUploadResponse.Builder ssekmsEncryptionContext(String ssekmsEncryptionContext)

If present, specifies the AWS 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.

Parameters:

ssekmsEncryptionContext - If present, specifies the AWS 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.

Returns:

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

requestCharged

CreateMultipartUploadResponse.Builder requestCharged(String requestCharged)

Sets the value of the RequestCharged property for this object.

Parameters:

requestCharged - The new value for the RequestCharged property for this object.

Returns:

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

See Also:

RequestCharged, RequestCharged

requestCharged

CreateMultipartUploadResponse.Builder requestCharged(RequestCharged requestCharged)

Sets the value of the RequestCharged property for this object.

Parameters:

requestCharged - The new value for the RequestCharged property for this object.

Returns:

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

See Also:

RequestCharged, RequestCharged