software.amazon.awssdk.services.s3.model

Interface UploadPartCopyRequest.Builder

All Superinterfaces:

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

Enclosing class:

UploadPartCopyRequest

public static interface UploadPartCopyRequest.Builder
extends S3Request.Builder, SdkPojo, CopyableBuilder<UploadPartCopyRequest.Builder,UploadPartCopyRequest>

Method Summary

Modifier and Type	Method and Description
UploadPartCopyRequest.Builder	bucket(String destinationBucket) Deprecated. Use destinationBucket(String)
UploadPartCopyRequest.Builder	copySource(String copySource) Deprecated. The copySource parameter has been deprecated in favor of the more user-friendly sourceBucket, sourceKey, and sourceVersionId parameters. The copySource parameter will remain fully functional, but it must not be used in conjunction with its replacement parameters.
UploadPartCopyRequest.Builder	copySourceIfMatch(String copySourceIfMatch) Copies the object if its entity tag (ETag) matches the specified tag.
UploadPartCopyRequest.Builder	copySourceIfModifiedSince(Instant copySourceIfModifiedSince) Copies the object if it has been modified since the specified time.
UploadPartCopyRequest.Builder	copySourceIfNoneMatch(String copySourceIfNoneMatch) Copies the object if its entity tag (ETag) is different than the specified ETag.
UploadPartCopyRequest.Builder	copySourceIfUnmodifiedSince(Instant copySourceIfUnmodifiedSince) Copies the object if it hasn't been modified since the specified time.
UploadPartCopyRequest.Builder	copySourceRange(String copySourceRange) The range of bytes to copy from the source object.
UploadPartCopyRequest.Builder	copySourceSSECustomerAlgorithm(String copySourceSSECustomerAlgorithm) Specifies the algorithm to use when decrypting the source object (for example, AES256).
UploadPartCopyRequest.Builder	copySourceSSECustomerKey(String copySourceSSECustomerKey) Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object.
UploadPartCopyRequest.Builder	copySourceSSECustomerKeyMD5(String copySourceSSECustomerKeyMD5) Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
UploadPartCopyRequest.Builder	destinationBucket(String destinationBucket) The bucket name.
UploadPartCopyRequest.Builder	destinationKey(String destinationKey) Object key for which the multipart upload was initiated.
UploadPartCopyRequest.Builder	expectedBucketOwner(String expectedBucketOwner) The account ID of the expected destination bucket owner.
UploadPartCopyRequest.Builder	expectedSourceBucketOwner(String expectedSourceBucketOwner) The account ID of the expected source bucket owner.
UploadPartCopyRequest.Builder	key(String destinationKey) Deprecated. Use destinationKey(String)
UploadPartCopyRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UploadPartCopyRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UploadPartCopyRequest.Builder	partNumber(Integer partNumber) Part number of part being copied.
UploadPartCopyRequest.Builder	requestPayer(RequestPayer requestPayer) Sets the value of the RequestPayer property for this object.
UploadPartCopyRequest.Builder	requestPayer(String requestPayer) Sets the value of the RequestPayer property for this object.
UploadPartCopyRequest.Builder	sourceBucket(String sourceBucket) The name of the bucket containing the object to copy.
UploadPartCopyRequest.Builder	sourceKey(String sourceKey) The key of the object to copy.
UploadPartCopyRequest.Builder	sourceVersionId(String sourceVersionId) Specifies a particular version of the source object to copy.
UploadPartCopyRequest.Builder	sseCustomerAlgorithm(String sseCustomerAlgorithm) Specifies the algorithm to use to when encrypting the object (for example, AES256).
UploadPartCopyRequest.Builder	sseCustomerKey(String sseCustomerKey) Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.
UploadPartCopyRequest.Builder	sseCustomerKeyMD5(String sseCustomerKeyMD5) Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
UploadPartCopyRequest.Builder	uploadId(String uploadId) Upload ID identifying the multipart upload whose part is being copied.

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

copySource

@Deprecated
UploadPartCopyRequest.Builder copySource(String copySource)

Deprecated. The copySource parameter has been deprecated in favor of the more user-friendly sourceBucket, sourceKey, and sourceVersionId parameters. The copySource parameter will remain fully functional, but it must not be used in conjunction with its replacement parameters.

Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:

• For objects not accessed through an access point, specify the name of the source bucket and key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL encoded.

• For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key> . For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

  Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.

  Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key> . For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL encoded.

To copy a specific version of an object, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.

Parameters:

copySource - Specifies the source object for the copy operation. You specify the value in one of two formats, depending on whether you want to access the source object through an access point:

• For objects not accessed through an access point, specify the name of the source bucket and key of the source object, separated by a slash (/). For example, to copy the object reports/january.pdf from the bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The value must be URL encoded.

• For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed through the access point, in the format arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key> . For example, to copy the object reports/january.pdf through access point my-access-point owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value must be URL encoded.

  Amazon S3 supports copy operations using access points only when the source and destination buckets are in the same Amazon Web Services Region.

  Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in the format arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key> . For example, to copy the object reports/january.pdf through outpost my-outpost owned by account 123456789012 in Region us-west-2, use the URL encoding of arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value must be URL encoded.

To copy a specific version of an object, append ?versionId=<version-id> to the value (for example, awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't specify a version ID, Amazon S3 copies the latest version of the source object.

Returns:

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

copySourceIfMatch

UploadPartCopyRequest.Builder copySourceIfMatch(String copySourceIfMatch)

Copies the object if its entity tag (ETag) matches the specified tag.

Parameters:

copySourceIfMatch - Copies the object if its entity tag (ETag) matches the specified tag.

Returns:

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

copySourceIfModifiedSince

UploadPartCopyRequest.Builder copySourceIfModifiedSince(Instant copySourceIfModifiedSince)

Copies the object if it has been modified since the specified time.

Parameters:

copySourceIfModifiedSince - Copies the object if it has been modified since the specified time.

Returns:

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

copySourceIfNoneMatch

UploadPartCopyRequest.Builder copySourceIfNoneMatch(String copySourceIfNoneMatch)

Copies the object if its entity tag (ETag) is different than the specified ETag.

Parameters:

copySourceIfNoneMatch - Copies the object if its entity tag (ETag) is different than the specified ETag.

Returns:

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

copySourceIfUnmodifiedSince

UploadPartCopyRequest.Builder copySourceIfUnmodifiedSince(Instant copySourceIfUnmodifiedSince)

Copies the object if it hasn't been modified since the specified time.

Parameters:

copySourceIfUnmodifiedSince - Copies the object if it hasn't been modified since the specified time.

Returns:

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

copySourceRange

UploadPartCopyRequest.Builder copySourceRange(String copySourceRange)

The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first 10 bytes of the source. You can copy a range only if the source object is greater than 5 MB.

Parameters:

copySourceRange - The range of bytes to copy from the source object. The range value must use the form bytes=first-last, where the first and last are the zero-based byte offsets to copy. For example, bytes=0-9 indicates that you want to copy the first 10 bytes of the source. You can copy a range only if the source object is greater than 5 MB.

Returns:

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

partNumber

UploadPartCopyRequest.Builder partNumber(Integer partNumber)

Part number of part being copied. This is a positive integer between 1 and 10,000.

Parameters:

partNumber - Part number of part being copied. This is a positive integer between 1 and 10,000.

Returns:

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

uploadId

UploadPartCopyRequest.Builder uploadId(String uploadId)

Upload ID identifying the multipart upload whose part is being copied.

Parameters:

uploadId - Upload ID identifying the multipart upload whose part is being copied.

Returns:

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

sseCustomerAlgorithm

UploadPartCopyRequest.Builder sseCustomerAlgorithm(String sseCustomerAlgorithm)

Specifies the algorithm to use to when encrypting the object (for example, AES256).

Parameters:

sseCustomerAlgorithm - Specifies the algorithm to use to when encrypting the object (for example, AES256).

Returns:

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

sseCustomerKey

UploadPartCopyRequest.Builder sseCustomerKey(String sseCustomerKey)

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

Parameters:

sseCustomerKey - Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header. This must be the same encryption key specified in the initiate multipart upload request.

Returns:

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

sseCustomerKeyMD5

UploadPartCopyRequest.Builder sseCustomerKeyMD5(String sseCustomerKeyMD5)

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

Parameters:

sseCustomerKeyMD5 - Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

Returns:

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

copySourceSSECustomerAlgorithm

UploadPartCopyRequest.Builder copySourceSSECustomerAlgorithm(String copySourceSSECustomerAlgorithm)

Specifies the algorithm to use when decrypting the source object (for example, AES256).

Parameters:

copySourceSSECustomerAlgorithm - Specifies the algorithm to use when decrypting the source object (for example, AES256).

Returns:

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

copySourceSSECustomerKey

UploadPartCopyRequest.Builder copySourceSSECustomerKey(String copySourceSSECustomerKey)

Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

Parameters:

copySourceSSECustomerKey - Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.

Returns:

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

copySourceSSECustomerKeyMD5

UploadPartCopyRequest.Builder copySourceSSECustomerKeyMD5(String copySourceSSECustomerKeyMD5)

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

Parameters:

copySourceSSECustomerKeyMD5 - Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

Returns:

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

requestPayer

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

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

UploadPartCopyRequest.Builder expectedBucketOwner(String expectedBucketOwner)

The account ID of the expected destination bucket owner. If the destination 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 destination bucket owner. If the destination 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.

expectedSourceBucketOwner

UploadPartCopyRequest.Builder expectedSourceBucketOwner(String expectedSourceBucketOwner)

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

Parameters:

expectedSourceBucketOwner - The account ID of the expected source bucket owner. If the source 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.

destinationBucket

UploadPartCopyRequest.Builder destinationBucket(String destinationBucket)

The bucket name.

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:

destinationBucket - The bucket name.

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.

bucket

@Deprecated
UploadPartCopyRequest.Builder bucket(String destinationBucket)

Deprecated. Use destinationBucket(String)

The bucket name.

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:

destinationBucket - The bucket name.

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.

destinationKey

UploadPartCopyRequest.Builder destinationKey(String destinationKey)

Object key for which the multipart upload was initiated.

Parameters:

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

Returns:

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

key

@Deprecated
UploadPartCopyRequest.Builder key(String destinationKey)

Deprecated. Use destinationKey(String)

Object key for which the multipart upload was initiated.

Parameters:

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

Returns:

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

sourceBucket

UploadPartCopyRequest.Builder sourceBucket(String sourceBucket)

The name of the bucket containing the object to copy. The provided input will be URL encoded. The sourceBucket, sourceKey, and sourceVersionId parameters must not be used in conjunction with the copySource parameter.

Parameters:

sourceBucket - The name of the bucket containing the object to copy. The provided input will be URL encoded. The sourceBucket, sourceKey, and sourceVersionId parameters must not be used in conjunction with the copySource parameter.

Returns:

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

sourceKey

UploadPartCopyRequest.Builder sourceKey(String sourceKey)

The key of the object to copy. The provided input will be URL encoded. The sourceBucket, sourceKey, and sourceVersionId parameters must not be used in conjunction with the copySource parameter.

Parameters:

sourceKey - The key of the object to copy. The provided input will be URL encoded. The sourceBucket, sourceKey, and sourceVersionId parameters must not be used in conjunction with the copySource parameter.

Returns:

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

sourceVersionId

UploadPartCopyRequest.Builder sourceVersionId(String sourceVersionId)

Specifies a particular version of the source object to copy. By default the latest version is copied. The sourceBucket, sourceKey, and sourceVersionId parameters must not be used in conjunction with the copySource parameter.

Parameters:

sourceVersionId - Specifies a particular version of the source object to copy. By default the latest version is copied. The sourceBucket, sourceKey, and sourceVersionId parameters must not be used in conjunction with the copySource parameter.

Returns:

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

overrideConfiguration

UploadPartCopyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder