public class CopyObjectRequest extends CosServiceRequest implements SSECOSKeyManagementParamsProvider, Serializable
Constructor and Description |
---|
CopyObjectRequest(Region sourceBucketRegion,
String sourceBucketName,
String sourceKey,
String destinationBucketName,
String destinationKey)
Constructs a new
com.qcloud.cos.model with only basic options. |
CopyObjectRequest(String sourceAppid,
Region sourceBucketRegion,
String sourceBucketName,
String sourceKey,
String destinationBucketName,
String destinationKey)
Constructs a new
com.qcloud.cos.model with only basic options. |
CopyObjectRequest(String sourceAppid,
Region sourceBucketRegion,
String sourceBucketName,
String sourceKey,
String sourceVersionId,
String destinationBucketName,
String destinationKey)
Constructs a new
CopyObjectRequest with basic options, providing an COS version ID
identifying the specific version of the source object to copy. |
CopyObjectRequest(String sourceBucketName,
String sourceKey,
String destinationBucketName,
String destinationKey)
Constructs a new
com.qcloud.cos.model with only basic options. |
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()
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() |
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.
|
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 |
getRedirectLocation()
Gets the optional redirect location for the newly copied object.
|
String |
getSourceAppid() |
String |
getSourceBucketName()
Gets the name of the bucket containing the source object to be copied.
|
Region |
getSourceBucketRegion() |
EndpointBuilder |
getSourceEndpointBuilder() |
String |
getSourceKey()
Gets the source bucket key under which the source object to be copied is stored.
|
SSECustomerKey |
getSourceSSECustomerKey() |
String |
getSourceVersionId()
Gets the version ID specifying which version of the source object to copy.
|
SSECOSKeyManagementParams |
getSSECOSKeyManagementParams()
Returns the optional SSECOSKeyManagementParams to use to encrypt the
uploaded object.
|
String |
getStorageClass()
Gets the optional Qcloud COS storage class to use when storing the newly copied object.
|
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.
|
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 destinationSSECustomerKey) |
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 |
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 |
setRedirectLocation(String redirectLocation)
Sets the optional redirect location for the newly copied object.
|
void |
setSourceAppid(String sourceAppid) |
void |
setSourceBucketName(String sourceBucketName)
Sets the name of the bucket containing the source object to be copied.
|
void |
setSourceBucketRegion(Region sourceBucketRegion) |
void |
setSourceEndpointBuilder(EndpointBuilder sourceEndpointBuilder) |
void |
setSourceKey(String sourceKey)
Sets the source bucket key under which the source object to be copied is stored.
|
void |
setSourceSSECustomerKey(SSECustomerKey sourceSSECustomerKey) |
void |
setSourceVersionId(String sourceVersionId)
Sets the optional version ID specifying which version of the source object to copy.
|
void |
setSSECOSKeyManagementParams(SSECOSKeyManagementParams sseCOSKeyManagementParams) |
void |
setStorageClass(StorageClass storageClass)
Sets the optional Qcloud COS storage class to use when storing the newly copied object.
|
void |
setStorageClass(String storageClass)
Sets the optional Qcloud COS 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 |
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(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 |
withNonmatchingETagConstraint(String eTag)
Adds a single ETag constraint to this request and returns this object, enabling additional
method calls to be chained together.
|
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 |
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 |
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 |
withStorageClass(StorageClass storageClass)
Sets the optional Qcloud COS 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 Qcloud COS 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.
|
clone, copyBaseTo, getCiSpecialEndParameter, getCloneRoot, getCloneSource, getCosCredentials, getCustomQueryParameters, getCustomRequestHeaders, getFixedEndpointAddr, getGeneralProgressListener, getReadLimit, getRequestClientOptions, putCustomQueryParameter, putCustomRequestHeader, setCiSpecialEndParameter, setCosCredentials, setFixedEndpointAddr, setGeneralProgressListener, withGeneralProgressListener
public CopyObjectRequest(String sourceBucketName, String sourceKey, String destinationBucketName, String destinationKey)
Constructs a new com.qcloud.cos.model
with only basic options.
sourceBucketName
- The name of the COS bucket containing the object to copy.sourceKey
- The source bucket key under which the object to copy is stored.destinationBucketName
- The name of the COS bucket to which the new object will be
copied.destinationKey
- The destination bucket key under which the new object will be copied.CopyObjectRequest#CopyObjectRequest(String, String, String, String, String)
public CopyObjectRequest(Region sourceBucketRegion, String sourceBucketName, String sourceKey, String destinationBucketName, String destinationKey)
Constructs a new com.qcloud.cos.model
with only basic options.
sourceBucketRegion
- The source Bucket RegionsourceBucketName
- The name of the COS bucket containing the object to copy.sourceKey
- The source bucket key under which the object to copy is stored.destinationBucketName
- The name of the COS bucket to which the new object will be
copied.destinationKey
- The destination bucket key under which the new object will be copied.CopyObjectRequest#CopyObjectRequest(String, String, String, String, String)
public CopyObjectRequest(String sourceAppid, Region sourceBucketRegion, String sourceBucketName, String sourceKey, String destinationBucketName, String destinationKey)
Constructs a new com.qcloud.cos.model
with only basic options.
sourceAppid
- The source bucket appidsourceBucketRegion
- The source Bucket RegionsourceBucketName
- The name of the COS bucket containing the object to copy.sourceKey
- The source bucket key under which the object to copy is stored.destinationBucketName
- The name of the COS bucket to which the new object will be
copied.destinationKey
- The destination bucket key under which the new object will be copied.CopyObjectRequest#CopyObjectRequest(String, String, String, String, String)
public CopyObjectRequest(String sourceAppid, Region sourceBucketRegion, String sourceBucketName, String sourceKey, String sourceVersionId, String destinationBucketName, String destinationKey)
Constructs a new CopyObjectRequest
with basic options, providing an COS version ID
identifying the specific version of the source object to copy.
sourceBucketRegion
- The source Bucket RegionsourceBucketName
- The name of the COS bucket containing the object to copy.sourceKey
- The key in the source bucket under which the object to copy is stored.sourceVersionId
- The COS version ID which uniquely identifies a specific version of the
source object to copy.destinationBucketName
- The name of the COS bucket in which the new object will be
copied.destinationKey
- The key in the destination bucket under which the new object will be
copied.CopyObjectRequest(String sourceBucketName, String sourceKey, String
destinationBucketName, String destinationKey)
public String getSourceAppid()
public void setSourceAppid(String sourceAppid)
public Region getSourceBucketRegion()
public void setSourceBucketRegion(Region sourceBucketRegion)
public String getSourceBucketName()
setSourceBucketName(String sourceBucketName)
public void setSourceBucketName(String sourceBucketName)
sourceBucketName
- The name of the bucket containing the source object to be copied.getSourceBucketName()
public CopyObjectRequest withSourceBucketName(String sourceBucketName)
sourceBucketName
- The name of the bucket containing the source object to be copied.CopyObjectRequest
instance, enabling additional method calls to be
chained together.public String getSourceKey()
setSourceKey(String sourceKey)
public void setSourceKey(String sourceKey)
sourceKey
- The source bucket key under which the source object to be copied is stored.setSourceKey(String sourceKey)}
public CopyObjectRequest withSourceKey(String sourceKey)
sourceKey
- The key in the source bucket under which the source object to be copied is
stored.CopyObjectRequest
instance, enabling additional method calls to be
chained together.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
COS#setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest)
.
Constants#NULL_VERSION_ID
,
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
COS#setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest)
.
sourceVersionId
- The optional version ID specifying which version of the source object
to copy.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
COS#setBucketVersioningConfiguration(SetBucketVersioningConfigurationRequest)
.
sourceVersionId
- The optional version ID specifying which version of the source object
to copy.CopyObjectRequest
, enabling additional method calls to be chained
together.public String getDestinationBucketName()
setDestinationBucketName(String destinationBucketName)
public void setDestinationBucketName(String destinationBucketName)
destinationBucketName
- The name of the destination bucket which will contain the new,
copied object.getDestinationBucketName()
public CopyObjectRequest withDestinationBucketName(String destinationBucketName)
destinationBucketName
- The name of the destination bucket which will contain the new,
copied object.CopyObjectRequest
, enabling additional method calls to be chained
together.public String getDestinationKey()
setDestinationKey(String destinationKey)
public void setDestinationKey(String destinationKey)
destinationKey
- The destination bucket key under which the new, copied object will be
stored.getDestinationKey()
public CopyObjectRequest withDestinationKey(String destinationKey)
destinationKey
- The destination bucket key under which the new, copied object will be
stored.CopyObjectRequest
, enabling additional method calls to be chained
together.public String getStorageClass()
Gets the optional Qcloud COS storage class to use when storing the newly copied object. If not specified, the default standard storage class is used.
For more information on available Qcloud COS storage classes, see the StorageClass
enumeration.
setStorageClass(String)
,
setStorageClass(StorageClass)
public void setStorageClass(String storageClass)
Sets the optional Qcloud COS storage class to use when storing the newly copied object. If not specified, the default standard storage class is used.
For more information on Qcloud COS storage classes and available values, see the
StorageClass
enumeration.
getStorageClass()
,
setStorageClass(StorageClass)
public CopyObjectRequest withStorageClass(String storageClass)
Sets the optional Qcloud COS 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 Qcloud COS storage classes and available values, see the
StorageClass
enumeration.
CopyObjectRequest
, enabling additional method calls to be chained
together.public void setStorageClass(StorageClass storageClass)
Sets the optional Qcloud COS storage class to use when storing the newly copied object. If not specified, the default standard storage class is used.
For more information on Qcloud COS storage classes and available values, see the
StorageClass
enumeration.
getStorageClass()
,
setStorageClass(String)
public CopyObjectRequest withStorageClass(StorageClass storageClass)
Sets the optional Qcloud COS 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 Qcloud COS storage classes and available values, see the
StorageClass
enumeration.
CopyObjectRequest
, enabling additional method calls to be chained
together.public CannedAccessControlList getCannedAccessControlList()
CannedAccessControlList.Private
canned ACL for all copied
objects.null
if no canned
ACL has been specified.public void setCannedAccessControlList(CannedAccessControlList cannedACL)
CannedAccessControlList.Private
canned ACL for all copied
objects.cannedACL
- The canned ACL to set for the newly copied object.public CopyObjectRequest withCannedAccessControlList(CannedAccessControlList cannedACL)
CopyObjectRequest
, enabling additional method calls to be chained together.cannedACL
- The canned ACL to set for the newly copied object.CopyObjectRequest
, enabling additional method calls to be chained
together.public AccessControlList getAccessControlList()
public void setAccessControlList(AccessControlList accessControlList)
accessControlList
- The access control list for the new object.public CopyObjectRequest withAccessControlList(AccessControlList accessControlList)
CopyObjectRequest
, enabling additional method calls to be
chained together.accessControlList
- The access control list for the new object.public ObjectMetadata getNewObjectMetadata()
null
if
no object metadata has been specified.setNewObjectMetadata(ObjectMetadata newObjectMetadata)
public void setNewObjectMetadata(ObjectMetadata newObjectMetadata)
newObjectMetadata
- The object metadata to use for the newly copied object.getNewObjectMetadata()
public CopyObjectRequest withNewObjectMetadata(ObjectMetadata newObjectMetadata)
newObjectMetadata
- The object metadata to use for the newly copied object.CopyObjectRequest
, 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 Qcloud COS.
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 Qcloud COS.
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 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.
eTag
- The matching ETag constraint to add to this request.CopyObjectRequest
, 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 Qcloud COS.
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 Qcloud COS.
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 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 Qcloud COS.
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.CopyObjectRequest
, 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 Qcloud COS 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 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 Qcloud COS 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.CopyObjectRequest
, 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 Qcloud COS 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 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 Qcloud COS 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.CopyObjectRequest
, enabling additional method calls to be chained
together.public void setRedirectLocation(String redirectLocation)
redirectLocation
- The redirect location for the newly copied object.public String getRedirectLocation()
public CopyObjectRequest withRedirectLocation(String redirectLocation)
CopyObjectRequest
, enabling additional method calls to be chained together.redirectLocation
- The redirect location for the newly copied object.public SSECustomerKey getSourceSSECustomerKey()
public void setSourceSSECustomerKey(SSECustomerKey sourceSSECustomerKey)
public SSECustomerKey getDestinationSSECustomerKey()
public void setDestinationSSECustomerKey(SSECustomerKey destinationSSECustomerKey)
public void setSSECOSKeyManagementParams(SSECOSKeyManagementParams sseCOSKeyManagementParams)
public SSECOSKeyManagementParams getSSECOSKeyManagementParams()
SSECOSKeyManagementParamsProvider
getSSECOSKeyManagementParams
in interface SSECOSKeyManagementParamsProvider
public EndpointBuilder getSourceEndpointBuilder()
public void setSourceEndpointBuilder(EndpointBuilder sourceEndpointBuilder)
public String getMetadataDirective()
public void setMetadataDirective(String metadataDirective)
metadataDirective
- New value for the metadata directive.public CopyObjectRequest withMetadataDirective(String metadataDirective)
metadataDirective
- New value for the metadata directive.Copyright © 2024. All rights reserved.