S3CopyObjectOperation (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.s3control.model.S3CopyObjectOperation

All Implemented Interfaces:

Serializable, Cloneable
```
@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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

S3CopyObjectOperation()

Constructors
Constructor and Description
`S3CopyObjectOperation()`

Method Summary

All Methods Instance Methods Concrete Methods
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`	`getChecksumAlgorithm()` Indicates the algorithm you want Amazon S3 to use to create the checksum.
`String`	`getMetadataDirective()`
`Date`	`getModifiedSinceConstraint()`
`S3ObjectMetadata`	`getNewObjectMetadata()` If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects.
`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`	`setChecksumAlgorithm(String checksumAlgorithm)` Indicates the algorithm you want Amazon S3 to use to create the checksum.
`void`	`setMetadataDirective(String metadataDirective)`
`void`	`setModifiedSinceConstraint(Date modifiedSinceConstraint)`
`void`	`setNewObjectMetadata(S3ObjectMetadata newObjectMetadata)` If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects.
`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`	`withChecksumAlgorithm(S3ChecksumAlgorithm checksumAlgorithm)` Indicates the algorithm you want Amazon S3 to use to create the checksum.
`S3CopyObjectOperation`	`withChecksumAlgorithm(String checksumAlgorithm)` Indicates the algorithm you want Amazon S3 to use to create the checksum.
`S3CopyObjectOperation`	`withMetadataDirective(S3MetadataDirective metadataDirective)`
`S3CopyObjectOperation`	`withMetadataDirective(String metadataDirective)`
`S3CopyObjectOperation`	`withModifiedSinceConstraint(Date modifiedSinceConstraint)`
`S3CopyObjectOperation`	`withNewObjectMetadata(S3ObjectMetadata newObjectMetadata)` If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects.
`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)`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - S3CopyObjectOperation
```
public S3CopyObjectOperation()
```
- Method Detail
  - setTargetResource
```
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".
    
    Parameters:
    
    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".
  - getTargetResource
```
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".
    
    Returns:
    
    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".
  - withTargetResource
```
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".
    
    Parameters:
    
    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".
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCannedAccessControlList
```
public void setCannedAccessControlList(String cannedAccessControlList)
```
    Parameters:
    
    cannedAccessControlList -
    
    See Also:
    
    S3CannedAccessControlList
  - getCannedAccessControlList
```
public String getCannedAccessControlList()
```
    Returns:
    
    See Also:
    
    S3CannedAccessControlList
  - withCannedAccessControlList
```
public S3CopyObjectOperation withCannedAccessControlList(String cannedAccessControlList)
```
    Parameters:
    
    cannedAccessControlList -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    S3CannedAccessControlList
  - withCannedAccessControlList
```
public S3CopyObjectOperation withCannedAccessControlList(S3CannedAccessControlList cannedAccessControlList)
```
    Parameters:
    
    cannedAccessControlList -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    S3CannedAccessControlList
  - getAccessControlGrants
```
public List<S3Grant> getAccessControlGrants()
```
    Returns:
  - setAccessControlGrants
```
public void setAccessControlGrants(Collection<S3Grant> accessControlGrants)
```
    Parameters:
    
    accessControlGrants -
  - withAccessControlGrants
```
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.
    
    Parameters:
    
    accessControlGrants -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAccessControlGrants
```
public S3CopyObjectOperation withAccessControlGrants(Collection<S3Grant> accessControlGrants)
```
    Parameters:
    
    accessControlGrants -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetadataDirective
```
public void setMetadataDirective(String metadataDirective)
```
    Parameters:
    
    metadataDirective -
    
    See Also:
    
    S3MetadataDirective
  - getMetadataDirective
```
public String getMetadataDirective()
```
    Returns:
    
    See Also:
    
    S3MetadataDirective
  - withMetadataDirective
```
public S3CopyObjectOperation withMetadataDirective(String metadataDirective)
```
    Parameters:
    
    metadataDirective -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    S3MetadataDirective
  - withMetadataDirective
```
public S3CopyObjectOperation withMetadataDirective(S3MetadataDirective metadataDirective)
```
    Parameters:
    
    metadataDirective -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    S3MetadataDirective
  - setModifiedSinceConstraint
```
public void setModifiedSinceConstraint(Date modifiedSinceConstraint)
```
    Parameters:
    
    modifiedSinceConstraint -
  - getModifiedSinceConstraint
```
public Date getModifiedSinceConstraint()
```
    Returns:
  - withModifiedSinceConstraint
```
public S3CopyObjectOperation withModifiedSinceConstraint(Date modifiedSinceConstraint)
```
    Parameters:
    
    modifiedSinceConstraint -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNewObjectMetadata
```
public void setNewObjectMetadata(S3ObjectMetadata newObjectMetadata)
```
    If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects. If you specify an empty set, the new objects will have no tags. Otherwise, Amazon S3 assigns the supplied tags to the new objects.
    
    Parameters:
    
    newObjectMetadata - If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects. If you specify an empty set, the new objects will have no tags. Otherwise, Amazon S3 assigns the supplied tags to the new objects.
  - getNewObjectMetadata
```
public S3ObjectMetadata getNewObjectMetadata()
```
    If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects. If you specify an empty set, the new objects will have no tags. Otherwise, Amazon S3 assigns the supplied tags to the new objects.
    
    Returns:
    
    If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects. If you specify an empty set, the new objects will have no tags. Otherwise, Amazon S3 assigns the supplied tags to the new objects.
  - withNewObjectMetadata
```
public S3CopyObjectOperation withNewObjectMetadata(S3ObjectMetadata newObjectMetadata)
```
    If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects. If you specify an empty set, the new objects will have no tags. Otherwise, Amazon S3 assigns the supplied tags to the new objects.
    
    Parameters:
    
    newObjectMetadata - If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects. If you specify an empty set, the new objects will have no tags. Otherwise, Amazon S3 assigns the supplied tags to the new objects.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getNewObjectTagging
```
public List<S3Tag> getNewObjectTagging()
```
    Returns:
  - setNewObjectTagging
```
public void setNewObjectTagging(Collection<S3Tag> newObjectTagging)
```
    Parameters:
    
    newObjectTagging -
  - withNewObjectTagging
```
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.
    
    Parameters:
    
    newObjectTagging -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withNewObjectTagging
```
public S3CopyObjectOperation withNewObjectTagging(Collection<S3Tag> newObjectTagging)
```
    Parameters:
    
    newObjectTagging -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRedirectLocation
```
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.
    
    Parameters:
    
    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.
  - getRedirectLocation
```
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.
    
    Returns:
    
    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.
  - withRedirectLocation
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRequesterPays
```
public void setRequesterPays(Boolean requesterPays)
```
    Parameters:
    
    requesterPays -
  - getRequesterPays
```
public Boolean getRequesterPays()
```
    Returns:
  - withRequesterPays
```
public S3CopyObjectOperation withRequesterPays(Boolean requesterPays)
```
    Parameters:
    
    requesterPays -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isRequesterPays
```
public Boolean isRequesterPays()
```
    Returns:
  - setStorageClass
```
public void setStorageClass(String storageClass)
```
    Parameters:
    
    storageClass -
    
    See Also:
    
    S3StorageClass
  - getStorageClass
```
public String getStorageClass()
```
    Returns:
    
    See Also:
    
    S3StorageClass
  - withStorageClass
```
public S3CopyObjectOperation withStorageClass(String storageClass)
```
    Parameters:
    
    storageClass -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    S3StorageClass
  - withStorageClass
```
public S3CopyObjectOperation withStorageClass(S3StorageClass storageClass)
```
    Parameters:
    
    storageClass -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    S3StorageClass
  - setUnModifiedSinceConstraint
```
public void setUnModifiedSinceConstraint(Date unModifiedSinceConstraint)
```
    Parameters:
    
    unModifiedSinceConstraint -
  - getUnModifiedSinceConstraint
```
public Date getUnModifiedSinceConstraint()
```
    Returns:
  - withUnModifiedSinceConstraint
```
public S3CopyObjectOperation withUnModifiedSinceConstraint(Date unModifiedSinceConstraint)
```
    Parameters:
    
    unModifiedSinceConstraint -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSSEAwsKmsKeyId
```
public void setSSEAwsKmsKeyId(String sSEAwsKmsKeyId)
```
    Parameters:
    
    sSEAwsKmsKeyId -
  - getSSEAwsKmsKeyId
```
public String getSSEAwsKmsKeyId()
```
    Returns:
  - withSSEAwsKmsKeyId
```
public S3CopyObjectOperation withSSEAwsKmsKeyId(String sSEAwsKmsKeyId)
```
    Parameters:
    
    sSEAwsKmsKeyId -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTargetKeyPrefix
```
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.
    
    Parameters:
    
    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.
  - getTargetKeyPrefix
```
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.
    
    Returns:
    
    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.
  - withTargetKeyPrefix
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setObjectLockLegalHoldStatus
```
public void setObjectLockLegalHoldStatus(String objectLockLegalHoldStatus)
```
    The legal hold status to be applied to all objects in the Batch Operations job.
    
    Parameters:
    
    objectLockLegalHoldStatus - The legal hold status to be applied to all objects in the Batch Operations job.
    
    See Also:
    
    S3ObjectLockLegalHoldStatus
  - getObjectLockLegalHoldStatus
```
public String getObjectLockLegalHoldStatus()
```
    The legal hold status to be applied to all objects in the Batch Operations job.
    
    Returns:
    
    The legal hold status to be applied to all objects in the Batch Operations job.
    
    See Also:
    
    S3ObjectLockLegalHoldStatus
  - withObjectLockLegalHoldStatus
```
public S3CopyObjectOperation withObjectLockLegalHoldStatus(String objectLockLegalHoldStatus)
```
    The legal hold status to be applied to all objects in the Batch Operations job.
    
    Parameters:
    
    objectLockLegalHoldStatus - The legal hold status to be applied to all objects in the Batch Operations job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    S3ObjectLockLegalHoldStatus
  - withObjectLockLegalHoldStatus
```
public S3CopyObjectOperation withObjectLockLegalHoldStatus(S3ObjectLockLegalHoldStatus objectLockLegalHoldStatus)
```
    The legal hold status to be applied to all objects in the Batch Operations job.
    
    Parameters:
    
    objectLockLegalHoldStatus - The legal hold status to be applied to all objects in the Batch Operations job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    S3ObjectLockLegalHoldStatus
  - setObjectLockMode
```
public void setObjectLockMode(String objectLockMode)
```
    The retention mode to be applied to all objects in the Batch Operations job.
    
    Parameters:
    
    objectLockMode - The retention mode to be applied to all objects in the Batch Operations job.
    
    See Also:
    
    S3ObjectLockMode
  - getObjectLockMode
```
public String getObjectLockMode()
```
    The retention mode to be applied to all objects in the Batch Operations job.
    
    Returns:
    
    The retention mode to be applied to all objects in the Batch Operations job.
    
    See Also:
    
    S3ObjectLockMode
  - withObjectLockMode
```
public S3CopyObjectOperation withObjectLockMode(String objectLockMode)
```
    The retention mode to be applied to all objects in the Batch Operations job.
    
    Parameters:
    
    objectLockMode - The retention mode to be applied to all objects in the Batch Operations job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    S3ObjectLockMode
  - withObjectLockMode
```
public S3CopyObjectOperation withObjectLockMode(S3ObjectLockMode objectLockMode)
```
    The retention mode to be applied to all objects in the Batch Operations job.
    
    Parameters:
    
    objectLockMode - The retention mode to be applied to all objects in the Batch Operations job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    S3ObjectLockMode
  - setObjectLockRetainUntilDate
```
public void setObjectLockRetainUntilDate(Date objectLockRetainUntilDate)
```
    The date when the applied object retention configuration expires on all objects in the Batch Operations job.
    
    Parameters:
    
    objectLockRetainUntilDate - The date when the applied object retention configuration expires on all objects in the Batch Operations job.
  - getObjectLockRetainUntilDate
```
public Date getObjectLockRetainUntilDate()
```
    The date when the applied object retention configuration expires on all objects in the Batch Operations job.
    
    Returns:
    
    The date when the applied object retention configuration expires on all objects in the Batch Operations job.
  - withObjectLockRetainUntilDate
```
public S3CopyObjectOperation withObjectLockRetainUntilDate(Date objectLockRetainUntilDate)
```
    The date when the applied object retention configuration expires on all objects in the Batch Operations job.
    
    Parameters:
    
    objectLockRetainUntilDate - The date when the applied object retention configuration expires on all objects in the Batch Operations job.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBucketKeyEnabled
```
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.
    
    Parameters:
    
    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.
  - getBucketKeyEnabled
```
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.
    
    Returns:
    
    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.
  - withBucketKeyEnabled
```
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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isBucketKeyEnabled
```
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.
    
    Returns:
    
    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.
  - setChecksumAlgorithm
```
public void setChecksumAlgorithm(String checksumAlgorithm)
```
    Indicates the algorithm you want Amazon S3 to use to create the checksum. For more information see Checking object integrity in the Amazon S3 User Guide.
    
    Parameters:
    
    checksumAlgorithm - Indicates the algorithm you want Amazon S3 to use to create the checksum. For more information see Checking object integrity in the Amazon S3 User Guide.
    
    See Also:
    
    S3ChecksumAlgorithm
  - getChecksumAlgorithm
```
public String getChecksumAlgorithm()
```
    Indicates the algorithm you want Amazon S3 to use to create the checksum. For more information see Checking object integrity in the Amazon S3 User Guide.
    
    Returns:
    
    Indicates the algorithm you want Amazon S3 to use to create the checksum. For more information see Checking object integrity in the Amazon S3 User Guide.
    
    See Also:
    
    S3ChecksumAlgorithm
  - withChecksumAlgorithm
```
public S3CopyObjectOperation withChecksumAlgorithm(String checksumAlgorithm)
```
    Indicates the algorithm you want Amazon S3 to use to create the checksum. For more information see Checking object integrity in the Amazon S3 User Guide.
    
    Parameters:
    
    checksumAlgorithm - Indicates the algorithm you want Amazon S3 to use to create the checksum. For more information see Checking object integrity in the Amazon S3 User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    S3ChecksumAlgorithm
  - withChecksumAlgorithm
```
public S3CopyObjectOperation withChecksumAlgorithm(S3ChecksumAlgorithm checksumAlgorithm)
```
    Indicates the algorithm you want Amazon S3 to use to create the checksum. For more information see Checking object integrity in the Amazon S3 User Guide.
    
    Parameters:
    
    checksumAlgorithm - Indicates the algorithm you want Amazon S3 to use to create the checksum. For more information see Checking object integrity in the Amazon S3 User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    S3ChecksumAlgorithm
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public S3CopyObjectOperation clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class S3CopyObjectOperation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

S3CopyObjectOperation

Method Detail

setTargetResource

getTargetResource

withTargetResource

setCannedAccessControlList

getCannedAccessControlList

withCannedAccessControlList

withCannedAccessControlList

getAccessControlGrants

setAccessControlGrants

withAccessControlGrants

withAccessControlGrants

setMetadataDirective

getMetadataDirective

withMetadataDirective

withMetadataDirective

setModifiedSinceConstraint

getModifiedSinceConstraint

withModifiedSinceConstraint

setNewObjectMetadata

getNewObjectMetadata

withNewObjectMetadata

getNewObjectTagging

setNewObjectTagging

withNewObjectTagging

withNewObjectTagging

setRedirectLocation

getRedirectLocation

withRedirectLocation

setRequesterPays

getRequesterPays

withRequesterPays

isRequesterPays

setStorageClass

getStorageClass

withStorageClass

withStorageClass

setUnModifiedSinceConstraint

getUnModifiedSinceConstraint

withUnModifiedSinceConstraint

setSSEAwsKmsKeyId

getSSEAwsKmsKeyId

withSSEAwsKmsKeyId

setTargetKeyPrefix

getTargetKeyPrefix

withTargetKeyPrefix

setObjectLockLegalHoldStatus

getObjectLockLegalHoldStatus

withObjectLockLegalHoldStatus

withObjectLockLegalHoldStatus

setObjectLockMode

getObjectLockMode

withObjectLockMode

withObjectLockMode

setObjectLockRetainUntilDate

getObjectLockRetainUntilDate

withObjectLockRetainUntilDate

setBucketKeyEnabled

getBucketKeyEnabled

withBucketKeyEnabled

isBucketKeyEnabled

setChecksumAlgorithm

getChecksumAlgorithm

withChecksumAlgorithm

withChecksumAlgorithm

toString

equals

hashCode

clone