com.sinacloud.scs.services.scs.model

类 CopyObjectRequest

java.lang.Object

com.sinacloud.scs.SCSWebServiceRequest

com.sinacloud.scs.services.scs.model.CopyObjectRequest

public class CopyObjectRequest
extends SCSWebServiceRequest

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.

另请参阅:

SCSClient#copyObject(String, String, String, String), SCSClient#copyObject(com.amazonaws.services.s3.model.CopyObjectRequest), CopyObjectResult

构造器概要

构造器

构造器和说明
CopyObjectRequest(String sourceBucketName, String sourceKey, String destinationBucketName, String destinationKey) Constructs a new com.amazonaws.services.s3.model#CopyObjectRequest with only basic options.

方法概要

方法

限定符和类型	方法和说明
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.
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.
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	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.
String	getStorageClass() Gets the optional Amazon S3 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	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	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	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	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	withMatchingETagConstraint(String eTag) Adds a single ETag constraint to this request and returns this object, enabling additional method calls to be chained together.
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	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.

从类继承的方法 com.sinacloud.scs.SCSWebServiceRequest

copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, setDelegationToken, setRequestCredentials

从类继承的方法 java.lang.Object

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

构造器详细资料

CopyObjectRequest

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

Constructs a new com.amazonaws.services.s3.model#CopyObjectRequest with only basic options.

参数:

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#CopyObjectRequest(String, String, String, String, String)

方法详细资料

getSourceBucketName

public String getSourceBucketName()

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

返回:

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

另请参阅:

setSourceBucketName(String sourceBucketName)

setSourceBucketName

public void setSourceBucketName(String sourceBucketName)

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

参数:

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

另请参阅:

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.

参数:

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

返回:

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.

返回:

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

另请参阅:

setSourceKey(String sourceKey)

setSourceKey

public void setSourceKey(String sourceKey)

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

参数:

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

另请参阅:

setSourceKey(String sourceKey)}

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.

参数:

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

返回:

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

getDestinationBucketName

public String getDestinationBucketName()

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

返回:

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

另请参阅:

setDestinationBucketName(String destinationBucketName)

setDestinationBucketName

public void setDestinationBucketName(String destinationBucketName)

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

参数:

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

另请参阅:

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.

参数:

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

返回:

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.

返回:

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

另请参阅:

setDestinationKey(String destinationKey)

setDestinationKey

public void setDestinationKey(String destinationKey)

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

参数:

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

另请参阅:

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.

参数:

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

返回:

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

getStorageClass

public String getStorageClass()

Gets 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 available Amazon S3 storage classes, see the StorageClass enumeration.

返回:

The Amazon S3 storage class to use when storing the newly copied object.

另请参阅:

setStorageClass(String), setStorageClass(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.

另请参阅:

getStorageClass(), 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.

返回:

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.

另请参阅:

getStorageClass(), 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.

返回:

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.

返回:

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.

参数:

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.

参数:

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

返回:

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.

参数:

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.

参数:

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.

返回:

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

另请参阅:

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.

参数:

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

另请参阅:

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.

参数:

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

返回:

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.

返回:

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.

参数:

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.

参数:

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

返回:

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.

返回:

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.

参数:

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.

参数:

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

返回:

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.

返回:

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.

参数:

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.

参数:

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

返回:

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.

返回:

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.

参数:

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.

参数:

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

返回:

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.

参数:

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.

参数:

redirectLocation - The redirect location for the newly copied object.