public class CopyPartRequest extends AmazonWebServiceRequest implements Serializable, S3AccelerateUnsupported
Provides options for copying an Amazon S3 object from a source location to a part of a multipart upload.
All CopyPartRequests must specify an upload id, a source bucket
and key, along with a destination bucket and key. Beyond that, requests also
specify constraints controlling if the copy will be performed or not.
NOOP| Constructor and Description |
|---|
CopyPartRequest() |
| Modifier and Type | Method and Description |
|---|---|
String |
getDestinationBucketName()
Gets the destination bucket name which will contain the new,
copied object.
|
String |
getDestinationKey()
Gets the destination bucket key under which the new, copied
object will be stored.
|
SSECustomerKey |
getDestinationSSECustomerKey()
Returns the optional customer-provided server-side encryption key to use
to encrypt the source object part being copied.
|
Long |
getFirstByte()
Returns the optional start range to copy from the source object.
|
Long |
getLastByte()
Returns the optional zero-based byte offset to stop copying the source.
|
List<String> |
getMatchingETagConstraints()
Gets the optional list of ETag constraints that, when present,
must include a match for the source object's current ETag in order
for the copy object request to be executed.
|
Date |
getModifiedSinceConstraint()
Gets the optional modified constraint that restricts this request to
executing only if the source object has been modified after the
specified date.
|
List<String> |
getNonmatchingETagConstraints()
Gets the optional list of ETag constraints that, when present, must
not include a match for the source object's current ETag in order for
the copy object request to be executed.
|
int |
getPartNumber()
Returns the part number describing this part's position relative to the
other parts in the multipart upload.
|
String |
getSourceBucketName()
Gets the name of the bucket containing the source object to be copied.
|
String |
getSourceKey()
Gets the source bucket key under which the source object to be copied is
stored.
|
SSECustomerKey |
getSourceSSECustomerKey()
Returns the optional customer-provided server-side encryption key to use
to decrypt the source object part being copied.
|
String |
getSourceVersionId()
Gets the version ID specifying which version of the source object to
copy.
|
Date |
getUnmodifiedSinceConstraint()
Gets the optional unmodified constraint that restricts this request to
executing only if the source object has not been modified after
the specified date.
|
String |
getUploadId()
Returns the ID of the existing, initiated multipart upload with which
this new part will be associated.
|
boolean |
isRequesterPays()
Returns true if the user has enabled Requester Pays option when
conducting this operation from Requester Pays Bucket; else false.
|
void |
setDestinationBucketName(String destinationBucketName)
Sets the destination bucket name which will contain the new,
copied object.
|
void |
setDestinationKey(String destinationKey)
Sets the destination bucket key under which the new, copied object
will be stored.
|
void |
setDestinationSSECustomerKey(SSECustomerKey sseKey)
Sets the optional customer-provided server-side encryption key to use to
encrypt the source object part being copied.
|
void |
setFirstByte(Long firstByte)
Sets the optional zero-based byte offset to begin copying the source
object.
|
void |
setLastByte(Long lastByte)
Sets the optional zero-based byte offset to stop copying the source.
|
void |
setMatchingETagConstraints(List<String> eTagList)
Sets the optional list of ETag constraints that, when present,
must include a match for the source object's current ETag in order
for the copy object request to be executed.
|
void |
setModifiedSinceConstraint(Date date)
Sets the optional modified constraint that restricts this request to
executing only if the source object has been modified after the
specified date.
|
void |
setNonmatchingETagConstraints(List<String> eTagList)
Sets the optional list of ETag constraints that, when present, must
not include a match for the source object's current ETag in order for
the copy object request to be executed.
|
void |
setPartNumber(int partNumber)
Sets the part number describing this part's position relative to the
other parts in the multipart upload.
|
void |
setRequesterPays(boolean isRequesterPays)
Used for conducting this operation from a Requester Pays Bucket.
|
void |
setSourceBucketName(String sourceBucketName)
Sets the name of the bucket containing the source object to be copied.
|
void |
setSourceKey(String sourceKey)
Sets the source bucket key under which the source object to be copied is
stored.
|
void |
setSourceSSECustomerKey(SSECustomerKey sseKey)
Sets the optional customer-provided server-side encryption key to use to
decrypt the source object part being copied.
|
void |
setSourceVersionId(String sourceVersionId)
Sets the optional version ID specifying which version of the source
object to copy.
|
void |
setUnmodifiedSinceConstraint(Date date)
Sets the optional unmodified constraint that restricts this request to
executing only if the source object has not been modified after
the specified date.
|
void |
setUploadId(String uploadId)
Sets the ID of the existing, initiated multipart upload with which this
new part will be associated.
|
CopyPartRequest |
withDestinationBucketName(String destinationBucketName)
Sets the name of the destination bucket which will contain the new,
copied object and returns this object, enabling additional method calls
to be chained together.
|
CopyPartRequest |
withDestinationKey(String destinationKey)
Sets the destination bucket key under which the new, copied object
will be stored and returns this object, enabling additional method calls
can be chained together.
|
CopyPartRequest |
withDestinationSSECustomerKey(SSECustomerKey sseKey)
Returns the optional customer-provided server-side encryption key to use
to encrypt the source object part being copied, and returns the updated
request object so that additional method calls can be chained together.
|
CopyPartRequest |
withFirstByte(Long firstByte)
Sets the optional zero-based byte offset to begin copying the source
object.
|
CopyPartRequest |
withLastByte(Long lastByte)
Sets the optional zero-based byte offset to stop copying the source.
|
CopyPartRequest |
withMatchingETagConstraint(String eTag)
Adds a single ETag constraint to this request and returns this object,
enabling additional method calls to be chained together.
|
CopyPartRequest |
withMatchingETagConstraints(List<String> eTagList)
Fluent API for
CopyPartRequest.setMatchingETagConstraints(List). |
CopyPartRequest |
withModifiedSinceConstraint(Date date)
Sets the optional modified constraint that restricts this request to
executing only if the source object has been modified after the
specified date.
|
CopyPartRequest |
withNonmatchingETagConstraint(String eTag)
Adds a single ETag constraint to this request and returns this object,
enabling additional method calls to be chained together.
|
CopyPartRequest |
withNonmatchingETagConstraints(List<String> eTagList)
Fluent API for
CopyPartRequest.setNonmatchingETagConstraints(List). |
CopyPartRequest |
withPartNumber(int partNumber)
Sets the part number describing this part's position relative to the
other parts in the multipart upload.
|
CopyPartRequest |
withRequesterPays(boolean isRequesterPays)
Used for conducting this operation from a Requester Pays Bucket.
|
CopyPartRequest |
withSourceBucketName(String sourceBucketName)
Sets the name of the bucket containing the source object to be copied.
|
CopyPartRequest |
withSourceKey(String sourceKey)
Sets the source bucket key under which the source object to be copied is
stored.
|
CopyPartRequest |
withSourceSSECustomerKey(SSECustomerKey sseKey)
Sets the optional customer-provided server-side encryption key to use to
decrypt the source object part being copied, and returns the updated
request object so that additional method calls can be chained together.
|
CopyPartRequest |
withSourceVersionId(String sourceVersionId)
Sets the optional version ID specifying which version of the source
object to copy.
|
CopyPartRequest |
withUnmodifiedSinceConstraint(Date date)
Sets the optional unmodified constraint that restricts this request to
executing only if the source object has not been modified after
the specified date.
|
CopyPartRequest |
withUploadId(String uploadId)
Sets the ID of the existing, initiated multipart upload with which this
new part will be associated.
|
addHandlerContext, clone, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic String getUploadId()
public void setUploadId(String uploadId)
uploadId - the ID of the existing, initiated multipart upload with which
this new part will be associated.public CopyPartRequest withUploadId(String uploadId)
uploadId - the ID of the existing, initiated multipart upload with which
this new part will be associated. * @return This
CopyPartRequest, enabling additional method calls
to be chained together.public int getPartNumber()
public void setPartNumber(int partNumber)
partNumber - the part number describing this part's position relative to
the other parts in the multipart upload. Part number must be
between 1 and 10,000 (inclusive).public CopyPartRequest withPartNumber(int partNumber)
partNumber - the part number describing this part's position relative to
the other parts in the multipart upload. Part number must be
between 1 and 10,000 (inclusive).CopyPartRequest, enabling additional method
calls to be chained together.public String getSourceBucketName()
CopyPartRequest.setSourceBucketName(String sourceBucketName)public void setSourceBucketName(String sourceBucketName)
sourceBucketName - The name of the bucket containing the source object to be
copied.CopyPartRequest.getSourceBucketName()public CopyPartRequest withSourceBucketName(String sourceBucketName)
sourceBucketName - The name of the bucket containing the source object to be
copied.CopyPartRequest, enabling additional method
calls to be chained together.CopyPartRequest.getSourceBucketName()public String getSourceKey()
CopyPartRequest.setSourceKey(String sourceKey)public void setSourceKey(String sourceKey)
sourceKey - The source bucket key under which the source object to be
copied is stored.CopyPartRequest.setSourceKey(String sourceKey)public CopyPartRequest withSourceKey(String sourceKey)
sourceKey - The source bucket key under which the source object to be
copied is stored.CopyPartRequest, enabling additional method
calls to be chained together.CopyPartRequest.setSourceKey(String sourceKey)public String getSourceVersionId()
Gets the version ID specifying which version of the source object to copy. If not specified, the most recent version of the source object will be copied.
Objects created before enabling versioning or when versioning is
suspended are given the default null version ID (see
Constants.NULL_VERSION_ID). Note that the null
version ID is a valid version ID and is not the same as not having a
version ID.
For more information about enabling versioning for a bucket, see
AmazonS3.setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest)
.
Constants.NULL_VERSION_ID,
CopyPartRequest.setSourceVersionId(String sourceVersionId)public void setSourceVersionId(String sourceVersionId)
Sets the optional version ID specifying which version of the source object to copy. If not specified, the most recent version of the source object will be copied.
Objects created before enabling versioning or when versioning is
suspended are given the default null version ID (see
Constants.NULL_VERSION_ID). Note that the null
version ID is a valid version ID and is not the same as not having a
version ID.
For more information about enabling versioning for a bucket, see
AmazonS3.setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest)
.
sourceVersionId - The optional version ID specifying which version of the source
object to copy.public CopyPartRequest withSourceVersionId(String sourceVersionId)
Sets the optional version ID specifying which version of the source object to copy. If not specified, the most recent version of the source object will be copied.
Objects created before enabling versioning or when versioning is
suspended are given the default null version ID (see
Constants.NULL_VERSION_ID). Note that the null
version ID is a valid version ID and is not the same as not having a
version ID.
For more information about enabling versioning for a bucket, see
AmazonS3.setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest)
.
sourceVersionId - The optional version ID specifying which version of the source
object to copy.CopyPartRequest, enabling additional method
calls to be chained together.public String getDestinationBucketName()
CopyPartRequest.setDestinationBucketName(String destinationBucketName)public void setDestinationBucketName(String destinationBucketName)
destinationBucketName - The name of the destination bucket which will contain the new,
copied object.CopyPartRequest.getDestinationBucketName()public CopyPartRequest withDestinationBucketName(String destinationBucketName)
destinationBucketName - The name of the destination bucket which will contain the new,
copied object.CopyPartRequest, enabling additional method calls to be
chained together.public String getDestinationKey()
CopyPartRequest.setDestinationKey(String destinationKey)public void setDestinationKey(String destinationKey)
destinationKey - The destination bucket key under which the new, copied
object will be stored.CopyPartRequest.getDestinationKey()public CopyPartRequest withDestinationKey(String destinationKey)
destinationKey - The destination bucket key under which the new, copied
object will be stored.CopyPartRequest, enabling additional method calls to be
chained together.public Long getFirstByte()
public void setFirstByte(Long firstByte)
firstByte - the optional zero-based byte offset to begin copying the
source object.public CopyPartRequest withFirstByte(Long firstByte)
firstByte - the optional zero-based byte offset to begin copying the
source object.CopyPartRequest, enabling additional method
calls to be chained together.public Long getLastByte()
public void setLastByte(Long lastByte)
public CopyPartRequest withLastByte(Long lastByte)
CopyPartRequest, enabling additional method
calls to be chained together.public List<String> getMatchingETagConstraints()
Gets the optional list of ETag constraints that, when present, must include a match for the source object's current ETag in order for the copy object request to be executed. Only one ETag in the list needs to match for the request to be executed by Amazon S3.
Matching ETag constraints may be used with the unmodified since constraint, but not with any other type of constraint.
public void setMatchingETagConstraints(List<String> eTagList)
Sets the optional list of ETag constraints that, when present, must include a match for the source object's current ETag in order for the copy object request to be executed. If none of the specified ETags match the source object's current ETag, the copy object operation will be aborted. Only one ETag in the list needs to match for the request to be executed by Amazon S3.
Matching ETag constraints may be used with the unmodified since constraint, but not with any other type of constraint.
eTagList - The optional list of ETag constraints that must include a
match for the source object's current ETag in order for this
request to be executed.public CopyPartRequest withMatchingETagConstraints(List<String> eTagList)
CopyPartRequest.setMatchingETagConstraints(List).public CopyPartRequest withMatchingETagConstraint(String eTag)
Adds a single ETag constraint to this request and returns this object, enabling additional method calls to be chained together. Multiple ETag constraints can be added to a request, but one must match the source object's current ETag in order for the copy object request to be executed. If none of the ETag constraints added to this request match the source object's current ETag, the copy object operation will be aborted.
Matching ETag constraints may be used with the unmodified since constraint, but not with any other type of constraint.
eTag - The matching ETag constraint to add to this request.CopyPartRequest, enabling additional method
calls to be chained together.public List<String> getNonmatchingETagConstraints()
Gets the optional list of ETag constraints that, when present, must not include a match for the source object's current ETag in order for the copy object request to be executed. If any entry in the non-matching ETag constraint list matches the source object's current ETag, this copy request will not be executed by Amazon S3.
Non-matching ETag constraints may be used with the modified since constraint, but not with any other type of constraint.
public void setNonmatchingETagConstraints(List<String> eTagList)
Sets the optional list of ETag constraints that, when present, must not include a match for the source object's current ETag in order for the copy object request to be executed. If any entry in the non-matching ETag constraint list matches the source object's current ETag, this copy request will not be executed by Amazon S3.
Non-matching ETag constraints may be used with the modified since constraint, but not with any other type of constraint.
eTagList - The list of ETag constraints that, when present, must
not include a match for the source object's current ETag
in order for this request to be executed.public CopyPartRequest withNonmatchingETagConstraints(List<String> eTagList)
CopyPartRequest.setNonmatchingETagConstraints(List).public CopyPartRequest withNonmatchingETagConstraint(String eTag)
Adds a single ETag constraint to this request and returns this object, enabling additional method calls to be chained together. Multiple ETag constraints can be added to a request, but all ETag constraints must not match the source object's current ETag in order for the copy object request to be executed. If any entry in the non-matching ETag constraint list matches the source object's current ETag, this copy request will not be executed by Amazon S3.
Non-matching ETag constraints may be used with the modified since constraint, but not with any other type of constraint.
eTag - The non-matching ETag constraint to add to this request.CopyPartRequest, enabling additional method
calls to be chained together.public Date getUnmodifiedSinceConstraint()
Gets the optional unmodified constraint that restricts this request to executing only if the source object has not been modified after the specified date.
The unmodified since constraint may be used with matching ETag constraints, but not with any other type of constraint.
public void setUnmodifiedSinceConstraint(Date date)
Sets the optional unmodified constraint that restricts this request to executing only if the source object has not been modified after the specified date.
The unmodified constraint may be used with matching ETag constraints, but not with any other type of constraint.
Note that Amazon S3 will ignore any dates occurring in the future.
date - The unmodified constraint that restricts this request to
executing only if the source object has not been
modified after this date.public CopyPartRequest withUnmodifiedSinceConstraint(Date date)
Sets the optional unmodified constraint that restricts this request to executing only if the source object has not been modified after the specified date. Returns this object, enabling additional method calls to be chained together.
The unmodified constraint may be used with matching ETag constraints, but not with any other type of constraint.
Note that Amazon S3 will ignore any dates occurring in the future.
date - The unmodified constraint that restricts this request to
executing only if the source object has not been
modified after this date.CopyPartRequest, enabling additional method
calls to be chained together.public Date getModifiedSinceConstraint()
Gets the optional modified constraint that restricts this request to executing only if the source object has been modified after the specified date.
The modified constraint may be used with non-matching ETag constraints, but not with any other type of constraint.
public void setModifiedSinceConstraint(Date date)
Sets the optional modified constraint that restricts this request to executing only if the source object has been modified after the specified date.
The modified constraint may be used with non-matching ETag constraints, but not with any other type of constraint.
Note that Amazon S3 will ignore any dates occurring in the future.
date - The modified constraint that restricts this request to
executing only if the source object has been modified
after the specified date.public CopyPartRequest withModifiedSinceConstraint(Date date)
Sets the optional modified constraint that restricts this request to executing only if the source object has been modified after the specified date. Returns this object, enabling additional method calls to be chained together.
The modified constraint may be used with non-matching ETag constraints, but not with any other type of constraint.
Note that Amazon S3 will ignore any dates occurring in the future.
date - The modified constraint that restricts this request to
executing only if the source object has been modified
after the specified date.CopyPartRequest, enabling additional method
calls to be chained together.public SSECustomerKey getSourceSSECustomerKey()
public void setSourceSSECustomerKey(SSECustomerKey sseKey)
sseKey - The optional customer-provided server-side encryption key to
use to decrypt the source object part being copied.public CopyPartRequest withSourceSSECustomerKey(SSECustomerKey sseKey)
sseKey - The optional customer-provided server-side encryption key to
use to decrypt the source object part being copied.public SSECustomerKey getDestinationSSECustomerKey()
public void setDestinationSSECustomerKey(SSECustomerKey sseKey)
sseKey - The optional customer-provided server-side encryption key to
use to encrypt the source object part being copied.public CopyPartRequest withDestinationSSECustomerKey(SSECustomerKey sseKey)
sseKey - The optional customer-provided server-side encryption key to
use to encrypt the source object part being copied.public boolean isRequesterPays()
If a bucket is enabled for Requester Pays, then any attempt to upload or download an object from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.
Enabling Requester Pays disables the ability to have anonymous access to this bucket
public void setRequesterPays(boolean isRequesterPays)
If a bucket is enabled for Requester Pays, then any attempt to upload or download an object from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.
Enabling Requester Pays disables the ability to have anonymous access to this bucket.
isRequesterPays - Enable Requester Pays option for the operation.public CopyPartRequest withRequesterPays(boolean isRequesterPays)
If a bucket is enabled for Requester Pays, then any attempt to upload or download an object from it without Requester Pays enabled will result in a 403 error and the bucket owner will be charged for the request.
Enabling Requester Pays disables the ability to have anonymous access to this bucket.
isRequesterPays - Enable Requester Pays option for the operation.Copyright © 2024. All rights reserved.