@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class S3CopyObjectOperation extends Object implements Serializable, Cloneable
Contains the configuration parameters for a PUT Copy object operation. S3 Batch Operations passes every object to the underlying PUT Copy object API. For more information about the parameters for this operation, see PUT Object - Copy.
Constructor and Description |
---|
S3CopyObjectOperation() |
Modifier and Type | Method and Description |
---|---|
S3CopyObjectOperation |
clone() |
boolean |
equals(Object obj) |
List<S3Grant> |
getAccessControlGrants()
|
Boolean |
getBucketKeyEnabled()
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using
Amazon Web Services KMS (SSE-KMS).
|
String |
getCannedAccessControlList()
|
String |
getMetadataDirective()
|
Date |
getModifiedSinceConstraint()
|
S3ObjectMetadata |
getNewObjectMetadata()
|
List<S3Tag> |
getNewObjectTagging()
|
String |
getObjectLockLegalHoldStatus()
The legal hold status to be applied to all objects in the Batch Operations job.
|
String |
getObjectLockMode()
The retention mode to be applied to all objects in the Batch Operations job.
|
Date |
getObjectLockRetainUntilDate()
The date when the applied object retention configuration expires on all objects in the Batch Operations job.
|
String |
getRedirectLocation()
Specifies an optional metadata property for website redirects,
x-amz-website-redirect-location . |
Boolean |
getRequesterPays()
|
String |
getSSEAwsKmsKeyId()
|
String |
getStorageClass()
|
String |
getTargetKeyPrefix()
Specifies the folder prefix into which you would like the objects to be copied.
|
String |
getTargetResource()
Specifies the destination bucket ARN for the batch copy operation.
|
Date |
getUnModifiedSinceConstraint()
|
int |
hashCode() |
Boolean |
isBucketKeyEnabled()
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using
Amazon Web Services KMS (SSE-KMS).
|
Boolean |
isRequesterPays()
|
void |
setAccessControlGrants(Collection<S3Grant> accessControlGrants)
|
void |
setBucketKeyEnabled(Boolean bucketKeyEnabled)
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using
Amazon Web Services KMS (SSE-KMS).
|
void |
setCannedAccessControlList(String cannedAccessControlList)
|
void |
setMetadataDirective(String metadataDirective)
|
void |
setModifiedSinceConstraint(Date modifiedSinceConstraint)
|
void |
setNewObjectMetadata(S3ObjectMetadata newObjectMetadata)
|
void |
setNewObjectTagging(Collection<S3Tag> newObjectTagging)
|
void |
setObjectLockLegalHoldStatus(String objectLockLegalHoldStatus)
The legal hold status to be applied to all objects in the Batch Operations job.
|
void |
setObjectLockMode(String objectLockMode)
The retention mode to be applied to all objects in the Batch Operations job.
|
void |
setObjectLockRetainUntilDate(Date objectLockRetainUntilDate)
The date when the applied object retention configuration expires on all objects in the Batch Operations job.
|
void |
setRedirectLocation(String redirectLocation)
Specifies an optional metadata property for website redirects,
x-amz-website-redirect-location . |
void |
setRequesterPays(Boolean requesterPays)
|
void |
setSSEAwsKmsKeyId(String sSEAwsKmsKeyId)
|
void |
setStorageClass(String storageClass)
|
void |
setTargetKeyPrefix(String targetKeyPrefix)
Specifies the folder prefix into which you would like the objects to be copied.
|
void |
setTargetResource(String targetResource)
Specifies the destination bucket ARN for the batch copy operation.
|
void |
setUnModifiedSinceConstraint(Date unModifiedSinceConstraint)
|
String |
toString()
Returns a string representation of this object.
|
S3CopyObjectOperation |
withAccessControlGrants(Collection<S3Grant> accessControlGrants)
|
S3CopyObjectOperation |
withAccessControlGrants(S3Grant... accessControlGrants)
|
S3CopyObjectOperation |
withBucketKeyEnabled(Boolean bucketKeyEnabled)
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using
Amazon Web Services KMS (SSE-KMS).
|
S3CopyObjectOperation |
withCannedAccessControlList(S3CannedAccessControlList cannedAccessControlList)
|
S3CopyObjectOperation |
withCannedAccessControlList(String cannedAccessControlList)
|
S3CopyObjectOperation |
withMetadataDirective(S3MetadataDirective metadataDirective)
|
S3CopyObjectOperation |
withMetadataDirective(String metadataDirective)
|
S3CopyObjectOperation |
withModifiedSinceConstraint(Date modifiedSinceConstraint)
|
S3CopyObjectOperation |
withNewObjectMetadata(S3ObjectMetadata newObjectMetadata)
|
S3CopyObjectOperation |
withNewObjectTagging(Collection<S3Tag> newObjectTagging)
|
S3CopyObjectOperation |
withNewObjectTagging(S3Tag... newObjectTagging)
|
S3CopyObjectOperation |
withObjectLockLegalHoldStatus(S3ObjectLockLegalHoldStatus objectLockLegalHoldStatus)
The legal hold status to be applied to all objects in the Batch Operations job.
|
S3CopyObjectOperation |
withObjectLockLegalHoldStatus(String objectLockLegalHoldStatus)
The legal hold status to be applied to all objects in the Batch Operations job.
|
S3CopyObjectOperation |
withObjectLockMode(S3ObjectLockMode objectLockMode)
The retention mode to be applied to all objects in the Batch Operations job.
|
S3CopyObjectOperation |
withObjectLockMode(String objectLockMode)
The retention mode to be applied to all objects in the Batch Operations job.
|
S3CopyObjectOperation |
withObjectLockRetainUntilDate(Date objectLockRetainUntilDate)
The date when the applied object retention configuration expires on all objects in the Batch Operations job.
|
S3CopyObjectOperation |
withRedirectLocation(String redirectLocation)
Specifies an optional metadata property for website redirects,
x-amz-website-redirect-location . |
S3CopyObjectOperation |
withRequesterPays(Boolean requesterPays)
|
S3CopyObjectOperation |
withSSEAwsKmsKeyId(String sSEAwsKmsKeyId)
|
S3CopyObjectOperation |
withStorageClass(S3StorageClass storageClass)
|
S3CopyObjectOperation |
withStorageClass(String storageClass)
|
S3CopyObjectOperation |
withTargetKeyPrefix(String targetKeyPrefix)
Specifies the folder prefix into which you would like the objects to be copied.
|
S3CopyObjectOperation |
withTargetResource(String targetResource)
Specifies the destination bucket ARN for the batch copy operation.
|
S3CopyObjectOperation |
withUnModifiedSinceConstraint(Date unModifiedSinceConstraint)
|
public void setTargetResource(String targetResource)
Specifies the destination bucket ARN for the batch copy operation. For example, to copy objects to a bucket named "destinationBucket", set the TargetResource to "arn:aws:s3:::destinationBucket".
targetResource
- Specifies the destination bucket ARN for the batch copy operation. For example, to copy objects to a
bucket named "destinationBucket", set the TargetResource to "arn:aws:s3:::destinationBucket".public String getTargetResource()
Specifies the destination bucket ARN for the batch copy operation. For example, to copy objects to a bucket named "destinationBucket", set the TargetResource to "arn:aws:s3:::destinationBucket".
public S3CopyObjectOperation withTargetResource(String targetResource)
Specifies the destination bucket ARN for the batch copy operation. For example, to copy objects to a bucket named "destinationBucket", set the TargetResource to "arn:aws:s3:::destinationBucket".
targetResource
- Specifies the destination bucket ARN for the batch copy operation. For example, to copy objects to a
bucket named "destinationBucket", set the TargetResource to "arn:aws:s3:::destinationBucket".public void setCannedAccessControlList(String cannedAccessControlList)
cannedAccessControlList
- S3CannedAccessControlList
public String getCannedAccessControlList()
S3CannedAccessControlList
public S3CopyObjectOperation withCannedAccessControlList(String cannedAccessControlList)
cannedAccessControlList
- S3CannedAccessControlList
public S3CopyObjectOperation withCannedAccessControlList(S3CannedAccessControlList cannedAccessControlList)
cannedAccessControlList
- S3CannedAccessControlList
public void setAccessControlGrants(Collection<S3Grant> accessControlGrants)
accessControlGrants
- public S3CopyObjectOperation withAccessControlGrants(S3Grant... accessControlGrants)
NOTE: This method appends the values to the existing list (if any). Use
setAccessControlGrants(java.util.Collection)
or withAccessControlGrants(java.util.Collection)
if you want to override the existing values.
accessControlGrants
- public S3CopyObjectOperation withAccessControlGrants(Collection<S3Grant> accessControlGrants)
accessControlGrants
- public void setMetadataDirective(String metadataDirective)
metadataDirective
- S3MetadataDirective
public String getMetadataDirective()
S3MetadataDirective
public S3CopyObjectOperation withMetadataDirective(String metadataDirective)
metadataDirective
- S3MetadataDirective
public S3CopyObjectOperation withMetadataDirective(S3MetadataDirective metadataDirective)
metadataDirective
- S3MetadataDirective
public void setModifiedSinceConstraint(Date modifiedSinceConstraint)
modifiedSinceConstraint
- public Date getModifiedSinceConstraint()
public S3CopyObjectOperation withModifiedSinceConstraint(Date modifiedSinceConstraint)
modifiedSinceConstraint
- public void setNewObjectMetadata(S3ObjectMetadata newObjectMetadata)
newObjectMetadata
- public S3ObjectMetadata getNewObjectMetadata()
public S3CopyObjectOperation withNewObjectMetadata(S3ObjectMetadata newObjectMetadata)
newObjectMetadata
- public void setNewObjectTagging(Collection<S3Tag> newObjectTagging)
newObjectTagging
- public S3CopyObjectOperation withNewObjectTagging(S3Tag... newObjectTagging)
NOTE: This method appends the values to the existing list (if any). Use
setNewObjectTagging(java.util.Collection)
or withNewObjectTagging(java.util.Collection)
if you
want to override the existing values.
newObjectTagging
- public S3CopyObjectOperation withNewObjectTagging(Collection<S3Tag> newObjectTagging)
newObjectTagging
- public void setRedirectLocation(String redirectLocation)
Specifies an optional metadata property for website redirects, x-amz-website-redirect-location
.
Allows webpage redirects if the object is accessed through a website endpoint.
redirectLocation
- Specifies an optional metadata property for website redirects,
x-amz-website-redirect-location
. Allows webpage redirects if the object is accessed through a
website endpoint.public String getRedirectLocation()
Specifies an optional metadata property for website redirects, x-amz-website-redirect-location
.
Allows webpage redirects if the object is accessed through a website endpoint.
x-amz-website-redirect-location
. Allows webpage redirects if the object is accessed through
a website endpoint.public S3CopyObjectOperation withRedirectLocation(String redirectLocation)
Specifies an optional metadata property for website redirects, x-amz-website-redirect-location
.
Allows webpage redirects if the object is accessed through a website endpoint.
redirectLocation
- Specifies an optional metadata property for website redirects,
x-amz-website-redirect-location
. Allows webpage redirects if the object is accessed through a
website endpoint.public void setRequesterPays(Boolean requesterPays)
requesterPays
- public Boolean getRequesterPays()
public S3CopyObjectOperation withRequesterPays(Boolean requesterPays)
requesterPays
- public Boolean isRequesterPays()
public void setStorageClass(String storageClass)
storageClass
- S3StorageClass
public String getStorageClass()
S3StorageClass
public S3CopyObjectOperation withStorageClass(String storageClass)
storageClass
- S3StorageClass
public S3CopyObjectOperation withStorageClass(S3StorageClass storageClass)
storageClass
- S3StorageClass
public void setUnModifiedSinceConstraint(Date unModifiedSinceConstraint)
unModifiedSinceConstraint
- public Date getUnModifiedSinceConstraint()
public S3CopyObjectOperation withUnModifiedSinceConstraint(Date unModifiedSinceConstraint)
unModifiedSinceConstraint
- public void setSSEAwsKmsKeyId(String sSEAwsKmsKeyId)
sSEAwsKmsKeyId
- public String getSSEAwsKmsKeyId()
public S3CopyObjectOperation withSSEAwsKmsKeyId(String sSEAwsKmsKeyId)
sSEAwsKmsKeyId
- public void setTargetKeyPrefix(String targetKeyPrefix)
Specifies the folder prefix into which you would like the objects to be copied. For example, to copy objects into a folder named "Folder1" in the destination bucket, set the TargetKeyPrefix to "Folder1/".
targetKeyPrefix
- Specifies the folder prefix into which you would like the objects to be copied. For example, to copy
objects into a folder named "Folder1" in the destination bucket, set the TargetKeyPrefix to "Folder1/".public String getTargetKeyPrefix()
Specifies the folder prefix into which you would like the objects to be copied. For example, to copy objects into a folder named "Folder1" in the destination bucket, set the TargetKeyPrefix to "Folder1/".
public S3CopyObjectOperation withTargetKeyPrefix(String targetKeyPrefix)
Specifies the folder prefix into which you would like the objects to be copied. For example, to copy objects into a folder named "Folder1" in the destination bucket, set the TargetKeyPrefix to "Folder1/".
targetKeyPrefix
- Specifies the folder prefix into which you would like the objects to be copied. For example, to copy
objects into a folder named "Folder1" in the destination bucket, set the TargetKeyPrefix to "Folder1/".public void setObjectLockLegalHoldStatus(String objectLockLegalHoldStatus)
The legal hold status to be applied to all objects in the Batch Operations job.
objectLockLegalHoldStatus
- The legal hold status to be applied to all objects in the Batch Operations job.S3ObjectLockLegalHoldStatus
public String getObjectLockLegalHoldStatus()
The legal hold status to be applied to all objects in the Batch Operations job.
S3ObjectLockLegalHoldStatus
public S3CopyObjectOperation withObjectLockLegalHoldStatus(String objectLockLegalHoldStatus)
The legal hold status to be applied to all objects in the Batch Operations job.
objectLockLegalHoldStatus
- The legal hold status to be applied to all objects in the Batch Operations job.S3ObjectLockLegalHoldStatus
public S3CopyObjectOperation withObjectLockLegalHoldStatus(S3ObjectLockLegalHoldStatus objectLockLegalHoldStatus)
The legal hold status to be applied to all objects in the Batch Operations job.
objectLockLegalHoldStatus
- The legal hold status to be applied to all objects in the Batch Operations job.S3ObjectLockLegalHoldStatus
public void setObjectLockMode(String objectLockMode)
The retention mode to be applied to all objects in the Batch Operations job.
objectLockMode
- The retention mode to be applied to all objects in the Batch Operations job.S3ObjectLockMode
public String getObjectLockMode()
The retention mode to be applied to all objects in the Batch Operations job.
S3ObjectLockMode
public S3CopyObjectOperation withObjectLockMode(String objectLockMode)
The retention mode to be applied to all objects in the Batch Operations job.
objectLockMode
- The retention mode to be applied to all objects in the Batch Operations job.S3ObjectLockMode
public S3CopyObjectOperation withObjectLockMode(S3ObjectLockMode objectLockMode)
The retention mode to be applied to all objects in the Batch Operations job.
objectLockMode
- The retention mode to be applied to all objects in the Batch Operations job.S3ObjectLockMode
public void setObjectLockRetainUntilDate(Date objectLockRetainUntilDate)
The date when the applied object retention configuration expires on all objects in the Batch Operations job.
objectLockRetainUntilDate
- The date when the applied object retention configuration expires on all objects in the Batch Operations
job.public Date getObjectLockRetainUntilDate()
The date when the applied object retention configuration expires on all objects in the Batch Operations job.
public S3CopyObjectOperation withObjectLockRetainUntilDate(Date objectLockRetainUntilDate)
The date when the applied object retention configuration expires on all objects in the Batch Operations job.
objectLockRetainUntilDate
- The date when the applied object retention configuration expires on all objects in the Batch Operations
job.public void setBucketKeyEnabled(Boolean bucketKeyEnabled)
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using
Amazon Web Services KMS (SSE-KMS). Setting this header to true
causes Amazon S3 to use an S3 Bucket
Key for object encryption with SSE-KMS.
Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.
bucketKeyEnabled
- Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption
using Amazon Web Services KMS (SSE-KMS). Setting this header to true
causes Amazon S3 to use
an S3 Bucket Key for object encryption with SSE-KMS.
Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.
public Boolean getBucketKeyEnabled()
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using
Amazon Web Services KMS (SSE-KMS). Setting this header to true
causes Amazon S3 to use an S3 Bucket
Key for object encryption with SSE-KMS.
Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.
true
causes Amazon S3 to use
an S3 Bucket Key for object encryption with SSE-KMS.
Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.
public S3CopyObjectOperation withBucketKeyEnabled(Boolean bucketKeyEnabled)
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using
Amazon Web Services KMS (SSE-KMS). Setting this header to true
causes Amazon S3 to use an S3 Bucket
Key for object encryption with SSE-KMS.
Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.
bucketKeyEnabled
- Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption
using Amazon Web Services KMS (SSE-KMS). Setting this header to true
causes Amazon S3 to use
an S3 Bucket Key for object encryption with SSE-KMS.
Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.
public Boolean isBucketKeyEnabled()
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using
Amazon Web Services KMS (SSE-KMS). Setting this header to true
causes Amazon S3 to use an S3 Bucket
Key for object encryption with SSE-KMS.
Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.
true
causes Amazon S3 to use
an S3 Bucket Key for object encryption with SSE-KMS.
Specifying this header with an object action doesn’t affect bucket-level settings for S3 Bucket Key.
public String toString()
toString
in class Object
Object.toString()
public S3CopyObjectOperation clone()