com.ibm.cos.v2.services.s3.model

Interface CompleteMultipartUploadRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CompleteMultipartUploadRequest.Builder,CompleteMultipartUploadRequest>, S3Request.Builder, SdkBuilder<CompleteMultipartUploadRequest.Builder,CompleteMultipartUploadRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CompleteMultipartUploadRequest

@Mutable
 @NotThreadSafe
public static interface CompleteMultipartUploadRequest.Builder
extends S3Request.Builder, SdkPojo, CopyableBuilder<CompleteMultipartUploadRequest.Builder,CompleteMultipartUploadRequest>

Method Summary

Modifier and Type	Method and Description
CompleteMultipartUploadRequest.Builder	bucket(String bucket) Name of the bucket to which the multipart upload was initiated.
CompleteMultipartUploadRequest.Builder	checksumCRC32(String checksumCRC32) This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
CompleteMultipartUploadRequest.Builder	checksumCRC32C(String checksumCRC32C) This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
CompleteMultipartUploadRequest.Builder	checksumCRC64NVME(String checksumCRC64NVME) This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
CompleteMultipartUploadRequest.Builder	checksumSHA1(String checksumSHA1) This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
CompleteMultipartUploadRequest.Builder	checksumSHA256(String checksumSHA256) This header can be used as a data integrity check to verify that the data received is the same data that was originally sent.
CompleteMultipartUploadRequest.Builder	checksumType(ChecksumType checksumType) This header specifies the checksum type of the object, which determines how part-level checksums are combined to create an object-level checksum for multipart objects.
CompleteMultipartUploadRequest.Builder	checksumType(String checksumType) This header specifies the checksum type of the object, which determines how part-level checksums are combined to create an object-level checksum for multipart objects.
CompleteMultipartUploadRequest.Builder	expectedBucketOwner(String expectedBucketOwner) The account ID of the expected bucket owner.
CompleteMultipartUploadRequest.Builder	ifMatch(String ifMatch) Uploads the object only if the ETag (entity tag) value provided during the WRITE operation matches the ETag of the object in S3.
CompleteMultipartUploadRequest.Builder	ifNoneMatch(String ifNoneMatch) Uploads the object only if the object key name does not already exist in the bucket specified.
CompleteMultipartUploadRequest.Builder	key(String key) Object key for which the multipart upload was initiated.
CompleteMultipartUploadRequest.Builder	mpuObjectSize(Long mpuObjectSize) The expected total object size of the multipart upload request.
CompleteMultipartUploadRequest.Builder	multipartUpload(CompletedMultipartUpload multipartUpload) The container for the multipart upload request information.
default CompleteMultipartUploadRequest.Builder	multipartUpload(Consumer<CompletedMultipartUpload.Builder> multipartUpload) The container for the multipart upload request information.
CompleteMultipartUploadRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CompleteMultipartUploadRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CompleteMultipartUploadRequest.Builder	requestPayer(RequestPayer requestPayer) Sets the value of the RequestPayer property for this object.
CompleteMultipartUploadRequest.Builder	requestPayer(String requestPayer) Sets the value of the RequestPayer property for this object.
CompleteMultipartUploadRequest.Builder	retentionExpirationDate(Instant retentionExpirationDate)
CompleteMultipartUploadRequest.Builder	retentionLegalHoldId(String retentionLegalHoldId)
CompleteMultipartUploadRequest.Builder	retentionPeriod(Long retentionPeriod)
CompleteMultipartUploadRequest.Builder	sseCustomerAlgorithm(String sseCustomerAlgorithm) The server-side encryption (SSE) algorithm used to encrypt the object.
CompleteMultipartUploadRequest.Builder	sseCustomerKey(String sseCustomerKey) The server-side encryption (SSE) customer managed key.
CompleteMultipartUploadRequest.Builder	sseCustomerKeyMD5(String sseCustomerKeyMD5) The MD5 server-side encryption (SSE) customer managed key.
CompleteMultipartUploadRequest.Builder	uploadId(String uploadId) ID for the initiated multipart upload.

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

build

Methods inherited from interface com.ibm.cos.v2.awscore.AwsRequest.Builder

overrideConfiguration

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

bucket

CompleteMultipartUploadRequest.Builder bucket(String bucket)

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

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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.

Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

Parameters:

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

Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3 (for example, amzn-s3-demo-bucket--usw2-az1--x-s3). For information about bucket naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.

Access points - When you use this action with an access point for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. When using the access point ARN, 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.

Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

Returns:

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

key

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

multipartUpload

CompleteMultipartUploadRequest.Builder multipartUpload(CompletedMultipartUpload multipartUpload)

The container for the multipart upload request information.

Parameters:

multipartUpload - The container for the multipart upload request information.

Returns:

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

multipartUpload

default CompleteMultipartUploadRequest.Builder multipartUpload(Consumer<CompletedMultipartUpload.Builder> multipartUpload)

The container for the multipart upload request information.

This is a convenience method that creates an instance of the CompletedMultipartUpload.Builder avoiding the need to create one manually via CompletedMultipartUpload.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to multipartUpload(CompletedMultipartUpload).

Parameters:

multipartUpload - a consumer that will call methods on CompletedMultipartUpload.Builder

Returns:

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

See Also:

multipartUpload(CompletedMultipartUpload)

uploadId

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

checksumCRC32

CompleteMultipartUploadRequest.Builder checksumCRC32(String checksumCRC32)

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 32-bit CRC32 checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

Parameters:

checksumCRC32 - This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 32-bit CRC32 checksum of the object. 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.

checksumCRC32C

CompleteMultipartUploadRequest.Builder checksumCRC32C(String checksumCRC32C)

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 32-bit CRC32C checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

Parameters:

checksumCRC32C - This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 32-bit CRC32C checksum of the object. 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.

checksumCRC64NVME

CompleteMultipartUploadRequest.Builder checksumCRC64NVME(String checksumCRC64NVME)

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 64-bit CRC64NVME checksum of the object. The CRC64NVME checksum is always a full object checksum. For more information, see Checking object integrity in the Amazon S3 User Guide.

Parameters:

checksumCRC64NVME - This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 64-bit CRC64NVME checksum of the object. The CRC64NVME checksum is always a full object checksum. 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.

checksumSHA1

CompleteMultipartUploadRequest.Builder checksumSHA1(String checksumSHA1)

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 160-bit SHA1 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

Parameters:

checksumSHA1 - This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 160-bit SHA1 digest of the object. 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.

checksumSHA256

CompleteMultipartUploadRequest.Builder checksumSHA256(String checksumSHA256)

This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 256-bit SHA256 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

Parameters:

checksumSHA256 - This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the Base64 encoded, 256-bit SHA256 digest of the object. 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.

checksumType

CompleteMultipartUploadRequest.Builder checksumType(String checksumType)

This header specifies the checksum type of the object, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header as a data integrity check to verify that the checksum type that is received is the same checksum that was specified. If the checksum type doesn’t match the checksum type that was specified for the object during the CreateMultipartUpload request, it’ll result in a BadDigest error. For more information, see Checking object integrity in the Amazon S3 User Guide.

Parameters:

checksumType - This header specifies the checksum type of the object, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header as a data integrity check to verify that the checksum type that is received is the same checksum that was specified. If the checksum type doesn’t match the checksum type that was specified for the object during the CreateMultipartUpload request, it’ll result in a BadDigest error. 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

CompleteMultipartUploadRequest.Builder checksumType(ChecksumType checksumType)

This header specifies the checksum type of the object, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header as a data integrity check to verify that the checksum type that is received is the same checksum that was specified. If the checksum type doesn’t match the checksum type that was specified for the object during the CreateMultipartUpload request, it’ll result in a BadDigest error. For more information, see Checking object integrity in the Amazon S3 User Guide.

Parameters:

checksumType - This header specifies the checksum type of the object, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header as a data integrity check to verify that the checksum type that is received is the same checksum that was specified. If the checksum type doesn’t match the checksum type that was specified for the object during the CreateMultipartUpload request, it’ll result in a BadDigest error. 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

mpuObjectSize

CompleteMultipartUploadRequest.Builder mpuObjectSize(Long mpuObjectSize)

The expected total object size of the multipart upload request. If there’s a mismatch between the specified object size value and the actual object size value, it results in an HTTP 400 InvalidRequest error.

Parameters:

mpuObjectSize - The expected total object size of the multipart upload request. If there’s a mismatch between the specified object size value and the actual object size value, it results in an HTTP 400 InvalidRequest error.

Returns:

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

requestPayer

CompleteMultipartUploadRequest.Builder requestPayer(String requestPayer)

Sets the value of the RequestPayer property for this object.

Parameters:

requestPayer - The new value for the RequestPayer property for this object.

Returns:

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

See Also:

RequestPayer, RequestPayer

requestPayer

CompleteMultipartUploadRequest.Builder requestPayer(RequestPayer requestPayer)

Sets the value of the RequestPayer property for this object.

Parameters:

requestPayer - The new value for the RequestPayer property for this object.

Returns:

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

See Also:

RequestPayer, RequestPayer

expectedBucketOwner

CompleteMultipartUploadRequest.Builder expectedBucketOwner(String expectedBucketOwner)

The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

Parameters:

expectedBucketOwner - The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).

Returns:

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

ifMatch

CompleteMultipartUploadRequest.Builder ifMatch(String ifMatch)

Uploads the object only if the ETag (entity tag) value provided during the WRITE operation matches the ETag of the object in S3. If the ETag values do not match, the operation returns a 412 Precondition Failed error.

If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict response. On a 409 failure you should fetch the object's ETag, re-initiate the multipart upload with CreateMultipartUpload, and re-upload each part.

Expects the ETag value as a string.

For more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.

Parameters:

ifMatch - Uploads the object only if the ETag (entity tag) value provided during the WRITE operation matches the ETag of the object in S3. If the ETag values do not match, the operation returns a 412 Precondition Failed error.

If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict response. On a 409 failure you should fetch the object's ETag, re-initiate the multipart upload with CreateMultipartUpload, and re-upload each part.

Expects the ETag value as a string.

For more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.

Returns:

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

ifNoneMatch

CompleteMultipartUploadRequest.Builder ifNoneMatch(String ifNoneMatch)

Uploads the object only if the object key name does not already exist in the bucket specified. Otherwise, Amazon S3 returns a 412 Precondition Failed error.

If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict response. On a 409 failure you should re-initiate the multipart upload with CreateMultipartUpload and re-upload each part.

Expects the '*' (asterisk) character.

For more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.

Parameters:

ifNoneMatch - Uploads the object only if the object key name does not already exist in the bucket specified. Otherwise, Amazon S3 returns a 412 Precondition Failed error.

If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict response. On a 409 failure you should re-initiate the multipart upload with CreateMultipartUpload and re-upload each part.

Expects the '*' (asterisk) character.

For more information about conditional requests, see RFC 7232, or Conditional requests in the Amazon S3 User Guide.

Returns:

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

sseCustomerAlgorithm

CompleteMultipartUploadRequest.Builder sseCustomerAlgorithm(String sseCustomerAlgorithm)

The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is required only when the object was created using a checksum algorithm or if your bucket policy requires the use of SSE-C. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

Parameters:

sseCustomerAlgorithm - The server-side encryption (SSE) algorithm used to encrypt the object. This parameter is required only when the object was created using a checksum algorithm or if your bucket policy requires the use of SSE-C. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

Returns:

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

sseCustomerKey

CompleteMultipartUploadRequest.Builder sseCustomerKey(String sseCustomerKey)

The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

Parameters:

sseCustomerKey - The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

Returns:

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

sseCustomerKeyMD5

CompleteMultipartUploadRequest.Builder sseCustomerKeyMD5(String sseCustomerKeyMD5)

The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

Parameters:

sseCustomerKeyMD5 - The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm. For more information, see Protecting data using SSE-C keys in the Amazon S3 User Guide.

This functionality is not supported for directory buckets.

Returns:

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

overrideConfiguration

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

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

retentionExpirationDate

CompleteMultipartUploadRequest.Builder retentionExpirationDate(Instant retentionExpirationDate)

retentionLegalHoldId

CompleteMultipartUploadRequest.Builder retentionLegalHoldId(String retentionLegalHoldId)

retentionPeriod

CompleteMultipartUploadRequest.Builder retentionPeriod(Long retentionPeriod)