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. Amazon S3 batch operations passes each value through 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()`
`String`	`getCannedAccessControlList()`
`String`	`getMetadataDirective()`
`Date`	`getModifiedSinceConstraint()`
`S3ObjectMetadata`	`getNewObjectMetadata()`
`List<S3Tag>`	`getNewObjectTagging()`
`String`	`getObjectLockLegalHoldStatus()`
`String`	`getObjectLockMode()`
`Date`	`getObjectLockRetainUntilDate()`
`String`	`getRedirectLocation()`
`Boolean`	`getRequesterPays()`
`String`	`getSSEAwsKmsKeyId()`
`String`	`getStorageClass()`
`String`	`getTargetKeyPrefix()`
`String`	`getTargetResource()`
`Date`	`getUnModifiedSinceConstraint()`
`int`	`hashCode()`
`Boolean`	`isRequesterPays()`
`void`	`setAccessControlGrants(Collection<S3Grant> accessControlGrants)`
`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)`
`void`	`setObjectLockMode(String objectLockMode)`
`void`	`setObjectLockRetainUntilDate(Date objectLockRetainUntilDate)`
`void`	`setRedirectLocation(String redirectLocation)`
`void`	`setRequesterPays(Boolean requesterPays)`
`void`	`setSSEAwsKmsKeyId(String sSEAwsKmsKeyId)`
`void`	`setStorageClass(String storageClass)`
`void`	`setTargetKeyPrefix(String targetKeyPrefix)`
`void`	`setTargetResource(String targetResource)`
`void`	`setUnModifiedSinceConstraint(Date unModifiedSinceConstraint)`
`String`	`toString()` Returns a string representation of this object.
`S3CopyObjectOperation`	`withAccessControlGrants(Collection<S3Grant> accessControlGrants)`
`S3CopyObjectOperation`	`withAccessControlGrants(S3Grant... accessControlGrants)`
`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)`
`S3CopyObjectOperation`	`withObjectLockLegalHoldStatus(String objectLockLegalHoldStatus)`
`S3CopyObjectOperation`	`withObjectLockMode(S3ObjectLockMode objectLockMode)`
`S3CopyObjectOperation`	`withObjectLockMode(String objectLockMode)`
`S3CopyObjectOperation`	`withObjectLockRetainUntilDate(Date objectLockRetainUntilDate)`
`S3CopyObjectOperation`	`withRedirectLocation(String redirectLocation)`
`S3CopyObjectOperation`	`withRequesterPays(Boolean requesterPays)`
`S3CopyObjectOperation`	`withSSEAwsKmsKeyId(String sSEAwsKmsKeyId)`
`S3CopyObjectOperation`	`withStorageClass(S3StorageClass storageClass)`
`S3CopyObjectOperation`	`withStorageClass(String storageClass)`
`S3CopyObjectOperation`	`withTargetKeyPrefix(String targetKeyPrefix)`
`S3CopyObjectOperation`	`withTargetResource(String targetResource)`
`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)
```
    Parameters:
    
    targetResource -
  - getTargetResource
```
public String getTargetResource()
```
    Returns:
  - withTargetResource
```
public S3CopyObjectOperation withTargetResource(String targetResource)
```
    Parameters:
    
    targetResource -
    
    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)
```
    Parameters:
    
    newObjectMetadata -
  - getNewObjectMetadata
```
public S3ObjectMetadata getNewObjectMetadata()
```
    Returns:
  - withNewObjectMetadata
```
public S3CopyObjectOperation withNewObjectMetadata(S3ObjectMetadata newObjectMetadata)
```
    Parameters:
    
    newObjectMetadata -
    
    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)
```
    Parameters:
    
    redirectLocation -
  - getRedirectLocation
```
public String getRedirectLocation()
```
    Returns:
  - withRedirectLocation
```
public S3CopyObjectOperation withRedirectLocation(String redirectLocation)
```
    Parameters:
    
    redirectLocation -
    
    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)
```
    Parameters:
    
    targetKeyPrefix -
  - getTargetKeyPrefix
```
public String getTargetKeyPrefix()
```
    Returns:
  - withTargetKeyPrefix
```
public S3CopyObjectOperation withTargetKeyPrefix(String targetKeyPrefix)
```
    Parameters:
    
    targetKeyPrefix -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setObjectLockLegalHoldStatus
```
public void setObjectLockLegalHoldStatus(String objectLockLegalHoldStatus)
```
    Parameters:
    
    objectLockLegalHoldStatus -
    
    See Also:
    
    S3ObjectLockLegalHoldStatus
  - getObjectLockLegalHoldStatus
```
public String getObjectLockLegalHoldStatus()
```
    Returns:
    
    See Also:
    
    S3ObjectLockLegalHoldStatus
  - withObjectLockLegalHoldStatus
```
public S3CopyObjectOperation withObjectLockLegalHoldStatus(String objectLockLegalHoldStatus)
```
    Parameters:
    
    objectLockLegalHoldStatus -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    S3ObjectLockLegalHoldStatus
  - withObjectLockLegalHoldStatus
```
public S3CopyObjectOperation withObjectLockLegalHoldStatus(S3ObjectLockLegalHoldStatus objectLockLegalHoldStatus)
```
    Parameters:
    
    objectLockLegalHoldStatus -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    S3ObjectLockLegalHoldStatus
  - setObjectLockMode
```
public void setObjectLockMode(String objectLockMode)
```
    Parameters:
    
    objectLockMode -
    
    See Also:
    
    S3ObjectLockMode
  - getObjectLockMode
```
public String getObjectLockMode()
```
    Returns:
    
    See Also:
    
    S3ObjectLockMode
  - withObjectLockMode
```
public S3CopyObjectOperation withObjectLockMode(String objectLockMode)
```
    Parameters:
    
    objectLockMode -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    S3ObjectLockMode
  - withObjectLockMode
```
public S3CopyObjectOperation withObjectLockMode(S3ObjectLockMode objectLockMode)
```
    Parameters:
    
    objectLockMode -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    S3ObjectLockMode
  - setObjectLockRetainUntilDate
```
public void setObjectLockRetainUntilDate(Date objectLockRetainUntilDate)
```
    Parameters:
    
    objectLockRetainUntilDate -
  - getObjectLockRetainUntilDate
```
public Date getObjectLockRetainUntilDate()
```
    Returns:
  - withObjectLockRetainUntilDate
```
public S3CopyObjectOperation withObjectLockRetainUntilDate(Date objectLockRetainUntilDate)
```
    Parameters:
    
    objectLockRetainUntilDate -
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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

toString

equals

hashCode

clone