software.amazon.awssdk.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

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	expectedBucketOwner(String expectedBucketOwner) The account ID of the expected bucket owner.
CompleteMultipartUploadRequest.Builder	key(String key) Object key for which the multipart upload was initiated.
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)
CompleteMultipartUploadRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
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	uploadId(String uploadId) ID for the initiated multipart upload.

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

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

bucket

CompleteMultipartUploadRequest.Builder bucket(String bucket)

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

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 using 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 using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon S3 User Guide.

Parameters:

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

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 using 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 using this action using S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using 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 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.

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 bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Parameters:

expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a different account, the request will fail with an HTTP 403 (Access Denied) error.

Returns:

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

overrideConfiguration

CompleteMultipartUploadRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

CompleteMultipartUploadRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder