Package software.amazon.awssdk.services.s3.model

Interface CopyObjectRequest.Builder

All Superinterfaces:

CopyableBuilder<CopyObjectRequest.Builder,CopyObjectRequest>, SdkBuilder<CopyObjectRequest.Builder,CopyObjectRequest>

Enclosing class:

CopyObjectRequest

public static interface CopyObjectRequest.Builder
extends CopyableBuilder<CopyObjectRequest.Builder,CopyObjectRequest>

Method Summary

Modifier and Type	Method	Description
CopyObjectRequest.Builder	acl(String acl)	The canned ACL to apply to the object.
CopyObjectRequest.Builder	acl(ObjectCannedACL 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(Date 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(Date 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(Date 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(String metadataDirective)	Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.
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	requestPayer(String requestPayer)
CopyObjectRequest.Builder	requestPayer(RequestPayer requestPayer)
CopyObjectRequest.Builder	serverSideEncryption(String serverSideEncryption)	The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
CopyObjectRequest.Builder	serverSideEncryption(ServerSideEncryption 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	ssekmsKeyId(String ssekmsKeyId)	Specifies the AWS KMS key ID to use for object encryption.
CopyObjectRequest.Builder	storageClass(String storageClass)	The type of storage to use for the object.
CopyObjectRequest.Builder	storageClass(StorageClass 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	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.

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

copy

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

apply, build

Method Detail

acl

CopyObjectRequest.Builder acl(String acl)

The canned ACL to apply to the object.

Parameters:

acl - The canned ACL to apply to the object.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ObjectCannedACL

acl

CopyObjectRequest.Builder acl(ObjectCannedACL acl)

The canned ACL to apply to the object.

Parameters:

acl - The canned ACL to apply to the object.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ObjectCannedACL

bucket

CopyObjectRequest.Builder bucket(String bucket)

Parameters:

bucket -

Returns:

Returns a reference to this object so that method calls can be chained together.

cacheControl

CopyObjectRequest.Builder cacheControl(String cacheControl)

Specifies caching behavior along the request/reply chain.

Parameters:

cacheControl - Specifies caching behavior along the request/reply chain.

Returns:

Returns a reference to this object so that method calls can be chained together.

contentDisposition

CopyObjectRequest.Builder contentDisposition(String contentDisposition)

Specifies presentational information for the object.

Parameters:

contentDisposition - Specifies presentational information for the object.

Returns:

Returns a reference to this object so that method calls can be chained together.

contentEncoding

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

contentLanguage

CopyObjectRequest.Builder contentLanguage(String contentLanguage)

The language the content is in.

Parameters:

contentLanguage - The language the content is in.

Returns:

Returns a reference to this object so that method calls can be chained together.

contentType

CopyObjectRequest.Builder contentType(String contentType)

A standard MIME type describing the format of the object data.

Parameters:

contentType - A standard MIME type describing the format of the object data.

Returns:

Returns a reference to this object so that method calls can be chained together.

copySource

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.

Parameters:

copySource - The name of the source bucket and key name of the source object, separated by a slash (/). Must be URL-encoded.

Returns:

Returns a reference to this object so that method calls can be chained together.

copySourceIfMatch

CopyObjectRequest.Builder copySourceIfMatch(String copySourceIfMatch)

Copies the object if its entity tag (ETag) matches the specified tag.

Parameters:

copySourceIfMatch - Copies the object if its entity tag (ETag) matches the specified tag.

Returns:

Returns a reference to this object so that method calls can be chained together.

copySourceIfModifiedSince

CopyObjectRequest.Builder copySourceIfModifiedSince(Date copySourceIfModifiedSince)

Copies the object if it has been modified since the specified time.

Parameters:

copySourceIfModifiedSince - Copies the object if it has been modified since the specified time.

Returns:

Returns a reference to this object so that method calls can be chained together.

copySourceIfNoneMatch

CopyObjectRequest.Builder copySourceIfNoneMatch(String copySourceIfNoneMatch)

Copies the object if its entity tag (ETag) is different than the specified ETag.

Parameters:

copySourceIfNoneMatch - Copies the object if its entity tag (ETag) is different than the specified ETag.

Returns:

Returns a reference to this object so that method calls can be chained together.

copySourceIfUnmodifiedSince

CopyObjectRequest.Builder copySourceIfUnmodifiedSince(Date copySourceIfUnmodifiedSince)

Copies the object if it hasn't been modified since the specified time.

Parameters:

copySourceIfUnmodifiedSince - Copies the object if it hasn't been modified since the specified time.

Returns:

Returns a reference to this object so that method calls can be chained together.

expires

CopyObjectRequest.Builder expires(Date expires)

The date and time at which the object is no longer cacheable.

Parameters:

expires - The date and time at which the object is no longer cacheable.

Returns:

Returns a reference to this object so that method calls can be chained together.

grantFullControl

CopyObjectRequest.Builder grantFullControl(String grantFullControl)

Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

Parameters:

grantFullControl - Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.

Returns:

Returns a reference to this object so that method calls can be chained together.

grantRead

CopyObjectRequest.Builder grantRead(String grantRead)

Allows grantee to read the object data and its metadata.

Parameters:

grantRead - Allows grantee to read the object data and its metadata.

Returns:

Returns a reference to this object so that method calls can be chained together.

grantReadACP

CopyObjectRequest.Builder grantReadACP(String grantReadACP)

Allows grantee to read the object ACL.

Parameters:

grantReadACP - Allows grantee to read the object ACL.

Returns:

Returns a reference to this object so that method calls can be chained together.

grantWriteACP

CopyObjectRequest.Builder grantWriteACP(String grantWriteACP)

Allows grantee to write the ACL for the applicable object.

Parameters:

grantWriteACP - Allows grantee to write the ACL for the applicable object.

Returns:

Returns a reference to this object so that method calls can be chained together.

key

CopyObjectRequest.Builder key(String key)

Parameters:

key -

Returns:

Returns a reference to this object so that method calls can be chained together.

metadata

CopyObjectRequest.Builder metadata(Map<String,String> metadata)

A map of metadata to store with the object in S3.

Parameters:

metadata - A map of metadata to store with the object in S3.

Returns:

Returns a reference to this object so that method calls can be chained together.

metadataDirective

CopyObjectRequest.Builder metadataDirective(String metadataDirective)

Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

Parameters:

metadataDirective - Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

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.

Parameters:

metadataDirective - Specifies whether the metadata is copied from the source object or replaced with metadata provided in the request.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

MetadataDirective

taggingDirective

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.

Parameters:

taggingDirective - Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

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.

Parameters:

taggingDirective - Specifies whether the object tag-set are copied from the source object or replaced with tag-set provided in the request.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TaggingDirective

serverSideEncryption

CopyObjectRequest.Builder serverSideEncryption(String serverSideEncryption)

The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

Parameters:

serverSideEncryption - The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServerSideEncryption

serverSideEncryption

CopyObjectRequest.Builder serverSideEncryption(ServerSideEncryption serverSideEncryption)

The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

Parameters:

serverSideEncryption - The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServerSideEncryption

storageClass

CopyObjectRequest.Builder storageClass(String storageClass)

The type of storage to use for the object. Defaults to 'STANDARD'.

Parameters:

storageClass - The type of storage to use for the object. Defaults to 'STANDARD'.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StorageClass

storageClass

CopyObjectRequest.Builder storageClass(StorageClass storageClass)

The type of storage to use for the object. Defaults to 'STANDARD'.

Parameters:

storageClass - The type of storage to use for the object. Defaults to 'STANDARD'.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StorageClass

websiteRedirectLocation

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

sseCustomerAlgorithm

CopyObjectRequest.Builder sseCustomerAlgorithm(String sseCustomerAlgorithm)

Specifies the algorithm to use to when encrypting the object (e.g., AES256).

Parameters:

sseCustomerAlgorithm - Specifies the algorithm to use to when encrypting the object (e.g., AES256).

Returns:

Returns a reference to this object so that method calls can be chained together.

sseCustomerKey

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

sseCustomerKeyMD5

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

ssekmsKeyId

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

copySourceSSECustomerAlgorithm

CopyObjectRequest.Builder copySourceSSECustomerAlgorithm(String copySourceSSECustomerAlgorithm)

Specifies the algorithm to use when decrypting the source object (e.g., AES256).

Parameters:

copySourceSSECustomerAlgorithm - Specifies the algorithm to use when decrypting the source object (e.g., AES256).

Returns:

Returns a reference to this object so that method calls can be chained together.

copySourceSSECustomerKey

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

copySourceSSECustomerKeyMD5

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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

requestPayer

CopyObjectRequest.Builder requestPayer(String requestPayer)

Parameters:

requestPayer -

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RequestPayer

requestPayer

CopyObjectRequest.Builder requestPayer(RequestPayer requestPayer)

Parameters:

requestPayer -

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

RequestPayer

tagging

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

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 parameters

Returns:

Returns a reference to this object so that method calls can be chained together.