com.ibm.cos.v2.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

@Mutable
 @NotThreadSafe
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) 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 Key Management Service (KMS) keys (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	checksumType(ChecksumType checksumType) Indicates the checksum type that you want Amazon S3 to use to calculate the object’s checksum value.
CreateMultipartUploadResponse.Builder	checksumType(String checksumType) Indicates the checksum type that you want Amazon S3 to use to calculate the object’s checksum value.
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 you store this object in Amazon S3 (for example, AES256, aws:kms).
CreateMultipartUploadResponse.Builder	serverSideEncryption(String serverSideEncryption) The server-side encryption algorithm used when you store 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 to confirm the encryption algorithm that's 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 the round-trip message integrity verification of the customer-provided encryption key.
CreateMultipartUploadResponse.Builder	ssekmsEncryptionContext(String ssekmsEncryptionContext) If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption.
CreateMultipartUploadResponse.Builder	ssekmsKeyId(String ssekmsKeyId) If present, indicates the ID of the KMS key that was used for object encryption.
CreateMultipartUploadResponse.Builder	uploadId(String uploadId) ID for the initiated multipart upload.

Methods inherited from interface com.ibm.cos.v2.services.s3.model.S3Response.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface com.ibm.cos.v2.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface com.ibm.cos.v2.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface com.ibm.cos.v2.utils.builder.CopyableBuilder

copy

Methods inherited from interface com.ibm.cos.v2.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 Configuration in the Amazon S3 User Guide.

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

This functionality is not supported for directory buckets.

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 Configuration in the Amazon S3 User Guide.

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

This functionality is not supported for directory buckets.

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.

This functionality is not supported for directory buckets.

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.

This functionality is not supported for directory buckets.

Returns:

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

bucket

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.

Access points are not supported by directory buckets.

Parameters:

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.

Access points are not supported by directory buckets.

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 you store this object in Amazon S3 (for example, AES256, aws:kms).

Parameters:

serverSideEncryption - The server-side encryption algorithm used when you store 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 you store this object in Amazon S3 (for example, AES256, aws:kms).

Parameters:

serverSideEncryption - The server-side encryption algorithm used when you store 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 to confirm the encryption algorithm that's used.

This functionality is not supported for directory buckets.

Parameters:

sseCustomerAlgorithm - If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.

This functionality is not supported for directory buckets.

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 the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

Parameters:

sseCustomerKeyMD5 - If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

Returns:

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

ssekmsKeyId

CreateMultipartUploadResponse.Builder ssekmsKeyId(String ssekmsKeyId)

If present, indicates the ID of the KMS key that was used for object encryption.

Parameters:

ssekmsKeyId - If present, indicates the ID of the KMS key that was used for object encryption.

Returns:

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

ssekmsEncryptionContext

CreateMultipartUploadResponse.Builder ssekmsEncryptionContext(String ssekmsEncryptionContext)

If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs.

Parameters:

ssekmsEncryptionContext - If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a Base64 encoded string of a UTF-8 encoded JSON, which contains the encryption context as key-value pairs.

Returns:

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

bucketKeyEnabled

CreateMultipartUploadResponse.Builder bucketKeyEnabled(Boolean bucketKeyEnabled)

Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

Parameters:

bucketKeyEnabled - Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

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

checksumAlgorithm

CreateMultipartUploadResponse.Builder checksumAlgorithm(String checksumAlgorithm)

The algorithm that was used to create a checksum of the object.

Parameters:

checksumAlgorithm - The algorithm that was used to create a checksum of the object.

Returns:

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

See Also:

ChecksumAlgorithm, ChecksumAlgorithm

checksumAlgorithm

CreateMultipartUploadResponse.Builder checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm)

The algorithm that was used to create a checksum of the object.

Parameters:

checksumAlgorithm - The algorithm that was used to create a checksum of the object.

Returns:

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

See Also:

ChecksumAlgorithm, ChecksumAlgorithm

checksumType

CreateMultipartUploadResponse.Builder checksumType(String checksumType)

Indicates the checksum type that you want Amazon S3 to use to calculate the object’s checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.

Parameters:

checksumType - Indicates the checksum type that you want Amazon S3 to use to calculate the object’s checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.

Returns:

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

See Also:

ChecksumType, ChecksumType

checksumType

CreateMultipartUploadResponse.Builder checksumType(ChecksumType checksumType)

Indicates the checksum type that you want Amazon S3 to use to calculate the object’s checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.

Parameters:

checksumType - Indicates the checksum type that you want Amazon S3 to use to calculate the object’s checksum value. For more information, see Checking object integrity in the Amazon S3 User Guide.

Returns:

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

See Also:

ChecksumType, ChecksumType