java.lang.Object
- software.amazon.awssdk.services.s3control.model.S3CopyObjectOperation

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<S3CopyObjectOperation.Builder,S3CopyObjectOperation>
```
@Generated("software.amazon.awssdk:codegen")
public final class S3CopyObjectOperation
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<S3CopyObjectOperation.Builder,S3CopyObjectOperation>
```
Contains the configuration parameters for a PUT Copy object operation. S3 Batch Operations passes every object to the underlying CopyObject API operation. For more information about the parameters for this operation, see CopyObject.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface S3CopyObjectOperation.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<S3Grant>`	`accessControlGrants()`
`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).
`static S3CopyObjectOperation.Builder`	`builder()`
`S3CannedAccessControlList`	`cannedAccessControlList()`
`String`	`cannedAccessControlListAsString()`
`S3ChecksumAlgorithm`	`checksumAlgorithm()`	Indicates the algorithm that you want Amazon S3 to use to create the checksum.
`String`	`checksumAlgorithmAsString()`	Indicates the algorithm that you want Amazon S3 to use to create the checksum.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAccessControlGrants()`	For responses, this returns true if the service returned a value for the AccessControlGrants property.
`int`	`hashCode()`
`boolean`	`hasNewObjectTagging()`	For responses, this returns true if the service returned a value for the NewObjectTagging property.
`S3MetadataDirective`	`metadataDirective()`
`String`	`metadataDirectiveAsString()`
`Instant`	`modifiedSinceConstraint()`
`S3ObjectMetadata`	`newObjectMetadata()`	If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects.
`List<S3Tag>`	`newObjectTagging()`
`S3ObjectLockLegalHoldStatus`	`objectLockLegalHoldStatus()`	The legal hold status to be applied to all objects in the Batch Operations job.
`String`	`objectLockLegalHoldStatusAsString()`	The legal hold status to be applied to all objects in the Batch Operations job.
`S3ObjectLockMode`	`objectLockMode()`	The retention mode to be applied to all objects in the Batch Operations job.
`String`	`objectLockModeAsString()`	The retention mode to be applied to all objects in the Batch Operations job.
`Instant`	`objectLockRetainUntilDate()`	The date when the applied object retention configuration expires on all objects in the Batch Operations job.
`String`	`redirectLocation()`	Specifies an optional metadata property for website redirects, `x-amz-website-redirect-location`.
`Boolean`	`requesterPays()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends S3CopyObjectOperation.Builder>`	`serializableBuilderClass()`
`String`	`sseAwsKmsKeyId()`
`S3StorageClass`	`storageClass()`
`String`	`storageClassAsString()`
`String`	`targetKeyPrefix()`	Specifies the folder prefix that you want the objects to be copied into.
`String`	`targetResource()`	Specifies the destination bucket Amazon Resource Name (ARN) for the batch copy operation.
`S3CopyObjectOperation.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Instant`	`unModifiedSinceConstraint()`

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - targetResource
```
public final String targetResource()
```
    Specifies the destination bucket Amazon Resource Name (ARN) for the batch copy operation. For example, to copy objects to a bucket named destinationBucket, set the TargetResource property to arn:aws:s3:::destinationBucket.
    
    Returns:
    
    Specifies the destination bucket Amazon Resource Name (ARN) for the batch copy operation. For example, to copy objects to a bucket named destinationBucket, set the TargetResource property to arn:aws:s3:::destinationBucket.
  - cannedAccessControlList
```
public final S3CannedAccessControlList cannedAccessControlList()
```
    If the service returns an enum value that is not available in the current SDK version, cannedAccessControlList will return S3CannedAccessControlList.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cannedAccessControlListAsString().
    
    Returns:
    
    See Also:
    
    S3CannedAccessControlList
  - cannedAccessControlListAsString
```
public final String cannedAccessControlListAsString()
```
    If the service returns an enum value that is not available in the current SDK version, cannedAccessControlList will return S3CannedAccessControlList.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cannedAccessControlListAsString().
    
    Returns:
    
    See Also:
    
    S3CannedAccessControlList
  - hasAccessControlGrants
```
public final boolean hasAccessControlGrants()
```
    For responses, this returns true if the service returned a value for the AccessControlGrants property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - accessControlGrants
```
public final List<S3Grant> accessControlGrants()
```
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAccessControlGrants() method.
    
    Returns:
  - metadataDirective
```
public final S3MetadataDirective metadataDirective()
```
    If the service returns an enum value that is not available in the current SDK version, metadataDirective will return S3MetadataDirective.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metadataDirectiveAsString().
    
    Returns:
    
    See Also:
    
    S3MetadataDirective
  - metadataDirectiveAsString
```
public final String metadataDirectiveAsString()
```
    If the service returns an enum value that is not available in the current SDK version, metadataDirective will return S3MetadataDirective.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metadataDirectiveAsString().
    
    Returns:
    
    See Also:
    
    S3MetadataDirective
  - modifiedSinceConstraint
```
public final Instant modifiedSinceConstraint()
```
    Returns:
  - newObjectMetadata
```
public final 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.
    
    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.
  - hasNewObjectTagging
```
public final boolean hasNewObjectTagging()
```
    For responses, this returns true if the service returned a value for the NewObjectTagging property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - newObjectTagging
```
public final List<S3Tag> newObjectTagging()
```
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasNewObjectTagging() method.
    
    Returns:
  - redirectLocation
```
public final 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.
    
    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.
  - requesterPays
```
public final Boolean requesterPays()
```
    Returns:
  - storageClass
```
public final S3StorageClass storageClass()
```
    If the service returns an enum value that is not available in the current SDK version, storageClass will return S3StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageClassAsString().
    
    Returns:
    
    See Also:
    
    S3StorageClass
  - storageClassAsString
```
public final String storageClassAsString()
```
    If the service returns an enum value that is not available in the current SDK version, storageClass will return S3StorageClass.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from storageClassAsString().
    
    Returns:
    
    See Also:
    
    S3StorageClass
  - unModifiedSinceConstraint
```
public final Instant unModifiedSinceConstraint()
```
    Returns:
  - sseAwsKmsKeyId
```
public final String sseAwsKmsKeyId()
```
    Returns:
  - targetKeyPrefix
```
public final String targetKeyPrefix()
```
    Specifies the folder prefix that you want the objects to be copied into. For example, to copy objects into a folder named Folder1 in the destination bucket, set the TargetKeyPrefix property to Folder1.
    
    Returns:
    
    Specifies the folder prefix that you want the objects to be copied into. For example, to copy objects into a folder named Folder1 in the destination bucket, set the TargetKeyPrefix property to Folder1.
  - objectLockLegalHoldStatus
```
public final S3ObjectLockLegalHoldStatus objectLockLegalHoldStatus()
```
    The legal hold status to be applied to all objects in the Batch Operations job.
    
    If the service returns an enum value that is not available in the current SDK version, objectLockLegalHoldStatus will return S3ObjectLockLegalHoldStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectLockLegalHoldStatusAsString().
    
    Returns:
    
    The legal hold status to be applied to all objects in the Batch Operations job.
    
    See Also:
    
    S3ObjectLockLegalHoldStatus
  - objectLockLegalHoldStatusAsString
```
public final String objectLockLegalHoldStatusAsString()
```
    The legal hold status to be applied to all objects in the Batch Operations job.
    
    If the service returns an enum value that is not available in the current SDK version, objectLockLegalHoldStatus will return S3ObjectLockLegalHoldStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectLockLegalHoldStatusAsString().
    
    Returns:
    
    The legal hold status to be applied to all objects in the Batch Operations job.
    
    See Also:
    
    S3ObjectLockLegalHoldStatus
  - objectLockMode
```
public final S3ObjectLockMode objectLockMode()
```
    The retention mode to be applied to all objects in the Batch Operations job.
    
    If the service returns an enum value that is not available in the current SDK version, objectLockMode will return S3ObjectLockMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectLockModeAsString().
    
    Returns:
    
    The retention mode to be applied to all objects in the Batch Operations job.
    
    See Also:
    
    S3ObjectLockMode
  - objectLockModeAsString
```
public final String objectLockModeAsString()
```
    The retention mode to be applied to all objects in the Batch Operations job.
    
    If the service returns an enum value that is not available in the current SDK version, objectLockMode will return S3ObjectLockMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from objectLockModeAsString().
    
    Returns:
    
    The retention mode to be applied to all objects in the Batch Operations job.
    
    See Also:
    
    S3ObjectLockMode
  - objectLockRetainUntilDate
```
public final Instant objectLockRetainUntilDate()
```
    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.
  - bucketKeyEnabled
```
public final 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.
    
    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.
  - checksumAlgorithm
```
public final S3ChecksumAlgorithm checksumAlgorithm()
```
    Indicates the algorithm that you want Amazon S3 to use to create the checksum. For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm will return S3ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumAlgorithmAsString().
    
    Returns:
    
    Indicates the algorithm that 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
  - checksumAlgorithmAsString
```
public final String checksumAlgorithmAsString()
```
    Indicates the algorithm that you want Amazon S3 to use to create the checksum. For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    If the service returns an enum value that is not available in the current SDK version, checksumAlgorithm will return S3ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumAlgorithmAsString().
    
    Returns:
    
    Indicates the algorithm that 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
  - toBuilder
```
public S3CopyObjectOperation.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<S3CopyObjectOperation.Builder,S3CopyObjectOperation>
  - builder
```
public static S3CopyObjectOperation.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends S3CopyObjectOperation.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class S3CopyObjectOperation

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

targetResource

cannedAccessControlList

cannedAccessControlListAsString

hasAccessControlGrants

accessControlGrants

metadataDirective

metadataDirectiveAsString

modifiedSinceConstraint

newObjectMetadata

hasNewObjectTagging

newObjectTagging

redirectLocation

requesterPays

storageClass

storageClassAsString

unModifiedSinceConstraint

sseAwsKmsKeyId

targetKeyPrefix

objectLockLegalHoldStatus

objectLockLegalHoldStatusAsString

objectLockMode

objectLockModeAsString

objectLockRetainUntilDate

bucketKeyEnabled

checksumAlgorithm

checksumAlgorithmAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields