software.amazon.awssdk.services.s3.model

Class CopyObjectRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.s3.model.S3Request

software.amazon.awssdk.services.s3.model.CopyObjectRequest

All Implemented Interfaces:

ToCopyableBuilder<CopyObjectRequest.Builder,CopyObjectRequest>

@Generated(value="software.amazon.awssdk:codegen")
public class CopyObjectRequest
extends S3Request
implements ToCopyableBuilder<CopyObjectRequest.Builder,CopyObjectRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CopyObjectRequest.Builder

Method Summary

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() Returns the value of the Bucket property for this object.
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 (e.g., 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.
boolean	equals(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) Used to retrieve the value of a field from any class that extends SdkRequest.
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()
String	key() Returns the value of the Key property for this object.
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.
RequestPayer	requestPayer() Returns the value of the RequestPayer property for this object.
String	requestPayerAsString() Returns the value of the RequestPayer property for this object.
static Class<? extends CopyObjectRequest.Builder>	serializableBuilderClass()
ServerSideEncryption	serverSideEncryption() The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
String	serverSideEncryptionAsString() The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
String	sseCustomerAlgorithm() Specifies the algorithm to use to when encrypting the object (e.g., 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	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() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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 class software.amazon.awssdk.awscore.AwsRequest

requestOverrideConfig

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

acl

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().

Returns:

The canned ACL to apply to the object.

See Also:

ObjectCannedACL

aclAsString

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().

Returns:

The canned ACL to apply to the object.

See Also:

ObjectCannedACL

bucket

public String bucket()

Returns the value of the Bucket property for this object.

Returns:

The value of the Bucket property for this object.

cacheControl

public String cacheControl()

Specifies caching behavior along the request/reply chain.

Returns:

Specifies caching behavior along the request/reply chain.

contentDisposition

public String contentDisposition()

Specifies presentational information for the object.

Returns:

Specifies presentational information for the object.

contentEncoding

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.

Returns:

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.

contentLanguage

public String contentLanguage()

The language the content is in.

Returns:

The language the content is in.

contentType

public String contentType()

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

Returns:

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

copySource

public String copySource()

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

Returns:

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

copySourceIfMatch

public String copySourceIfMatch()

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

Returns:

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

copySourceIfModifiedSince

public Instant copySourceIfModifiedSince()

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

Returns:

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

copySourceIfNoneMatch

public String copySourceIfNoneMatch()

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

Returns:

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

copySourceIfUnmodifiedSince

public Instant copySourceIfUnmodifiedSince()

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

Returns:

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

expires

public Instant expires()

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

Returns:

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

grantFullControl

public String grantFullControl()

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

Returns:

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

grantRead

public String grantRead()

Allows grantee to read the object data and its metadata.

Returns:

Allows grantee to read the object data and its metadata.

grantReadACP

public String grantReadACP()

Allows grantee to read the object ACL.

Returns:

Allows grantee to read the object ACL.

grantWriteACP

public String grantWriteACP()

Allows grantee to write the ACL for the applicable object.

Returns:

Allows grantee to write the ACL for the applicable object.

key

public String key()

Returns the value of the Key property for this object.

Returns:

The value of the Key property for this object.

metadata

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.

Returns:

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

metadataDirective

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().

Returns:

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

See Also:

MetadataDirective

metadataDirectiveAsString

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().

Returns:

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

See Also:

MetadataDirective

taggingDirective

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().

Returns:

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

See Also:

TaggingDirective

taggingDirectiveAsString

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().

Returns:

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

See Also:

TaggingDirective

serverSideEncryption

public ServerSideEncryption serverSideEncryption()

The Server-side encryption algorithm used when storing this object in S3 (e.g., 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().

Returns:

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

See Also:

ServerSideEncryption

serverSideEncryptionAsString

public String serverSideEncryptionAsString()

The Server-side encryption algorithm used when storing this object in S3 (e.g., 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().

Returns:

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

See Also:

ServerSideEncryption

storageClass

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().

Returns:

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

See Also:

StorageClass

storageClassAsString

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().

Returns:

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

See Also:

StorageClass

websiteRedirectLocation

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.

Returns:

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.

sseCustomerAlgorithm

public String sseCustomerAlgorithm()

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

Returns:

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

sseCustomerKey

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 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:

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.

sseCustomerKeyMD5

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 the encryption key was transmitted without error.

Returns:

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.

ssekmsKeyId

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. 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:

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

copySourceSSECustomerAlgorithm

public String copySourceSSECustomerAlgorithm()

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

Returns:

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

copySourceSSECustomerKey

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.

Returns:

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.

copySourceSSECustomerKeyMD5

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 the encryption key was transmitted without error.

Returns:

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.

requestPayer

public RequestPayer requestPayer()

Returns the value of the RequestPayer property for this object.

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().

Returns:

The value of the RequestPayer property for this object.

See Also:

RequestPayer

requestPayerAsString

public String requestPayerAsString()

Returns the value of the RequestPayer property for this object.

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().

Returns:

The value of the RequestPayer property for this object.

See Also:

RequestPayer

tagging

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

Returns:

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

toBuilder

public CopyObjectRequest.Builder 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 interface ToCopyableBuilder<CopyObjectRequest.Builder,CopyObjectRequest>

Specified by:

toBuilder in class S3Request

Returns:

a builder for type T

builder

public static CopyObjectRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CopyObjectRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value