Class S3CopyObjectOperation
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using Amazon Web Services KMS (SSE-KMS).builder()
final String
final S3ChecksumAlgorithm
Indicates the algorithm that you want Amazon S3 to use to create the checksum.final String
Indicates the algorithm that you want Amazon S3 to use to create the checksum.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the AccessControlGrants property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the NewObjectTagging property.final S3MetadataDirective
final String
final Instant
final S3ObjectMetadata
If you don't provide this parameter, Amazon S3 copies all the metadata from the original objects.Specifies a list of tags to add to the destination objects after they are copied.The legal hold status to be applied to all objects in the Batch Operations job.final String
The legal hold status to be applied to all objects in the Batch Operations job.final S3ObjectLockMode
The retention mode to be applied to all objects in the Batch Operations job.final String
The retention mode to be applied to all objects in the Batch Operations job.final Instant
The date when the applied object retention configuration expires on all objects in the Batch Operations job.final String
If the destination bucket is configured as a website, specifies an optional metadata property for website redirects,x-amz-website-redirect-location
.final Boolean
static Class
<? extends S3CopyObjectOperation.Builder> final String
final S3StorageClass
Specify the storage class for the destination objects in aCopy
operation.final String
Specify the storage class for the destination objects in aCopy
operation.final String
Specifies the folder prefix that you want the objects to be copied into.final String
Specifies the destination bucket Amazon Resource Name (ARN) for the batch copy operation.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Instant
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
targetResource
Specifies the destination bucket Amazon Resource Name (ARN) for the batch copy operation.
-
General purpose buckets - For example, to copy objects to a general purpose bucket named
destinationBucket
, set theTargetResource
property toarn:aws:s3:::destinationBucket
. -
Directory buckets - For example, to copy objects to a directory bucket named
destinationBucket
in the Availability Zone; identified by the AZ IDusw2-az1
, set theTargetResource
property toarn:aws:s3express:region:account_id:/bucket/destination_bucket_base_name--usw2-az1--x-s3
.
- Returns:
- Specifies the destination bucket Amazon Resource Name (ARN) for the batch copy operation.
-
General purpose buckets - For example, to copy objects to a general purpose bucket named
destinationBucket
, set theTargetResource
property toarn:aws:s3:::destinationBucket
. -
Directory buckets - For example, to copy objects to a directory bucket named
destinationBucket
in the Availability Zone; identified by the AZ IDusw2-az1
, set theTargetResource
property toarn:aws:s3express:region:account_id:/bucket/destination_bucket_base_name--usw2-az1--x-s3
.
-
-
-
cannedAccessControlList
This functionality is not supported by directory buckets.
If the service returns an enum value that is not available in the current SDK version,
cannedAccessControlList
will returnS3CannedAccessControlList.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcannedAccessControlListAsString()
.- Returns:
This functionality is not supported by directory buckets.
- See Also:
-
cannedAccessControlListAsString
This functionality is not supported by directory buckets.
If the service returns an enum value that is not available in the current SDK version,
cannedAccessControlList
will returnS3CannedAccessControlList.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcannedAccessControlListAsString()
.- Returns:
This functionality is not supported by directory buckets.
- See Also:
-
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 theisEmpty()
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
This functionality is not supported by directory buckets.
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:
This functionality is not supported by directory buckets.
-
metadataDirective
If the service returns an enum value that is not available in the current SDK version,
metadataDirective
will returnS3MetadataDirective.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommetadataDirectiveAsString()
.- Returns:
- See Also:
-
metadataDirectiveAsString
If the service returns an enum value that is not available in the current SDK version,
metadataDirective
will returnS3MetadataDirective.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommetadataDirectiveAsString()
.- Returns:
- See Also:
-
modifiedSinceConstraint
- Returns:
-
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 theisEmpty()
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
Specifies a list of tags to add to the destination objects after they are copied. If
NewObjectTagging
is not specified, the tags of the source objects are copied to destination objects by default.Directory buckets - Tags aren't supported by directory buckets. If your source objects have tags and your destination bucket is a directory bucket, specify an empty tag set in the
NewObjectTagging
field to prevent copying the source object tags to the directory bucket.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:
- Specifies a list of tags to add to the destination objects after they are copied. If
NewObjectTagging
is not specified, the tags of the source objects are copied to destination objects by default.Directory buckets - Tags aren't supported by directory buckets. If your source objects have tags and your destination bucket is a directory bucket, specify an empty tag set in the
NewObjectTagging
field to prevent copying the source object tags to the directory bucket.
-
redirectLocation
If the destination bucket is configured as a website, specifies an optional metadata property for website redirects,
x-amz-website-redirect-location
. Allows webpage redirects if the object copy is accessed through a website endpoint.This functionality is not supported by directory buckets.
- Returns:
- If the destination bucket is configured as a website, specifies an optional metadata property for website
redirects,
x-amz-website-redirect-location
. Allows webpage redirects if the object copy is accessed through a website endpoint.This functionality is not supported by directory buckets.
-
requesterPays
This functionality is not supported by directory buckets.
- Returns:
This functionality is not supported by directory buckets.
-
storageClass
Specify the storage class for the destination objects in a
Copy
operation.Directory buckets - This functionality is not supported by directory buckets.
If the service returns an enum value that is not available in the current SDK version,
storageClass
will returnS3StorageClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageClassAsString()
.- Returns:
- Specify the storage class for the destination objects in a
Copy
operation.Directory buckets - This functionality is not supported by directory buckets.
- See Also:
-
storageClassAsString
Specify the storage class for the destination objects in a
Copy
operation.Directory buckets - This functionality is not supported by directory buckets.
If the service returns an enum value that is not available in the current SDK version,
storageClass
will returnS3StorageClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstorageClassAsString()
.- Returns:
- Specify the storage class for the destination objects in a
Copy
operation.Directory buckets - This functionality is not supported by directory buckets.
- See Also:
-
unModifiedSinceConstraint
- Returns:
-
sseAwsKmsKeyId
This functionality is not supported by directory buckets.
- Returns:
This functionality is not supported by directory buckets.
-
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 theTargetKeyPrefix
property toFolder1
.- 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 theTargetKeyPrefix
property toFolder1
.
-
objectLockLegalHoldStatus
The legal hold status to be applied to all objects in the Batch Operations job.
This functionality is not supported by directory buckets.
If the service returns an enum value that is not available in the current SDK version,
objectLockLegalHoldStatus
will returnS3ObjectLockLegalHoldStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromobjectLockLegalHoldStatusAsString()
.- Returns:
- The legal hold status to be applied to all objects in the Batch Operations job.
This functionality is not supported by directory buckets.
- See Also:
-
objectLockLegalHoldStatusAsString
The legal hold status to be applied to all objects in the Batch Operations job.
This functionality is not supported by directory buckets.
If the service returns an enum value that is not available in the current SDK version,
objectLockLegalHoldStatus
will returnS3ObjectLockLegalHoldStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromobjectLockLegalHoldStatusAsString()
.- Returns:
- The legal hold status to be applied to all objects in the Batch Operations job.
This functionality is not supported by directory buckets.
- See Also:
-
objectLockMode
The retention mode to be applied to all objects in the Batch Operations job.
This functionality is not supported by directory buckets.
If the service returns an enum value that is not available in the current SDK version,
objectLockMode
will returnS3ObjectLockMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromobjectLockModeAsString()
.- Returns:
- The retention mode to be applied to all objects in the Batch Operations job.
This functionality is not supported by directory buckets.
- See Also:
-
objectLockModeAsString
The retention mode to be applied to all objects in the Batch Operations job.
This functionality is not supported by directory buckets.
If the service returns an enum value that is not available in the current SDK version,
objectLockMode
will returnS3ObjectLockMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromobjectLockModeAsString()
.- Returns:
- The retention mode to be applied to all objects in the Batch Operations job.
This functionality is not supported by directory buckets.
- See Also:
-
objectLockRetainUntilDate
The date when the applied object retention configuration expires on all objects in the Batch Operations job.
This functionality is not supported by directory buckets.
- Returns:
- The date when the applied object retention configuration expires on all objects in the Batch Operations
job.
This functionality is not supported by directory buckets.
-
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.
This functionality is not supported by directory buckets.
- 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.
This functionality is not supported by directory buckets.
-
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 returnS3ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchecksumAlgorithmAsString()
.- 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:
-
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 returnS3ChecksumAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchecksumAlgorithmAsString()
.- 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:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<S3CopyObjectOperation.Builder,
S3CopyObjectOperation> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-