public static interface CopyObjectRequest.Builder extends S3Request.Builder, SdkPojo, CopyableBuilder<CopyObjectRequest.Builder,CopyObjectRequest>
Modifier and Type | Method and Description |
---|---|
CopyObjectRequest.Builder |
acl(ObjectCannedACL acl)
The canned ACL to apply to the object.
|
CopyObjectRequest.Builder |
acl(String acl)
The canned ACL to apply to the object.
|
CopyObjectRequest.Builder |
bucket(String bucket)
|
CopyObjectRequest.Builder |
cacheControl(String cacheControl)
Specifies caching behavior along the request/reply chain.
|
CopyObjectRequest.Builder |
contentDisposition(String contentDisposition)
Specifies presentational information for the object.
|
CopyObjectRequest.Builder |
contentEncoding(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.
|
CopyObjectRequest.Builder |
contentLanguage(String contentLanguage)
The language the content is in.
|
CopyObjectRequest.Builder |
contentType(String contentType)
A standard MIME type describing the format of the object data.
|
CopyObjectRequest.Builder |
copySource(String copySource)
The name of the source bucket and key name of the source object, separated by a slash (/).
|
CopyObjectRequest.Builder |
copySourceIfMatch(String copySourceIfMatch)
Copies the object if its entity tag (ETag) matches the specified tag.
|
CopyObjectRequest.Builder |
copySourceIfModifiedSince(Instant copySourceIfModifiedSince)
Copies the object if it has been modified since the specified time.
|
CopyObjectRequest.Builder |
copySourceIfNoneMatch(String copySourceIfNoneMatch)
Copies the object if its entity tag (ETag) is different than the specified ETag.
|
CopyObjectRequest.Builder |
copySourceIfUnmodifiedSince(Instant copySourceIfUnmodifiedSince)
Copies the object if it hasn't been modified since the specified time.
|
CopyObjectRequest.Builder |
copySourceSSECustomerAlgorithm(String copySourceSSECustomerAlgorithm)
Specifies the algorithm to use when decrypting the source object (e.g., AES256).
|
CopyObjectRequest.Builder |
copySourceSSECustomerKey(String copySourceSSECustomerKey)
Specifies the customer-provided encryption key for Amazon S3 to use to decrypt the source object.
|
CopyObjectRequest.Builder |
copySourceSSECustomerKeyMD5(String copySourceSSECustomerKeyMD5)
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
|
CopyObjectRequest.Builder |
expires(Instant expires)
The date and time at which the object is no longer cacheable.
|
CopyObjectRequest.Builder |
grantFullControl(String grantFullControl)
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
|
CopyObjectRequest.Builder |
grantRead(String grantRead)
Allows grantee to read the object data and its metadata.
|
CopyObjectRequest.Builder |
grantReadACP(String grantReadACP)
Allows grantee to read the object ACL.
|
CopyObjectRequest.Builder |
grantWriteACP(String grantWriteACP)
Allows grantee to write the ACL for the applicable object.
|
CopyObjectRequest.Builder |
key(String key)
|
CopyObjectRequest.Builder |
metadata(Map<String,String> metadata)
A map of metadata to store with the object in S3.
|
CopyObjectRequest.Builder |
metadataDirective(MetadataDirective metadataDirective)
Specifies whether the metadata is copied from the source object or replaced with metadata provided in the
request.
|
CopyObjectRequest.Builder |
metadataDirective(String metadataDirective)
Specifies whether the metadata is copied from the source object or replaced with metadata provided in the
request.
|
CopyObjectRequest.Builder |
objectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus)
Specifies whether you want to apply a Legal Hold to the copied object.
|
CopyObjectRequest.Builder |
objectLockLegalHoldStatus(String objectLockLegalHoldStatus)
Specifies whether you want to apply a Legal Hold to the copied object.
|
CopyObjectRequest.Builder |
objectLockMode(ObjectLockMode objectLockMode)
The object lock mode that you want to apply to the copied object.
|
CopyObjectRequest.Builder |
objectLockMode(String objectLockMode)
The object lock mode that you want to apply to the copied object.
|
CopyObjectRequest.Builder |
objectLockRetainUntilDate(Instant objectLockRetainUntilDate)
The date and time when you want the copied object's object lock to expire.
|
CopyObjectRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CopyObjectRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CopyObjectRequest.Builder |
requestPayer(RequestPayer requestPayer)
Sets the value of the RequestPayer property for this object.
|
CopyObjectRequest.Builder |
requestPayer(String requestPayer)
Sets the value of the RequestPayer property for this object.
|
CopyObjectRequest.Builder |
serverSideEncryption(ServerSideEncryption serverSideEncryption)
The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
|
CopyObjectRequest.Builder |
serverSideEncryption(String serverSideEncryption)
The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
|
CopyObjectRequest.Builder |
sseCustomerAlgorithm(String sseCustomerAlgorithm)
Specifies the algorithm to use to when encrypting the object (e.g., AES256).
|
CopyObjectRequest.Builder |
sseCustomerKey(String sseCustomerKey)
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.
|
CopyObjectRequest.Builder |
sseCustomerKeyMD5(String sseCustomerKeyMD5)
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
|
CopyObjectRequest.Builder |
ssekmsEncryptionContext(String ssekmsEncryptionContext)
Specifies the AWS KMS Encryption Context to use for object encryption.
|
CopyObjectRequest.Builder |
ssekmsKeyId(String ssekmsKeyId)
Specifies the AWS KMS key ID to use for object encryption.
|
CopyObjectRequest.Builder |
storageClass(StorageClass storageClass)
The type of storage to use for the object.
|
CopyObjectRequest.Builder |
storageClass(String storageClass)
The type of storage to use for the object.
|
CopyObjectRequest.Builder |
tagging(String tagging)
The tag-set for the object destination object this value must be used in conjunction with the
TaggingDirective.
|
CopyObjectRequest.Builder |
tagging(Tagging tagging) |
CopyObjectRequest.Builder |
taggingDirective(String taggingDirective)
Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in
the request.
|
CopyObjectRequest.Builder |
taggingDirective(TaggingDirective taggingDirective)
Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in
the request.
|
CopyObjectRequest.Builder |
websiteRedirectLocation(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.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
CopyObjectRequest.Builder acl(String acl)
The canned ACL to apply to the object.
acl
- The canned ACL to apply to the object.ObjectCannedACL
,
ObjectCannedACL
CopyObjectRequest.Builder acl(ObjectCannedACL acl)
The canned ACL to apply to the object.
acl
- The canned ACL to apply to the object.ObjectCannedACL
,
ObjectCannedACL
CopyObjectRequest.Builder bucket(String bucket)
bucket
- CopyObjectRequest.Builder cacheControl(String cacheControl)
Specifies caching behavior along the request/reply chain.
cacheControl
- Specifies caching behavior along the request/reply chain.CopyObjectRequest.Builder contentDisposition(String contentDisposition)
Specifies presentational information for the object.
contentDisposition
- Specifies presentational information for the object.CopyObjectRequest.Builder contentEncoding(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.
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.CopyObjectRequest.Builder contentLanguage(String contentLanguage)
The language the content is in.
contentLanguage
- The language the content is in.CopyObjectRequest.Builder contentType(String contentType)
A standard MIME type describing the format of the object data.
contentType
- A standard MIME type describing the format of the object data.CopyObjectRequest.Builder copySource(String copySource)
The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.
copySource
- The name of the source bucket and key name of the source object, separated by a slash (/). Must be
URL-encoded.CopyObjectRequest.Builder copySourceIfMatch(String copySourceIfMatch)
Copies the object if its entity tag (ETag) matches the specified tag.
copySourceIfMatch
- Copies the object if its entity tag (ETag) matches the specified tag.CopyObjectRequest.Builder copySourceIfModifiedSince(Instant copySourceIfModifiedSince)
Copies the object if it has been modified since the specified time.
copySourceIfModifiedSince
- Copies the object if it has been modified since the specified time.CopyObjectRequest.Builder copySourceIfNoneMatch(String copySourceIfNoneMatch)
Copies the object if its entity tag (ETag) is different than the specified ETag.
copySourceIfNoneMatch
- Copies the object if its entity tag (ETag) is different than the specified ETag.CopyObjectRequest.Builder copySourceIfUnmodifiedSince(Instant copySourceIfUnmodifiedSince)
Copies the object if it hasn't been modified since the specified time.
copySourceIfUnmodifiedSince
- Copies the object if it hasn't been modified since the specified time.CopyObjectRequest.Builder expires(Instant expires)
The date and time at which the object is no longer cacheable.
expires
- The date and time at which the object is no longer cacheable.CopyObjectRequest.Builder grantFullControl(String grantFullControl)
Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
grantFullControl
- Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.CopyObjectRequest.Builder grantRead(String grantRead)
Allows grantee to read the object data and its metadata.
grantRead
- Allows grantee to read the object data and its metadata.CopyObjectRequest.Builder grantReadACP(String grantReadACP)
Allows grantee to read the object ACL.
grantReadACP
- Allows grantee to read the object ACL.CopyObjectRequest.Builder grantWriteACP(String grantWriteACP)
Allows grantee to write the ACL for the applicable object.
grantWriteACP
- Allows grantee to write the ACL for the applicable object.CopyObjectRequest.Builder key(String key)
key
- CopyObjectRequest.Builder metadata(Map<String,String> metadata)
A map of metadata to store with the object in S3.
metadata
- A map of metadata to store with the object in S3.CopyObjectRequest.Builder metadataDirective(String metadataDirective)
Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
metadataDirective
- Specifies whether the metadata is copied from the source object or replaced with metadata provided in
the request.MetadataDirective
,
MetadataDirective
CopyObjectRequest.Builder metadataDirective(MetadataDirective metadataDirective)
Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
metadataDirective
- Specifies whether the metadata is copied from the source object or replaced with metadata provided in
the request.MetadataDirective
,
MetadataDirective
CopyObjectRequest.Builder taggingDirective(String taggingDirective)
Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.
taggingDirective
- Specifies whether the object tag-set are copied from the source object or replaced with tag-set
provided in the request.TaggingDirective
,
TaggingDirective
CopyObjectRequest.Builder taggingDirective(TaggingDirective taggingDirective)
Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.
taggingDirective
- Specifies whether the object tag-set are copied from the source object or replaced with tag-set
provided in the request.TaggingDirective
,
TaggingDirective
CopyObjectRequest.Builder serverSideEncryption(String serverSideEncryption)
The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
serverSideEncryption
- The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).ServerSideEncryption
,
ServerSideEncryption
CopyObjectRequest.Builder serverSideEncryption(ServerSideEncryption serverSideEncryption)
The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
serverSideEncryption
- The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).ServerSideEncryption
,
ServerSideEncryption
CopyObjectRequest.Builder storageClass(String storageClass)
The type of storage to use for the object. Defaults to 'STANDARD'.
storageClass
- The type of storage to use for the object. Defaults to 'STANDARD'.StorageClass
,
StorageClass
CopyObjectRequest.Builder storageClass(StorageClass storageClass)
The type of storage to use for the object. Defaults to 'STANDARD'.
storageClass
- The type of storage to use for the object. Defaults to 'STANDARD'.StorageClass
,
StorageClass
CopyObjectRequest.Builder websiteRedirectLocation(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.
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.CopyObjectRequest.Builder sseCustomerAlgorithm(String sseCustomerAlgorithm)
Specifies the algorithm to use to when encrypting the object (e.g., AES256).
sseCustomerAlgorithm
- Specifies the algorithm to use to when encrypting the object (e.g., AES256).CopyObjectRequest.Builder sseCustomerKey(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 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.
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 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.CopyObjectRequest.Builder sseCustomerKeyMD5(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 the encryption key was transmitted without error.
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 the encryption key was transmitted without error.CopyObjectRequest.Builder ssekmsKeyId(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. Documentation on configuring any of the officially supported AWS SDKs and CLI can be found at http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-version
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. Documentation on configuring any of
the officially supported AWS SDKs and CLI can be found at
http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingAWSSDK.html#specify-signature-versionCopyObjectRequest.Builder ssekmsEncryptionContext(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.
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.CopyObjectRequest.Builder copySourceSSECustomerAlgorithm(String copySourceSSECustomerAlgorithm)
Specifies the algorithm to use when decrypting the source object (e.g., AES256).
copySourceSSECustomerAlgorithm
- Specifies the algorithm to use when decrypting the source object (e.g., AES256).CopyObjectRequest.Builder copySourceSSECustomerKey(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.
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.CopyObjectRequest.Builder copySourceSSECustomerKeyMD5(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 the encryption key was transmitted without error.
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 the encryption key was transmitted without error.CopyObjectRequest.Builder requestPayer(String requestPayer)
requestPayer
- The new value for the RequestPayer property for this object.RequestPayer
,
RequestPayer
CopyObjectRequest.Builder requestPayer(RequestPayer requestPayer)
requestPayer
- The new value for the RequestPayer property for this object.RequestPayer
,
RequestPayer
CopyObjectRequest.Builder tagging(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
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 parametersCopyObjectRequest.Builder tagging(Tagging tagging)
CopyObjectRequest.Builder objectLockMode(String objectLockMode)
The object lock mode that you want to apply to the copied object.
objectLockMode
- The object lock mode that you want to apply to the copied object.ObjectLockMode
,
ObjectLockMode
CopyObjectRequest.Builder objectLockMode(ObjectLockMode objectLockMode)
The object lock mode that you want to apply to the copied object.
objectLockMode
- The object lock mode that you want to apply to the copied object.ObjectLockMode
,
ObjectLockMode
CopyObjectRequest.Builder objectLockRetainUntilDate(Instant objectLockRetainUntilDate)
The date and time when you want the copied object's object lock to expire.
objectLockRetainUntilDate
- The date and time when you want the copied object's object lock to expire.CopyObjectRequest.Builder objectLockLegalHoldStatus(String objectLockLegalHoldStatus)
Specifies whether you want to apply a Legal Hold to the copied object.
objectLockLegalHoldStatus
- Specifies whether you want to apply a Legal Hold to the copied object.ObjectLockLegalHoldStatus
,
ObjectLockLegalHoldStatus
CopyObjectRequest.Builder objectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus)
Specifies whether you want to apply a Legal Hold to the copied object.
objectLockLegalHoldStatus
- Specifies whether you want to apply a Legal Hold to the copied object.ObjectLockLegalHoldStatus
,
ObjectLockLegalHoldStatus
CopyObjectRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
CopyObjectRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2019. All rights reserved.