software.amazon.awssdk.services.s3.model.CopyObjectRequest Maven / Gradle / Ivy
Show all versions of s3 Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.s3.model;
import java.time.Instant;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.traits.MapTrait;
import software.amazon.awssdk.core.traits.RequiredTrait;
import software.amazon.awssdk.core.traits.TimestampFormatTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.services.s3.internal.TaggingAdapter;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CopyObjectRequest extends S3Request implements ToCopyableBuilder {
private static final SdkField ACL_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ACL")
.getter(getter(CopyObjectRequest::aclAsString))
.setter(setter(Builder::acl))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-acl")
.unmarshallLocationName("x-amz-acl").build()).build();
private static final SdkField CACHE_CONTROL_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("CacheControl")
.getter(getter(CopyObjectRequest::cacheControl))
.setter(setter(Builder::cacheControl))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("Cache-Control")
.unmarshallLocationName("Cache-Control").build()).build();
private static final SdkField CHECKSUM_ALGORITHM_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ChecksumAlgorithm")
.getter(getter(CopyObjectRequest::checksumAlgorithmAsString))
.setter(setter(Builder::checksumAlgorithm))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-checksum-algorithm")
.unmarshallLocationName("x-amz-checksum-algorithm").build()).build();
private static final SdkField CONTENT_DISPOSITION_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ContentDisposition")
.getter(getter(CopyObjectRequest::contentDisposition))
.setter(setter(Builder::contentDisposition))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("Content-Disposition")
.unmarshallLocationName("Content-Disposition").build()).build();
private static final SdkField CONTENT_ENCODING_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ContentEncoding")
.getter(getter(CopyObjectRequest::contentEncoding))
.setter(setter(Builder::contentEncoding))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("Content-Encoding")
.unmarshallLocationName("Content-Encoding").build()).build();
private static final SdkField CONTENT_LANGUAGE_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ContentLanguage")
.getter(getter(CopyObjectRequest::contentLanguage))
.setter(setter(Builder::contentLanguage))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("Content-Language")
.unmarshallLocationName("Content-Language").build()).build();
private static final SdkField CONTENT_TYPE_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ContentType")
.getter(getter(CopyObjectRequest::contentType))
.setter(setter(Builder::contentType))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("Content-Type")
.unmarshallLocationName("Content-Type").build()).build();
private static final SdkField COPY_SOURCE_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("CopySource")
.getter(getter(CopyObjectRequest::copySource))
.setter(setter(Builder::copySource))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-copy-source")
.unmarshallLocationName("x-amz-copy-source").build(), RequiredTrait.create()).build();
private static final SdkField COPY_SOURCE_IF_MATCH_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("CopySourceIfMatch")
.getter(getter(CopyObjectRequest::copySourceIfMatch))
.setter(setter(Builder::copySourceIfMatch))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-copy-source-if-match")
.unmarshallLocationName("x-amz-copy-source-if-match").build()).build();
private static final SdkField COPY_SOURCE_IF_MODIFIED_SINCE_FIELD = SdkField
. builder(MarshallingType.INSTANT)
.memberName("CopySourceIfModifiedSince")
.getter(getter(CopyObjectRequest::copySourceIfModifiedSince))
.setter(setter(Builder::copySourceIfModifiedSince))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-copy-source-if-modified-since")
.unmarshallLocationName("x-amz-copy-source-if-modified-since").build()).build();
private static final SdkField COPY_SOURCE_IF_NONE_MATCH_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("CopySourceIfNoneMatch")
.getter(getter(CopyObjectRequest::copySourceIfNoneMatch))
.setter(setter(Builder::copySourceIfNoneMatch))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-copy-source-if-none-match")
.unmarshallLocationName("x-amz-copy-source-if-none-match").build()).build();
private static final SdkField COPY_SOURCE_IF_UNMODIFIED_SINCE_FIELD = SdkField
. builder(MarshallingType.INSTANT)
.memberName("CopySourceIfUnmodifiedSince")
.getter(getter(CopyObjectRequest::copySourceIfUnmodifiedSince))
.setter(setter(Builder::copySourceIfUnmodifiedSince))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER)
.locationName("x-amz-copy-source-if-unmodified-since")
.unmarshallLocationName("x-amz-copy-source-if-unmodified-since").build()).build();
private static final SdkField EXPIRES_FIELD = SdkField
. builder(MarshallingType.INSTANT)
.memberName("Expires")
.getter(getter(CopyObjectRequest::expires))
.setter(setter(Builder::expires))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("Expires")
.unmarshallLocationName("Expires").build()).build();
private static final SdkField GRANT_FULL_CONTROL_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("GrantFullControl")
.getter(getter(CopyObjectRequest::grantFullControl))
.setter(setter(Builder::grantFullControl))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-grant-full-control")
.unmarshallLocationName("x-amz-grant-full-control").build()).build();
private static final SdkField GRANT_READ_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("GrantRead")
.getter(getter(CopyObjectRequest::grantRead))
.setter(setter(Builder::grantRead))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-grant-read")
.unmarshallLocationName("x-amz-grant-read").build()).build();
private static final SdkField GRANT_READ_ACP_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("GrantReadACP")
.getter(getter(CopyObjectRequest::grantReadACP))
.setter(setter(Builder::grantReadACP))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-grant-read-acp")
.unmarshallLocationName("x-amz-grant-read-acp").build()).build();
private static final SdkField GRANT_WRITE_ACP_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("GrantWriteACP")
.getter(getter(CopyObjectRequest::grantWriteACP))
.setter(setter(Builder::grantWriteACP))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-grant-write-acp")
.unmarshallLocationName("x-amz-grant-write-acp").build()).build();
private static final SdkField> METADATA_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Metadata")
.getter(getter(CopyObjectRequest::metadata))
.setter(setter(Builder::metadata))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-meta-")
.unmarshallLocationName("x-amz-meta-").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").unmarshallLocationName("value").build()).build())
.build()).build();
private static final SdkField METADATA_DIRECTIVE_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("MetadataDirective")
.getter(getter(CopyObjectRequest::metadataDirectiveAsString))
.setter(setter(Builder::metadataDirective))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-metadata-directive")
.unmarshallLocationName("x-amz-metadata-directive").build()).build();
private static final SdkField TAGGING_DIRECTIVE_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("TaggingDirective")
.getter(getter(CopyObjectRequest::taggingDirectiveAsString))
.setter(setter(Builder::taggingDirective))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-tagging-directive")
.unmarshallLocationName("x-amz-tagging-directive").build()).build();
private static final SdkField SERVER_SIDE_ENCRYPTION_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ServerSideEncryption")
.getter(getter(CopyObjectRequest::serverSideEncryptionAsString))
.setter(setter(Builder::serverSideEncryption))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-server-side-encryption")
.unmarshallLocationName("x-amz-server-side-encryption").build()).build();
private static final SdkField STORAGE_CLASS_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("StorageClass")
.getter(getter(CopyObjectRequest::storageClassAsString))
.setter(setter(Builder::storageClass))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-storage-class")
.unmarshallLocationName("x-amz-storage-class").build()).build();
private static final SdkField WEBSITE_REDIRECT_LOCATION_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("WebsiteRedirectLocation")
.getter(getter(CopyObjectRequest::websiteRedirectLocation))
.setter(setter(Builder::websiteRedirectLocation))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-website-redirect-location")
.unmarshallLocationName("x-amz-website-redirect-location").build()).build();
private static final SdkField SSE_CUSTOMER_ALGORITHM_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("SSECustomerAlgorithm")
.getter(getter(CopyObjectRequest::sseCustomerAlgorithm))
.setter(setter(Builder::sseCustomerAlgorithm))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER)
.locationName("x-amz-server-side-encryption-customer-algorithm")
.unmarshallLocationName("x-amz-server-side-encryption-customer-algorithm").build()).build();
private static final SdkField SSE_CUSTOMER_KEY_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("SSECustomerKey")
.getter(getter(CopyObjectRequest::sseCustomerKey))
.setter(setter(Builder::sseCustomerKey))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER)
.locationName("x-amz-server-side-encryption-customer-key")
.unmarshallLocationName("x-amz-server-side-encryption-customer-key").build()).build();
private static final SdkField SSE_CUSTOMER_KEY_MD5_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("SSECustomerKeyMD5")
.getter(getter(CopyObjectRequest::sseCustomerKeyMD5))
.setter(setter(Builder::sseCustomerKeyMD5))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER)
.locationName("x-amz-server-side-encryption-customer-key-MD5")
.unmarshallLocationName("x-amz-server-side-encryption-customer-key-MD5").build()).build();
private static final SdkField SSEKMS_KEY_ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("SSEKMSKeyId")
.getter(getter(CopyObjectRequest::ssekmsKeyId))
.setter(setter(Builder::ssekmsKeyId))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER)
.locationName("x-amz-server-side-encryption-aws-kms-key-id")
.unmarshallLocationName("x-amz-server-side-encryption-aws-kms-key-id").build()).build();
private static final SdkField SSEKMS_ENCRYPTION_CONTEXT_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("SSEKMSEncryptionContext")
.getter(getter(CopyObjectRequest::ssekmsEncryptionContext))
.setter(setter(Builder::ssekmsEncryptionContext))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER)
.locationName("x-amz-server-side-encryption-context")
.unmarshallLocationName("x-amz-server-side-encryption-context").build()).build();
private static final SdkField BUCKET_KEY_ENABLED_FIELD = SdkField
. builder(MarshallingType.BOOLEAN)
.memberName("BucketKeyEnabled")
.getter(getter(CopyObjectRequest::bucketKeyEnabled))
.setter(setter(Builder::bucketKeyEnabled))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER)
.locationName("x-amz-server-side-encryption-bucket-key-enabled")
.unmarshallLocationName("x-amz-server-side-encryption-bucket-key-enabled").build()).build();
private static final SdkField COPY_SOURCE_SSE_CUSTOMER_ALGORITHM_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("CopySourceSSECustomerAlgorithm")
.getter(getter(CopyObjectRequest::copySourceSSECustomerAlgorithm))
.setter(setter(Builder::copySourceSSECustomerAlgorithm))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER)
.locationName("x-amz-copy-source-server-side-encryption-customer-algorithm")
.unmarshallLocationName("x-amz-copy-source-server-side-encryption-customer-algorithm").build()).build();
private static final SdkField COPY_SOURCE_SSE_CUSTOMER_KEY_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("CopySourceSSECustomerKey")
.getter(getter(CopyObjectRequest::copySourceSSECustomerKey))
.setter(setter(Builder::copySourceSSECustomerKey))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER)
.locationName("x-amz-copy-source-server-side-encryption-customer-key")
.unmarshallLocationName("x-amz-copy-source-server-side-encryption-customer-key").build()).build();
private static final SdkField COPY_SOURCE_SSE_CUSTOMER_KEY_MD5_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("CopySourceSSECustomerKeyMD5")
.getter(getter(CopyObjectRequest::copySourceSSECustomerKeyMD5))
.setter(setter(Builder::copySourceSSECustomerKeyMD5))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER)
.locationName("x-amz-copy-source-server-side-encryption-customer-key-MD5")
.unmarshallLocationName("x-amz-copy-source-server-side-encryption-customer-key-MD5").build()).build();
private static final SdkField REQUEST_PAYER_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("RequestPayer")
.getter(getter(CopyObjectRequest::requestPayerAsString))
.setter(setter(Builder::requestPayer))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-request-payer")
.unmarshallLocationName("x-amz-request-payer").build()).build();
private static final SdkField TAGGING_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("Tagging")
.getter(getter(CopyObjectRequest::tagging))
.setter(setter(Builder::tagging))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-tagging")
.unmarshallLocationName("x-amz-tagging").build()).build();
private static final SdkField OBJECT_LOCK_MODE_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ObjectLockMode")
.getter(getter(CopyObjectRequest::objectLockModeAsString))
.setter(setter(Builder::objectLockMode))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-object-lock-mode")
.unmarshallLocationName("x-amz-object-lock-mode").build()).build();
private static final SdkField OBJECT_LOCK_RETAIN_UNTIL_DATE_FIELD = SdkField
. builder(MarshallingType.INSTANT)
.memberName("ObjectLockRetainUntilDate")
.getter(getter(CopyObjectRequest::objectLockRetainUntilDate))
.setter(setter(Builder::objectLockRetainUntilDate))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-object-lock-retain-until-date")
.unmarshallLocationName("x-amz-object-lock-retain-until-date").build(),
TimestampFormatTrait.create(TimestampFormatTrait.Format.ISO_8601)).build();
private static final SdkField OBJECT_LOCK_LEGAL_HOLD_STATUS_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ObjectLockLegalHoldStatus")
.getter(getter(CopyObjectRequest::objectLockLegalHoldStatusAsString))
.setter(setter(Builder::objectLockLegalHoldStatus))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-object-lock-legal-hold")
.unmarshallLocationName("x-amz-object-lock-legal-hold").build()).build();
private static final SdkField EXPECTED_BUCKET_OWNER_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ExpectedBucketOwner")
.getter(getter(CopyObjectRequest::expectedBucketOwner))
.setter(setter(Builder::expectedBucketOwner))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-expected-bucket-owner")
.unmarshallLocationName("x-amz-expected-bucket-owner").build()).build();
private static final SdkField EXPECTED_SOURCE_BUCKET_OWNER_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ExpectedSourceBucketOwner")
.getter(getter(CopyObjectRequest::expectedSourceBucketOwner))
.setter(setter(Builder::expectedSourceBucketOwner))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-source-expected-bucket-owner")
.unmarshallLocationName("x-amz-source-expected-bucket-owner").build()).build();
private static final SdkField DESTINATION_BUCKET_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("DestinationBucket")
.getter(getter(CopyObjectRequest::destinationBucket))
.setter(setter(Builder::destinationBucket))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("Bucket")
.unmarshallLocationName("Bucket").build()).build();
private static final SdkField DESTINATION_KEY_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("DestinationKey")
.getter(getter(CopyObjectRequest::destinationKey))
.setter(setter(Builder::destinationKey))
.traits(LocationTrait.builder().location(MarshallLocation.GREEDY_PATH).locationName("Key")
.unmarshallLocationName("Key").build()).build();
private static final SdkField SOURCE_BUCKET_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("SourceBucket")
.getter(getter(CopyObjectRequest::sourceBucket))
.setter(setter(Builder::sourceBucket))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SourceBucket")
.unmarshallLocationName("SourceBucket").build()).build();
private static final SdkField SOURCE_KEY_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("SourceKey")
.getter(getter(CopyObjectRequest::sourceKey))
.setter(setter(Builder::sourceKey))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SourceKey")
.unmarshallLocationName("SourceKey").build()).build();
private static final SdkField SOURCE_VERSION_ID_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("SourceVersionId")
.getter(getter(CopyObjectRequest::sourceVersionId))
.setter(setter(Builder::sourceVersionId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("SourceVersionId")
.unmarshallLocationName("SourceVersionId").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ACL_FIELD,
CACHE_CONTROL_FIELD, CHECKSUM_ALGORITHM_FIELD, CONTENT_DISPOSITION_FIELD, CONTENT_ENCODING_FIELD,
CONTENT_LANGUAGE_FIELD, CONTENT_TYPE_FIELD, COPY_SOURCE_FIELD, COPY_SOURCE_IF_MATCH_FIELD,
COPY_SOURCE_IF_MODIFIED_SINCE_FIELD, COPY_SOURCE_IF_NONE_MATCH_FIELD, COPY_SOURCE_IF_UNMODIFIED_SINCE_FIELD,
EXPIRES_FIELD, GRANT_FULL_CONTROL_FIELD, GRANT_READ_FIELD, GRANT_READ_ACP_FIELD, GRANT_WRITE_ACP_FIELD,
METADATA_FIELD, METADATA_DIRECTIVE_FIELD, TAGGING_DIRECTIVE_FIELD, SERVER_SIDE_ENCRYPTION_FIELD, STORAGE_CLASS_FIELD,
WEBSITE_REDIRECT_LOCATION_FIELD, SSE_CUSTOMER_ALGORITHM_FIELD, SSE_CUSTOMER_KEY_FIELD, SSE_CUSTOMER_KEY_MD5_FIELD,
SSEKMS_KEY_ID_FIELD, SSEKMS_ENCRYPTION_CONTEXT_FIELD, BUCKET_KEY_ENABLED_FIELD,
COPY_SOURCE_SSE_CUSTOMER_ALGORITHM_FIELD, COPY_SOURCE_SSE_CUSTOMER_KEY_FIELD, COPY_SOURCE_SSE_CUSTOMER_KEY_MD5_FIELD,
REQUEST_PAYER_FIELD, TAGGING_FIELD, OBJECT_LOCK_MODE_FIELD, OBJECT_LOCK_RETAIN_UNTIL_DATE_FIELD,
OBJECT_LOCK_LEGAL_HOLD_STATUS_FIELD, EXPECTED_BUCKET_OWNER_FIELD, EXPECTED_SOURCE_BUCKET_OWNER_FIELD,
DESTINATION_BUCKET_FIELD, DESTINATION_KEY_FIELD, SOURCE_BUCKET_FIELD, SOURCE_KEY_FIELD, SOURCE_VERSION_ID_FIELD));
private final String acl;
private final String cacheControl;
private final String checksumAlgorithm;
private final String contentDisposition;
private final String contentEncoding;
private final String contentLanguage;
private final String contentType;
private final String copySource;
private final String copySourceIfMatch;
private final Instant copySourceIfModifiedSince;
private final String copySourceIfNoneMatch;
private final Instant copySourceIfUnmodifiedSince;
private final Instant expires;
private final String grantFullControl;
private final String grantRead;
private final String grantReadACP;
private final String grantWriteACP;
private final Map metadata;
private final String metadataDirective;
private final String taggingDirective;
private final String serverSideEncryption;
private final String storageClass;
private final String websiteRedirectLocation;
private final String sseCustomerAlgorithm;
private final String sseCustomerKey;
private final String sseCustomerKeyMD5;
private final String ssekmsKeyId;
private final String ssekmsEncryptionContext;
private final Boolean bucketKeyEnabled;
private final String copySourceSSECustomerAlgorithm;
private final String copySourceSSECustomerKey;
private final String copySourceSSECustomerKeyMD5;
private final String requestPayer;
private final String tagging;
private final String objectLockMode;
private final Instant objectLockRetainUntilDate;
private final String objectLockLegalHoldStatus;
private final String expectedBucketOwner;
private final String expectedSourceBucketOwner;
private final String destinationBucket;
private final String destinationKey;
private final String sourceBucket;
private final String sourceKey;
private final String sourceVersionId;
private CopyObjectRequest(BuilderImpl builder) {
super(builder);
this.acl = builder.acl;
this.cacheControl = builder.cacheControl;
this.checksumAlgorithm = builder.checksumAlgorithm;
this.contentDisposition = builder.contentDisposition;
this.contentEncoding = builder.contentEncoding;
this.contentLanguage = builder.contentLanguage;
this.contentType = builder.contentType;
this.copySource = builder.copySource;
this.copySourceIfMatch = builder.copySourceIfMatch;
this.copySourceIfModifiedSince = builder.copySourceIfModifiedSince;
this.copySourceIfNoneMatch = builder.copySourceIfNoneMatch;
this.copySourceIfUnmodifiedSince = builder.copySourceIfUnmodifiedSince;
this.expires = builder.expires;
this.grantFullControl = builder.grantFullControl;
this.grantRead = builder.grantRead;
this.grantReadACP = builder.grantReadACP;
this.grantWriteACP = builder.grantWriteACP;
this.metadata = builder.metadata;
this.metadataDirective = builder.metadataDirective;
this.taggingDirective = builder.taggingDirective;
this.serverSideEncryption = builder.serverSideEncryption;
this.storageClass = builder.storageClass;
this.websiteRedirectLocation = builder.websiteRedirectLocation;
this.sseCustomerAlgorithm = builder.sseCustomerAlgorithm;
this.sseCustomerKey = builder.sseCustomerKey;
this.sseCustomerKeyMD5 = builder.sseCustomerKeyMD5;
this.ssekmsKeyId = builder.ssekmsKeyId;
this.ssekmsEncryptionContext = builder.ssekmsEncryptionContext;
this.bucketKeyEnabled = builder.bucketKeyEnabled;
this.copySourceSSECustomerAlgorithm = builder.copySourceSSECustomerAlgorithm;
this.copySourceSSECustomerKey = builder.copySourceSSECustomerKey;
this.copySourceSSECustomerKeyMD5 = builder.copySourceSSECustomerKeyMD5;
this.requestPayer = builder.requestPayer;
this.tagging = builder.tagging;
this.objectLockMode = builder.objectLockMode;
this.objectLockRetainUntilDate = builder.objectLockRetainUntilDate;
this.objectLockLegalHoldStatus = builder.objectLockLegalHoldStatus;
this.expectedBucketOwner = builder.expectedBucketOwner;
this.expectedSourceBucketOwner = builder.expectedSourceBucketOwner;
this.destinationBucket = builder.destinationBucket;
this.destinationKey = builder.destinationKey;
this.sourceBucket = builder.sourceBucket;
this.sourceKey = builder.sourceKey;
this.sourceVersionId = builder.sourceVersionId;
}
/**
*
* The canned access control list (ACL) to apply to the object.
*
*
* When you copy an object, the ACL metadata is not preserved and is set to private by default. Only
* the owner has full access control. To override the default ACL setting, specify a new ACL when you generate a
* copy request. For more information, see Using ACLs.
*
*
* If the destination bucket that you're copying objects to uses the bucket owner enforced setting for S3 Object
* Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept
* PUT requests that don't specify an ACL or PUT requests that specify bucket owner full
* control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of this ACL
* expressed in the XML format. For more information, see Controlling ownership of
* objects and disabling ACLs in the Amazon S3 User Guide.
*
*
*
* -
*
* If your destination bucket uses the bucket owner enforced setting for Object Ownership, all objects written to
* the bucket by any account will be owned by the bucket owner.
*
*
* -
*
* This functionality is not supported for directory buckets.
*
*
* -
*
* This functionality is not supported for Amazon S3 on Outposts.
*
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #acl} will return
* {@link ObjectCannedACL#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #aclAsString}.
*
*
* @return The canned access control list (ACL) to apply to the object.
*
* When you copy an object, the ACL metadata is not preserved and is set to private by default.
* Only the owner has full access control. To override the default ACL setting, specify a new ACL when you
* generate a copy request. For more information, see Using ACLs.
*
*
* If the destination bucket that you're copying objects to uses the bucket owner enforced setting for S3
* Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only
* accept PUT requests that don't specify an ACL or PUT requests that specify
* bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an
* equivalent form of this ACL expressed in the XML format. For more information, see Controlling
* ownership of objects and disabling ACLs in the Amazon S3 User Guide.
*
*
*
* -
*
* If your destination bucket uses the bucket owner enforced setting for Object Ownership, all objects
* written to the bucket by any account will be owned by the bucket owner.
*
*
* -
*
* This functionality is not supported for directory buckets.
*
*
* -
*
* This functionality is not supported for Amazon S3 on Outposts.
*
*
*
* @see ObjectCannedACL
*/
public final ObjectCannedACL acl() {
return ObjectCannedACL.fromValue(acl);
}
/**
*
* The canned access control list (ACL) to apply to the object.
*
*
* When you copy an object, the ACL metadata is not preserved and is set to private by default. Only
* the owner has full access control. To override the default ACL setting, specify a new ACL when you generate a
* copy request. For more information, see Using ACLs.
*
*
* If the destination bucket that you're copying objects to uses the bucket owner enforced setting for S3 Object
* Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept
* PUT requests that don't specify an ACL or PUT requests that specify bucket owner full
* control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of this ACL
* expressed in the XML format. For more information, see Controlling ownership of
* objects and disabling ACLs in the Amazon S3 User Guide.
*
*
*
* -
*
* If your destination bucket uses the bucket owner enforced setting for Object Ownership, all objects written to
* the bucket by any account will be owned by the bucket owner.
*
*
* -
*
* This functionality is not supported for directory buckets.
*
*
* -
*
* This functionality is not supported for Amazon S3 on Outposts.
*
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #acl} will return
* {@link ObjectCannedACL#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #aclAsString}.
*
*
* @return The canned access control list (ACL) to apply to the object.
*
* When you copy an object, the ACL metadata is not preserved and is set to private by default.
* Only the owner has full access control. To override the default ACL setting, specify a new ACL when you
* generate a copy request. For more information, see Using ACLs.
*
*
* If the destination bucket that you're copying objects to uses the bucket owner enforced setting for S3
* Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only
* accept PUT requests that don't specify an ACL or PUT requests that specify
* bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL or an
* equivalent form of this ACL expressed in the XML format. For more information, see Controlling
* ownership of objects and disabling ACLs in the Amazon S3 User Guide.
*
*
*
* -
*
* If your destination bucket uses the bucket owner enforced setting for Object Ownership, all objects
* written to the bucket by any account will be owned by the bucket owner.
*
*
* -
*
* This functionality is not supported for directory buckets.
*
*
* -
*
* This functionality is not supported for Amazon S3 on Outposts.
*
*
*
* @see ObjectCannedACL
*/
public final String aclAsString() {
return acl;
}
/**
*
* Specifies the caching behavior along the request/reply chain.
*
*
* @return Specifies the caching behavior along the request/reply chain.
*/
public final String cacheControl() {
return cacheControl;
}
/**
*
* Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more
* information, see Checking object
* integrity in the Amazon S3 User Guide.
*
*
* When you copy an object, if the source object has a checksum, that checksum value will be copied to the new
* object by default. If the CopyObject request does not include this
* x-amz-checksum-algorithm header, the checksum algorithm will be copied from the source object to the
* destination object (if it's present on the source object). You can optionally specify a different checksum
* algorithm to use with the x-amz-checksum-algorithm header. Unrecognized or unsupported values will
* respond with the HTTP status code 400 Bad Request.
*
*
*
* For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum
* algorithm that's used for performance.
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #checksumAlgorithm}
* will return {@link ChecksumAlgorithm#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #checksumAlgorithmAsString}.
*
*
* @return Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more
* information, see Checking
* object integrity in the Amazon S3 User Guide.
*
* When you copy an object, if the source object has a checksum, that checksum value will be copied to the
* new object by default. If the CopyObject request does not include this
* x-amz-checksum-algorithm header, the checksum algorithm will be copied from the source
* object to the destination object (if it's present on the source object). You can optionally specify a
* different checksum algorithm to use with the x-amz-checksum-algorithm header. Unrecognized
* or unsupported values will respond with the HTTP status code 400 Bad Request.
*
*
*
* For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum
* algorithm that's used for performance.
*
* @see ChecksumAlgorithm
*/
public final ChecksumAlgorithm checksumAlgorithm() {
return ChecksumAlgorithm.fromValue(checksumAlgorithm);
}
/**
*
* Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more
* information, see Checking object
* integrity in the Amazon S3 User Guide.
*
*
* When you copy an object, if the source object has a checksum, that checksum value will be copied to the new
* object by default. If the CopyObject request does not include this
* x-amz-checksum-algorithm header, the checksum algorithm will be copied from the source object to the
* destination object (if it's present on the source object). You can optionally specify a different checksum
* algorithm to use with the x-amz-checksum-algorithm header. Unrecognized or unsupported values will
* respond with the HTTP status code 400 Bad Request.
*
*
*
* For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum
* algorithm that's used for performance.
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #checksumAlgorithm}
* will return {@link ChecksumAlgorithm#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #checksumAlgorithmAsString}.
*
*
* @return Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more
* information, see Checking
* object integrity in the Amazon S3 User Guide.
*
* When you copy an object, if the source object has a checksum, that checksum value will be copied to the
* new object by default. If the CopyObject request does not include this
* x-amz-checksum-algorithm header, the checksum algorithm will be copied from the source
* object to the destination object (if it's present on the source object). You can optionally specify a
* different checksum algorithm to use with the x-amz-checksum-algorithm header. Unrecognized
* or unsupported values will respond with the HTTP status code 400 Bad Request.
*
*
*
* For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum
* algorithm that's used for performance.
*
* @see ChecksumAlgorithm
*/
public final String checksumAlgorithmAsString() {
return checksumAlgorithm;
}
/**
*
* Specifies presentational information for the object. Indicates whether an object should be displayed in a web
* browser or downloaded as a file. It allows specifying the desired filename for the downloaded file.
*
*
* @return Specifies presentational information for the object. Indicates whether an object should be displayed in a
* web browser or downloaded as a file. It allows specifying the desired filename for the downloaded file.
*/
public final String contentDisposition() {
return contentDisposition;
}
/**
*
* 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.
*
*
*
* For directory buckets, only the aws-chunked value is supported in this header field.
*
*
*
* @return 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.
*
* For directory buckets, only the aws-chunked value is supported in this header field.
*
*/
public final String contentEncoding() {
return contentEncoding;
}
/**
*
* The language the content is in.
*
*
* @return The language the content is in.
*/
public final String contentLanguage() {
return contentLanguage;
}
/**
*
* A standard MIME type that describes the format of the object data.
*
*
* @return A standard MIME type that describes the format of the object data.
*/
public final String contentType() {
return contentType;
}
/**
*
* Specifies the source object for the copy operation. The source object can be up to 5 GB. If the source object is
* an object that was uploaded by using a multipart upload, the object copy will be a single part object after the
* source object is copied to the destination bucket.
*
*
* You specify the value of the copy source in one of two formats, depending on whether you want to access the
* source object through an access point:
*
*
* -
*
* For objects not accessed through an access point, specify the name of the source bucket and the key of the source
* object, separated by a slash (/). For example, to copy the object reports/january.pdf from the
* general purpose bucket awsexamplebucket, use awsexamplebucket/reports/january.pdf. The
* value must be URL-encoded. To copy the object reports/january.pdf from the directory bucket
* awsexamplebucket--use1-az5--x-s3, use
* awsexamplebucket--use1-az5--x-s3/reports/january.pdf. The value must be URL-encoded.
*
*
* -
*
* For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed
* through the access point, in the format
* arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>
* . For example, to copy the object reports/january.pdf through access point
* my-access-point owned by account 123456789012 in Region us-west-2, use the
* URL encoding of
* arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The value
* must be URL encoded.
*
*
*
* -
*
* Amazon S3 supports copy operations using Access points only when the source and destination buckets are in the
* same Amazon Web Services Region.
*
*
* -
*
* Access points are not supported by directory buckets.
*
*
*
*
*
* Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed in
* the format
* arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>.
* For example, to copy the object reports/january.pdf through outpost my-outpost owned by
* account 123456789012 in Region us-west-2, use the URL encoding of
* arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The value
* must be URL-encoded.
*
*
*
*
* If your source bucket versioning is enabled, the x-amz-copy-source header by default identifies the
* current version of an object to copy. If the current version is a delete marker, Amazon S3 behaves as if the
* object was deleted. To copy a different version, use the versionId query parameter. Specifically,
* append ?versionId=<version-id> to the value (for example,
* awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you don't
* specify a version ID, Amazon S3 copies the latest version of the source object.
*
*
* If you enable versioning on the destination bucket, Amazon S3 generates a unique version ID for the copied
* object. This version ID is different from the version ID of the source object. Amazon S3 returns the version ID
* of the copied object in the x-amz-version-id response header in the response.
*
*
* If you do not enable versioning or suspend it on the destination bucket, the version ID that Amazon S3 generates
* in the x-amz-version-id response header is always null.
*
*
*
* Directory buckets - S3 Versioning isn't enabled and supported for directory buckets.
*
*
*
* @return Specifies the source object for the copy operation. The source object can be up to 5 GB. If the source
* object is an object that was uploaded by using a multipart upload, the object copy will be a single part
* object after the source object is copied to the destination bucket.
*
* You specify the value of the copy source in one of two formats, depending on whether you want to access
* the source object through an access point:
*
*
* -
*
* For objects not accessed through an access point, specify the name of the source bucket and the key of
* the source object, separated by a slash (/). For example, to copy the object
* reports/january.pdf from the general purpose bucket awsexamplebucket, use
* awsexamplebucket/reports/january.pdf. The value must be URL-encoded. To copy the object
* reports/january.pdf from the directory bucket awsexamplebucket--use1-az5--x-s3,
* use awsexamplebucket--use1-az5--x-s3/reports/january.pdf. The value must be URL-encoded.
*
*
* -
*
* For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as
* accessed through the access point, in the format
* arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>
* . For example, to copy the object reports/january.pdf through access point
* my-access-point owned by account 123456789012 in Region us-west-2,
* use the URL encoding of
* arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf.
* The value must be URL encoded.
*
*
*
* -
*
* Amazon S3 supports copy operations using Access points only when the source and destination buckets are
* in the same Amazon Web Services Region.
*
*
* -
*
* Access points are not supported by directory buckets.
*
*
*
*
*
* Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as
* accessed in the format
* arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>
* . For example, to copy the object reports/january.pdf through outpost
* my-outpost owned by account 123456789012 in Region us-west-2, use
* the URL encoding of
* arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf.
* The value must be URL-encoded.
*
*
*
*
* If your source bucket versioning is enabled, the x-amz-copy-source header by default
* identifies the current version of an object to copy. If the current version is a delete marker, Amazon S3
* behaves as if the object was deleted. To copy a different version, use the versionId query
* parameter. Specifically, append ?versionId=<version-id> to the value (for example,
* awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you
* don't specify a version ID, Amazon S3 copies the latest version of the source object.
*
*
* If you enable versioning on the destination bucket, Amazon S3 generates a unique version ID for the
* copied object. This version ID is different from the version ID of the source object. Amazon S3 returns
* the version ID of the copied object in the x-amz-version-id response header in the response.
*
*
* If you do not enable versioning or suspend it on the destination bucket, the version ID that Amazon S3
* generates in the x-amz-version-id response header is always null.
*
*
*
* Directory buckets - S3 Versioning isn't enabled and supported for directory buckets.
*
* @deprecated The {@code copySource} parameter has been deprecated in favor of the more user-friendly
* {@code sourceBucket}, {@code sourceKey}, and {@code sourceVersionId} parameters. The
* {@code copySource} parameter will remain fully functional, but it must not be used in conjunction
* with its replacement parameters.
*/
@Deprecated
public final String copySource() {
return copySource;
}
/**
*
* Copies the object if its entity tag (ETag) matches the specified tag.
*
*
* If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since
* headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK and copies the
* data:
*
*
* -
*
* x-amz-copy-source-if-match condition evaluates to true
*
*
* -
*
* x-amz-copy-source-if-unmodified-since condition evaluates to false
*
*
*
*
* @return Copies the object if its entity tag (ETag) matches the specified tag.
*
* If both the x-amz-copy-source-if-match and
* x-amz-copy-source-if-unmodified-since headers are present in the request and evaluate as
* follows, Amazon S3 returns 200 OK and copies the data:
*
*
* -
*
* x-amz-copy-source-if-match condition evaluates to true
*
*
* -
*
* x-amz-copy-source-if-unmodified-since condition evaluates to false
*
*
*/
public final String copySourceIfMatch() {
return copySourceIfMatch;
}
/**
*
* Copies the object if it has been modified since the specified time.
*
*
* If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since
* headers are present in the request and evaluate as follows, Amazon S3 returns the
* 412 Precondition Failed response code:
*
*
* -
*
* x-amz-copy-source-if-none-match condition evaluates to false
*
*
* -
*
* x-amz-copy-source-if-modified-since condition evaluates to true
*
*
*
*
* @return Copies the object if it has been modified since the specified time.
*
* If both the x-amz-copy-source-if-none-match and
* x-amz-copy-source-if-modified-since headers are present in the request and evaluate as
* follows, Amazon S3 returns the 412 Precondition Failed response code:
*
*
* -
*
* x-amz-copy-source-if-none-match condition evaluates to false
*
*
* -
*
* x-amz-copy-source-if-modified-since condition evaluates to true
*
*
*/
public final Instant copySourceIfModifiedSince() {
return copySourceIfModifiedSince;
}
/**
*
* Copies the object if its entity tag (ETag) is different than the specified ETag.
*
*
* If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since
* headers are present in the request and evaluate as follows, Amazon S3 returns the
* 412 Precondition Failed response code:
*
*
* -
*
* x-amz-copy-source-if-none-match condition evaluates to false
*
*
* -
*
* x-amz-copy-source-if-modified-since condition evaluates to true
*
*
*
*
* @return Copies the object if its entity tag (ETag) is different than the specified ETag.
*
* If both the x-amz-copy-source-if-none-match and
* x-amz-copy-source-if-modified-since headers are present in the request and evaluate as
* follows, Amazon S3 returns the 412 Precondition Failed response code:
*
*
* -
*
* x-amz-copy-source-if-none-match condition evaluates to false
*
*
* -
*
* x-amz-copy-source-if-modified-since condition evaluates to true
*
*
*/
public final String copySourceIfNoneMatch() {
return copySourceIfNoneMatch;
}
/**
*
* Copies the object if it hasn't been modified since the specified time.
*
*
* If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since
* headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK and copies the
* data:
*
*
* -
*
* x-amz-copy-source-if-match condition evaluates to true
*
*
* -
*
* x-amz-copy-source-if-unmodified-since condition evaluates to false
*
*
*
*
* @return Copies the object if it hasn't been modified since the specified time.
*
* If both the x-amz-copy-source-if-match and
* x-amz-copy-source-if-unmodified-since headers are present in the request and evaluate as
* follows, Amazon S3 returns 200 OK and copies the data:
*
*
* -
*
* x-amz-copy-source-if-match condition evaluates to true
*
*
* -
*
* x-amz-copy-source-if-unmodified-since condition evaluates to false
*
*
*/
public final Instant copySourceIfUnmodifiedSince() {
return copySourceIfUnmodifiedSince;
}
/**
*
* The date and time at which the object is no longer cacheable.
*
*
* @return The date and time at which the object is no longer cacheable.
*/
public final Instant expires() {
return expires;
}
/**
*
* Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
*
*
*
* -
*
* This functionality is not supported for directory buckets.
*
*
* -
*
* This functionality is not supported for Amazon S3 on Outposts.
*
*
*
*
*
* @return Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
*
* -
*
* This functionality is not supported for directory buckets.
*
*
* -
*
* This functionality is not supported for Amazon S3 on Outposts.
*
*
*
*/
public final String grantFullControl() {
return grantFullControl;
}
/**
*
* Allows grantee to read the object data and its metadata.
*
*
*
* -
*
* This functionality is not supported for directory buckets.
*
*
* -
*
* This functionality is not supported for Amazon S3 on Outposts.
*
*
*
*
*
* @return Allows grantee to read the object data and its metadata.
*
* -
*
* This functionality is not supported for directory buckets.
*
*
* -
*
* This functionality is not supported for Amazon S3 on Outposts.
*
*
*
*/
public final String grantRead() {
return grantRead;
}
/**
*
* Allows grantee to read the object ACL.
*
*
*
* -
*
* This functionality is not supported for directory buckets.
*
*
* -
*
* This functionality is not supported for Amazon S3 on Outposts.
*
*
*
*
*
* @return Allows grantee to read the object ACL.
*
* -
*
* This functionality is not supported for directory buckets.
*
*
* -
*
* This functionality is not supported for Amazon S3 on Outposts.
*
*
*
*/
public final String grantReadACP() {
return grantReadACP;
}
/**
*
* Allows grantee to write the ACL for the applicable object.
*
*
*
* -
*
* This functionality is not supported for directory buckets.
*
*
* -
*
* This functionality is not supported for Amazon S3 on Outposts.
*
*
*
*
*
* @return Allows grantee to write the ACL for the applicable object.
*
* -
*
* This functionality is not supported for directory buckets.
*
*
* -
*
* This functionality is not supported for Amazon S3 on Outposts.
*
*
*
*/
public final String grantWriteACP() {
return grantWriteACP;
}
/**
* For responses, this returns true if the service returned a value for the Metadata property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code isEmpty()} 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.
*/
public final boolean hasMetadata() {
return metadata != null && !(metadata instanceof SdkAutoConstructMap);
}
/**
*
* 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.
*
*
* 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 {@link #hasMetadata} method.
*
*
* @return A map of metadata to store with the object in S3.
*/
public final Map metadata() {
return metadata;
}
/**
*
* Specifies whether the metadata is copied from the source object or replaced with metadata that's provided in the
* request. When copying an object, you can preserve all metadata (the default) or specify new metadata. If this
* header isn’t specified, COPY is the default behavior.
*
*
* General purpose bucket - For general purpose buckets, when you grant permissions, you can use the
* s3:x-amz-metadata-directive condition key to enforce certain metadata behavior when objects are
* uploaded. For more information, see Amazon S3 condition key
* examples in the Amazon S3 User Guide.
*
*
*
* x-amz-website-redirect-location is unique to each object and is not copied when using the
* x-amz-metadata-directive header. To copy the value, you must specify
* x-amz-website-redirect-location in the request header.
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #metadataDirective}
* will return {@link MetadataDirective#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #metadataDirectiveAsString}.
*
*
* @return Specifies whether the metadata is copied from the source object or replaced with metadata that's provided
* in the request. When copying an object, you can preserve all metadata (the default) or specify new
* metadata. If this header isn’t specified, COPY is the default behavior.
*
* General purpose bucket - For general purpose buckets, when you grant permissions, you can use the
* s3:x-amz-metadata-directive condition key to enforce certain metadata behavior when objects
* are uploaded. For more information, see Amazon S3 condition key
* examples in the Amazon S3 User Guide.
*
*
*
* x-amz-website-redirect-location is unique to each object and is not copied when using the
* x-amz-metadata-directive header. To copy the value, you must specify
* x-amz-website-redirect-location in the request header.
*
* @see MetadataDirective
*/
public final MetadataDirective metadataDirective() {
return MetadataDirective.fromValue(metadataDirective);
}
/**
*
* Specifies whether the metadata is copied from the source object or replaced with metadata that's provided in the
* request. When copying an object, you can preserve all metadata (the default) or specify new metadata. If this
* header isn’t specified, COPY is the default behavior.
*
*
* General purpose bucket - For general purpose buckets, when you grant permissions, you can use the
* s3:x-amz-metadata-directive condition key to enforce certain metadata behavior when objects are
* uploaded. For more information, see Amazon S3 condition key
* examples in the Amazon S3 User Guide.
*
*
*
* x-amz-website-redirect-location is unique to each object and is not copied when using the
* x-amz-metadata-directive header. To copy the value, you must specify
* x-amz-website-redirect-location in the request header.
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #metadataDirective}
* will return {@link MetadataDirective#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #metadataDirectiveAsString}.
*
*
* @return Specifies whether the metadata is copied from the source object or replaced with metadata that's provided
* in the request. When copying an object, you can preserve all metadata (the default) or specify new
* metadata. If this header isn’t specified, COPY is the default behavior.
*
* General purpose bucket - For general purpose buckets, when you grant permissions, you can use the
* s3:x-amz-metadata-directive condition key to enforce certain metadata behavior when objects
* are uploaded. For more information, see Amazon S3 condition key
* examples in the Amazon S3 User Guide.
*
*
*
* x-amz-website-redirect-location is unique to each object and is not copied when using the
* x-amz-metadata-directive header. To copy the value, you must specify
* x-amz-website-redirect-location in the request header.
*
* @see MetadataDirective
*/
public final String metadataDirectiveAsString() {
return metadataDirective;
}
/**
*
* Specifies whether the object tag-set is copied from the source object or replaced with the tag-set that's
* provided in the request.
*
*
* The default value is COPY.
*
*
*
* Directory buckets - For directory buckets in a CopyObject operation, only the empty tag-set
* is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a
* 501 Not Implemented status code. When the destination bucket is a directory bucket, you will receive
* a 501 Not Implemented response in any of the following situations:
*
*
* -
*
* When you attempt to COPY the tag-set from an S3 source object that has non-empty tags.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a source object and set a non-empty value to
* x-amz-tagging.
*
*
* -
*
* When you don't set the x-amz-tagging-directive header and the source object has non-empty tags. This
* is because the default value of x-amz-tagging-directive is COPY.
*
*
*
*
* Because only the empty tag-set is supported for directory buckets in a CopyObject operation, the
* following situations are allowed:
*
*
* -
*
* When you attempt to COPY the tag-set from a directory bucket source object that has no tags to a
* general purpose bucket. It copies an empty tag-set to the destination object.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a directory bucket source object and set the
* x-amz-tagging value of the directory bucket destination object to empty.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a general purpose bucket source object that has non-empty
* tags and set the x-amz-tagging value of the directory bucket destination object to empty.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a directory bucket source object and don't set the
* x-amz-tagging value of the directory bucket destination object. This is because the default value of
* x-amz-tagging is the empty value.
*
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #taggingDirective}
* will return {@link TaggingDirective#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #taggingDirectiveAsString}.
*
*
* @return Specifies whether the object tag-set is copied from the source object or replaced with the tag-set that's
* provided in the request.
*
* The default value is COPY.
*
*
*
* Directory buckets - For directory buckets in a CopyObject operation, only the empty
* tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will
* receive a 501 Not Implemented status code. When the destination bucket is a directory
* bucket, you will receive a 501 Not Implemented response in any of the following situations:
*
*
* -
*
* When you attempt to COPY the tag-set from an S3 source object that has non-empty tags.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a source object and set a non-empty value to
* x-amz-tagging.
*
*
* -
*
* When you don't set the x-amz-tagging-directive header and the source object has non-empty
* tags. This is because the default value of x-amz-tagging-directive is COPY.
*
*
*
*
* Because only the empty tag-set is supported for directory buckets in a CopyObject operation,
* the following situations are allowed:
*
*
* -
*
* When you attempt to COPY the tag-set from a directory bucket source object that has no tags
* to a general purpose bucket. It copies an empty tag-set to the destination object.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a directory bucket source object and set the
* x-amz-tagging value of the directory bucket destination object to empty.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a general purpose bucket source object that has
* non-empty tags and set the x-amz-tagging value of the directory bucket destination object to
* empty.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a directory bucket source object and don't set
* the x-amz-tagging value of the directory bucket destination object. This is because the
* default value of x-amz-tagging is the empty value.
*
*
*
* @see TaggingDirective
*/
public final TaggingDirective taggingDirective() {
return TaggingDirective.fromValue(taggingDirective);
}
/**
*
* Specifies whether the object tag-set is copied from the source object or replaced with the tag-set that's
* provided in the request.
*
*
* The default value is COPY.
*
*
*
* Directory buckets - For directory buckets in a CopyObject operation, only the empty tag-set
* is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a
* 501 Not Implemented status code. When the destination bucket is a directory bucket, you will receive
* a 501 Not Implemented response in any of the following situations:
*
*
* -
*
* When you attempt to COPY the tag-set from an S3 source object that has non-empty tags.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a source object and set a non-empty value to
* x-amz-tagging.
*
*
* -
*
* When you don't set the x-amz-tagging-directive header and the source object has non-empty tags. This
* is because the default value of x-amz-tagging-directive is COPY.
*
*
*
*
* Because only the empty tag-set is supported for directory buckets in a CopyObject operation, the
* following situations are allowed:
*
*
* -
*
* When you attempt to COPY the tag-set from a directory bucket source object that has no tags to a
* general purpose bucket. It copies an empty tag-set to the destination object.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a directory bucket source object and set the
* x-amz-tagging value of the directory bucket destination object to empty.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a general purpose bucket source object that has non-empty
* tags and set the x-amz-tagging value of the directory bucket destination object to empty.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a directory bucket source object and don't set the
* x-amz-tagging value of the directory bucket destination object. This is because the default value of
* x-amz-tagging is the empty value.
*
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #taggingDirective}
* will return {@link TaggingDirective#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #taggingDirectiveAsString}.
*
*
* @return Specifies whether the object tag-set is copied from the source object or replaced with the tag-set that's
* provided in the request.
*
* The default value is COPY.
*
*
*
* Directory buckets - For directory buckets in a CopyObject operation, only the empty
* tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will
* receive a 501 Not Implemented status code. When the destination bucket is a directory
* bucket, you will receive a 501 Not Implemented response in any of the following situations:
*
*
* -
*
* When you attempt to COPY the tag-set from an S3 source object that has non-empty tags.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a source object and set a non-empty value to
* x-amz-tagging.
*
*
* -
*
* When you don't set the x-amz-tagging-directive header and the source object has non-empty
* tags. This is because the default value of x-amz-tagging-directive is COPY.
*
*
*
*
* Because only the empty tag-set is supported for directory buckets in a CopyObject operation,
* the following situations are allowed:
*
*
* -
*
* When you attempt to COPY the tag-set from a directory bucket source object that has no tags
* to a general purpose bucket. It copies an empty tag-set to the destination object.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a directory bucket source object and set the
* x-amz-tagging value of the directory bucket destination object to empty.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a general purpose bucket source object that has
* non-empty tags and set the x-amz-tagging value of the directory bucket destination object to
* empty.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a directory bucket source object and don't set
* the x-amz-tagging value of the directory bucket destination object. This is because the
* default value of x-amz-tagging is the empty value.
*
*
*
* @see TaggingDirective
*/
public final String taggingDirectiveAsString() {
return taggingDirective;
}
/**
*
* The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse). Unrecognized or unsupported values won’t write a destination
* object and will receive a 400 Bad Request response.
*
*
* Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When copying an object, if you
* don't specify encryption information in your copy request, the encryption setting of the target object is set to
* the default encryption configuration of the destination bucket. By default, all buckets have a base level of
* encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the
* destination bucket has a default encryption configuration that uses server-side encryption with Key Management
* Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or
* server-side encryption with customer-provided encryption keys (SSE-C), Amazon S3 uses the corresponding KMS key,
* or a customer-provided key to encrypt the target object copy.
*
*
* When you perform a CopyObject operation, if you want to use a different type of encryption setting
* for the target object, you can specify appropriate encryption-related headers to encrypt the target object with
* an Amazon S3 managed key, a KMS key, or a customer-provided key. If the encryption setting in your request is
* different from the default encryption configuration of the destination bucket, the encryption setting in your
* request takes precedence.
*
*
* With server-side encryption, Amazon S3 encrypts your data as it writes your data to disks in its data centers and
* decrypts the data when you access it. For more information about server-side encryption, see Using Server-Side Encryption
* in the Amazon S3 User Guide.
*
*
*
* For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is
* supported.
*
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #serverSideEncryption} will return {@link ServerSideEncryption#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #serverSideEncryptionAsString}.
*
*
* @return The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
* AES256, aws:kms, aws:kms:dsse). Unrecognized or unsupported values
* won’t write a destination object and will receive a 400 Bad Request response.
*
* Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When copying an object,
* if you don't specify encryption information in your copy request, the encryption setting of the target
* object is set to the default encryption configuration of the destination bucket. By default, all buckets
* have a base level of encryption configuration that uses server-side encryption with Amazon S3 managed
* keys (SSE-S3). If the destination bucket has a default encryption configuration that uses server-side
* encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with
* Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with customer-provided encryption keys
* (SSE-C), Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the target
* object copy.
*
*
* When you perform a CopyObject operation, if you want to use a different type of encryption
* setting for the target object, you can specify appropriate encryption-related headers to encrypt the
* target object with an Amazon S3 managed key, a KMS key, or a customer-provided key. If the encryption
* setting in your request is different from the default encryption configuration of the destination bucket,
* the encryption setting in your request takes precedence.
*
*
* With server-side encryption, Amazon S3 encrypts your data as it writes your data to disks in its data
* centers and decrypts the data when you access it. For more information about server-side encryption, see
* Using Server-Side
* Encryption in the Amazon S3 User Guide.
*
*
*
* For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (
* AES256) is supported.
*
* @see ServerSideEncryption
*/
public final ServerSideEncryption serverSideEncryption() {
return ServerSideEncryption.fromValue(serverSideEncryption);
}
/**
*
* The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse). Unrecognized or unsupported values won’t write a destination
* object and will receive a 400 Bad Request response.
*
*
* Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When copying an object, if you
* don't specify encryption information in your copy request, the encryption setting of the target object is set to
* the default encryption configuration of the destination bucket. By default, all buckets have a base level of
* encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If the
* destination bucket has a default encryption configuration that uses server-side encryption with Key Management
* Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or
* server-side encryption with customer-provided encryption keys (SSE-C), Amazon S3 uses the corresponding KMS key,
* or a customer-provided key to encrypt the target object copy.
*
*
* When you perform a CopyObject operation, if you want to use a different type of encryption setting
* for the target object, you can specify appropriate encryption-related headers to encrypt the target object with
* an Amazon S3 managed key, a KMS key, or a customer-provided key. If the encryption setting in your request is
* different from the default encryption configuration of the destination bucket, the encryption setting in your
* request takes precedence.
*
*
* With server-side encryption, Amazon S3 encrypts your data as it writes your data to disks in its data centers and
* decrypts the data when you access it. For more information about server-side encryption, see Using Server-Side Encryption
* in the Amazon S3 User Guide.
*
*
*
* For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) is
* supported.
*
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #serverSideEncryption} will return {@link ServerSideEncryption#UNKNOWN_TO_SDK_VERSION}. The raw value
* returned by the service is available from {@link #serverSideEncryptionAsString}.
*
*
* @return The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
* AES256, aws:kms, aws:kms:dsse). Unrecognized or unsupported values
* won’t write a destination object and will receive a 400 Bad Request response.
*
* Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When copying an object,
* if you don't specify encryption information in your copy request, the encryption setting of the target
* object is set to the default encryption configuration of the destination bucket. By default, all buckets
* have a base level of encryption configuration that uses server-side encryption with Amazon S3 managed
* keys (SSE-S3). If the destination bucket has a default encryption configuration that uses server-side
* encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with
* Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with customer-provided encryption keys
* (SSE-C), Amazon S3 uses the corresponding KMS key, or a customer-provided key to encrypt the target
* object copy.
*
*
* When you perform a CopyObject operation, if you want to use a different type of encryption
* setting for the target object, you can specify appropriate encryption-related headers to encrypt the
* target object with an Amazon S3 managed key, a KMS key, or a customer-provided key. If the encryption
* setting in your request is different from the default encryption configuration of the destination bucket,
* the encryption setting in your request takes precedence.
*
*
* With server-side encryption, Amazon S3 encrypts your data as it writes your data to disks in its data
* centers and decrypts the data when you access it. For more information about server-side encryption, see
* Using Server-Side
* Encryption in the Amazon S3 User Guide.
*
*
*
* For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (
* AES256) is supported.
*
* @see ServerSideEncryption
*/
public final String serverSideEncryptionAsString() {
return serverSideEncryption;
}
/**
*
* If the x-amz-storage-class header is not used, the copied object will be stored in the
* STANDARD Storage Class by default. The STANDARD storage class provides high durability
* and high availability. Depending on performance needs, you can specify a different Storage Class.
*
*
*
* -
*
* Directory buckets - For directory buckets, only the S3 Express One Zone storage class is supported to
* store newly created objects. Unsupported storage class values won't write a destination object and will respond
* with the HTTP status code 400 Bad Request.
*
*
* -
*
* Amazon S3 on Outposts - S3 on Outposts only uses the OUTPOSTS Storage Class.
*
*
*
*
*
* You can use the CopyObject action to change the storage class of an object that is already stored in
* Amazon S3 by using the x-amz-storage-class header. For more information, see Storage Classes in the
* Amazon S3 User Guide.
*
*
* Before using an object as a source object for the copy operation, you must restore a copy of it if it meets any
* of the following conditions:
*
*
* -
*
* The storage class of the source object is GLACIER or DEEP_ARCHIVE.
*
*
* -
*
* The storage class of the source object is INTELLIGENT_TIERING and it's S3 Intelligent-Tiering access tier is Archive Access or Deep Archive Access.
*
*
*
*
* For more information, see RestoreObject and Copying Objects in the
* Amazon S3 User Guide.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #storageClass} will
* return {@link StorageClass#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #storageClassAsString}.
*
*
* @return If the x-amz-storage-class header is not used, the copied object will be stored in the
* STANDARD Storage Class by default. The STANDARD storage class provides high
* durability and high availability. Depending on performance needs, you can specify a different Storage
* Class.
*
* -
*
* Directory buckets - For directory buckets, only the S3 Express One Zone storage class is
* supported to store newly created objects. Unsupported storage class values won't write a destination
* object and will respond with the HTTP status code 400 Bad Request.
*
*
* -
*
* Amazon S3 on Outposts - S3 on Outposts only uses the OUTPOSTS Storage Class.
*
*
*
*
*
* You can use the CopyObject action to change the storage class of an object that is already
* stored in Amazon S3 by using the x-amz-storage-class header. For more information, see Storage Classes in
* the Amazon S3 User Guide.
*
*
* Before using an object as a source object for the copy operation, you must restore a copy of it if it
* meets any of the following conditions:
*
*
* -
*
* The storage class of the source object is GLACIER or DEEP_ARCHIVE.
*
*
* -
*
* The storage class of the source object is INTELLIGENT_TIERING and it's S3 Intelligent-Tiering access tier is Archive Access or
* Deep Archive Access.
*
*
*
*
* For more information, see RestoreObject and Copying Objects in
* the Amazon S3 User Guide.
* @see StorageClass
*/
public final StorageClass storageClass() {
return StorageClass.fromValue(storageClass);
}
/**
*
* If the x-amz-storage-class header is not used, the copied object will be stored in the
* STANDARD Storage Class by default. The STANDARD storage class provides high durability
* and high availability. Depending on performance needs, you can specify a different Storage Class.
*
*
*
* -
*
* Directory buckets - For directory buckets, only the S3 Express One Zone storage class is supported to
* store newly created objects. Unsupported storage class values won't write a destination object and will respond
* with the HTTP status code 400 Bad Request.
*
*
* -
*
* Amazon S3 on Outposts - S3 on Outposts only uses the OUTPOSTS Storage Class.
*
*
*
*
*
* You can use the CopyObject action to change the storage class of an object that is already stored in
* Amazon S3 by using the x-amz-storage-class header. For more information, see Storage Classes in the
* Amazon S3 User Guide.
*
*
* Before using an object as a source object for the copy operation, you must restore a copy of it if it meets any
* of the following conditions:
*
*
* -
*
* The storage class of the source object is GLACIER or DEEP_ARCHIVE.
*
*
* -
*
* The storage class of the source object is INTELLIGENT_TIERING and it's S3 Intelligent-Tiering access tier is Archive Access or Deep Archive Access.
*
*
*
*
* For more information, see RestoreObject and Copying Objects in the
* Amazon S3 User Guide.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #storageClass} will
* return {@link StorageClass#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #storageClassAsString}.
*
*
* @return If the x-amz-storage-class header is not used, the copied object will be stored in the
* STANDARD Storage Class by default. The STANDARD storage class provides high
* durability and high availability. Depending on performance needs, you can specify a different Storage
* Class.
*
* -
*
* Directory buckets - For directory buckets, only the S3 Express One Zone storage class is
* supported to store newly created objects. Unsupported storage class values won't write a destination
* object and will respond with the HTTP status code 400 Bad Request.
*
*
* -
*
* Amazon S3 on Outposts - S3 on Outposts only uses the OUTPOSTS Storage Class.
*
*
*
*
*
* You can use the CopyObject action to change the storage class of an object that is already
* stored in Amazon S3 by using the x-amz-storage-class header. For more information, see Storage Classes in
* the Amazon S3 User Guide.
*
*
* Before using an object as a source object for the copy operation, you must restore a copy of it if it
* meets any of the following conditions:
*
*
* -
*
* The storage class of the source object is GLACIER or DEEP_ARCHIVE.
*
*
* -
*
* The storage class of the source object is INTELLIGENT_TIERING and it's S3 Intelligent-Tiering access tier is Archive Access or
* Deep Archive Access.
*
*
*
*
* For more information, see RestoreObject and Copying Objects in
* the Amazon S3 User Guide.
* @see StorageClass
*/
public final String storageClassAsString() {
return storageClass;
}
/**
*
* If the destination bucket is configured as a website, redirects requests for this object copy to another object
* in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. This
* value is unique to each object and is not copied when using the x-amz-metadata-directive header.
* Instead, you may opt to provide this header in combination with the x-amz-metadata-directive header.
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* @return If the destination bucket is configured as a website, redirects requests for this object copy to another
* object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object
* metadata. This value is unique to each object and is not copied when using the
* x-amz-metadata-directive header. Instead, you may opt to provide this header in combination
* with the x-amz-metadata-directive header.
*
* This functionality is not supported for directory buckets.
*
*/
public final String websiteRedirectLocation() {
return websiteRedirectLocation;
}
/**
*
* Specifies the algorithm to use when encrypting the object (for example, AES256).
*
*
* When you perform a CopyObject operation, if you want to use a different type of encryption setting
* for the target object, you can specify appropriate encryption-related headers to encrypt the target object with
* an Amazon S3 managed key, a KMS key, or a customer-provided key. If the encryption setting in your request is
* different from the default encryption configuration of the destination bucket, the encryption setting in your
* request takes precedence.
*
*
*
* This functionality is not supported when the destination bucket is a directory bucket.
*
*
*
* @return Specifies the algorithm to use when encrypting the object (for example, AES256).
*
* When you perform a CopyObject operation, if you want to use a different type of encryption
* setting for the target object, you can specify appropriate encryption-related headers to encrypt the
* target object with an Amazon S3 managed key, a KMS key, or a customer-provided key. If the encryption
* setting in your request is different from the default encryption configuration of the destination bucket,
* the encryption setting in your request takes precedence.
*
*
*
* This functionality is not supported when the destination bucket is a directory bucket.
*
*/
public final String sseCustomerAlgorithm() {
return sseCustomerAlgorithm;
}
/**
*
* 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.
*
*
*
* This functionality is not supported when the destination bucket is a directory bucket.
*
*
*
* @return 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.
*
* This functionality is not supported when the destination bucket is a directory bucket.
*
*/
public final String sseCustomerKey() {
return sseCustomerKey;
}
/**
*
* 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.
*
*
*
* This functionality is not supported when the destination bucket is a directory bucket.
*
*
*
* @return 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.
*
* This functionality is not supported when the destination bucket is a directory bucket.
*
*/
public final String sseCustomerKeyMD5() {
return sseCustomerKeyMD5;
}
/**
*
* Specifies the KMS ID (Key ID, Key ARN, or Key Alias) to use for object encryption. All GET and PUT requests for
* an object protected by KMS will fail if they're not made via SSL or using SigV4. For information about
* configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying the
* Signature Version in Request Authentication in the Amazon S3 User Guide.
*
*
*
* This functionality is not supported when the destination bucket is a directory bucket.
*
*
*
* @return Specifies the KMS ID (Key ID, Key ARN, or Key Alias) to use for object encryption. All GET and PUT
* requests for an object protected by KMS will fail if they're not made via SSL or using SigV4. For
* information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web
* Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User Guide.
*
*
* This functionality is not supported when the destination bucket is a directory bucket.
*
*/
public final String ssekmsKeyId() {
return ssekmsKeyId;
}
/**
*
* Specifies the Amazon Web Services 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. This value must be
* explicitly added to specify encryption context for CopyObject requests.
*
*
*
* This functionality is not supported when the destination bucket is a directory bucket.
*
*
*
* @return Specifies the Amazon Web Services 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. This
* value must be explicitly added to specify encryption context for CopyObject requests.
*
*
* This functionality is not supported when the destination bucket is a directory bucket.
*
*/
public final String ssekmsEncryptionContext() {
return ssekmsEncryptionContext;
}
/**
*
* Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption using
* Key Management Service (KMS) keys (SSE-KMS). If a target object uses SSE-KMS, you can enable an S3 Bucket Key for
* the object.
*
*
* Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with
* SSE-KMS. Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.
*
*
* For more information, see Amazon S3
* Bucket Keys in the Amazon S3 User Guide.
*
*
*
* This functionality is not supported when the destination bucket is a directory bucket.
*
*
*
* @return Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption
* using Key Management Service (KMS) keys (SSE-KMS). If a target object uses SSE-KMS, you can enable an S3
* Bucket Key for the object.
*
* Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption
* with SSE-KMS. Specifying this header with a COPY action doesn’t affect bucket-level settings for S3
* Bucket Key.
*
*
* For more information, see Amazon S3 Bucket Keys in the
* Amazon S3 User Guide.
*
*
*
* This functionality is not supported when the destination bucket is a directory bucket.
*
*/
public final Boolean bucketKeyEnabled() {
return bucketKeyEnabled;
}
/**
*
* Specifies the algorithm to use when decrypting the source object (for example, AES256).
*
*
* If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary encryption
* information in your request so that Amazon S3 can decrypt the object for copying.
*
*
*
* This functionality is not supported when the source object is in a directory bucket.
*
*
*
* @return Specifies the algorithm to use when decrypting the source object (for example, AES256).
*
* If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary
* encryption information in your request so that Amazon S3 can decrypt the object for copying.
*
*
*
* This functionality is not supported when the source object is in a directory bucket.
*
*/
public final String copySourceSSECustomerAlgorithm() {
return copySourceSSECustomerAlgorithm;
}
/**
*
* 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 the same one that was used when the source object was created.
*
*
* If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary encryption
* information in your request so that Amazon S3 can decrypt the object for copying.
*
*
*
* This functionality is not supported when the source object is in a directory bucket.
*
*
*
* @return 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 the same one that was used when the source object was
* created.
*
* If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary
* encryption information in your request so that Amazon S3 can decrypt the object for copying.
*
*
*
* This functionality is not supported when the source object is in a directory bucket.
*
*/
public final String copySourceSSECustomerKey() {
return copySourceSSECustomerKey;
}
/**
*
* 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.
*
*
* If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary encryption
* information in your request so that Amazon S3 can decrypt the object for copying.
*
*
*
* This functionality is not supported when the source object is in a directory bucket.
*
*
*
* @return 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.
*
* If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary
* encryption information in your request so that Amazon S3 can decrypt the object for copying.
*
*
*
* This functionality is not supported when the source object is in a directory bucket.
*
*/
public final String copySourceSSECustomerKeyMD5() {
return copySourceSSECustomerKeyMD5;
}
/**
* 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, {@link #requestPayer} will
* return {@link RequestPayer#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #requestPayerAsString}.
*
*
* @return The value of the RequestPayer property for this object.
* @see RequestPayer
*/
public final RequestPayer requestPayer() {
return RequestPayer.fromValue(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, {@link #requestPayer} will
* return {@link RequestPayer#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #requestPayerAsString}.
*
*
* @return The value of the RequestPayer property for this object.
* @see RequestPayer
*/
public final String requestPayerAsString() {
return requestPayer;
}
/**
*
* The tag-set for the object copy in the destination bucket. This value must be used in conjunction with the
* x-amz-tagging-directive if you choose REPLACE for the
* x-amz-tagging-directive. If you choose COPY for the
* x-amz-tagging-directive, you don't need to set the x-amz-tagging header, because the
* tag-set will be copied from the source object directly. The tag-set must be encoded as URL Query parameters.
*
*
* The default value is the empty value.
*
*
*
* Directory buckets - For directory buckets in a CopyObject operation, only the empty tag-set
* is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a
* 501 Not Implemented status code. When the destination bucket is a directory bucket, you will receive
* a 501 Not Implemented response in any of the following situations:
*
*
* -
*
* When you attempt to COPY the tag-set from an S3 source object that has non-empty tags.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a source object and set a non-empty value to
* x-amz-tagging.
*
*
* -
*
* When you don't set the x-amz-tagging-directive header and the source object has non-empty tags. This
* is because the default value of x-amz-tagging-directive is COPY.
*
*
*
*
* Because only the empty tag-set is supported for directory buckets in a CopyObject operation, the
* following situations are allowed:
*
*
* -
*
* When you attempt to COPY the tag-set from a directory bucket source object that has no tags to a
* general purpose bucket. It copies an empty tag-set to the destination object.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a directory bucket source object and set the
* x-amz-tagging value of the directory bucket destination object to empty.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a general purpose bucket source object that has non-empty
* tags and set the x-amz-tagging value of the directory bucket destination object to empty.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a directory bucket source object and don't set the
* x-amz-tagging value of the directory bucket destination object. This is because the default value of
* x-amz-tagging is the empty value.
*
*
*
*
*
* @return The tag-set for the object copy in the destination bucket. This value must be used in conjunction with
* the x-amz-tagging-directive if you choose REPLACE for the
* x-amz-tagging-directive. If you choose COPY for the
* x-amz-tagging-directive, you don't need to set the x-amz-tagging header,
* because the tag-set will be copied from the source object directly. The tag-set must be encoded as URL
* Query parameters.
*
* The default value is the empty value.
*
*
*
* Directory buckets - For directory buckets in a CopyObject operation, only the empty
* tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will
* receive a 501 Not Implemented status code. When the destination bucket is a directory
* bucket, you will receive a 501 Not Implemented response in any of the following situations:
*
*
* -
*
* When you attempt to COPY the tag-set from an S3 source object that has non-empty tags.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a source object and set a non-empty value to
* x-amz-tagging.
*
*
* -
*
* When you don't set the x-amz-tagging-directive header and the source object has non-empty
* tags. This is because the default value of x-amz-tagging-directive is COPY.
*
*
*
*
* Because only the empty tag-set is supported for directory buckets in a CopyObject operation,
* the following situations are allowed:
*
*
* -
*
* When you attempt to COPY the tag-set from a directory bucket source object that has no tags
* to a general purpose bucket. It copies an empty tag-set to the destination object.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a directory bucket source object and set the
* x-amz-tagging value of the directory bucket destination object to empty.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a general purpose bucket source object that has
* non-empty tags and set the x-amz-tagging value of the directory bucket destination object to
* empty.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a directory bucket source object and don't set
* the x-amz-tagging value of the directory bucket destination object. This is because the
* default value of x-amz-tagging is the empty value.
*
*
*
*/
public final String tagging() {
return tagging;
}
/**
*
* The Object Lock mode that you want to apply to the object copy.
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #objectLockMode}
* will return {@link ObjectLockMode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #objectLockModeAsString}.
*
*
* @return The Object Lock mode that you want to apply to the object copy.
*
* This functionality is not supported for directory buckets.
*
* @see ObjectLockMode
*/
public final ObjectLockMode objectLockMode() {
return ObjectLockMode.fromValue(objectLockMode);
}
/**
*
* The Object Lock mode that you want to apply to the object copy.
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #objectLockMode}
* will return {@link ObjectLockMode#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available
* from {@link #objectLockModeAsString}.
*
*
* @return The Object Lock mode that you want to apply to the object copy.
*
* This functionality is not supported for directory buckets.
*
* @see ObjectLockMode
*/
public final String objectLockModeAsString() {
return objectLockMode;
}
/**
*
* The date and time when you want the Object Lock of the object copy to expire.
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* @return The date and time when you want the Object Lock of the object copy to expire.
*
* This functionality is not supported for directory buckets.
*
*/
public final Instant objectLockRetainUntilDate() {
return objectLockRetainUntilDate;
}
/**
*
* Specifies whether you want to apply a legal hold to the object copy.
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #objectLockLegalHoldStatus} will return {@link ObjectLockLegalHoldStatus#UNKNOWN_TO_SDK_VERSION}. The raw
* value returned by the service is available from {@link #objectLockLegalHoldStatusAsString}.
*
*
* @return Specifies whether you want to apply a legal hold to the object copy.
*
* This functionality is not supported for directory buckets.
*
* @see ObjectLockLegalHoldStatus
*/
public final ObjectLockLegalHoldStatus objectLockLegalHoldStatus() {
return ObjectLockLegalHoldStatus.fromValue(objectLockLegalHoldStatus);
}
/**
*
* Specifies whether you want to apply a legal hold to the object copy.
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* If the service returns an enum value that is not available in the current SDK version,
* {@link #objectLockLegalHoldStatus} will return {@link ObjectLockLegalHoldStatus#UNKNOWN_TO_SDK_VERSION}. The raw
* value returned by the service is available from {@link #objectLockLegalHoldStatusAsString}.
*
*
* @return Specifies whether you want to apply a legal hold to the object copy.
*
* This functionality is not supported for directory buckets.
*
* @see ObjectLockLegalHoldStatus
*/
public final String objectLockLegalHoldStatusAsString() {
return objectLockLegalHoldStatus;
}
/**
*
* The account ID of the expected destination bucket owner. If the account ID that you provide does not match the
* actual owner of the destination bucket, the request fails with the HTTP status code 403 Forbidden
* (access denied).
*
*
* @return The account ID of the expected destination bucket owner. If the account ID that you provide does not
* match the actual owner of the destination bucket, the request fails with the HTTP status code
* 403 Forbidden (access denied).
*/
public final String expectedBucketOwner() {
return expectedBucketOwner;
}
/**
*
* The account ID of the expected source bucket owner. If the account ID that you provide does not match the actual
* owner of the source bucket, the request fails with the HTTP status code 403 Forbidden (access
* denied).
*
*
* @return The account ID of the expected source bucket owner. If the account ID that you provide does not match the
* actual owner of the source bucket, the request fails with the HTTP status code 403 Forbidden
* (access denied).
*/
public final String expectedSourceBucketOwner() {
return expectedSourceBucketOwner;
}
/**
*
* The name of the destination bucket.
*
*
* Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style
* requests in the format Bucket_name.s3express-az_id.region.amazonaws.com.
* Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone.
* Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example,
* DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming
* restrictions, see Directory bucket
* naming rules in the Amazon S3 User Guide.
*
*
* Access points - When you use this action with an access point, you must provide the alias of the access
* point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must
* direct requests to the access point hostname. The access point hostname takes the form
* AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with
* an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket
* name. For more information about access point ARNs, see Using access points in
* the Amazon S3 User Guide.
*
*
*
* Access points and Object Lambda access points are not supported by directory buckets.
*
*
*
* S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3
* on Outposts hostname. The S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
* When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the
* Amazon S3 User Guide.
*
*
* @return The name of the destination bucket.
*
* Directory buckets - When you use this operation with a directory bucket, you must use
* virtual-hosted-style requests in the format
* Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests
* are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names
* must follow the format bucket_base_name--az-id--x-s3 (for example,
* DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming
* restrictions, see Directory
* bucket naming rules in the Amazon S3 User Guide.
*
*
* Access points - When you use this action with an access point, you must provide the alias of the
* access point in place of the bucket name or specify the access point ARN. When using the access point
* ARN, you must direct requests to the access point hostname. The access point hostname takes the form
* AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this
* action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in
* place of the bucket name. For more information about access point ARNs, see Using access
* points in the Amazon S3 User Guide.
*
*
*
* Access points and Object Lambda access points are not supported by directory buckets.
*
*
*
* S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to
* the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
* . When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the
* Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs,
* see What is S3 on
* Outposts? in the Amazon S3 User Guide.
* @deprecated Use {@link #destinationBucket()}
*/
@Deprecated
public final String bucket() {
return destinationBucket;
}
/**
*
* The name of the destination bucket.
*
*
* Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style
* requests in the format Bucket_name.s3express-az_id.region.amazonaws.com.
* Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone.
* Bucket names must follow the format bucket_base_name--az-id--x-s3 (for example,
* DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming
* restrictions, see Directory bucket
* naming rules in the Amazon S3 User Guide.
*
*
* Access points - When you use this action with an access point, you must provide the alias of the access
* point in place of the bucket name or specify the access point ARN. When using the access point ARN, you must
* direct requests to the access point hostname. The access point hostname takes the form
* AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action with
* an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the bucket
* name. For more information about access point ARNs, see Using access points in
* the Amazon S3 User Guide.
*
*
*
* Access points and Object Lambda access points are not supported by directory buckets.
*
*
*
* S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the S3
* on Outposts hostname. The S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com.
* When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the
* Amazon S3 User Guide.
*
*
* @return The name of the destination bucket.
*
* Directory buckets - When you use this operation with a directory bucket, you must use
* virtual-hosted-style requests in the format
* Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests
* are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names
* must follow the format bucket_base_name--az-id--x-s3 (for example,
* DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming
* restrictions, see Directory
* bucket naming rules in the Amazon S3 User Guide.
*
*
* Access points - When you use this action with an access point, you must provide the alias of the
* access point in place of the bucket name or specify the access point ARN. When using the access point
* ARN, you must direct requests to the access point hostname. The access point hostname takes the form
* AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this
* action with an access point through the Amazon Web Services SDKs, you provide the access point ARN in
* place of the bucket name. For more information about access point ARNs, see Using access
* points in the Amazon S3 User Guide.
*
*
*
* Access points and Object Lambda access points are not supported by directory buckets.
*
*
*
* S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to
* the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
* . When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the
* Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs,
* see What is S3 on
* Outposts? in the Amazon S3 User Guide.
*/
public final String destinationBucket() {
return destinationBucket;
}
/**
*
* The key of the destination object.
*
*
* @return The key of the destination object.
* @deprecated Use {@link #destinationKey()}
*/
@Deprecated
public final String key() {
return destinationKey;
}
/**
*
* The key of the destination object.
*
*
* @return The key of the destination object.
*/
public final String destinationKey() {
return destinationKey;
}
/**
* The name of the bucket containing the object to copy. The provided input will be URL encoded. The
* {@code sourceBucket}, {@code sourceKey}, and {@code sourceVersionId} parameters must not be used in conjunction
* with the {@code copySource} parameter.
*
* @return The name of the bucket containing the object to copy. The provided input will be URL encoded. The
* {@code sourceBucket}, {@code sourceKey}, and {@code sourceVersionId} parameters must not be used in
* conjunction with the {@code copySource} parameter.
*/
public final String sourceBucket() {
return sourceBucket;
}
/**
* The key of the object to copy. The provided input will be URL encoded. The {@code sourceBucket},
* {@code sourceKey}, and {@code sourceVersionId} parameters must not be used in conjunction with the
* {@code copySource} parameter.
*
* @return The key of the object to copy. The provided input will be URL encoded. The {@code sourceBucket},
* {@code sourceKey}, and {@code sourceVersionId} parameters must not be used in conjunction with the
* {@code copySource} parameter.
*/
public final String sourceKey() {
return sourceKey;
}
/**
* Specifies a particular version of the source object to copy. By default the latest version is copied. The
* {@code sourceBucket}, {@code sourceKey}, and {@code sourceVersionId} parameters must not be used in conjunction
* with the {@code copySource} parameter.
*
* @return Specifies a particular version of the source object to copy. By default the latest version is copied. The
* {@code sourceBucket}, {@code sourceKey}, and {@code sourceVersionId} parameters must not be used in
* conjunction with the {@code copySource} parameter.
*/
public final String sourceVersionId() {
return sourceVersionId;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(aclAsString());
hashCode = 31 * hashCode + Objects.hashCode(cacheControl());
hashCode = 31 * hashCode + Objects.hashCode(checksumAlgorithmAsString());
hashCode = 31 * hashCode + Objects.hashCode(contentDisposition());
hashCode = 31 * hashCode + Objects.hashCode(contentEncoding());
hashCode = 31 * hashCode + Objects.hashCode(contentLanguage());
hashCode = 31 * hashCode + Objects.hashCode(contentType());
hashCode = 31 * hashCode + Objects.hashCode(copySource());
hashCode = 31 * hashCode + Objects.hashCode(copySourceIfMatch());
hashCode = 31 * hashCode + Objects.hashCode(copySourceIfModifiedSince());
hashCode = 31 * hashCode + Objects.hashCode(copySourceIfNoneMatch());
hashCode = 31 * hashCode + Objects.hashCode(copySourceIfUnmodifiedSince());
hashCode = 31 * hashCode + Objects.hashCode(expires());
hashCode = 31 * hashCode + Objects.hashCode(grantFullControl());
hashCode = 31 * hashCode + Objects.hashCode(grantRead());
hashCode = 31 * hashCode + Objects.hashCode(grantReadACP());
hashCode = 31 * hashCode + Objects.hashCode(grantWriteACP());
hashCode = 31 * hashCode + Objects.hashCode(hasMetadata() ? metadata() : null);
hashCode = 31 * hashCode + Objects.hashCode(metadataDirectiveAsString());
hashCode = 31 * hashCode + Objects.hashCode(taggingDirectiveAsString());
hashCode = 31 * hashCode + Objects.hashCode(serverSideEncryptionAsString());
hashCode = 31 * hashCode + Objects.hashCode(storageClassAsString());
hashCode = 31 * hashCode + Objects.hashCode(websiteRedirectLocation());
hashCode = 31 * hashCode + Objects.hashCode(sseCustomerAlgorithm());
hashCode = 31 * hashCode + Objects.hashCode(sseCustomerKey());
hashCode = 31 * hashCode + Objects.hashCode(sseCustomerKeyMD5());
hashCode = 31 * hashCode + Objects.hashCode(ssekmsKeyId());
hashCode = 31 * hashCode + Objects.hashCode(ssekmsEncryptionContext());
hashCode = 31 * hashCode + Objects.hashCode(bucketKeyEnabled());
hashCode = 31 * hashCode + Objects.hashCode(copySourceSSECustomerAlgorithm());
hashCode = 31 * hashCode + Objects.hashCode(copySourceSSECustomerKey());
hashCode = 31 * hashCode + Objects.hashCode(copySourceSSECustomerKeyMD5());
hashCode = 31 * hashCode + Objects.hashCode(requestPayerAsString());
hashCode = 31 * hashCode + Objects.hashCode(tagging());
hashCode = 31 * hashCode + Objects.hashCode(objectLockModeAsString());
hashCode = 31 * hashCode + Objects.hashCode(objectLockRetainUntilDate());
hashCode = 31 * hashCode + Objects.hashCode(objectLockLegalHoldStatusAsString());
hashCode = 31 * hashCode + Objects.hashCode(expectedBucketOwner());
hashCode = 31 * hashCode + Objects.hashCode(expectedSourceBucketOwner());
hashCode = 31 * hashCode + Objects.hashCode(destinationBucket());
hashCode = 31 * hashCode + Objects.hashCode(destinationKey());
hashCode = 31 * hashCode + Objects.hashCode(sourceBucket());
hashCode = 31 * hashCode + Objects.hashCode(sourceKey());
hashCode = 31 * hashCode + Objects.hashCode(sourceVersionId());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CopyObjectRequest)) {
return false;
}
CopyObjectRequest other = (CopyObjectRequest) obj;
return Objects.equals(aclAsString(), other.aclAsString()) && Objects.equals(cacheControl(), other.cacheControl())
&& Objects.equals(checksumAlgorithmAsString(), other.checksumAlgorithmAsString())
&& Objects.equals(contentDisposition(), other.contentDisposition())
&& Objects.equals(contentEncoding(), other.contentEncoding())
&& Objects.equals(contentLanguage(), other.contentLanguage())
&& Objects.equals(contentType(), other.contentType()) && Objects.equals(copySource(), other.copySource())
&& Objects.equals(copySourceIfMatch(), other.copySourceIfMatch())
&& Objects.equals(copySourceIfModifiedSince(), other.copySourceIfModifiedSince())
&& Objects.equals(copySourceIfNoneMatch(), other.copySourceIfNoneMatch())
&& Objects.equals(copySourceIfUnmodifiedSince(), other.copySourceIfUnmodifiedSince())
&& Objects.equals(expires(), other.expires()) && Objects.equals(grantFullControl(), other.grantFullControl())
&& Objects.equals(grantRead(), other.grantRead()) && Objects.equals(grantReadACP(), other.grantReadACP())
&& Objects.equals(grantWriteACP(), other.grantWriteACP()) && hasMetadata() == other.hasMetadata()
&& Objects.equals(metadata(), other.metadata())
&& Objects.equals(metadataDirectiveAsString(), other.metadataDirectiveAsString())
&& Objects.equals(taggingDirectiveAsString(), other.taggingDirectiveAsString())
&& Objects.equals(serverSideEncryptionAsString(), other.serverSideEncryptionAsString())
&& Objects.equals(storageClassAsString(), other.storageClassAsString())
&& Objects.equals(websiteRedirectLocation(), other.websiteRedirectLocation())
&& Objects.equals(sseCustomerAlgorithm(), other.sseCustomerAlgorithm())
&& Objects.equals(sseCustomerKey(), other.sseCustomerKey())
&& Objects.equals(sseCustomerKeyMD5(), other.sseCustomerKeyMD5())
&& Objects.equals(ssekmsKeyId(), other.ssekmsKeyId())
&& Objects.equals(ssekmsEncryptionContext(), other.ssekmsEncryptionContext())
&& Objects.equals(bucketKeyEnabled(), other.bucketKeyEnabled())
&& Objects.equals(copySourceSSECustomerAlgorithm(), other.copySourceSSECustomerAlgorithm())
&& Objects.equals(copySourceSSECustomerKey(), other.copySourceSSECustomerKey())
&& Objects.equals(copySourceSSECustomerKeyMD5(), other.copySourceSSECustomerKeyMD5())
&& Objects.equals(requestPayerAsString(), other.requestPayerAsString())
&& Objects.equals(tagging(), other.tagging())
&& Objects.equals(objectLockModeAsString(), other.objectLockModeAsString())
&& Objects.equals(objectLockRetainUntilDate(), other.objectLockRetainUntilDate())
&& Objects.equals(objectLockLegalHoldStatusAsString(), other.objectLockLegalHoldStatusAsString())
&& Objects.equals(expectedBucketOwner(), other.expectedBucketOwner())
&& Objects.equals(expectedSourceBucketOwner(), other.expectedSourceBucketOwner())
&& Objects.equals(destinationBucket(), other.destinationBucket())
&& Objects.equals(destinationKey(), other.destinationKey())
&& Objects.equals(sourceBucket(), other.sourceBucket()) && Objects.equals(sourceKey(), other.sourceKey())
&& Objects.equals(sourceVersionId(), other.sourceVersionId());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("CopyObjectRequest").add("ACL", aclAsString()).add("CacheControl", cacheControl())
.add("ChecksumAlgorithm", checksumAlgorithmAsString()).add("ContentDisposition", contentDisposition())
.add("ContentEncoding", contentEncoding()).add("ContentLanguage", contentLanguage())
.add("ContentType", contentType()).add("CopySource", copySource()).add("CopySourceIfMatch", copySourceIfMatch())
.add("CopySourceIfModifiedSince", copySourceIfModifiedSince())
.add("CopySourceIfNoneMatch", copySourceIfNoneMatch())
.add("CopySourceIfUnmodifiedSince", copySourceIfUnmodifiedSince()).add("Expires", expires())
.add("GrantFullControl", grantFullControl()).add("GrantRead", grantRead()).add("GrantReadACP", grantReadACP())
.add("GrantWriteACP", grantWriteACP()).add("Metadata", hasMetadata() ? metadata() : null)
.add("MetadataDirective", metadataDirectiveAsString()).add("TaggingDirective", taggingDirectiveAsString())
.add("ServerSideEncryption", serverSideEncryptionAsString()).add("StorageClass", storageClassAsString())
.add("WebsiteRedirectLocation", websiteRedirectLocation()).add("SSECustomerAlgorithm", sseCustomerAlgorithm())
.add("SSECustomerKey", sseCustomerKey() == null ? null : "*** Sensitive Data Redacted ***")
.add("SSECustomerKeyMD5", sseCustomerKeyMD5())
.add("SSEKMSKeyId", ssekmsKeyId() == null ? null : "*** Sensitive Data Redacted ***")
.add("SSEKMSEncryptionContext", ssekmsEncryptionContext() == null ? null : "*** Sensitive Data Redacted ***")
.add("BucketKeyEnabled", bucketKeyEnabled())
.add("CopySourceSSECustomerAlgorithm", copySourceSSECustomerAlgorithm())
.add("CopySourceSSECustomerKey", copySourceSSECustomerKey() == null ? null : "*** Sensitive Data Redacted ***")
.add("CopySourceSSECustomerKeyMD5", copySourceSSECustomerKeyMD5()).add("RequestPayer", requestPayerAsString())
.add("Tagging", tagging()).add("ObjectLockMode", objectLockModeAsString())
.add("ObjectLockRetainUntilDate", objectLockRetainUntilDate())
.add("ObjectLockLegalHoldStatus", objectLockLegalHoldStatusAsString())
.add("ExpectedBucketOwner", expectedBucketOwner()).add("ExpectedSourceBucketOwner", expectedSourceBucketOwner())
.add("DestinationBucket", destinationBucket()).add("DestinationKey", destinationKey())
.add("SourceBucket", sourceBucket()).add("SourceKey", sourceKey()).add("SourceVersionId", sourceVersionId())
.build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ACL":
return Optional.ofNullable(clazz.cast(aclAsString()));
case "CacheControl":
return Optional.ofNullable(clazz.cast(cacheControl()));
case "ChecksumAlgorithm":
return Optional.ofNullable(clazz.cast(checksumAlgorithmAsString()));
case "ContentDisposition":
return Optional.ofNullable(clazz.cast(contentDisposition()));
case "ContentEncoding":
return Optional.ofNullable(clazz.cast(contentEncoding()));
case "ContentLanguage":
return Optional.ofNullable(clazz.cast(contentLanguage()));
case "ContentType":
return Optional.ofNullable(clazz.cast(contentType()));
case "CopySource":
return Optional.ofNullable(clazz.cast(copySource()));
case "CopySourceIfMatch":
return Optional.ofNullable(clazz.cast(copySourceIfMatch()));
case "CopySourceIfModifiedSince":
return Optional.ofNullable(clazz.cast(copySourceIfModifiedSince()));
case "CopySourceIfNoneMatch":
return Optional.ofNullable(clazz.cast(copySourceIfNoneMatch()));
case "CopySourceIfUnmodifiedSince":
return Optional.ofNullable(clazz.cast(copySourceIfUnmodifiedSince()));
case "Expires":
return Optional.ofNullable(clazz.cast(expires()));
case "GrantFullControl":
return Optional.ofNullable(clazz.cast(grantFullControl()));
case "GrantRead":
return Optional.ofNullable(clazz.cast(grantRead()));
case "GrantReadACP":
return Optional.ofNullable(clazz.cast(grantReadACP()));
case "GrantWriteACP":
return Optional.ofNullable(clazz.cast(grantWriteACP()));
case "Metadata":
return Optional.ofNullable(clazz.cast(metadata()));
case "MetadataDirective":
return Optional.ofNullable(clazz.cast(metadataDirectiveAsString()));
case "TaggingDirective":
return Optional.ofNullable(clazz.cast(taggingDirectiveAsString()));
case "ServerSideEncryption":
return Optional.ofNullable(clazz.cast(serverSideEncryptionAsString()));
case "StorageClass":
return Optional.ofNullable(clazz.cast(storageClassAsString()));
case "WebsiteRedirectLocation":
return Optional.ofNullable(clazz.cast(websiteRedirectLocation()));
case "SSECustomerAlgorithm":
return Optional.ofNullable(clazz.cast(sseCustomerAlgorithm()));
case "SSECustomerKey":
return Optional.ofNullable(clazz.cast(sseCustomerKey()));
case "SSECustomerKeyMD5":
return Optional.ofNullable(clazz.cast(sseCustomerKeyMD5()));
case "SSEKMSKeyId":
return Optional.ofNullable(clazz.cast(ssekmsKeyId()));
case "SSEKMSEncryptionContext":
return Optional.ofNullable(clazz.cast(ssekmsEncryptionContext()));
case "BucketKeyEnabled":
return Optional.ofNullable(clazz.cast(bucketKeyEnabled()));
case "CopySourceSSECustomerAlgorithm":
return Optional.ofNullable(clazz.cast(copySourceSSECustomerAlgorithm()));
case "CopySourceSSECustomerKey":
return Optional.ofNullable(clazz.cast(copySourceSSECustomerKey()));
case "CopySourceSSECustomerKeyMD5":
return Optional.ofNullable(clazz.cast(copySourceSSECustomerKeyMD5()));
case "RequestPayer":
return Optional.ofNullable(clazz.cast(requestPayerAsString()));
case "Tagging":
return Optional.ofNullable(clazz.cast(tagging()));
case "ObjectLockMode":
return Optional.ofNullable(clazz.cast(objectLockModeAsString()));
case "ObjectLockRetainUntilDate":
return Optional.ofNullable(clazz.cast(objectLockRetainUntilDate()));
case "ObjectLockLegalHoldStatus":
return Optional.ofNullable(clazz.cast(objectLockLegalHoldStatusAsString()));
case "ExpectedBucketOwner":
return Optional.ofNullable(clazz.cast(expectedBucketOwner()));
case "ExpectedSourceBucketOwner":
return Optional.ofNullable(clazz.cast(expectedSourceBucketOwner()));
case "DestinationBucket":
return Optional.ofNullable(clazz.cast(destinationBucket()));
case "Bucket":
return Optional.ofNullable(clazz.cast(destinationBucket()));
case "DestinationKey":
return Optional.ofNullable(clazz.cast(destinationKey()));
case "Key":
return Optional.ofNullable(clazz.cast(destinationKey()));
case "SourceBucket":
return Optional.ofNullable(clazz.cast(sourceBucket()));
case "SourceKey":
return Optional.ofNullable(clazz.cast(sourceKey()));
case "SourceVersionId":
return Optional.ofNullable(clazz.cast(sourceVersionId()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CopyObjectRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends S3Request.Builder, SdkPojo, CopyableBuilder {
/**
*
* The canned access control list (ACL) to apply to the object.
*
*
* When you copy an object, the ACL metadata is not preserved and is set to private by default.
* Only the owner has full access control. To override the default ACL setting, specify a new ACL when you
* generate a copy request. For more information, see Using ACLs.
*
*
* If the destination bucket that you're copying objects to uses the bucket owner enforced setting for S3 Object
* Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept
* PUT requests that don't specify an ACL or PUT requests that specify bucket owner
* full control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of
* this ACL expressed in the XML format. For more information, see Controlling
* ownership of objects and disabling ACLs in the Amazon S3 User Guide.
*
*
*
* -
*
* If your destination bucket uses the bucket owner enforced setting for Object Ownership, all objects written
* to the bucket by any account will be owned by the bucket owner.
*
*
* -
*
* This functionality is not supported for directory buckets.
*
*
* -
*
* This functionality is not supported for Amazon S3 on Outposts.
*
*
*
*
*
* @param acl
* The canned access control list (ACL) to apply to the object.
*
* When you copy an object, the ACL metadata is not preserved and is set to private by
* default. Only the owner has full access control. To override the default ACL setting, specify a new
* ACL when you generate a copy request. For more information, see Using ACLs.
*
*
* If the destination bucket that you're copying objects to uses the bucket owner enforced setting for S3
* Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting
* only accept PUT requests that don't specify an ACL or PUT requests that
* specify bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL
* or an equivalent form of this ACL expressed in the XML format. For more information, see Controlling
* ownership of objects and disabling ACLs in the Amazon S3 User Guide.
*
*
*
* -
*
* If your destination bucket uses the bucket owner enforced setting for Object Ownership, all objects
* written to the bucket by any account will be owned by the bucket owner.
*
*
* -
*
* This functionality is not supported for directory buckets.
*
*
* -
*
* This functionality is not supported for Amazon S3 on Outposts.
*
*
*
* @see ObjectCannedACL
* @return Returns a reference to this object so that method calls can be chained together.
* @see ObjectCannedACL
*/
Builder acl(String acl);
/**
*
* The canned access control list (ACL) to apply to the object.
*
*
* When you copy an object, the ACL metadata is not preserved and is set to private by default.
* Only the owner has full access control. To override the default ACL setting, specify a new ACL when you
* generate a copy request. For more information, see Using ACLs.
*
*
* If the destination bucket that you're copying objects to uses the bucket owner enforced setting for S3 Object
* Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting only accept
* PUT requests that don't specify an ACL or PUT requests that specify bucket owner
* full control ACLs, such as the bucket-owner-full-control canned ACL or an equivalent form of
* this ACL expressed in the XML format. For more information, see Controlling
* ownership of objects and disabling ACLs in the Amazon S3 User Guide.
*
*
*
* -
*
* If your destination bucket uses the bucket owner enforced setting for Object Ownership, all objects written
* to the bucket by any account will be owned by the bucket owner.
*
*
* -
*
* This functionality is not supported for directory buckets.
*
*
* -
*
* This functionality is not supported for Amazon S3 on Outposts.
*
*
*
*
*
* @param acl
* The canned access control list (ACL) to apply to the object.
*
* When you copy an object, the ACL metadata is not preserved and is set to private by
* default. Only the owner has full access control. To override the default ACL setting, specify a new
* ACL when you generate a copy request. For more information, see Using ACLs.
*
*
* If the destination bucket that you're copying objects to uses the bucket owner enforced setting for S3
* Object Ownership, ACLs are disabled and no longer affect permissions. Buckets that use this setting
* only accept PUT requests that don't specify an ACL or PUT requests that
* specify bucket owner full control ACLs, such as the bucket-owner-full-control canned ACL
* or an equivalent form of this ACL expressed in the XML format. For more information, see Controlling
* ownership of objects and disabling ACLs in the Amazon S3 User Guide.
*
*
*
* -
*
* If your destination bucket uses the bucket owner enforced setting for Object Ownership, all objects
* written to the bucket by any account will be owned by the bucket owner.
*
*
* -
*
* This functionality is not supported for directory buckets.
*
*
* -
*
* This functionality is not supported for Amazon S3 on Outposts.
*
*
*
* @see ObjectCannedACL
* @return Returns a reference to this object so that method calls can be chained together.
* @see ObjectCannedACL
*/
Builder acl(ObjectCannedACL acl);
/**
*
* Specifies the caching behavior along the request/reply chain.
*
*
* @param cacheControl
* Specifies the caching behavior along the request/reply chain.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder cacheControl(String cacheControl);
/**
*
* Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more
* information, see Checking object
* integrity in the Amazon S3 User Guide.
*
*
* When you copy an object, if the source object has a checksum, that checksum value will be copied to the new
* object by default. If the CopyObject request does not include this
* x-amz-checksum-algorithm header, the checksum algorithm will be copied from the source object to
* the destination object (if it's present on the source object). You can optionally specify a different
* checksum algorithm to use with the x-amz-checksum-algorithm header. Unrecognized or unsupported
* values will respond with the HTTP status code 400 Bad Request.
*
*
*
* For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum
* algorithm that's used for performance.
*
*
*
* @param checksumAlgorithm
* Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more
* information, see Checking
* object integrity in the Amazon S3 User Guide.
*
* When you copy an object, if the source object has a checksum, that checksum value will be copied to
* the new object by default. If the CopyObject request does not include this
* x-amz-checksum-algorithm header, the checksum algorithm will be copied from the source
* object to the destination object (if it's present on the source object). You can optionally specify a
* different checksum algorithm to use with the x-amz-checksum-algorithm header.
* Unrecognized or unsupported values will respond with the HTTP status code 400 Bad Request
* .
*
*
*
* For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default
* checksum algorithm that's used for performance.
*
* @see ChecksumAlgorithm
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChecksumAlgorithm
*/
Builder checksumAlgorithm(String checksumAlgorithm);
/**
*
* Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more
* information, see Checking object
* integrity in the Amazon S3 User Guide.
*
*
* When you copy an object, if the source object has a checksum, that checksum value will be copied to the new
* object by default. If the CopyObject request does not include this
* x-amz-checksum-algorithm header, the checksum algorithm will be copied from the source object to
* the destination object (if it's present on the source object). You can optionally specify a different
* checksum algorithm to use with the x-amz-checksum-algorithm header. Unrecognized or unsupported
* values will respond with the HTTP status code 400 Bad Request.
*
*
*
* For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default checksum
* algorithm that's used for performance.
*
*
*
* @param checksumAlgorithm
* Indicates the algorithm that you want Amazon S3 to use to create the checksum for the object. For more
* information, see Checking
* object integrity in the Amazon S3 User Guide.
*
* When you copy an object, if the source object has a checksum, that checksum value will be copied to
* the new object by default. If the CopyObject request does not include this
* x-amz-checksum-algorithm header, the checksum algorithm will be copied from the source
* object to the destination object (if it's present on the source object). You can optionally specify a
* different checksum algorithm to use with the x-amz-checksum-algorithm header.
* Unrecognized or unsupported values will respond with the HTTP status code 400 Bad Request
* .
*
*
*
* For directory buckets, when you use Amazon Web Services SDKs, CRC32 is the default
* checksum algorithm that's used for performance.
*
* @see ChecksumAlgorithm
* @return Returns a reference to this object so that method calls can be chained together.
* @see ChecksumAlgorithm
*/
Builder checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm);
/**
*
* Specifies presentational information for the object. Indicates whether an object should be displayed in a web
* browser or downloaded as a file. It allows specifying the desired filename for the downloaded file.
*
*
* @param contentDisposition
* Specifies presentational information for the object. Indicates whether an object should be displayed
* in a web browser or downloaded as a file. It allows specifying the desired filename for the downloaded
* file.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder contentDisposition(String contentDisposition);
/**
*
* 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.
*
*
*
* For directory buckets, only the aws-chunked value is supported in this header field.
*
*
*
* @param 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.
*
* For directory buckets, only the aws-chunked value is supported in this header field.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder contentEncoding(String contentEncoding);
/**
*
* The language the content is in.
*
*
* @param contentLanguage
* The language the content is in.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder contentLanguage(String contentLanguage);
/**
*
* A standard MIME type that describes the format of the object data.
*
*
* @param contentType
* A standard MIME type that describes the format of the object data.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder contentType(String contentType);
/**
*
* Specifies the source object for the copy operation. The source object can be up to 5 GB. If the source object
* is an object that was uploaded by using a multipart upload, the object copy will be a single part object
* after the source object is copied to the destination bucket.
*
*
* You specify the value of the copy source in one of two formats, depending on whether you want to access the
* source object through an access point:
*
*
* -
*
* For objects not accessed through an access point, specify the name of the source bucket and the key of the
* source object, separated by a slash (/). For example, to copy the object reports/january.pdf
* from the general purpose bucket awsexamplebucket, use
* awsexamplebucket/reports/january.pdf. The value must be URL-encoded. To copy the object
* reports/january.pdf from the directory bucket awsexamplebucket--use1-az5--x-s3, use
* awsexamplebucket--use1-az5--x-s3/reports/january.pdf. The value must be URL-encoded.
*
*
* -
*
* For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as accessed
* through the access point, in the format
* arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>
* . For example, to copy the object reports/january.pdf through access point
* my-access-point owned by account 123456789012 in Region us-west-2, use
* the URL encoding of
* arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf. The
* value must be URL encoded.
*
*
*
* -
*
* Amazon S3 supports copy operations using Access points only when the source and destination buckets are in
* the same Amazon Web Services Region.
*
*
* -
*
* Access points are not supported by directory buckets.
*
*
*
*
*
* Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as accessed
* in the format
* arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>
* . For example, to copy the object reports/january.pdf through outpost my-outpost
* owned by account 123456789012 in Region us-west-2, use the URL encoding of
* arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf. The
* value must be URL-encoded.
*
*
*
*
* If your source bucket versioning is enabled, the x-amz-copy-source header by default identifies
* the current version of an object to copy. If the current version is a delete marker, Amazon S3 behaves as if
* the object was deleted. To copy a different version, use the versionId query parameter.
* Specifically, append ?versionId=<version-id> to the value (for example,
* awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If you
* don't specify a version ID, Amazon S3 copies the latest version of the source object.
*
*
* If you enable versioning on the destination bucket, Amazon S3 generates a unique version ID for the copied
* object. This version ID is different from the version ID of the source object. Amazon S3 returns the version
* ID of the copied object in the x-amz-version-id response header in the response.
*
*
* If you do not enable versioning or suspend it on the destination bucket, the version ID that Amazon S3
* generates in the x-amz-version-id response header is always null.
*
*
*
* Directory buckets - S3 Versioning isn't enabled and supported for directory buckets.
*
*
*
* @param copySource
* Specifies the source object for the copy operation. The source object can be up to 5 GB. If the source
* object is an object that was uploaded by using a multipart upload, the object copy will be a single
* part object after the source object is copied to the destination bucket.
*
* You specify the value of the copy source in one of two formats, depending on whether you want to
* access the source object through an access point:
*
*
* -
*
* For objects not accessed through an access point, specify the name of the source bucket and the key of
* the source object, separated by a slash (/). For example, to copy the object
* reports/january.pdf from the general purpose bucket awsexamplebucket, use
* awsexamplebucket/reports/january.pdf. The value must be URL-encoded. To copy the object
* reports/january.pdf from the directory bucket
* awsexamplebucket--use1-az5--x-s3, use
* awsexamplebucket--use1-az5--x-s3/reports/january.pdf. The value must be URL-encoded.
*
*
* -
*
* For objects accessed through access points, specify the Amazon Resource Name (ARN) of the object as
* accessed through the access point, in the format
* arn:aws:s3:<Region>:<account-id>:accesspoint/<access-point-name>/object/<key>
* . For example, to copy the object reports/january.pdf through access point
* my-access-point owned by account 123456789012 in Region
* us-west-2, use the URL encoding of
* arn:aws:s3:us-west-2:123456789012:accesspoint/my-access-point/object/reports/january.pdf.
* The value must be URL encoded.
*
*
*
* -
*
* Amazon S3 supports copy operations using Access points only when the source and destination buckets
* are in the same Amazon Web Services Region.
*
*
* -
*
* Access points are not supported by directory buckets.
*
*
*
*
*
* Alternatively, for objects accessed through Amazon S3 on Outposts, specify the ARN of the object as
* accessed in the format
* arn:aws:s3-outposts:<Region>:<account-id>:outpost/<outpost-id>/object/<key>
* . For example, to copy the object reports/january.pdf through outpost
* my-outpost owned by account 123456789012 in Region us-west-2,
* use the URL encoding of
* arn:aws:s3-outposts:us-west-2:123456789012:outpost/my-outpost/object/reports/january.pdf.
* The value must be URL-encoded.
*
*
*
*
* If your source bucket versioning is enabled, the x-amz-copy-source header by default
* identifies the current version of an object to copy. If the current version is a delete marker, Amazon
* S3 behaves as if the object was deleted. To copy a different version, use the versionId
* query parameter. Specifically, append ?versionId=<version-id> to the value (for
* example,
* awsexamplebucket/reports/january.pdf?versionId=QUpfdndhfd8438MNFDN93jdnJFkdmqnh893). If
* you don't specify a version ID, Amazon S3 copies the latest version of the source object.
*
*
* If you enable versioning on the destination bucket, Amazon S3 generates a unique version ID for the
* copied object. This version ID is different from the version ID of the source object. Amazon S3
* returns the version ID of the copied object in the x-amz-version-id response header in
* the response.
*
*
* If you do not enable versioning or suspend it on the destination bucket, the version ID that Amazon S3
* generates in the x-amz-version-id response header is always null.
*
*
*
* Directory buckets - S3 Versioning isn't enabled and supported for directory buckets.
*
* @return Returns a reference to this object so that method calls can be chained together.
* @deprecated The {@code copySource} parameter has been deprecated in favor of the more user-friendly
* {@code sourceBucket}, {@code sourceKey}, and {@code sourceVersionId} parameters. The
* {@code copySource} parameter will remain fully functional, but it must not be used in conjunction
* with its replacement parameters.
*/
@Deprecated
Builder copySource(String copySource);
/**
*
* Copies the object if its entity tag (ETag) matches the specified tag.
*
*
* If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since
* headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK and copies
* the data:
*
*
* -
*
* x-amz-copy-source-if-match condition evaluates to true
*
*
* -
*
* x-amz-copy-source-if-unmodified-since condition evaluates to false
*
*
*
*
* @param copySourceIfMatch
* Copies the object if its entity tag (ETag) matches the specified tag.
*
* If both the x-amz-copy-source-if-match and
* x-amz-copy-source-if-unmodified-since headers are present in the request and evaluate as
* follows, Amazon S3 returns 200 OK and copies the data:
*
*
* -
*
* x-amz-copy-source-if-match condition evaluates to true
*
*
* -
*
* x-amz-copy-source-if-unmodified-since condition evaluates to false
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder copySourceIfMatch(String copySourceIfMatch);
/**
*
* Copies the object if it has been modified since the specified time.
*
*
* If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since
* headers are present in the request and evaluate as follows, Amazon S3 returns the
* 412 Precondition Failed response code:
*
*
* -
*
* x-amz-copy-source-if-none-match condition evaluates to false
*
*
* -
*
* x-amz-copy-source-if-modified-since condition evaluates to true
*
*
*
*
* @param copySourceIfModifiedSince
* Copies the object if it has been modified since the specified time.
*
* If both the x-amz-copy-source-if-none-match and
* x-amz-copy-source-if-modified-since headers are present in the request and evaluate as
* follows, Amazon S3 returns the 412 Precondition Failed response code:
*
*
* -
*
* x-amz-copy-source-if-none-match condition evaluates to false
*
*
* -
*
* x-amz-copy-source-if-modified-since condition evaluates to true
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder copySourceIfModifiedSince(Instant copySourceIfModifiedSince);
/**
*
* Copies the object if its entity tag (ETag) is different than the specified ETag.
*
*
* If both the x-amz-copy-source-if-none-match and x-amz-copy-source-if-modified-since
* headers are present in the request and evaluate as follows, Amazon S3 returns the
* 412 Precondition Failed response code:
*
*
* -
*
* x-amz-copy-source-if-none-match condition evaluates to false
*
*
* -
*
* x-amz-copy-source-if-modified-since condition evaluates to true
*
*
*
*
* @param copySourceIfNoneMatch
* Copies the object if its entity tag (ETag) is different than the specified ETag.
*
* If both the x-amz-copy-source-if-none-match and
* x-amz-copy-source-if-modified-since headers are present in the request and evaluate as
* follows, Amazon S3 returns the 412 Precondition Failed response code:
*
*
* -
*
* x-amz-copy-source-if-none-match condition evaluates to false
*
*
* -
*
* x-amz-copy-source-if-modified-since condition evaluates to true
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder copySourceIfNoneMatch(String copySourceIfNoneMatch);
/**
*
* Copies the object if it hasn't been modified since the specified time.
*
*
* If both the x-amz-copy-source-if-match and x-amz-copy-source-if-unmodified-since
* headers are present in the request and evaluate as follows, Amazon S3 returns 200 OK and copies
* the data:
*
*
* -
*
* x-amz-copy-source-if-match condition evaluates to true
*
*
* -
*
* x-amz-copy-source-if-unmodified-since condition evaluates to false
*
*
*
*
* @param copySourceIfUnmodifiedSince
* Copies the object if it hasn't been modified since the specified time.
*
* If both the x-amz-copy-source-if-match and
* x-amz-copy-source-if-unmodified-since headers are present in the request and evaluate as
* follows, Amazon S3 returns 200 OK and copies the data:
*
*
* -
*
* x-amz-copy-source-if-match condition evaluates to true
*
*
* -
*
* x-amz-copy-source-if-unmodified-since condition evaluates to false
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder copySourceIfUnmodifiedSince(Instant copySourceIfUnmodifiedSince);
/**
*
* The date and time at which the object is no longer cacheable.
*
*
* @param expires
* The date and time at which the object is no longer cacheable.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder expires(Instant expires);
/**
*
* Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
*
*
*
* -
*
* This functionality is not supported for directory buckets.
*
*
* -
*
* This functionality is not supported for Amazon S3 on Outposts.
*
*
*
*
*
* @param grantFullControl
* Gives the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
*
* -
*
* This functionality is not supported for directory buckets.
*
*
* -
*
* This functionality is not supported for Amazon S3 on Outposts.
*
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder grantFullControl(String grantFullControl);
/**
*
* Allows grantee to read the object data and its metadata.
*
*
*
* -
*
* This functionality is not supported for directory buckets.
*
*
* -
*
* This functionality is not supported for Amazon S3 on Outposts.
*
*
*
*
*
* @param grantRead
* Allows grantee to read the object data and its metadata.
*
* -
*
* This functionality is not supported for directory buckets.
*
*
* -
*
* This functionality is not supported for Amazon S3 on Outposts.
*
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder grantRead(String grantRead);
/**
*
* Allows grantee to read the object ACL.
*
*
*
* -
*
* This functionality is not supported for directory buckets.
*
*
* -
*
* This functionality is not supported for Amazon S3 on Outposts.
*
*
*
*
*
* @param grantReadACP
* Allows grantee to read the object ACL.
*
* -
*
* This functionality is not supported for directory buckets.
*
*
* -
*
* This functionality is not supported for Amazon S3 on Outposts.
*
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder grantReadACP(String grantReadACP);
/**
*
* Allows grantee to write the ACL for the applicable object.
*
*
*
* -
*
* This functionality is not supported for directory buckets.
*
*
* -
*
* This functionality is not supported for Amazon S3 on Outposts.
*
*
*
*
*
* @param grantWriteACP
* Allows grantee to write the ACL for the applicable object.
*
* -
*
* This functionality is not supported for directory buckets.
*
*
* -
*
* This functionality is not supported for Amazon S3 on Outposts.
*
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder grantWriteACP(String grantWriteACP);
/**
*
* A map of metadata to store with the object in S3.
*
*
* @param metadata
* A map of metadata to store with the object in S3.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder metadata(Map metadata);
/**
*
* Specifies whether the metadata is copied from the source object or replaced with metadata that's provided in
* the request. When copying an object, you can preserve all metadata (the default) or specify new metadata. If
* this header isn’t specified, COPY is the default behavior.
*
*
* General purpose bucket - For general purpose buckets, when you grant permissions, you can use the
* s3:x-amz-metadata-directive condition key to enforce certain metadata behavior when objects are
* uploaded. For more information, see Amazon S3 condition key
* examples in the Amazon S3 User Guide.
*
*
*
* x-amz-website-redirect-location is unique to each object and is not copied when using the
* x-amz-metadata-directive header. To copy the value, you must specify
* x-amz-website-redirect-location in the request header.
*
*
*
* @param metadataDirective
* Specifies whether the metadata is copied from the source object or replaced with metadata that's
* provided in the request. When copying an object, you can preserve all metadata (the default) or
* specify new metadata. If this header isn’t specified, COPY is the default behavior.
*
* General purpose bucket - For general purpose buckets, when you grant permissions, you can use
* the s3:x-amz-metadata-directive condition key to enforce certain metadata behavior when
* objects are uploaded. For more information, see Amazon S3 condition
* key examples in the Amazon S3 User Guide.
*
*
*
* x-amz-website-redirect-location is unique to each object and is not copied when using the
* x-amz-metadata-directive header. To copy the value, you must specify
* x-amz-website-redirect-location in the request header.
*
* @see MetadataDirective
* @return Returns a reference to this object so that method calls can be chained together.
* @see MetadataDirective
*/
Builder metadataDirective(String metadataDirective);
/**
*
* Specifies whether the metadata is copied from the source object or replaced with metadata that's provided in
* the request. When copying an object, you can preserve all metadata (the default) or specify new metadata. If
* this header isn’t specified, COPY is the default behavior.
*
*
* General purpose bucket - For general purpose buckets, when you grant permissions, you can use the
* s3:x-amz-metadata-directive condition key to enforce certain metadata behavior when objects are
* uploaded. For more information, see Amazon S3 condition key
* examples in the Amazon S3 User Guide.
*
*
*
* x-amz-website-redirect-location is unique to each object and is not copied when using the
* x-amz-metadata-directive header. To copy the value, you must specify
* x-amz-website-redirect-location in the request header.
*
*
*
* @param metadataDirective
* Specifies whether the metadata is copied from the source object or replaced with metadata that's
* provided in the request. When copying an object, you can preserve all metadata (the default) or
* specify new metadata. If this header isn’t specified, COPY is the default behavior.
*
* General purpose bucket - For general purpose buckets, when you grant permissions, you can use
* the s3:x-amz-metadata-directive condition key to enforce certain metadata behavior when
* objects are uploaded. For more information, see Amazon S3 condition
* key examples in the Amazon S3 User Guide.
*
*
*
* x-amz-website-redirect-location is unique to each object and is not copied when using the
* x-amz-metadata-directive header. To copy the value, you must specify
* x-amz-website-redirect-location in the request header.
*
* @see MetadataDirective
* @return Returns a reference to this object so that method calls can be chained together.
* @see MetadataDirective
*/
Builder metadataDirective(MetadataDirective metadataDirective);
/**
*
* Specifies whether the object tag-set is copied from the source object or replaced with the tag-set that's
* provided in the request.
*
*
* The default value is COPY.
*
*
*
* Directory buckets - For directory buckets in a CopyObject operation, only the empty
* tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a
* 501 Not Implemented status code. When the destination bucket is a directory bucket, you will
* receive a 501 Not Implemented response in any of the following situations:
*
*
* -
*
* When you attempt to COPY the tag-set from an S3 source object that has non-empty tags.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a source object and set a non-empty value to
* x-amz-tagging.
*
*
* -
*
* When you don't set the x-amz-tagging-directive header and the source object has non-empty tags.
* This is because the default value of x-amz-tagging-directive is COPY.
*
*
*
*
* Because only the empty tag-set is supported for directory buckets in a CopyObject operation, the
* following situations are allowed:
*
*
* -
*
* When you attempt to COPY the tag-set from a directory bucket source object that has no tags to a
* general purpose bucket. It copies an empty tag-set to the destination object.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a directory bucket source object and set the
* x-amz-tagging value of the directory bucket destination object to empty.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a general purpose bucket source object that has
* non-empty tags and set the x-amz-tagging value of the directory bucket destination object to
* empty.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a directory bucket source object and don't set the
* x-amz-tagging value of the directory bucket destination object. This is because the default
* value of x-amz-tagging is the empty value.
*
*
*
*
*
* @param taggingDirective
* Specifies whether the object tag-set is copied from the source object or replaced with the tag-set
* that's provided in the request.
*
* The default value is COPY.
*
*
*
* Directory buckets - For directory buckets in a CopyObject operation, only the
* empty tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets
* will receive a 501 Not Implemented status code. When the destination bucket is a
* directory bucket, you will receive a 501 Not Implemented response in any of the following
* situations:
*
*
* -
*
* When you attempt to COPY the tag-set from an S3 source object that has non-empty tags.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a source object and set a non-empty value to
* x-amz-tagging.
*
*
* -
*
* When you don't set the x-amz-tagging-directive header and the source object has non-empty
* tags. This is because the default value of x-amz-tagging-directive is COPY.
*
*
*
*
* Because only the empty tag-set is supported for directory buckets in a CopyObject
* operation, the following situations are allowed:
*
*
* -
*
* When you attempt to COPY the tag-set from a directory bucket source object that has no
* tags to a general purpose bucket. It copies an empty tag-set to the destination object.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a directory bucket source object and set the
* x-amz-tagging value of the directory bucket destination object to empty.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a general purpose bucket source object that
* has non-empty tags and set the x-amz-tagging value of the directory bucket destination
* object to empty.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a directory bucket source object and don't set
* the x-amz-tagging value of the directory bucket destination object. This is because the
* default value of x-amz-tagging is the empty value.
*
*
*
* @see TaggingDirective
* @return Returns a reference to this object so that method calls can be chained together.
* @see TaggingDirective
*/
Builder taggingDirective(String taggingDirective);
/**
*
* Specifies whether the object tag-set is copied from the source object or replaced with the tag-set that's
* provided in the request.
*
*
* The default value is COPY.
*
*
*
* Directory buckets - For directory buckets in a CopyObject operation, only the empty
* tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a
* 501 Not Implemented status code. When the destination bucket is a directory bucket, you will
* receive a 501 Not Implemented response in any of the following situations:
*
*
* -
*
* When you attempt to COPY the tag-set from an S3 source object that has non-empty tags.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a source object and set a non-empty value to
* x-amz-tagging.
*
*
* -
*
* When you don't set the x-amz-tagging-directive header and the source object has non-empty tags.
* This is because the default value of x-amz-tagging-directive is COPY.
*
*
*
*
* Because only the empty tag-set is supported for directory buckets in a CopyObject operation, the
* following situations are allowed:
*
*
* -
*
* When you attempt to COPY the tag-set from a directory bucket source object that has no tags to a
* general purpose bucket. It copies an empty tag-set to the destination object.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a directory bucket source object and set the
* x-amz-tagging value of the directory bucket destination object to empty.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a general purpose bucket source object that has
* non-empty tags and set the x-amz-tagging value of the directory bucket destination object to
* empty.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a directory bucket source object and don't set the
* x-amz-tagging value of the directory bucket destination object. This is because the default
* value of x-amz-tagging is the empty value.
*
*
*
*
*
* @param taggingDirective
* Specifies whether the object tag-set is copied from the source object or replaced with the tag-set
* that's provided in the request.
*
* The default value is COPY.
*
*
*
* Directory buckets - For directory buckets in a CopyObject operation, only the
* empty tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets
* will receive a 501 Not Implemented status code. When the destination bucket is a
* directory bucket, you will receive a 501 Not Implemented response in any of the following
* situations:
*
*
* -
*
* When you attempt to COPY the tag-set from an S3 source object that has non-empty tags.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a source object and set a non-empty value to
* x-amz-tagging.
*
*
* -
*
* When you don't set the x-amz-tagging-directive header and the source object has non-empty
* tags. This is because the default value of x-amz-tagging-directive is COPY.
*
*
*
*
* Because only the empty tag-set is supported for directory buckets in a CopyObject
* operation, the following situations are allowed:
*
*
* -
*
* When you attempt to COPY the tag-set from a directory bucket source object that has no
* tags to a general purpose bucket. It copies an empty tag-set to the destination object.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a directory bucket source object and set the
* x-amz-tagging value of the directory bucket destination object to empty.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a general purpose bucket source object that
* has non-empty tags and set the x-amz-tagging value of the directory bucket destination
* object to empty.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a directory bucket source object and don't set
* the x-amz-tagging value of the directory bucket destination object. This is because the
* default value of x-amz-tagging is the empty value.
*
*
*
* @see TaggingDirective
* @return Returns a reference to this object so that method calls can be chained together.
* @see TaggingDirective
*/
Builder taggingDirective(TaggingDirective taggingDirective);
/**
*
* The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
* AES256, aws:kms, aws:kms:dsse). Unrecognized or unsupported values
* won’t write a destination object and will receive a 400 Bad Request response.
*
*
* Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When copying an object, if
* you don't specify encryption information in your copy request, the encryption setting of the target object is
* set to the default encryption configuration of the destination bucket. By default, all buckets have a base
* level of encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If
* the destination bucket has a default encryption configuration that uses server-side encryption with Key
* Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys
* (DSSE-KMS), or server-side encryption with customer-provided encryption keys (SSE-C), Amazon S3 uses the
* corresponding KMS key, or a customer-provided key to encrypt the target object copy.
*
*
* When you perform a CopyObject operation, if you want to use a different type of encryption
* setting for the target object, you can specify appropriate encryption-related headers to encrypt the target
* object with an Amazon S3 managed key, a KMS key, or a customer-provided key. If the encryption setting in
* your request is different from the default encryption configuration of the destination bucket, the encryption
* setting in your request takes precedence.
*
*
* With server-side encryption, Amazon S3 encrypts your data as it writes your data to disks in its data centers
* and decrypts the data when you access it. For more information about server-side encryption, see Using Server-Side
* Encryption in the Amazon S3 User Guide.
*
*
*
* For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256)
* is supported.
*
*
*
* @param serverSideEncryption
* The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
* AES256, aws:kms, aws:kms:dsse). Unrecognized or unsupported
* values won’t write a destination object and will receive a 400 Bad Request response.
*
* Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When copying an
* object, if you don't specify encryption information in your copy request, the encryption setting of
* the target object is set to the default encryption configuration of the destination bucket. By
* default, all buckets have a base level of encryption configuration that uses server-side encryption
* with Amazon S3 managed keys (SSE-S3). If the destination bucket has a default encryption configuration
* that uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer
* server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with
* customer-provided encryption keys (SSE-C), Amazon S3 uses the corresponding KMS key, or a
* customer-provided key to encrypt the target object copy.
*
*
* When you perform a CopyObject operation, if you want to use a different type of
* encryption setting for the target object, you can specify appropriate encryption-related headers to
* encrypt the target object with an Amazon S3 managed key, a KMS key, or a customer-provided key. If the
* encryption setting in your request is different from the default encryption configuration of the
* destination bucket, the encryption setting in your request takes precedence.
*
*
* With server-side encryption, Amazon S3 encrypts your data as it writes your data to disks in its data
* centers and decrypts the data when you access it. For more information about server-side encryption,
* see Using
* Server-Side Encryption in the Amazon S3 User Guide.
*
*
*
* For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (
* AES256) is supported.
*
* @see ServerSideEncryption
* @return Returns a reference to this object so that method calls can be chained together.
* @see ServerSideEncryption
*/
Builder serverSideEncryption(String serverSideEncryption);
/**
*
* The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
* AES256, aws:kms, aws:kms:dsse). Unrecognized or unsupported values
* won’t write a destination object and will receive a 400 Bad Request response.
*
*
* Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When copying an object, if
* you don't specify encryption information in your copy request, the encryption setting of the target object is
* set to the default encryption configuration of the destination bucket. By default, all buckets have a base
* level of encryption configuration that uses server-side encryption with Amazon S3 managed keys (SSE-S3). If
* the destination bucket has a default encryption configuration that uses server-side encryption with Key
* Management Service (KMS) keys (SSE-KMS), dual-layer server-side encryption with Amazon Web Services KMS keys
* (DSSE-KMS), or server-side encryption with customer-provided encryption keys (SSE-C), Amazon S3 uses the
* corresponding KMS key, or a customer-provided key to encrypt the target object copy.
*
*
* When you perform a CopyObject operation, if you want to use a different type of encryption
* setting for the target object, you can specify appropriate encryption-related headers to encrypt the target
* object with an Amazon S3 managed key, a KMS key, or a customer-provided key. If the encryption setting in
* your request is different from the default encryption configuration of the destination bucket, the encryption
* setting in your request takes precedence.
*
*
* With server-side encryption, Amazon S3 encrypts your data as it writes your data to disks in its data centers
* and decrypts the data when you access it. For more information about server-side encryption, see Using Server-Side
* Encryption in the Amazon S3 User Guide.
*
*
*
* For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256)
* is supported.
*
*
*
* @param serverSideEncryption
* The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
* AES256, aws:kms, aws:kms:dsse). Unrecognized or unsupported
* values won’t write a destination object and will receive a 400 Bad Request response.
*
* Amazon S3 automatically encrypts all new objects that are copied to an S3 bucket. When copying an
* object, if you don't specify encryption information in your copy request, the encryption setting of
* the target object is set to the default encryption configuration of the destination bucket. By
* default, all buckets have a base level of encryption configuration that uses server-side encryption
* with Amazon S3 managed keys (SSE-S3). If the destination bucket has a default encryption configuration
* that uses server-side encryption with Key Management Service (KMS) keys (SSE-KMS), dual-layer
* server-side encryption with Amazon Web Services KMS keys (DSSE-KMS), or server-side encryption with
* customer-provided encryption keys (SSE-C), Amazon S3 uses the corresponding KMS key, or a
* customer-provided key to encrypt the target object copy.
*
*
* When you perform a CopyObject operation, if you want to use a different type of
* encryption setting for the target object, you can specify appropriate encryption-related headers to
* encrypt the target object with an Amazon S3 managed key, a KMS key, or a customer-provided key. If the
* encryption setting in your request is different from the default encryption configuration of the
* destination bucket, the encryption setting in your request takes precedence.
*
*
* With server-side encryption, Amazon S3 encrypts your data as it writes your data to disks in its data
* centers and decrypts the data when you access it. For more information about server-side encryption,
* see Using
* Server-Side Encryption in the Amazon S3 User Guide.
*
*
*
* For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (
* AES256) is supported.
*
* @see ServerSideEncryption
* @return Returns a reference to this object so that method calls can be chained together.
* @see ServerSideEncryption
*/
Builder serverSideEncryption(ServerSideEncryption serverSideEncryption);
/**
*
* If the x-amz-storage-class header is not used, the copied object will be stored in the
* STANDARD Storage Class by default. The STANDARD storage class provides high
* durability and high availability. Depending on performance needs, you can specify a different Storage Class.
*
*
*
* -
*
* Directory buckets - For directory buckets, only the S3 Express One Zone storage class is supported to
* store newly created objects. Unsupported storage class values won't write a destination object and will
* respond with the HTTP status code 400 Bad Request.
*
*
* -
*
* Amazon S3 on Outposts - S3 on Outposts only uses the OUTPOSTS Storage Class.
*
*
*
*
*
* You can use the CopyObject action to change the storage class of an object that is already
* stored in Amazon S3 by using the x-amz-storage-class header. For more information, see Storage Classes in the
* Amazon S3 User Guide.
*
*
* Before using an object as a source object for the copy operation, you must restore a copy of it if it meets
* any of the following conditions:
*
*
* -
*
* The storage class of the source object is GLACIER or DEEP_ARCHIVE.
*
*
* -
*
* The storage class of the source object is INTELLIGENT_TIERING and it's S3 Intelligent-Tiering access tier is Archive Access or Deep Archive Access.
*
*
*
*
* For more information, see RestoreObject and Copying Objects in the
* Amazon S3 User Guide.
*
*
* @param storageClass
* If the x-amz-storage-class header is not used, the copied object will be stored in the
* STANDARD Storage Class by default. The STANDARD storage class provides high
* durability and high availability. Depending on performance needs, you can specify a different Storage
* Class.
*
* -
*
* Directory buckets - For directory buckets, only the S3 Express One Zone storage class is
* supported to store newly created objects. Unsupported storage class values won't write a destination
* object and will respond with the HTTP status code 400 Bad Request.
*
*
* -
*
* Amazon S3 on Outposts - S3 on Outposts only uses the OUTPOSTS Storage Class.
*
*
*
*
*
* You can use the CopyObject action to change the storage class of an object that is
* already stored in Amazon S3 by using the x-amz-storage-class header. For more
* information, see Storage Classes in
* the Amazon S3 User Guide.
*
*
* Before using an object as a source object for the copy operation, you must restore a copy of it if it
* meets any of the following conditions:
*
*
* -
*
* The storage class of the source object is GLACIER or DEEP_ARCHIVE.
*
*
* -
*
* The storage class of the source object is INTELLIGENT_TIERING and it's S3 Intelligent-Tiering access tier is Archive Access or
* Deep Archive Access.
*
*
*
*
* For more information, see RestoreObject and Copying Objects
* in the Amazon S3 User Guide.
* @see StorageClass
* @return Returns a reference to this object so that method calls can be chained together.
* @see StorageClass
*/
Builder storageClass(String storageClass);
/**
*
* If the x-amz-storage-class header is not used, the copied object will be stored in the
* STANDARD Storage Class by default. The STANDARD storage class provides high
* durability and high availability. Depending on performance needs, you can specify a different Storage Class.
*
*
*
* -
*
* Directory buckets - For directory buckets, only the S3 Express One Zone storage class is supported to
* store newly created objects. Unsupported storage class values won't write a destination object and will
* respond with the HTTP status code 400 Bad Request.
*
*
* -
*
* Amazon S3 on Outposts - S3 on Outposts only uses the OUTPOSTS Storage Class.
*
*
*
*
*
* You can use the CopyObject action to change the storage class of an object that is already
* stored in Amazon S3 by using the x-amz-storage-class header. For more information, see Storage Classes in the
* Amazon S3 User Guide.
*
*
* Before using an object as a source object for the copy operation, you must restore a copy of it if it meets
* any of the following conditions:
*
*
* -
*
* The storage class of the source object is GLACIER or DEEP_ARCHIVE.
*
*
* -
*
* The storage class of the source object is INTELLIGENT_TIERING and it's S3 Intelligent-Tiering access tier is Archive Access or Deep Archive Access.
*
*
*
*
* For more information, see RestoreObject and Copying Objects in the
* Amazon S3 User Guide.
*
*
* @param storageClass
* If the x-amz-storage-class header is not used, the copied object will be stored in the
* STANDARD Storage Class by default. The STANDARD storage class provides high
* durability and high availability. Depending on performance needs, you can specify a different Storage
* Class.
*
* -
*
* Directory buckets - For directory buckets, only the S3 Express One Zone storage class is
* supported to store newly created objects. Unsupported storage class values won't write a destination
* object and will respond with the HTTP status code 400 Bad Request.
*
*
* -
*
* Amazon S3 on Outposts - S3 on Outposts only uses the OUTPOSTS Storage Class.
*
*
*
*
*
* You can use the CopyObject action to change the storage class of an object that is
* already stored in Amazon S3 by using the x-amz-storage-class header. For more
* information, see Storage Classes in
* the Amazon S3 User Guide.
*
*
* Before using an object as a source object for the copy operation, you must restore a copy of it if it
* meets any of the following conditions:
*
*
* -
*
* The storage class of the source object is GLACIER or DEEP_ARCHIVE.
*
*
* -
*
* The storage class of the source object is INTELLIGENT_TIERING and it's S3 Intelligent-Tiering access tier is Archive Access or
* Deep Archive Access.
*
*
*
*
* For more information, see RestoreObject and Copying Objects
* in the Amazon S3 User Guide.
* @see StorageClass
* @return Returns a reference to this object so that method calls can be chained together.
* @see StorageClass
*/
Builder storageClass(StorageClass storageClass);
/**
*
* If the destination bucket is configured as a website, redirects requests for this object copy to another
* object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object
* metadata. This value is unique to each object and is not copied when using the
* x-amz-metadata-directive header. Instead, you may opt to provide this header in combination with
* the x-amz-metadata-directive header.
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* @param websiteRedirectLocation
* If the destination bucket is configured as a website, redirects requests for this object copy to
* another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in
* the object metadata. This value is unique to each object and is not copied when using the
* x-amz-metadata-directive header. Instead, you may opt to provide this header in
* combination with the x-amz-metadata-directive header.
*
* This functionality is not supported for directory buckets.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder websiteRedirectLocation(String websiteRedirectLocation);
/**
*
* Specifies the algorithm to use when encrypting the object (for example, AES256).
*
*
* When you perform a CopyObject operation, if you want to use a different type of encryption
* setting for the target object, you can specify appropriate encryption-related headers to encrypt the target
* object with an Amazon S3 managed key, a KMS key, or a customer-provided key. If the encryption setting in
* your request is different from the default encryption configuration of the destination bucket, the encryption
* setting in your request takes precedence.
*
*
*
* This functionality is not supported when the destination bucket is a directory bucket.
*
*
*
* @param sseCustomerAlgorithm
* Specifies the algorithm to use when encrypting the object (for example, AES256).
*
* When you perform a CopyObject operation, if you want to use a different type of
* encryption setting for the target object, you can specify appropriate encryption-related headers to
* encrypt the target object with an Amazon S3 managed key, a KMS key, or a customer-provided key. If the
* encryption setting in your request is different from the default encryption configuration of the
* destination bucket, the encryption setting in your request takes precedence.
*
*
*
* This functionality is not supported when the destination bucket is a directory bucket.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sseCustomerAlgorithm(String sseCustomerAlgorithm);
/**
*
* 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.
*
*
*
* This functionality is not supported when the destination bucket is a directory bucket.
*
*
*
* @param 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.
*
* This functionality is not supported when the destination bucket is a directory bucket.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sseCustomerKey(String sseCustomerKey);
/**
*
* 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.
*
*
*
* This functionality is not supported when the destination bucket is a directory bucket.
*
*
*
* @param 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.
*
* This functionality is not supported when the destination bucket is a directory bucket.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sseCustomerKeyMD5(String sseCustomerKeyMD5);
/**
*
* Specifies the KMS ID (Key ID, Key ARN, or Key Alias) to use for object encryption. All GET and PUT requests
* for an object protected by KMS will fail if they're not made via SSL or using SigV4. For information about
* configuring any of the officially supported Amazon Web Services SDKs and Amazon Web Services CLI, see Specifying
* the Signature Version in Request Authentication in the Amazon S3 User Guide.
*
*
*
* This functionality is not supported when the destination bucket is a directory bucket.
*
*
*
* @param ssekmsKeyId
* Specifies the KMS ID (Key ID, Key ARN, or Key Alias) to use for object encryption. All GET and PUT
* requests for an object protected by KMS will fail if they're not made via SSL or using SigV4. For
* information about configuring any of the officially supported Amazon Web Services SDKs and Amazon Web
* Services CLI, see Specifying the Signature Version in Request Authentication in the Amazon S3 User
* Guide.
*
* This functionality is not supported when the destination bucket is a directory bucket.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ssekmsKeyId(String ssekmsKeyId);
/**
*
* Specifies the Amazon Web Services 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. This value
* must be explicitly added to specify encryption context for CopyObject requests.
*
*
*
* This functionality is not supported when the destination bucket is a directory bucket.
*
*
*
* @param ssekmsEncryptionContext
* Specifies the Amazon Web Services 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.
* This value must be explicitly added to specify encryption context for CopyObject
* requests.
*
* This functionality is not supported when the destination bucket is a directory bucket.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ssekmsEncryptionContext(String ssekmsEncryptionContext);
/**
*
* Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side encryption
* using Key Management Service (KMS) keys (SSE-KMS). If a target object uses SSE-KMS, you can enable an S3
* Bucket Key for the object.
*
*
* Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object encryption with
* SSE-KMS. Specifying this header with a COPY action doesn’t affect bucket-level settings for S3 Bucket Key.
*
*
* For more information, see Amazon S3
* Bucket Keys in the Amazon S3 User Guide.
*
*
*
* This functionality is not supported when the destination bucket is a directory bucket.
*
*
*
* @param bucketKeyEnabled
* Specifies whether Amazon S3 should use an S3 Bucket Key for object encryption with server-side
* encryption using Key Management Service (KMS) keys (SSE-KMS). If a target object uses SSE-KMS, you can
* enable an S3 Bucket Key for the object.
*
* Setting this header to true causes Amazon S3 to use an S3 Bucket Key for object
* encryption with SSE-KMS. Specifying this header with a COPY action doesn’t affect bucket-level
* settings for S3 Bucket Key.
*
*
* For more information, see Amazon S3 Bucket Keys in
* the Amazon S3 User Guide.
*
*
*
* This functionality is not supported when the destination bucket is a directory bucket.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder bucketKeyEnabled(Boolean bucketKeyEnabled);
/**
*
* Specifies the algorithm to use when decrypting the source object (for example, AES256).
*
*
* If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary
* encryption information in your request so that Amazon S3 can decrypt the object for copying.
*
*
*
* This functionality is not supported when the source object is in a directory bucket.
*
*
*
* @param copySourceSSECustomerAlgorithm
* Specifies the algorithm to use when decrypting the source object (for example, AES256
* ).
*
* If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary
* encryption information in your request so that Amazon S3 can decrypt the object for copying.
*
*
*
* This functionality is not supported when the source object is in a directory bucket.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder copySourceSSECustomerAlgorithm(String copySourceSSECustomerAlgorithm);
/**
*
* 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 the same one that was used when the source object was created.
*
*
* If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary
* encryption information in your request so that Amazon S3 can decrypt the object for copying.
*
*
*
* This functionality is not supported when the source object is in a directory bucket.
*
*
*
* @param 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 the same one that was used when the source object was
* created.
*
* If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary
* encryption information in your request so that Amazon S3 can decrypt the object for copying.
*
*
*
* This functionality is not supported when the source object is in a directory bucket.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder copySourceSSECustomerKey(String copySourceSSECustomerKey);
/**
*
* 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.
*
*
* If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary
* encryption information in your request so that Amazon S3 can decrypt the object for copying.
*
*
*
* This functionality is not supported when the source object is in a directory bucket.
*
*
*
* @param 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.
*
* If the source object for the copy is stored in Amazon S3 using SSE-C, you must provide the necessary
* encryption information in your request so that Amazon S3 can decrypt the object for copying.
*
*
*
* This functionality is not supported when the source object is in a directory bucket.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder copySourceSSECustomerKeyMD5(String copySourceSSECustomerKeyMD5);
/**
* Sets the value of the RequestPayer property for this object.
*
* @param requestPayer
* The new value for the RequestPayer property for this object.
* @see RequestPayer
* @return Returns a reference to this object so that method calls can be chained together.
* @see RequestPayer
*/
Builder requestPayer(String requestPayer);
/**
* Sets the value of the RequestPayer property for this object.
*
* @param requestPayer
* The new value for the RequestPayer property for this object.
* @see RequestPayer
* @return Returns a reference to this object so that method calls can be chained together.
* @see RequestPayer
*/
Builder requestPayer(RequestPayer requestPayer);
/**
*
* The tag-set for the object copy in the destination bucket. This value must be used in conjunction with the
* x-amz-tagging-directive if you choose REPLACE for the
* x-amz-tagging-directive. If you choose COPY for the
* x-amz-tagging-directive, you don't need to set the x-amz-tagging header, because
* the tag-set will be copied from the source object directly. The tag-set must be encoded as URL Query
* parameters.
*
*
* The default value is the empty value.
*
*
*
* Directory buckets - For directory buckets in a CopyObject operation, only the empty
* tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets will receive a
* 501 Not Implemented status code. When the destination bucket is a directory bucket, you will
* receive a 501 Not Implemented response in any of the following situations:
*
*
* -
*
* When you attempt to COPY the tag-set from an S3 source object that has non-empty tags.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a source object and set a non-empty value to
* x-amz-tagging.
*
*
* -
*
* When you don't set the x-amz-tagging-directive header and the source object has non-empty tags.
* This is because the default value of x-amz-tagging-directive is COPY.
*
*
*
*
* Because only the empty tag-set is supported for directory buckets in a CopyObject operation, the
* following situations are allowed:
*
*
* -
*
* When you attempt to COPY the tag-set from a directory bucket source object that has no tags to a
* general purpose bucket. It copies an empty tag-set to the destination object.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a directory bucket source object and set the
* x-amz-tagging value of the directory bucket destination object to empty.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a general purpose bucket source object that has
* non-empty tags and set the x-amz-tagging value of the directory bucket destination object to
* empty.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a directory bucket source object and don't set the
* x-amz-tagging value of the directory bucket destination object. This is because the default
* value of x-amz-tagging is the empty value.
*
*
*
*
*
* @param tagging
* The tag-set for the object copy in the destination bucket. This value must be used in conjunction with
* the x-amz-tagging-directive if you choose REPLACE for the
* x-amz-tagging-directive. If you choose COPY for the
* x-amz-tagging-directive, you don't need to set the x-amz-tagging header,
* because the tag-set will be copied from the source object directly. The tag-set must be encoded as URL
* Query parameters.
*
* The default value is the empty value.
*
*
*
* Directory buckets - For directory buckets in a CopyObject operation, only the
* empty tag-set is supported. Any requests that attempt to write non-empty tags into directory buckets
* will receive a 501 Not Implemented status code. When the destination bucket is a
* directory bucket, you will receive a 501 Not Implemented response in any of the following
* situations:
*
*
* -
*
* When you attempt to COPY the tag-set from an S3 source object that has non-empty tags.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a source object and set a non-empty value to
* x-amz-tagging.
*
*
* -
*
* When you don't set the x-amz-tagging-directive header and the source object has non-empty
* tags. This is because the default value of x-amz-tagging-directive is COPY.
*
*
*
*
* Because only the empty tag-set is supported for directory buckets in a CopyObject
* operation, the following situations are allowed:
*
*
* -
*
* When you attempt to COPY the tag-set from a directory bucket source object that has no
* tags to a general purpose bucket. It copies an empty tag-set to the destination object.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a directory bucket source object and set the
* x-amz-tagging value of the directory bucket destination object to empty.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a general purpose bucket source object that
* has non-empty tags and set the x-amz-tagging value of the directory bucket destination
* object to empty.
*
*
* -
*
* When you attempt to REPLACE the tag-set of a directory bucket source object and don't set
* the x-amz-tagging value of the directory bucket destination object. This is because the
* default value of x-amz-tagging is the empty value.
*
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tagging(String tagging);
Builder tagging(Tagging tagging);
/**
*
* The Object Lock mode that you want to apply to the object copy.
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* @param objectLockMode
* The Object Lock mode that you want to apply to the object copy.
*
* This functionality is not supported for directory buckets.
*
* @see ObjectLockMode
* @return Returns a reference to this object so that method calls can be chained together.
* @see ObjectLockMode
*/
Builder objectLockMode(String objectLockMode);
/**
*
* The Object Lock mode that you want to apply to the object copy.
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* @param objectLockMode
* The Object Lock mode that you want to apply to the object copy.
*
* This functionality is not supported for directory buckets.
*
* @see ObjectLockMode
* @return Returns a reference to this object so that method calls can be chained together.
* @see ObjectLockMode
*/
Builder objectLockMode(ObjectLockMode objectLockMode);
/**
*
* The date and time when you want the Object Lock of the object copy to expire.
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* @param objectLockRetainUntilDate
* The date and time when you want the Object Lock of the object copy to expire.
*
* This functionality is not supported for directory buckets.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder objectLockRetainUntilDate(Instant objectLockRetainUntilDate);
/**
*
* Specifies whether you want to apply a legal hold to the object copy.
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* @param objectLockLegalHoldStatus
* Specifies whether you want to apply a legal hold to the object copy.
*
* This functionality is not supported for directory buckets.
*
* @see ObjectLockLegalHoldStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ObjectLockLegalHoldStatus
*/
Builder objectLockLegalHoldStatus(String objectLockLegalHoldStatus);
/**
*
* Specifies whether you want to apply a legal hold to the object copy.
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* @param objectLockLegalHoldStatus
* Specifies whether you want to apply a legal hold to the object copy.
*
* This functionality is not supported for directory buckets.
*
* @see ObjectLockLegalHoldStatus
* @return Returns a reference to this object so that method calls can be chained together.
* @see ObjectLockLegalHoldStatus
*/
Builder objectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus);
/**
*
* The account ID of the expected destination bucket owner. If the account ID that you provide does not match
* the actual owner of the destination bucket, the request fails with the HTTP status code
* 403 Forbidden (access denied).
*
*
* @param expectedBucketOwner
* The account ID of the expected destination bucket owner. If the account ID that you provide does not
* match the actual owner of the destination bucket, the request fails with the HTTP status code
* 403 Forbidden (access denied).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder expectedBucketOwner(String expectedBucketOwner);
/**
*
* The account ID of the expected source bucket owner. If the account ID that you provide does not match the
* actual owner of the source bucket, the request fails with the HTTP status code 403 Forbidden
* (access denied).
*
*
* @param expectedSourceBucketOwner
* The account ID of the expected source bucket owner. If the account ID that you provide does not match
* the actual owner of the source bucket, the request fails with the HTTP status code
* 403 Forbidden (access denied).
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder expectedSourceBucketOwner(String expectedSourceBucketOwner);
/**
*
* The name of the destination bucket.
*
*
* Directory buckets - When you use this operation with a directory bucket, you must use
* virtual-hosted-style requests in the format
* Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are
* not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must
* follow the format bucket_base_name--az-id--x-s3 (for example,
* DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming
* restrictions, see Directory
* bucket naming rules in the Amazon S3 User Guide.
*
*
* Access points - When you use this action with an access point, you must provide the alias of the
* access point in place of the bucket name or specify the access point ARN. When using the access point ARN,
* you must direct requests to the access point hostname. The access point hostname takes the form
* AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action
* with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the
* bucket name. For more information about access point ARNs, see Using access points
* in the Amazon S3 User Guide.
*
*
*
* Access points and Object Lambda access points are not supported by directory buckets.
*
*
*
* S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the
* S3 on Outposts hostname. The S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
* . When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in
* the Amazon S3 User Guide.
*
*
* @param destinationBucket
* The name of the destination bucket.
*
* Directory buckets - When you use this operation with a directory bucket, you must use
* virtual-hosted-style requests in the format
* Bucket_name.s3express-az_id.region.amazonaws.com. Path-style
* requests are not supported. Directory bucket names must be unique in the chosen Availability Zone.
* Bucket names must follow the format bucket_base_name--az-id--x-s3 (for
* example, DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket
* naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
*
*
* Access points - When you use this action with an access point, you must provide the alias of
* the access point in place of the bucket name or specify the access point ARN. When using the access
* point ARN, you must direct requests to the access point hostname. The access point hostname takes the
* form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using
* this action with an access point through the Amazon Web Services SDKs, you provide the access point
* ARN in place of the bucket name. For more information about access point ARNs, see Using access
* points in the Amazon S3 User Guide.
*
*
*
* Access points and Object Lambda access points are not supported by directory buckets.
*
*
*
* S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests
* to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
* . When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the
* Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs,
* see What is S3 on
* Outposts? in the Amazon S3 User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder destinationBucket(String destinationBucket);
/**
*
* The name of the destination bucket.
*
*
* Directory buckets - When you use this operation with a directory bucket, you must use
* virtual-hosted-style requests in the format
* Bucket_name.s3express-az_id.region.amazonaws.com. Path-style requests are
* not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must
* follow the format bucket_base_name--az-id--x-s3 (for example,
* DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket naming
* restrictions, see Directory
* bucket naming rules in the Amazon S3 User Guide.
*
*
* Access points - When you use this action with an access point, you must provide the alias of the
* access point in place of the bucket name or specify the access point ARN. When using the access point ARN,
* you must direct requests to the access point hostname. The access point hostname takes the form
* AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this action
* with an access point through the Amazon Web Services SDKs, you provide the access point ARN in place of the
* bucket name. For more information about access point ARNs, see Using access points
* in the Amazon S3 User Guide.
*
*
*
* Access points and Object Lambda access points are not supported by directory buckets.
*
*
*
* S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests to the
* S3 on Outposts hostname. The S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
* . When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts
* access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in
* the Amazon S3 User Guide.
*
*
* @param destinationBucket
* The name of the destination bucket.
*
* Directory buckets - When you use this operation with a directory bucket, you must use
* virtual-hosted-style requests in the format
* Bucket_name.s3express-az_id.region.amazonaws.com. Path-style
* requests are not supported. Directory bucket names must be unique in the chosen Availability Zone.
* Bucket names must follow the format bucket_base_name--az-id--x-s3 (for
* example, DOC-EXAMPLE-BUCKET--usw2-az2--x-s3). For information about bucket
* naming restrictions, see Directory bucket naming rules in the Amazon S3 User Guide.
*
*
* Access points - When you use this action with an access point, you must provide the alias of
* the access point in place of the bucket name or specify the access point ARN. When using the access
* point ARN, you must direct requests to the access point hostname. The access point hostname takes the
* form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using
* this action with an access point through the Amazon Web Services SDKs, you provide the access point
* ARN in place of the bucket name. For more information about access point ARNs, see Using access
* points in the Amazon S3 User Guide.
*
*
*
* Access points and Object Lambda access points are not supported by directory buckets.
*
*
*
* S3 on Outposts - When you use this action with Amazon S3 on Outposts, you must direct requests
* to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form
* AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com
* . When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the
* Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs,
* see What is S3 on
* Outposts? in the Amazon S3 User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
* @deprecated Use {@link #destinationBucket(String)}
*/
@Deprecated
Builder bucket(String destinationBucket);
/**
*
* The key of the destination object.
*
*
* @param destinationKey
* The key of the destination object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder destinationKey(String destinationKey);
/**
*
* The key of the destination object.
*
*
* @param destinationKey
* The key of the destination object.
* @return Returns a reference to this object so that method calls can be chained together.
* @deprecated Use {@link #destinationKey(String)}
*/
@Deprecated
Builder key(String destinationKey);
/**
* The name of the bucket containing the object to copy. The provided input will be URL encoded. The
* {@code sourceBucket}, {@code sourceKey}, and {@code sourceVersionId} parameters must not be used in
* conjunction with the {@code copySource} parameter.
*
* @param sourceBucket
* The name of the bucket containing the object to copy. The provided input will be URL encoded. The
* {@code sourceBucket}, {@code sourceKey}, and {@code sourceVersionId} parameters must not be used in
* conjunction with the {@code copySource} parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sourceBucket(String sourceBucket);
/**
* The key of the object to copy. The provided input will be URL encoded. The {@code sourceBucket},
* {@code sourceKey}, and {@code sourceVersionId} parameters must not be used in conjunction with the
* {@code copySource} parameter.
*
* @param sourceKey
* The key of the object to copy. The provided input will be URL encoded. The {@code sourceBucket},
* {@code sourceKey}, and {@code sourceVersionId} parameters must not be used in conjunction with the
* {@code copySource} parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sourceKey(String sourceKey);
/**
* Specifies a particular version of the source object to copy. By default the latest version is copied. The
* {@code sourceBucket}, {@code sourceKey}, and {@code sourceVersionId} parameters must not be used in
* conjunction with the {@code copySource} parameter.
*
* @param sourceVersionId
* Specifies a particular version of the source object to copy. By default the latest version is copied.
* The {@code sourceBucket}, {@code sourceKey}, and {@code sourceVersionId} parameters must not be used
* in conjunction with the {@code copySource} parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sourceVersionId(String sourceVersionId);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends S3Request.BuilderImpl implements Builder {
private String acl;
private String cacheControl;
private String checksumAlgorithm;
private String contentDisposition;
private String contentEncoding;
private String contentLanguage;
private String contentType;
private String copySource;
private String copySourceIfMatch;
private Instant copySourceIfModifiedSince;
private String copySourceIfNoneMatch;
private Instant copySourceIfUnmodifiedSince;
private Instant expires;
private String grantFullControl;
private String grantRead;
private String grantReadACP;
private String grantWriteACP;
private Map metadata = DefaultSdkAutoConstructMap.getInstance();
private String metadataDirective;
private String taggingDirective;
private String serverSideEncryption;
private String storageClass;
private String websiteRedirectLocation;
private String sseCustomerAlgorithm;
private String sseCustomerKey;
private String sseCustomerKeyMD5;
private String ssekmsKeyId;
private String ssekmsEncryptionContext;
private Boolean bucketKeyEnabled;
private String copySourceSSECustomerAlgorithm;
private String copySourceSSECustomerKey;
private String copySourceSSECustomerKeyMD5;
private String requestPayer;
private String tagging;
private String objectLockMode;
private Instant objectLockRetainUntilDate;
private String objectLockLegalHoldStatus;
private String expectedBucketOwner;
private String expectedSourceBucketOwner;
private String destinationBucket;
private String destinationKey;
private String sourceBucket;
private String sourceKey;
private String sourceVersionId;
private BuilderImpl() {
}
private BuilderImpl(CopyObjectRequest model) {
super(model);
acl(model.acl);
cacheControl(model.cacheControl);
checksumAlgorithm(model.checksumAlgorithm);
contentDisposition(model.contentDisposition);
contentEncoding(model.contentEncoding);
contentLanguage(model.contentLanguage);
contentType(model.contentType);
copySource(model.copySource);
copySourceIfMatch(model.copySourceIfMatch);
copySourceIfModifiedSince(model.copySourceIfModifiedSince);
copySourceIfNoneMatch(model.copySourceIfNoneMatch);
copySourceIfUnmodifiedSince(model.copySourceIfUnmodifiedSince);
expires(model.expires);
grantFullControl(model.grantFullControl);
grantRead(model.grantRead);
grantReadACP(model.grantReadACP);
grantWriteACP(model.grantWriteACP);
metadata(model.metadata);
metadataDirective(model.metadataDirective);
taggingDirective(model.taggingDirective);
serverSideEncryption(model.serverSideEncryption);
storageClass(model.storageClass);
websiteRedirectLocation(model.websiteRedirectLocation);
sseCustomerAlgorithm(model.sseCustomerAlgorithm);
sseCustomerKey(model.sseCustomerKey);
sseCustomerKeyMD5(model.sseCustomerKeyMD5);
ssekmsKeyId(model.ssekmsKeyId);
ssekmsEncryptionContext(model.ssekmsEncryptionContext);
bucketKeyEnabled(model.bucketKeyEnabled);
copySourceSSECustomerAlgorithm(model.copySourceSSECustomerAlgorithm);
copySourceSSECustomerKey(model.copySourceSSECustomerKey);
copySourceSSECustomerKeyMD5(model.copySourceSSECustomerKeyMD5);
requestPayer(model.requestPayer);
tagging(model.tagging);
objectLockMode(model.objectLockMode);
objectLockRetainUntilDate(model.objectLockRetainUntilDate);
objectLockLegalHoldStatus(model.objectLockLegalHoldStatus);
expectedBucketOwner(model.expectedBucketOwner);
expectedSourceBucketOwner(model.expectedSourceBucketOwner);
destinationBucket(model.destinationBucket);
destinationKey(model.destinationKey);
sourceBucket(model.sourceBucket);
sourceKey(model.sourceKey);
sourceVersionId(model.sourceVersionId);
}
public final String getAcl() {
return acl;
}
public final void setAcl(String acl) {
this.acl = acl;
}
@Override
public final Builder acl(String acl) {
this.acl = acl;
return this;
}
@Override
public final Builder acl(ObjectCannedACL acl) {
this.acl(acl == null ? null : acl.toString());
return this;
}
public final String getCacheControl() {
return cacheControl;
}
public final void setCacheControl(String cacheControl) {
this.cacheControl = cacheControl;
}
@Override
public final Builder cacheControl(String cacheControl) {
this.cacheControl = cacheControl;
return this;
}
public final String getChecksumAlgorithm() {
return checksumAlgorithm;
}
public final void setChecksumAlgorithm(String checksumAlgorithm) {
this.checksumAlgorithm = checksumAlgorithm;
}
@Override
public final Builder checksumAlgorithm(String checksumAlgorithm) {
this.checksumAlgorithm = checksumAlgorithm;
return this;
}
@Override
public final Builder checksumAlgorithm(ChecksumAlgorithm checksumAlgorithm) {
this.checksumAlgorithm(checksumAlgorithm == null ? null : checksumAlgorithm.toString());
return this;
}
public final String getContentDisposition() {
return contentDisposition;
}
public final void setContentDisposition(String contentDisposition) {
this.contentDisposition = contentDisposition;
}
@Override
public final Builder contentDisposition(String contentDisposition) {
this.contentDisposition = contentDisposition;
return this;
}
public final String getContentEncoding() {
return contentEncoding;
}
public final void setContentEncoding(String contentEncoding) {
this.contentEncoding = contentEncoding;
}
@Override
public final Builder contentEncoding(String contentEncoding) {
this.contentEncoding = contentEncoding;
return this;
}
public final String getContentLanguage() {
return contentLanguage;
}
public final void setContentLanguage(String contentLanguage) {
this.contentLanguage = contentLanguage;
}
@Override
public final Builder contentLanguage(String contentLanguage) {
this.contentLanguage = contentLanguage;
return this;
}
public final String getContentType() {
return contentType;
}
public final void setContentType(String contentType) {
this.contentType = contentType;
}
@Override
public final Builder contentType(String contentType) {
this.contentType = contentType;
return this;
}
@Deprecated
public final String getCopySource() {
return copySource;
}
@Deprecated
public final void setCopySource(String copySource) {
this.copySource = copySource;
}
@Override
@Deprecated
public final Builder copySource(String copySource) {
this.copySource = copySource;
return this;
}
public final String getCopySourceIfMatch() {
return copySourceIfMatch;
}
public final void setCopySourceIfMatch(String copySourceIfMatch) {
this.copySourceIfMatch = copySourceIfMatch;
}
@Override
public final Builder copySourceIfMatch(String copySourceIfMatch) {
this.copySourceIfMatch = copySourceIfMatch;
return this;
}
public final Instant getCopySourceIfModifiedSince() {
return copySourceIfModifiedSince;
}
public final void setCopySourceIfModifiedSince(Instant copySourceIfModifiedSince) {
this.copySourceIfModifiedSince = copySourceIfModifiedSince;
}
@Override
public final Builder copySourceIfModifiedSince(Instant copySourceIfModifiedSince) {
this.copySourceIfModifiedSince = copySourceIfModifiedSince;
return this;
}
public final String getCopySourceIfNoneMatch() {
return copySourceIfNoneMatch;
}
public final void setCopySourceIfNoneMatch(String copySourceIfNoneMatch) {
this.copySourceIfNoneMatch = copySourceIfNoneMatch;
}
@Override
public final Builder copySourceIfNoneMatch(String copySourceIfNoneMatch) {
this.copySourceIfNoneMatch = copySourceIfNoneMatch;
return this;
}
public final Instant getCopySourceIfUnmodifiedSince() {
return copySourceIfUnmodifiedSince;
}
public final void setCopySourceIfUnmodifiedSince(Instant copySourceIfUnmodifiedSince) {
this.copySourceIfUnmodifiedSince = copySourceIfUnmodifiedSince;
}
@Override
public final Builder copySourceIfUnmodifiedSince(Instant copySourceIfUnmodifiedSince) {
this.copySourceIfUnmodifiedSince = copySourceIfUnmodifiedSince;
return this;
}
public final Instant getExpires() {
return expires;
}
public final void setExpires(Instant expires) {
this.expires = expires;
}
@Override
public final Builder expires(Instant expires) {
this.expires = expires;
return this;
}
public final String getGrantFullControl() {
return grantFullControl;
}
public final void setGrantFullControl(String grantFullControl) {
this.grantFullControl = grantFullControl;
}
@Override
public final Builder grantFullControl(String grantFullControl) {
this.grantFullControl = grantFullControl;
return this;
}
public final String getGrantRead() {
return grantRead;
}
public final void setGrantRead(String grantRead) {
this.grantRead = grantRead;
}
@Override
public final Builder grantRead(String grantRead) {
this.grantRead = grantRead;
return this;
}
public final String getGrantReadACP() {
return grantReadACP;
}
public final void setGrantReadACP(String grantReadACP) {
this.grantReadACP = grantReadACP;
}
@Override
public final Builder grantReadACP(String grantReadACP) {
this.grantReadACP = grantReadACP;
return this;
}
public final String getGrantWriteACP() {
return grantWriteACP;
}
public final void setGrantWriteACP(String grantWriteACP) {
this.grantWriteACP = grantWriteACP;
}
@Override
public final Builder grantWriteACP(String grantWriteACP) {
this.grantWriteACP = grantWriteACP;
return this;
}
public final Map getMetadata() {
if (metadata instanceof SdkAutoConstructMap) {
return null;
}
return metadata;
}
public final void setMetadata(Map metadata) {
this.metadata = MetadataCopier.copy(metadata);
}
@Override
public final Builder metadata(Map metadata) {
this.metadata = MetadataCopier.copy(metadata);
return this;
}
public final String getMetadataDirective() {
return metadataDirective;
}
public final void setMetadataDirective(String metadataDirective) {
this.metadataDirective = metadataDirective;
}
@Override
public final Builder metadataDirective(String metadataDirective) {
this.metadataDirective = metadataDirective;
return this;
}
@Override
public final Builder metadataDirective(MetadataDirective metadataDirective) {
this.metadataDirective(metadataDirective == null ? null : metadataDirective.toString());
return this;
}
public final String getTaggingDirective() {
return taggingDirective;
}
public final void setTaggingDirective(String taggingDirective) {
this.taggingDirective = taggingDirective;
}
@Override
public final Builder taggingDirective(String taggingDirective) {
this.taggingDirective = taggingDirective;
return this;
}
@Override
public final Builder taggingDirective(TaggingDirective taggingDirective) {
this.taggingDirective(taggingDirective == null ? null : taggingDirective.toString());
return this;
}
public final String getServerSideEncryption() {
return serverSideEncryption;
}
public final void setServerSideEncryption(String serverSideEncryption) {
this.serverSideEncryption = serverSideEncryption;
}
@Override
public final Builder serverSideEncryption(String serverSideEncryption) {
this.serverSideEncryption = serverSideEncryption;
return this;
}
@Override
public final Builder serverSideEncryption(ServerSideEncryption serverSideEncryption) {
this.serverSideEncryption(serverSideEncryption == null ? null : serverSideEncryption.toString());
return this;
}
public final String getStorageClass() {
return storageClass;
}
public final void setStorageClass(String storageClass) {
this.storageClass = storageClass;
}
@Override
public final Builder storageClass(String storageClass) {
this.storageClass = storageClass;
return this;
}
@Override
public final Builder storageClass(StorageClass storageClass) {
this.storageClass(storageClass == null ? null : storageClass.toString());
return this;
}
public final String getWebsiteRedirectLocation() {
return websiteRedirectLocation;
}
public final void setWebsiteRedirectLocation(String websiteRedirectLocation) {
this.websiteRedirectLocation = websiteRedirectLocation;
}
@Override
public final Builder websiteRedirectLocation(String websiteRedirectLocation) {
this.websiteRedirectLocation = websiteRedirectLocation;
return this;
}
public final String getSseCustomerAlgorithm() {
return sseCustomerAlgorithm;
}
public final void setSseCustomerAlgorithm(String sseCustomerAlgorithm) {
this.sseCustomerAlgorithm = sseCustomerAlgorithm;
}
@Override
public final Builder sseCustomerAlgorithm(String sseCustomerAlgorithm) {
this.sseCustomerAlgorithm = sseCustomerAlgorithm;
return this;
}
public final String getSseCustomerKey() {
return sseCustomerKey;
}
public final void setSseCustomerKey(String sseCustomerKey) {
this.sseCustomerKey = sseCustomerKey;
}
@Override
public final Builder sseCustomerKey(String sseCustomerKey) {
this.sseCustomerKey = sseCustomerKey;
return this;
}
public final String getSseCustomerKeyMD5() {
return sseCustomerKeyMD5;
}
public final void setSseCustomerKeyMD5(String sseCustomerKeyMD5) {
this.sseCustomerKeyMD5 = sseCustomerKeyMD5;
}
@Override
public final Builder sseCustomerKeyMD5(String sseCustomerKeyMD5) {
this.sseCustomerKeyMD5 = sseCustomerKeyMD5;
return this;
}
public final String getSsekmsKeyId() {
return ssekmsKeyId;
}
public final void setSsekmsKeyId(String ssekmsKeyId) {
this.ssekmsKeyId = ssekmsKeyId;
}
@Override
public final Builder ssekmsKeyId(String ssekmsKeyId) {
this.ssekmsKeyId = ssekmsKeyId;
return this;
}
public final String getSsekmsEncryptionContext() {
return ssekmsEncryptionContext;
}
public final void setSsekmsEncryptionContext(String ssekmsEncryptionContext) {
this.ssekmsEncryptionContext = ssekmsEncryptionContext;
}
@Override
public final Builder ssekmsEncryptionContext(String ssekmsEncryptionContext) {
this.ssekmsEncryptionContext = ssekmsEncryptionContext;
return this;
}
public final Boolean getBucketKeyEnabled() {
return bucketKeyEnabled;
}
public final void setBucketKeyEnabled(Boolean bucketKeyEnabled) {
this.bucketKeyEnabled = bucketKeyEnabled;
}
@Override
public final Builder bucketKeyEnabled(Boolean bucketKeyEnabled) {
this.bucketKeyEnabled = bucketKeyEnabled;
return this;
}
public final String getCopySourceSSECustomerAlgorithm() {
return copySourceSSECustomerAlgorithm;
}
public final void setCopySourceSSECustomerAlgorithm(String copySourceSSECustomerAlgorithm) {
this.copySourceSSECustomerAlgorithm = copySourceSSECustomerAlgorithm;
}
@Override
public final Builder copySourceSSECustomerAlgorithm(String copySourceSSECustomerAlgorithm) {
this.copySourceSSECustomerAlgorithm = copySourceSSECustomerAlgorithm;
return this;
}
public final String getCopySourceSSECustomerKey() {
return copySourceSSECustomerKey;
}
public final void setCopySourceSSECustomerKey(String copySourceSSECustomerKey) {
this.copySourceSSECustomerKey = copySourceSSECustomerKey;
}
@Override
public final Builder copySourceSSECustomerKey(String copySourceSSECustomerKey) {
this.copySourceSSECustomerKey = copySourceSSECustomerKey;
return this;
}
public final String getCopySourceSSECustomerKeyMD5() {
return copySourceSSECustomerKeyMD5;
}
public final void setCopySourceSSECustomerKeyMD5(String copySourceSSECustomerKeyMD5) {
this.copySourceSSECustomerKeyMD5 = copySourceSSECustomerKeyMD5;
}
@Override
public final Builder copySourceSSECustomerKeyMD5(String copySourceSSECustomerKeyMD5) {
this.copySourceSSECustomerKeyMD5 = copySourceSSECustomerKeyMD5;
return this;
}
public final String getRequestPayer() {
return requestPayer;
}
public final void setRequestPayer(String requestPayer) {
this.requestPayer = requestPayer;
}
@Override
public final Builder requestPayer(String requestPayer) {
this.requestPayer = requestPayer;
return this;
}
@Override
public final Builder requestPayer(RequestPayer requestPayer) {
this.requestPayer(requestPayer == null ? null : requestPayer.toString());
return this;
}
public final String getTagging() {
return tagging;
}
public final void setTagging(String tagging) {
this.tagging = tagging;
}
@Override
public final Builder tagging(String tagging) {
this.tagging = tagging;
return this;
}
public Builder tagging(Tagging tagging) {
tagging(TaggingAdapter.instance().adapt(tagging));
return this;
}
public final String getObjectLockMode() {
return objectLockMode;
}
public final void setObjectLockMode(String objectLockMode) {
this.objectLockMode = objectLockMode;
}
@Override
public final Builder objectLockMode(String objectLockMode) {
this.objectLockMode = objectLockMode;
return this;
}
@Override
public final Builder objectLockMode(ObjectLockMode objectLockMode) {
this.objectLockMode(objectLockMode == null ? null : objectLockMode.toString());
return this;
}
public final Instant getObjectLockRetainUntilDate() {
return objectLockRetainUntilDate;
}
public final void setObjectLockRetainUntilDate(Instant objectLockRetainUntilDate) {
this.objectLockRetainUntilDate = objectLockRetainUntilDate;
}
@Override
public final Builder objectLockRetainUntilDate(Instant objectLockRetainUntilDate) {
this.objectLockRetainUntilDate = objectLockRetainUntilDate;
return this;
}
public final String getObjectLockLegalHoldStatus() {
return objectLockLegalHoldStatus;
}
public final void setObjectLockLegalHoldStatus(String objectLockLegalHoldStatus) {
this.objectLockLegalHoldStatus = objectLockLegalHoldStatus;
}
@Override
public final Builder objectLockLegalHoldStatus(String objectLockLegalHoldStatus) {
this.objectLockLegalHoldStatus = objectLockLegalHoldStatus;
return this;
}
@Override
public final Builder objectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus) {
this.objectLockLegalHoldStatus(objectLockLegalHoldStatus == null ? null : objectLockLegalHoldStatus.toString());
return this;
}
public final String getExpectedBucketOwner() {
return expectedBucketOwner;
}
public final void setExpectedBucketOwner(String expectedBucketOwner) {
this.expectedBucketOwner = expectedBucketOwner;
}
@Override
public final Builder expectedBucketOwner(String expectedBucketOwner) {
this.expectedBucketOwner = expectedBucketOwner;
return this;
}
public final String getExpectedSourceBucketOwner() {
return expectedSourceBucketOwner;
}
public final void setExpectedSourceBucketOwner(String expectedSourceBucketOwner) {
this.expectedSourceBucketOwner = expectedSourceBucketOwner;
}
@Override
public final Builder expectedSourceBucketOwner(String expectedSourceBucketOwner) {
this.expectedSourceBucketOwner = expectedSourceBucketOwner;
return this;
}
public final String getDestinationBucket() {
return destinationBucket;
}
public final void setDestinationBucket(String destinationBucket) {
this.destinationBucket = destinationBucket;
}
/**
* @deprecated Use {@link #setDestinationBucket} instead
*/
@Deprecated
public final void setBucket(String destinationBucket) {
this.destinationBucket = destinationBucket;
}
@Override
public final Builder destinationBucket(String destinationBucket) {
this.destinationBucket = destinationBucket;
return this;
}
@Override
public final Builder bucket(String destinationBucket) {
this.destinationBucket = destinationBucket;
return this;
}
public final String getDestinationKey() {
return destinationKey;
}
public final void setDestinationKey(String destinationKey) {
this.destinationKey = destinationKey;
}
/**
* @deprecated Use {@link #setDestinationKey} instead
*/
@Deprecated
public final void setKey(String destinationKey) {
this.destinationKey = destinationKey;
}
@Override
public final Builder destinationKey(String destinationKey) {
this.destinationKey = destinationKey;
return this;
}
@Override
public final Builder key(String destinationKey) {
this.destinationKey = destinationKey;
return this;
}
public final String getSourceBucket() {
return sourceBucket;
}
public final void setSourceBucket(String sourceBucket) {
this.sourceBucket = sourceBucket;
}
@Override
public final Builder sourceBucket(String sourceBucket) {
this.sourceBucket = sourceBucket;
return this;
}
public final String getSourceKey() {
return sourceKey;
}
public final void setSourceKey(String sourceKey) {
this.sourceKey = sourceKey;
}
@Override
public final Builder sourceKey(String sourceKey) {
this.sourceKey = sourceKey;
return this;
}
public final String getSourceVersionId() {
return sourceVersionId;
}
public final void setSourceVersionId(String sourceVersionId) {
this.sourceVersionId = sourceVersionId;
}
@Override
public final Builder sourceVersionId(String sourceVersionId) {
this.sourceVersionId = sourceVersionId;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CopyObjectRequest build() {
return new CopyObjectRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}