@Generated(value="software.amazon.awssdk:codegen") public final class CopyObjectRequest extends S3Request implements ToCopyableBuilder<CopyObjectRequest.Builder,CopyObjectRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
CopyObjectRequest.Builder |
Modifier and Type | Method and Description |
---|---|
ObjectCannedACL |
acl()
The canned ACL to apply to the object.
|
String |
aclAsString()
The canned ACL to apply to the object.
|
String |
bucket()
Deprecated.
|
static CopyObjectRequest.Builder |
builder() |
String |
cacheControl()
Specifies caching behavior along the request/reply chain.
|
String |
contentDisposition()
Specifies presentational information for the object.
|
String |
contentEncoding()
Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be
applied to obtain the media-type referenced by the Content-Type header field.
|
String |
contentLanguage()
The language the content is in.
|
String |
contentType()
A standard MIME type describing the format of the object data.
|
String |
copySource()
The name of the source bucket and key name of the source object, separated by a slash (/).
|
String |
copySourceIfMatch()
Copies the object if its entity tag (ETag) matches the specified tag.
|
Instant |
copySourceIfModifiedSince()
Copies the object if it has been modified since the specified time.
|
String |
copySourceIfNoneMatch()
Copies the object if its entity tag (ETag) is different than the specified ETag.
|
Instant |
copySourceIfUnmodifiedSince()
Copies the object if it hasn't been modified since the specified time.
|
String |
copySourceSSECustomerAlgorithm()
Specifies the algorithm to use when decrypting the source object (for example, AES256).
|
String |
copySourceSSECustomerKey()
Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object.
|
String |
copySourceSSECustomerKeyMD5()
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
|
String |
destinationBucket()
The name of the destination bucket.
|
String |
destinationKey()
The key of the destination object.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
Instant |
expires()
The date and time at which the object is no longer cacheable.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
String |
grantFullControl()
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
|
String |
grantRead()
Allows grantee to read the object data and its metadata.
|
String |
grantReadACP()
Allows grantee to read the object ACL.
|
String |
grantWriteACP()
Allows grantee to write the ACL for the applicable object.
|
int |
hashCode() |
boolean |
hasMetadata()
Returns true if the Metadata property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
String |
key()
Deprecated.
Use
destinationKey() |
Map<String,String> |
metadata()
A map of metadata to store with the object in S3.
|
MetadataDirective |
metadataDirective()
Specifies whether the metadata is copied from the source object or replaced with metadata provided in the
request.
|
String |
metadataDirectiveAsString()
Specifies whether the metadata is copied from the source object or replaced with metadata provided in the
request.
|
ObjectLockLegalHoldStatus |
objectLockLegalHoldStatus()
Specifies whether you want to apply a Legal Hold to the copied object.
|
String |
objectLockLegalHoldStatusAsString()
Specifies whether you want to apply a Legal Hold to the copied object.
|
ObjectLockMode |
objectLockMode()
The Object Lock mode that you want to apply to the copied object.
|
String |
objectLockModeAsString()
The Object Lock mode that you want to apply to the copied object.
|
Instant |
objectLockRetainUntilDate()
The date and time when you want the copied object's Object Lock to expire.
|
RequestPayer |
requestPayer()
Returns the value of the RequestPayer property for this object.
|
String |
requestPayerAsString()
Returns the value of the RequestPayer property for this object.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CopyObjectRequest.Builder> |
serializableBuilderClass() |
ServerSideEncryption |
serverSideEncryption()
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
|
String |
serverSideEncryptionAsString()
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
|
String |
sseCustomerAlgorithm()
Specifies the algorithm to use to when encrypting the object (for example, AES256).
|
String |
sseCustomerKey()
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.
|
String |
sseCustomerKeyMD5()
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
|
String |
ssekmsEncryptionContext()
Specifies the AWS KMS Encryption Context to use for object encryption.
|
String |
ssekmsKeyId()
Specifies the AWS KMS key ID to use for object encryption.
|
StorageClass |
storageClass()
The type of storage to use for the object.
|
String |
storageClassAsString()
The type of storage to use for the object.
|
String |
tagging()
The tag-set for the object destination object this value must be used in conjunction with the
TaggingDirective . |
TaggingDirective |
taggingDirective()
Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the
request.
|
String |
taggingDirectiveAsString()
Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the
request.
|
CopyObjectRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
websiteRedirectLocation()
If the bucket is configured as a website, redirects requests for this object to another object in the same bucket
or to an external URL.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public ObjectCannedACL acl()
The canned ACL to apply to the object.
If the service returns an enum value that is not available in the current SDK version, acl
will return
ObjectCannedACL.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
aclAsString()
.
ObjectCannedACL
public String aclAsString()
The canned ACL to apply to the object.
If the service returns an enum value that is not available in the current SDK version, acl
will return
ObjectCannedACL.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
aclAsString()
.
ObjectCannedACL
public String cacheControl()
Specifies caching behavior along the request/reply chain.
public String contentDisposition()
Specifies presentational information for the object.
public String contentEncoding()
Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
public String contentLanguage()
The language the content is in.
public String contentType()
A standard MIME type describing the format of the object data.
public String copySource()
The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.
public String copySourceIfMatch()
Copies the object if its entity tag (ETag) matches the specified tag.
public Instant copySourceIfModifiedSince()
Copies the object if it has been modified since the specified time.
public String copySourceIfNoneMatch()
Copies the object if its entity tag (ETag) is different than the specified ETag.
public Instant copySourceIfUnmodifiedSince()
Copies the object if it hasn't been modified since the specified time.
public Instant expires()
The date and time at which the object is no longer cacheable.
public String grantFullControl()
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
public String grantRead()
Allows grantee to read the object data and its metadata.
public String grantReadACP()
Allows grantee to read the object ACL.
public String grantWriteACP()
Allows grantee to write the ACL for the applicable object.
public boolean hasMetadata()
public Map<String,String> metadata()
A map of metadata to store with the object in S3.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
You can use hasMetadata()
to see if a value was sent in this field.
public MetadataDirective metadataDirective()
Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
If the service returns an enum value that is not available in the current SDK version, metadataDirective
will return MetadataDirective.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from metadataDirectiveAsString()
.
MetadataDirective
public String metadataDirectiveAsString()
Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
If the service returns an enum value that is not available in the current SDK version, metadataDirective
will return MetadataDirective.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from metadataDirectiveAsString()
.
MetadataDirective
public TaggingDirective taggingDirective()
Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.
If the service returns an enum value that is not available in the current SDK version, taggingDirective
will return TaggingDirective.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from taggingDirectiveAsString()
.
TaggingDirective
public String taggingDirectiveAsString()
Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.
If the service returns an enum value that is not available in the current SDK version, taggingDirective
will return TaggingDirective.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from taggingDirectiveAsString()
.
TaggingDirective
public ServerSideEncryption serverSideEncryption()
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
If the service returns an enum value that is not available in the current SDK version,
serverSideEncryption
will return ServerSideEncryption.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from serverSideEncryptionAsString()
.
ServerSideEncryption
public String serverSideEncryptionAsString()
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
If the service returns an enum value that is not available in the current SDK version,
serverSideEncryption
will return ServerSideEncryption.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from serverSideEncryptionAsString()
.
ServerSideEncryption
public StorageClass storageClass()
The type of storage to use for the object. Defaults to 'STANDARD'.
If the service returns an enum value that is not available in the current SDK version, storageClass
will
return StorageClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
storageClassAsString()
.
StorageClass
public String storageClassAsString()
The type of storage to use for the object. Defaults to 'STANDARD'.
If the service returns an enum value that is not available in the current SDK version, storageClass
will
return StorageClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
storageClassAsString()
.
StorageClass
public String websiteRedirectLocation()
If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
public String sseCustomerAlgorithm()
Specifies the algorithm to use to when encrypting the object (for example, AES256).
public String sseCustomerKey()
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to
store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be
appropriate for use with the algorithm specified in the
x-amz-server-side-encryption-customer-algorithm
header.
x-amz-server-side-encryption-customer-algorithm
header.public String sseCustomerKeyMD5()
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
public String ssekmsKeyId()
Specifies the AWS KMS key ID to use for object encryption. All GET and PUT requests for an object protected by AWS KMS will fail if not made via SSL or using SigV4. For information about configuring using any of the officially supported AWS SDKs and AWS CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 Developer Guide.
public String ssekmsEncryptionContext()
Specifies the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
public String copySourceSSECustomerAlgorithm()
Specifies the algorithm to use when decrypting the source object (for example, AES256).
public String copySourceSSECustomerKey()
Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object. The encryption key provided in this header must be one that was used when the source object was created.
public String copySourceSSECustomerKeyMD5()
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
public RequestPayer requestPayer()
If the service returns an enum value that is not available in the current SDK version, requestPayer
will
return RequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
requestPayerAsString()
.
RequestPayer
public String requestPayerAsString()
If the service returns an enum value that is not available in the current SDK version, requestPayer
will
return RequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
requestPayerAsString()
.
RequestPayer
public String tagging()
The tag-set for the object destination object this value must be used in conjunction with the
TaggingDirective
. The tag-set must be encoded as URL Query parameters.
TaggingDirective
. The tag-set must be encoded as URL Query parameters.public ObjectLockMode objectLockMode()
The Object Lock mode that you want to apply to the copied object.
If the service returns an enum value that is not available in the current SDK version, objectLockMode
will return ObjectLockMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from objectLockModeAsString()
.
ObjectLockMode
public String objectLockModeAsString()
The Object Lock mode that you want to apply to the copied object.
If the service returns an enum value that is not available in the current SDK version, objectLockMode
will return ObjectLockMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from objectLockModeAsString()
.
ObjectLockMode
public Instant objectLockRetainUntilDate()
The date and time when you want the copied object's Object Lock to expire.
public ObjectLockLegalHoldStatus objectLockLegalHoldStatus()
Specifies whether you want to apply a Legal Hold to the copied object.
If the service returns an enum value that is not available in the current SDK version,
objectLockLegalHoldStatus
will return ObjectLockLegalHoldStatus.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from objectLockLegalHoldStatusAsString()
.
ObjectLockLegalHoldStatus
public String objectLockLegalHoldStatusAsString()
Specifies whether you want to apply a Legal Hold to the copied object.
If the service returns an enum value that is not available in the current SDK version,
objectLockLegalHoldStatus
will return ObjectLockLegalHoldStatus.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from objectLockLegalHoldStatusAsString()
.
ObjectLockLegalHoldStatus
@Deprecated public String bucket()
destinationBucket()
The name of the destination bucket.
public String destinationBucket()
The name of the destination bucket.
@Deprecated public String key()
destinationKey()
The key of the destination object.
public String destinationKey()
The key of the destination object.
public CopyObjectRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<CopyObjectRequest.Builder,CopyObjectRequest>
toBuilder
in class S3Request
public static CopyObjectRequest.Builder builder()
public static Class<? extends CopyObjectRequest.Builder> serializableBuilderClass()
public int hashCode()
hashCode
in class AwsRequest
public boolean equals(Object obj)
equals
in class AwsRequest
public boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public String toString()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2020. All rights reserved.