@Generated(value="software.amazon.awssdk:codegen") public final class UploadPartCopyRequest extends S3Request implements ToCopyableBuilder<UploadPartCopyRequest.Builder,UploadPartCopyRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
UploadPartCopyRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
bucket()
Deprecated.
|
static UploadPartCopyRequest.Builder |
builder() |
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. |
String |
copySourceIfMatch()
Copies the object if its entity tag (ETag) matches the specified tag.
|
Instant |
copySourceIfModifiedSince()
Copies the object if it has been modified since the specified time.
|
String |
copySourceIfNoneMatch()
Copies the object if its entity tag (ETag) is different than the specified ETag.
|
Instant |
copySourceIfUnmodifiedSince()
Copies the object if it hasn't been modified since the specified time.
|
String |
copySourceRange()
The range of bytes to copy from the source object.
|
String |
copySourceSSECustomerAlgorithm()
Specifies the algorithm to use when decrypting the source object (for example, AES256).
|
String |
copySourceSSECustomerKey()
Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object.
|
String |
copySourceSSECustomerKeyMD5()
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
|
String |
destinationBucket()
The bucket name.
|
String |
destinationKey()
Object key for which the multipart upload was initiated.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
expectedBucketOwner()
The account ID of the expected destination bucket owner.
|
String |
expectedSourceBucketOwner()
The account ID of the expected source bucket owner.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
String |
key()
Deprecated.
Use
destinationKey() |
Integer |
partNumber()
Part number of part being copied.
|
RequestPayer |
requestPayer()
Returns the value of the RequestPayer property for this object.
|
String |
requestPayerAsString()
Returns the value of the RequestPayer property for this object.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends UploadPartCopyRequest.Builder> |
serializableBuilderClass() |
String |
sourceBucket()
The name of the bucket containing the object to copy.
|
String |
sourceKey()
The key of the object to copy.
|
String |
sourceVersionId()
Specifies a particular version of the source object to copy.
|
String |
sseCustomerAlgorithm()
Specifies the algorithm to use to when encrypting the object (for example, AES256).
|
String |
sseCustomerKey()
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.
|
String |
sseCustomerKeyMD5()
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
|
UploadPartCopyRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
uploadId()
Upload ID identifying the multipart upload whose part is being copied.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
@Deprecated public final String copySource()
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.
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.
public final String copySourceIfMatch()
Copies the object if its entity tag (ETag) matches the specified tag.
public final Instant copySourceIfModifiedSince()
Copies the object if it has been modified since the specified time.
public final String copySourceIfNoneMatch()
Copies the object if its entity tag (ETag) is different than the specified ETag.
public final Instant copySourceIfUnmodifiedSince()
Copies the object if it hasn't been modified since the specified time.
public final 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.
public final Integer partNumber()
Part number of part being copied. This is a positive integer between 1 and 10,000.
public final String uploadId()
Upload ID identifying the multipart upload whose part is being copied.
public final String sseCustomerAlgorithm()
Specifies the algorithm to use to when encrypting the object (for example, AES256).
public final 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.
x-amz-server-side-encryption-customer-algorithm
header. This must be the same encryption key
specified in the initiate multipart upload request.public final 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.
public final String copySourceSSECustomerAlgorithm()
Specifies the algorithm to use when decrypting the source object (for example, AES256).
public final 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.
public final 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.
public final RequestPayer requestPayer()
If the service returns an enum value that is not available in the current SDK version, requestPayer
will
return RequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
requestPayerAsString()
.
RequestPayer
public final String requestPayerAsString()
If the service returns an enum value that is not available in the current SDK version, requestPayer
will
return RequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
requestPayerAsString()
.
RequestPayer
public final String expectedBucketOwner()
The account ID of the expected destination bucket owner. If the destination bucket is owned by a different
account, the request fails with the HTTP status code 403 Forbidden
(access denied).
403 Forbidden
(access
denied).public final String expectedSourceBucketOwner()
The account ID of the expected source bucket owner. If the source bucket is owned by a different account, the
request fails with the HTTP status code 403 Forbidden
(access denied).
403 Forbidden
(access denied).@Deprecated public final String bucket()
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 you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the
Amazon S3 User Guide.
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 you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the
Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs,
see What is S3 on
Outposts in the Amazon S3 User Guide.
public final 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 you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts in the
Amazon S3 User Guide.
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 you use 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 you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the
Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs,
see What is S3 on
Outposts in the Amazon S3 User Guide.
@Deprecated public final String key()
destinationKey()
Object key for which the multipart upload was initiated.
public final String destinationKey()
Object key for which the multipart upload was initiated.
public final String sourceBucket()
sourceBucket
, sourceKey
, and sourceVersionId
parameters must not be used in conjunction
with the copySource
parameter.sourceBucket
, sourceKey
, and sourceVersionId
parameters must not be used in
conjunction with the copySource
parameter.public final String sourceKey()
sourceBucket
,
sourceKey
, and sourceVersionId
parameters must not be used in conjunction with the
copySource
parameter.sourceBucket
,
sourceKey
, and sourceVersionId
parameters must not be used in conjunction with the
copySource
parameter.public final String sourceVersionId()
sourceBucket
, sourceKey
, and sourceVersionId
parameters must not be used in conjunction
with the copySource
parameter.sourceBucket
, sourceKey
, and sourceVersionId
parameters must not be used in
conjunction with the copySource
parameter.public UploadPartCopyRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<UploadPartCopyRequest.Builder,UploadPartCopyRequest>
toBuilder
in class S3Request
public static UploadPartCopyRequest.Builder builder()
public static Class<? extends UploadPartCopyRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2023. All rights reserved.