com.ibm.cloud.objectstorage.services.s3.model

Class CopyObjectRequest

java.lang.Object

com.ibm.cloud.objectstorage.AmazonWebServiceRequest

com.ibm.cloud.objectstorage.services.s3.model.CopyObjectRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, S3AccelerateUnsupported, SSEAwsKeyManagementParamsProvider, Serializable, Cloneable

public class CopyObjectRequest
extends AmazonWebServiceRequest
implements SSEAwsKeyManagementParamsProvider, Serializable, S3AccelerateUnsupported

Provides options for copying an Amazon S3 object from a source location to a new destination.

All CopyObjectRequests must specify a source bucket and key, along with a destination bucket and key. Beyond that, requests also specify:

• Object metadata for new object,
• A CannedAccessControlList for the new object,
• Constraints controlling if the copy will be performed or not.

See Also:

AmazonS3Client.copyObject(String, String, String, String), AmazonS3Client.copyObject(com.ibm.cloud.objectstorage.services.s3.model.CopyObjectRequest), CopyObjectResult, Serialized Form

Field Summary

Fields inherited from class com.ibm.cloud.objectstorage.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CopyObjectRequest() Constructs a new CopyObjectRequest object.
CopyObjectRequest(String sourceBucketName, String sourceKey, String destinationBucketName, String destinationKey) Constructs with basic options.
CopyObjectRequest(String sourceBucketName, String sourceKey, String sourceVersionId, String destinationBucketName, String destinationKey) Constructs a new CopyObjectRequest with basic options, providing an S3 version ID identifying the specific version of the source object to copy.

Method Summary

Modifier and Type	Method and Description
AccessControlList	getAccessControlList() Returns the optional access control list for the new object.
CannedAccessControlList	getCannedAccessControlList() Gets the canned ACL to use for the new, copied object.
String	getDestinationBucketName() The name of the destination bucket.
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 destination object being copied.
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.
String	getMetadataDirective() Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
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.
ObjectMetadata	getNewObjectMetadata() Gets the optional object metadata to set for the new, copied object.
com.ibm.cloud.objectstorage.services.s3.model.ObjectTagging	getNewObjectTagging()
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.
String	getObjectLockLegalHoldStatus() Specifies whether you want to apply a Legal Hold to the copied object.
String	getObjectLockMode() The Object Lock mode that you want to apply to the copied object.
Date	getObjectLockRetainUntilDate() The date and time when you want this object's Object Lock to expire.
String	getRedirectLocation() Gets the optional redirect location for the newly copied object.
RetentionDirective	getRetentionDirective()
Date	getRetentionExpirationDate()
String	getRetentionLegalHoldId()
Long	getRetentionPeriod()
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 being copied.
String	getSourceVersionId() Gets the version ID specifying which version of the source object to copy.
SSEAwsKeyManagementParams	getSSEAwsKeyManagementParams() Returns the Amazon Web Services Key Management System parameters used to encrypt the object on server side.
String	getStorageClass() By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects.
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.
boolean	isRequesterPays() Returns true if the user has enabled Requester Pays option when conducting this operation from Requester Pays Bucket; else false.
void	setAccessControlList(AccessControlList accessControlList) Sets the optional access control list for the new object.
void	setCannedAccessControlList(CannedAccessControlList cannedACL) Sets the canned ACL to use for the newly copied object.
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 destination object being copied.
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	setMetadataDirective(String metadataDirective) Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
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	setNewObjectMetadata(ObjectMetadata newObjectMetadata) Sets the object metadata to use for the new, copied object.
void	setNewObjectTagging(com.ibm.cloud.objectstorage.services.s3.model.ObjectTagging newObjectTagging) set the tagging for the new object.
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	setObjectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus) Specifies whether you want to apply a Legal Hold to the copied object.
void	setObjectLockLegalHoldStatus(String objectLockLegalHoldStatus) Specifies whether you want to apply a Legal Hold to the copied object.
void	setObjectLockMode(ObjectLockMode objectLockMode) The Object Lock mode that you want to apply to the copied object.
void	setObjectLockMode(String objectLockMode) The Object Lock mode that you want to apply to the copied object.
void	setObjectLockRetainUntilDate(Date objectLockRetainUntilDate) The date and time when you want this object's Object Lock to expire.
void	setRedirectLocation(String redirectLocation) Sets the optional redirect location for the newly copied object.
void	setRequesterPays(boolean isRequesterPays) Used for conducting this operation from a Requester Pays Bucket.
void	setRetentionDirective(RetentionDirective retentionDirective)
void	setRetentionExpirationDate(Date retentionExpirationDate)
void	setRetentionLegalHoldId(String retentionLegalHoldId)
void	setRetentionPeriod(Long retentionPeriod)
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 being copied.
void	setSourceVersionId(String sourceVersionId) Sets the optional version ID specifying which version of the source object to copy.
void	setSSEAwsKeyManagementParams(SSEAwsKeyManagementParams params) Sets the Amazon Web Services Key Management System parameters used to encrypt the object on server side.
void	setStorageClass(StorageClass storageClass) Sets the optional Amazon S3 storage class to use when storing the newly copied object.
void	setStorageClass(String storageClass) Sets the optional Amazon S3 storage class to use when storing the newly copied object.
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.
CopyObjectRequest	withAccessControlList(AccessControlList accessControlList) Sets the optional access control list for the new object.
CopyObjectRequest	withCannedAccessControlList(CannedAccessControlList cannedACL) Sets the canned ACL to use for the newly copied object, and returns this CopyObjectRequest, enabling additional method calls to be chained together.
CopyObjectRequest	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.
CopyObjectRequest	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.
CopyObjectRequest	withDestinationSSECustomerKey(SSECustomerKey sseKey) Sets the optional customer-provided server-side encryption key to use to encrypt the destination object being copied, and returns the updated request object so that additional method calls can be chained together.
CopyObjectRequest	withMatchingETagConstraint(String eTag) Adds a single ETag constraint to this request and returns this object, enabling additional method calls to be chained together.
CopyObjectRequest	withMetadataDirective(MetadataDirective metadataDirective) Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
CopyObjectRequest	withMetadataDirective(String metadataDirective) Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
CopyObjectRequest	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.
CopyObjectRequest	withNewObjectMetadata(ObjectMetadata newObjectMetadata) Sets the object metadata to use for the new, copied object and returns this object, enabling additional method calls to be chained together.
CopyObjectRequest	withNewObjectTagging(com.ibm.cloud.objectstorage.services.s3.model.ObjectTagging newObjectTagging) set the tagging for the new object.
CopyObjectRequest	withNonmatchingETagConstraint(String eTag) Adds a single ETag constraint to this request and returns this object, enabling additional method calls to be chained together.
CopyObjectRequest	withObjectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus) Specifies whether you want to apply a Legal Hold to the copied object.
CopyObjectRequest	withObjectLockLegalHoldStatus(String objectLockLegalHoldStatus) Specifies whether you want to apply a Legal Hold to the copied object.
CopyObjectRequest	withObjectLockMode(ObjectLockMode objectLockMode) The Object Lock mode that you want to apply to the copied object.
CopyObjectRequest	withObjectLockMode(String objectLockMode) The Object Lock mode that you want to apply to the copied object.
CopyObjectRequest	withObjectLockRetainUntilDate(Date objectLockRetainUntilDate) The date and time when you want this object's Object Lock to expire.
CopyObjectRequest	withRedirectLocation(String redirectLocation) Sets the optional redirect location for the newly copied object.Returns this CopyObjectRequest, enabling additional method calls to be chained together.
CopyObjectRequest	withRequesterPays(boolean isRequesterPays) Used for conducting this operation from a Requester Pays Bucket.
CopyObjectRequest	withSourceBucketName(String sourceBucketName) Sets the name of the bucket containing the source object to be copied, and returns this object, enabling additional method calls to be chained together.
CopyObjectRequest	withSourceKey(String sourceKey) Sets the key in the source bucket under which the source object to be copied is stored and returns this object, enabling additional method calls to be chained together.
CopyObjectRequest	withSourceSSECustomerKey(SSECustomerKey sseKey) Sets the optional customer-provided server-side encryption key to use to decrypt the source object being copied, and returns the updated request object so that additional method calls can be chained together.
CopyObjectRequest	withSourceVersionId(String sourceVersionId) Sets the optional version ID specifying which version of the source object to copy and returns this object, enabling additional method calls to be chained together.
CopyObjectRequest	withSSEAwsKeyManagementParams(SSEAwsKeyManagementParams sseAwsKeyManagementParams) Sets the Amazon Web Services Key Management System parameters used to encrypt the object on server side.
CopyObjectRequest	withStorageClass(StorageClass storageClass) Sets the optional Amazon S3 storage class to use when storing the newly copied object and returns this CopyObjectRequest, enabling additional method calls to be chained together.
CopyObjectRequest	withStorageClass(String storageClass) Sets the optional Amazon S3 storage class to use when storing the newly copied object and returns this CopyObjectRequest, enabling additional method calls to be chained together.
CopyObjectRequest	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.

Methods inherited from class com.ibm.cloud.objectstorage.AmazonWebServiceRequest

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, withSdkRequestTimeout

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CopyObjectRequest

public CopyObjectRequest()

Constructs a new CopyObjectRequest object. The caller must populate the object fields before the request is ready to be executed.

See Also:

CopyObjectRequest(String, String, String, String), CopyObjectRequest(String, String, String, String, String)

CopyObjectRequest

public CopyObjectRequest(String sourceBucketName,
                         String sourceKey,
                         String destinationBucketName,
                         String destinationKey)

Constructs with basic options.

Parameters:

sourceBucketName - The name of the S3 bucket containing the object to copy.

sourceKey - The source bucket key under which the object to copy is stored.

destinationBucketName - The name of the S3 bucket to which the new object will be copied.

destinationKey - The destination bucket key under which the new object will be copied.

CopyObjectRequest

public CopyObjectRequest(String sourceBucketName,
                         String sourceKey,
                         String sourceVersionId,
                         String destinationBucketName,
                         String destinationKey)

Constructs a new CopyObjectRequest with basic options, providing an S3 version ID identifying the specific version of the source object to copy.

Parameters:

sourceBucketName - The name of the S3 bucket containing the object to copy.

sourceKey - The key in the source bucket under which the object to copy is stored.

sourceVersionId - The S3 version ID which uniquely identifies a specific version of the source object to copy.

destinationBucketName - The name of the S3 bucket in which the new object will be copied.

destinationKey - The key in the destination bucket under which the new object will be copied.

See Also:

CopyObjectRequest(String sourceBucketName, String sourceKey, String destinationBucketName, String destinationKey)

Method Detail

getSourceBucketName

public String getSourceBucketName()

Gets the name of the bucket containing the source object to be copied.

Returns:

The name of the bucket containing the source object to be copied.

See Also:

CopyObjectRequest.setSourceBucketName(String sourceBucketName)

setSourceBucketName

public void setSourceBucketName(String sourceBucketName)

Sets the name of the bucket containing the source object to be copied.

Parameters:

sourceBucketName - The name of the bucket containing the source object to be copied.

See Also:

CopyObjectRequest.getSourceBucketName()

withSourceBucketName

public CopyObjectRequest withSourceBucketName(String sourceBucketName)

Sets the name of the bucket containing the source object to be copied, and returns this object, enabling additional method calls to be chained together.

Parameters:

sourceBucketName - The name of the bucket containing the source object to be copied.

Returns:

This CopyObjectRequest instance, enabling additional method calls to be chained together.

getSourceKey

public String getSourceKey()

Gets the source bucket key under which the source object to be copied is stored.

Returns:

The source bucket key under which the source object to be copied is stored.

See Also:

CopyObjectRequest.setSourceKey(String sourceKey)

setSourceKey

public void setSourceKey(String sourceKey)

Sets the source bucket key under which the source object to be copied is stored.

Parameters:

sourceKey - The source bucket key under which the source object to be copied is stored.

See Also:

CopyObjectRequest.setSourceKey(String)

withSourceKey

public CopyObjectRequest withSourceKey(String sourceKey)

Sets the key in the source bucket under which the source object to be copied is stored and returns this object, enabling additional method calls to be chained together.

Parameters:

sourceKey - The key in the source bucket under which the source object to be copied is stored.

Returns:

This CopyObjectRequest instance, enabling additional method calls to be chained together.

getSourceVersionId

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

Returns:

The version ID specifying which version of the source object to copy.

See Also:

Constants.NULL_VERSION_ID, CopyObjectRequest.setSourceVersionId(String sourceVersionId)

setSourceVersionId

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

Parameters:

sourceVersionId - The optional version ID specifying which version of the source object to copy.

withSourceVersionId

public CopyObjectRequest withSourceVersionId(String sourceVersionId)

Sets the optional version ID specifying which version of the source object to copy and returns this object, enabling additional method calls to be chained together. 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).

Parameters:

sourceVersionId - The optional version ID specifying which version of the source object to copy.

Returns:

This CopyObjectRequest, enabling additional method calls to be chained together.

getDestinationBucketName

public String getDestinationBucketName()

The name of the destination bucket.

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

Returns:

The name of the destination bucket.

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

See Also:

CopyObjectRequest.setDestinationBucketName(String destinationBucketName)

setDestinationBucketName

public void setDestinationBucketName(String destinationBucketName)

Sets the destination bucket name which will contain the new, copied object.

Parameters:

destinationBucketName - The name of the destination bucket which will contain the new, copied object.

See Also:

CopyObjectRequest.getDestinationBucketName()

withDestinationBucketName

public CopyObjectRequest 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.

Parameters:

destinationBucketName - The name of the destination bucket which will contain the new, copied object.

Returns:

This CopyObjectRequest, enabling additional method calls to be chained together.

getDestinationKey

public String getDestinationKey()

Gets the destination bucket key under which the new, copied object will be stored.

Returns:

The destination bucket key under which the new, copied object will be stored.

See Also:

CopyObjectRequest.setDestinationKey(String destinationKey)

setDestinationKey

public void setDestinationKey(String destinationKey)

Sets the destination bucket key under which the new, copied object will be stored.

Parameters:

destinationKey - The destination bucket key under which the new, copied object will be stored.

See Also:

CopyObjectRequest.getDestinationKey()

withDestinationKey

public CopyObjectRequest 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.

Parameters:

destinationKey - The destination bucket key under which the new, copied object will be stored.

Returns:

This CopyObjectRequest, enabling additional method calls to be chained together.

getStorageClass

public String getStorageClass()

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

Returns:

By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class. Amazon S3 on Outposts only uses the OUTPOSTS Storage Class. For more information, see Storage Classes in the Amazon S3 User Guide.

See Also:

StorageClass

setStorageClass

public void setStorageClass(String storageClass)

Sets the optional Amazon S3 storage class to use when storing the newly copied object. If not specified, the default standard storage class is used.

For more information on Amazon S3 storage classes and available values, see the StorageClass enumeration.

See Also:

CopyObjectRequest.getStorageClass(), CopyObjectRequest.setStorageClass(StorageClass)

withStorageClass

public CopyObjectRequest withStorageClass(String storageClass)

Sets the optional Amazon S3 storage class to use when storing the newly copied object and returns this CopyObjectRequest, enabling additional method calls to be chained together. If not specified, the default standard storage class is used.

For more information on Amazon S3 storage classes and available values, see the StorageClass enumeration.

Returns:

This CopyObjectRequest, enabling additional method calls to be chained together.

setStorageClass

public void setStorageClass(StorageClass storageClass)

Sets the optional Amazon S3 storage class to use when storing the newly copied object. If not specified, the default standard storage class is used.

For more information on Amazon S3 storage classes and available values, see the StorageClass enumeration.

See Also:

CopyObjectRequest.getStorageClass(), CopyObjectRequest.setStorageClass(String)

withStorageClass

public CopyObjectRequest withStorageClass(StorageClass storageClass)

Sets the optional Amazon S3 storage class to use when storing the newly copied object and returns this CopyObjectRequest, enabling additional method calls to be chained together. If not specified, the default standard storage class is used.

For more information on Amazon S3 storage classes and available values, see the StorageClass enumeration.

Returns:

This CopyObjectRequest, enabling additional method calls to be chained together.

getCannedAccessControlList

public CannedAccessControlList getCannedAccessControlList()

Gets the canned ACL to use for the new, copied object. If no canned ACL is specified, S3 will default to using the CannedAccessControlList.Private canned ACL for all copied objects.

Returns:

The canned ACL to set for the newly copied object, or null if no canned ACL has been specified.

setCannedAccessControlList

public void setCannedAccessControlList(CannedAccessControlList cannedACL)

Sets the canned ACL to use for the newly copied object. If no canned ACL is specified, S3 will default to using the CannedAccessControlList.Private canned ACL for all copied objects.

Parameters:

cannedACL - The canned ACL to set for the newly copied object.

withCannedAccessControlList

public CopyObjectRequest withCannedAccessControlList(CannedAccessControlList cannedACL)

Sets the canned ACL to use for the newly copied object, and returns this CopyObjectRequest, enabling additional method calls to be chained together.

Parameters:

cannedACL - The canned ACL to set for the newly copied object.

Returns:

This CopyObjectRequest, enabling additional method calls to be chained together.

getAccessControlList

public AccessControlList getAccessControlList()

Returns the optional access control list for the new object. If specified, cannedAcl will be ignored.

setAccessControlList

public void setAccessControlList(AccessControlList accessControlList)

Sets the optional access control list for the new object. If specified, cannedAcl will be ignored.

Parameters:

accessControlList - The access control list for the new object.

withAccessControlList

public CopyObjectRequest withAccessControlList(AccessControlList accessControlList)

Sets the optional access control list for the new object. If specified, cannedAcl will be ignored. Returns this CopyObjectRequest, enabling additional method calls to be chained together.

Parameters:

accessControlList - The access control list for the new object.

getNewObjectMetadata

public ObjectMetadata getNewObjectMetadata()

Gets the optional object metadata to set for the new, copied object.

Returns:

The object metadata to set for the newly copied object. Returns null if no object metadata has been specified.

See Also:

CopyObjectRequest.setNewObjectMetadata(ObjectMetadata newObjectMetadata)

setNewObjectMetadata

public void setNewObjectMetadata(ObjectMetadata newObjectMetadata)

Sets the object metadata to use for the new, copied object. By default the object metadata from the source object is copied to the destination object, but when setting object metadata with this method, no metadata from the source object is copied. Instead, the new destination object will have the metadata specified with this call.

Parameters:

newObjectMetadata - The object metadata to use for the newly copied object.

See Also:

CopyObjectRequest.getNewObjectMetadata()

withNewObjectMetadata

public CopyObjectRequest withNewObjectMetadata(ObjectMetadata newObjectMetadata)

Sets the object metadata to use for the new, copied object and returns this object, enabling additional method calls to be chained together. By default, the object metadata from the source object will be copied to the destination object, but if callers set object metadata with this method, it will be used instead.

Parameters:

newObjectMetadata - The object metadata to use for the newly copied object.

Returns:

This CopyObjectRequest, enabling additional method calls to be chained together.

getMatchingETagConstraints

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.

Returns:

The optional list of ETag constraints that when present must include a match for the source object's current ETag in order for this request to be executed.

setMatchingETagConstraints

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.

Parameters:

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.

withMatchingETagConstraint

public CopyObjectRequest 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.

Parameters:

eTag - The matching ETag constraint to add to this request.

Returns:

This CopyObjectRequest, enabling additional method calls to be chained together.

getNonmatchingETagConstraints

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.

Returns:

The optional 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.

setNonmatchingETagConstraints

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.

Parameters:

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.

withNonmatchingETagConstraint

public CopyObjectRequest 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.

Parameters:

eTag - The non-matching ETag constraint to add to this request.

Returns:

This CopyObjectRequest, enabling additional method calls to be chained together.

getUnmodifiedSinceConstraint

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.

Returns:

The optional unmodified constraint that restricts this request to executing only if the source object has not been modified after the specified date.

setUnmodifiedSinceConstraint

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.

Parameters:

date - The unmodified constraint that restricts this request to executing only if the source object has not been modified after this date.

withUnmodifiedSinceConstraint

public CopyObjectRequest 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.

Parameters:

date - The unmodified constraint that restricts this request to executing only if the source object has not been modified after this date.

Returns:

This CopyObjectRequest, enabling additional method calls to be chained together.

getModifiedSinceConstraint

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.

Returns:

The optional modified constraint that restricts this request to executing only if the source object has been modified after the specified date.

setModifiedSinceConstraint

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.

Parameters:

date - The modified constraint that restricts this request to executing only if the source object has been modified after the specified date.

withModifiedSinceConstraint

public CopyObjectRequest 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.

Parameters:

date - The modified constraint that restricts this request to executing only if the source object has been modified after the specified date.

Returns:

This CopyObjectRequest, enabling additional method calls to be chained together.

setRedirectLocation

public void setRedirectLocation(String redirectLocation)

Sets the optional redirect location for the newly copied object.

Parameters:

redirectLocation - The redirect location for the newly copied object.

getRedirectLocation

public String getRedirectLocation()

Gets the optional redirect location for the newly copied object.

withRedirectLocation

public CopyObjectRequest withRedirectLocation(String redirectLocation)

Sets the optional redirect location for the newly copied object.Returns this CopyObjectRequest, enabling additional method calls to be chained together.

Parameters:

redirectLocation - The redirect location for the newly copied object.

getSourceSSECustomerKey

public SSECustomerKey getSourceSSECustomerKey()

Returns the optional customer-provided server-side encryption key to use to decrypt the source object being copied.

Returns:

The optional customer-provided server-side encryption key to use to decrypt the source object being copied.

setSourceSSECustomerKey

public void setSourceSSECustomerKey(SSECustomerKey sseKey)

Sets the optional customer-provided server-side encryption key to use to decrypt the source object being copied.

Parameters:

sseKey - The optional customer-provided server-side encryption key to use to decrypt the source object being copied.

withSourceSSECustomerKey

public CopyObjectRequest withSourceSSECustomerKey(SSECustomerKey sseKey)

Sets the optional customer-provided server-side encryption key to use to decrypt the source object being copied, and returns the updated request object so that additional method calls can be chained together.

Parameters:

sseKey - The optional customer-provided server-side encryption key to use to decrypt the source object being copied.

Returns:

This updated request object so that additional method calls can be chained together.

getDestinationSSECustomerKey

public SSECustomerKey getDestinationSSECustomerKey()

Returns the optional customer-provided server-side encryption key to use to encrypt the destination object being copied.

Returns:

The optional customer-provided server-side encryption key to use to encrypt the destination object being copied.

setDestinationSSECustomerKey

public void setDestinationSSECustomerKey(SSECustomerKey sseKey)

Sets the optional customer-provided server-side encryption key to use to encrypt the destination object being copied.

Parameters:

sseKey - The optional customer-provided server-side encryption key to use to encrypt the destination object being copied.

withDestinationSSECustomerKey

public CopyObjectRequest withDestinationSSECustomerKey(SSECustomerKey sseKey)

Sets the optional customer-provided server-side encryption key to use to encrypt the destination object being copied, and returns the updated request object so that additional method calls can be chained together.

Parameters:

sseKey - The optional customer-provided server-side encryption key to use to encrypt the destination object being copied.

Returns:

This updated request object so that additional method calls can be chained together.

getSSEAwsKeyManagementParams

public SSEAwsKeyManagementParams getSSEAwsKeyManagementParams()

Returns the Amazon Web Services Key Management System parameters used to encrypt the object on server side.

Specified by:

getSSEAwsKeyManagementParams in interface SSEAwsKeyManagementParamsProvider

Returns:

The optional SSEAwsKeyManagementParams to use to encrypt the uploaded object.

setSSEAwsKeyManagementParams

public void setSSEAwsKeyManagementParams(SSEAwsKeyManagementParams params)

Sets the Amazon Web Services Key Management System parameters used to encrypt the object on server side.

withSSEAwsKeyManagementParams

public CopyObjectRequest withSSEAwsKeyManagementParams(SSEAwsKeyManagementParams sseAwsKeyManagementParams)

Sets the Amazon Web Services Key Management System parameters used to encrypt the object on server side.

Returns:

returns the update CopyObjectRequest

isRequesterPays

public boolean isRequesterPays()

Returns true if the user has enabled Requester Pays option when conducting this operation from Requester Pays Bucket; else false.

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

Returns:

true if the user has enabled Requester Pays option for conducting this operation from Requester Pays Bucket.

setRequesterPays

public void setRequesterPays(boolean isRequesterPays)

Used for conducting this operation from a Requester Pays Bucket. If set the requester is charged for requests from the bucket.

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.

Parameters:

isRequesterPays - Enable Requester Pays option for the operation.

withRequesterPays

public CopyObjectRequest withRequesterPays(boolean isRequesterPays)

Used for conducting this operation from a Requester Pays Bucket. If set the requester is charged for requests from the bucket. It returns this updated CopyObjectRequest object so that additional method calls can be chained together.

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.

Parameters:

isRequesterPays - Enable Requester Pays option for the operation.

Returns:

The updated CopyObjectRequest object.

getNewObjectTagging

public com.ibm.cloud.objectstorage.services.s3.model.ObjectTagging getNewObjectTagging()

Returns:

the tagging for the new object.

setNewObjectTagging

public void setNewObjectTagging(com.ibm.cloud.objectstorage.services.s3.model.ObjectTagging newObjectTagging)

set the tagging for the new object.

Parameters:

newObjectTagging - the tagging for the new object.

withNewObjectTagging

public CopyObjectRequest withNewObjectTagging(com.ibm.cloud.objectstorage.services.s3.model.ObjectTagging newObjectTagging)

set the tagging for the new object.

Parameters:

newObjectTagging - the tagging for the new object.

Returns:

This object for chaining.

getRetentionDirective

public RetentionDirective getRetentionDirective()

setRetentionDirective

public void setRetentionDirective(RetentionDirective retentionDirective)

getRetentionExpirationDate

public Date getRetentionExpirationDate()

setRetentionExpirationDate

public void setRetentionExpirationDate(Date retentionExpirationDate)

getRetentionLegalHoldId

public String getRetentionLegalHoldId()

setRetentionLegalHoldId

public void setRetentionLegalHoldId(String retentionLegalHoldId)

getRetentionPeriod

public Long getRetentionPeriod()

setRetentionPeriod

public void setRetentionPeriod(Long retentionPeriod)

getMetadataDirective

public String getMetadataDirective()

Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

setMetadataDirective

public void setMetadataDirective(String metadataDirective)

Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

Parameters:

metadataDirective - New value for the metadata directive.

withMetadataDirective

public CopyObjectRequest withMetadataDirective(String metadataDirective)

Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

Parameters:

metadataDirective - New value for the metadata directive.

Returns:

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

withMetadataDirective

public CopyObjectRequest withMetadataDirective(MetadataDirective metadataDirective)

Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

Parameters:

metadataDirective - New value for the metadata directive.

Returns:

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

getObjectLockMode

public String getObjectLockMode()

The Object Lock mode that you want to apply to the copied object.

withObjectLockMode

public CopyObjectRequest withObjectLockMode(String objectLockMode)

The Object Lock mode that you want to apply to the copied object.

withObjectLockMode

public CopyObjectRequest withObjectLockMode(ObjectLockMode objectLockMode)

The Object Lock mode that you want to apply to the copied object.

setObjectLockMode

public void setObjectLockMode(String objectLockMode)

The Object Lock mode that you want to apply to the copied object.

setObjectLockMode

public void setObjectLockMode(ObjectLockMode objectLockMode)

The Object Lock mode that you want to apply to the copied object.

getObjectLockRetainUntilDate

public Date getObjectLockRetainUntilDate()

The date and time when you want this object's Object Lock to expire.

withObjectLockRetainUntilDate

public CopyObjectRequest withObjectLockRetainUntilDate(Date objectLockRetainUntilDate)

The date and time when you want this object's Object Lock to expire.

setObjectLockRetainUntilDate

public void setObjectLockRetainUntilDate(Date objectLockRetainUntilDate)

The date and time when you want this object's Object Lock to expire.

getObjectLockLegalHoldStatus

public String getObjectLockLegalHoldStatus()

Specifies whether you want to apply a Legal Hold to the copied object.

withObjectLockLegalHoldStatus

public CopyObjectRequest withObjectLockLegalHoldStatus(String objectLockLegalHoldStatus)

Specifies whether you want to apply a Legal Hold to the copied object.

withObjectLockLegalHoldStatus

public CopyObjectRequest withObjectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus)

Specifies whether you want to apply a Legal Hold to the copied object.

setObjectLockLegalHoldStatus

public void setObjectLockLegalHoldStatus(String objectLockLegalHoldStatus)

Specifies whether you want to apply a Legal Hold to the copied object.

setObjectLockLegalHoldStatus

public void setObjectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus)

Specifies whether you want to apply a Legal Hold to the copied object.