software.amazon.awssdk.services.s3.model.PutObjectRequest 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.HashMap;
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 PutObjectRequest extends S3Request implements ToCopyableBuilder {
private static final SdkField ACL_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ACL")
.getter(getter(PutObjectRequest::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 BUCKET_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("Bucket")
.getter(getter(PutObjectRequest::bucket))
.setter(setter(Builder::bucket))
.traits(LocationTrait.builder().location(MarshallLocation.PATH).locationName("Bucket")
.unmarshallLocationName("Bucket").build(), RequiredTrait.create()).build();
private static final SdkField CACHE_CONTROL_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("CacheControl")
.getter(getter(PutObjectRequest::cacheControl))
.setter(setter(Builder::cacheControl))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("Cache-Control")
.unmarshallLocationName("Cache-Control").build()).build();
private static final SdkField CONTENT_DISPOSITION_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ContentDisposition")
.getter(getter(PutObjectRequest::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(PutObjectRequest::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(PutObjectRequest::contentLanguage))
.setter(setter(Builder::contentLanguage))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("Content-Language")
.unmarshallLocationName("Content-Language").build()).build();
private static final SdkField CONTENT_LENGTH_FIELD = SdkField
. builder(MarshallingType.LONG)
.memberName("ContentLength")
.getter(getter(PutObjectRequest::contentLength))
.setter(setter(Builder::contentLength))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("Content-Length")
.unmarshallLocationName("Content-Length").build()).build();
private static final SdkField CONTENT_MD5_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ContentMD5")
.getter(getter(PutObjectRequest::contentMD5))
.setter(setter(Builder::contentMD5))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("Content-MD5")
.unmarshallLocationName("Content-MD5").build()).build();
private static final SdkField CONTENT_TYPE_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ContentType")
.getter(getter(PutObjectRequest::contentType))
.setter(setter(Builder::contentType))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("Content-Type")
.unmarshallLocationName("Content-Type").build()).build();
private static final SdkField CHECKSUM_ALGORITHM_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ChecksumAlgorithm")
.getter(getter(PutObjectRequest::checksumAlgorithmAsString))
.setter(setter(Builder::checksumAlgorithm))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-sdk-checksum-algorithm")
.unmarshallLocationName("x-amz-sdk-checksum-algorithm").build()).build();
private static final SdkField CHECKSUM_CRC32_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ChecksumCRC32")
.getter(getter(PutObjectRequest::checksumCRC32))
.setter(setter(Builder::checksumCRC32))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-checksum-crc32")
.unmarshallLocationName("x-amz-checksum-crc32").build()).build();
private static final SdkField CHECKSUM_CRC32_C_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ChecksumCRC32C")
.getter(getter(PutObjectRequest::checksumCRC32C))
.setter(setter(Builder::checksumCRC32C))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-checksum-crc32c")
.unmarshallLocationName("x-amz-checksum-crc32c").build()).build();
private static final SdkField CHECKSUM_SHA1_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ChecksumSHA1")
.getter(getter(PutObjectRequest::checksumSHA1))
.setter(setter(Builder::checksumSHA1))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-checksum-sha1")
.unmarshallLocationName("x-amz-checksum-sha1").build()).build();
private static final SdkField CHECKSUM_SHA256_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ChecksumSHA256")
.getter(getter(PutObjectRequest::checksumSHA256))
.setter(setter(Builder::checksumSHA256))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-checksum-sha256")
.unmarshallLocationName("x-amz-checksum-sha256").build()).build();
private static final SdkField EXPIRES_FIELD = SdkField
. builder(MarshallingType.INSTANT)
.memberName("Expires")
.getter(getter(PutObjectRequest::expires))
.setter(setter(Builder::expires))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("Expires")
.unmarshallLocationName("Expires").build()).build();
private static final SdkField IF_MATCH_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("IfMatch")
.getter(getter(PutObjectRequest::ifMatch))
.setter(setter(Builder::ifMatch))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("If-Match")
.unmarshallLocationName("If-Match").build()).build();
private static final SdkField IF_NONE_MATCH_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("IfNoneMatch")
.getter(getter(PutObjectRequest::ifNoneMatch))
.setter(setter(Builder::ifNoneMatch))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("If-None-Match")
.unmarshallLocationName("If-None-Match").build()).build();
private static final SdkField GRANT_FULL_CONTROL_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("GrantFullControl")
.getter(getter(PutObjectRequest::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(PutObjectRequest::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(PutObjectRequest::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(PutObjectRequest::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 KEY_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("Key")
.getter(getter(PutObjectRequest::key))
.setter(setter(Builder::key))
.traits(LocationTrait.builder().location(MarshallLocation.GREEDY_PATH).locationName("Key")
.unmarshallLocationName("Key").build(), RequiredTrait.create()).build();
private static final SdkField WRITE_OFFSET_BYTES_FIELD = SdkField
. builder(MarshallingType.LONG)
.memberName("WriteOffsetBytes")
.getter(getter(PutObjectRequest::writeOffsetBytes))
.setter(setter(Builder::writeOffsetBytes))
.traits(LocationTrait.builder().location(MarshallLocation.HEADER).locationName("x-amz-write-offset-bytes")
.unmarshallLocationName("x-amz-write-offset-bytes").build()).build();
private static final SdkField> METADATA_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Metadata")
.getter(getter(PutObjectRequest::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 SERVER_SIDE_ENCRYPTION_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ServerSideEncryption")
.getter(getter(PutObjectRequest::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(PutObjectRequest::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(PutObjectRequest::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(PutObjectRequest::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(PutObjectRequest::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(PutObjectRequest::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(PutObjectRequest::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(PutObjectRequest::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(PutObjectRequest::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 REQUEST_PAYER_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("RequestPayer")
.getter(getter(PutObjectRequest::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(PutObjectRequest::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(PutObjectRequest::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(PutObjectRequest::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(PutObjectRequest::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(PutObjectRequest::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 List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(ACL_FIELD, BUCKET_FIELD,
CACHE_CONTROL_FIELD, CONTENT_DISPOSITION_FIELD, CONTENT_ENCODING_FIELD, CONTENT_LANGUAGE_FIELD, CONTENT_LENGTH_FIELD,
CONTENT_MD5_FIELD, CONTENT_TYPE_FIELD, CHECKSUM_ALGORITHM_FIELD, CHECKSUM_CRC32_FIELD, CHECKSUM_CRC32_C_FIELD,
CHECKSUM_SHA1_FIELD, CHECKSUM_SHA256_FIELD, EXPIRES_FIELD, IF_MATCH_FIELD, IF_NONE_MATCH_FIELD,
GRANT_FULL_CONTROL_FIELD, GRANT_READ_FIELD, GRANT_READ_ACP_FIELD, GRANT_WRITE_ACP_FIELD, KEY_FIELD,
WRITE_OFFSET_BYTES_FIELD, METADATA_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, 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));
private static final Map> SDK_NAME_TO_FIELD = memberNameToFieldInitializer();
private final String acl;
private final String bucket;
private final String cacheControl;
private final String contentDisposition;
private final String contentEncoding;
private final String contentLanguage;
private final Long contentLength;
private final String contentMD5;
private final String contentType;
private final String checksumAlgorithm;
private final String checksumCRC32;
private final String checksumCRC32C;
private final String checksumSHA1;
private final String checksumSHA256;
private final Instant expires;
private final String ifMatch;
private final String ifNoneMatch;
private final String grantFullControl;
private final String grantRead;
private final String grantReadACP;
private final String grantWriteACP;
private final String key;
private final Long writeOffsetBytes;
private final Map metadata;
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 requestPayer;
private final String tagging;
private final String objectLockMode;
private final Instant objectLockRetainUntilDate;
private final String objectLockLegalHoldStatus;
private final String expectedBucketOwner;
private PutObjectRequest(BuilderImpl builder) {
super(builder);
this.acl = builder.acl;
this.bucket = builder.bucket;
this.cacheControl = builder.cacheControl;
this.contentDisposition = builder.contentDisposition;
this.contentEncoding = builder.contentEncoding;
this.contentLanguage = builder.contentLanguage;
this.contentLength = builder.contentLength;
this.contentMD5 = builder.contentMD5;
this.contentType = builder.contentType;
this.checksumAlgorithm = builder.checksumAlgorithm;
this.checksumCRC32 = builder.checksumCRC32;
this.checksumCRC32C = builder.checksumCRC32C;
this.checksumSHA1 = builder.checksumSHA1;
this.checksumSHA256 = builder.checksumSHA256;
this.expires = builder.expires;
this.ifMatch = builder.ifMatch;
this.ifNoneMatch = builder.ifNoneMatch;
this.grantFullControl = builder.grantFullControl;
this.grantRead = builder.grantRead;
this.grantReadACP = builder.grantReadACP;
this.grantWriteACP = builder.grantWriteACP;
this.key = builder.key;
this.writeOffsetBytes = builder.writeOffsetBytes;
this.metadata = builder.metadata;
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.requestPayer = builder.requestPayer;
this.tagging = builder.tagging;
this.objectLockMode = builder.objectLockMode;
this.objectLockRetainUntilDate = builder.objectLockRetainUntilDate;
this.objectLockLegalHoldStatus = builder.objectLockLegalHoldStatus;
this.expectedBucketOwner = builder.expectedBucketOwner;
}
/**
*
* The canned ACL to apply to the object. For more information, see Canned ACL in the
* Amazon S3 User Guide.
*
*
* When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web Services
* accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object.
* By default, all objects are private. Only the owner has full access control. For more information, see Access Control List (ACL) Overview
* and Managing ACLs Using the
* REST API in the Amazon S3 User Guide.
*
*
* If the bucket that you're uploading 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.
* PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail
* and return a 400 error with the error code AccessControlListNotSupported. For more
* information, see
* Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.
*
*
*
* -
*
* 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 ACL to apply to the object. For more information, see Canned ACL in the
* Amazon S3 User Guide.
*
* When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web
* Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the
* ACL on the object. By default, all objects are private. Only the owner has full access control. For more
* information, see Access
* Control List (ACL) Overview and Managing ACLs Using the
* REST API in the Amazon S3 User Guide.
*
*
* If the bucket that you're uploading 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. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web
* Services accounts) fail and return a 400 error with the error code
* AccessControlListNotSupported. For more information, see Controlling
* ownership of objects and disabling ACLs in the Amazon S3 User Guide.
*
*
*
* -
*
* 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 ACL to apply to the object. For more information, see Canned ACL in the
* Amazon S3 User Guide.
*
*
* When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web Services
* accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL on the object.
* By default, all objects are private. Only the owner has full access control. For more information, see Access Control List (ACL) Overview
* and Managing ACLs Using the
* REST API in the Amazon S3 User Guide.
*
*
* If the bucket that you're uploading 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.
* PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services accounts) fail
* and return a 400 error with the error code AccessControlListNotSupported. For more
* information, see
* Controlling ownership of objects and disabling ACLs in the Amazon S3 User Guide.
*
*
*
* -
*
* 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 ACL to apply to the object. For more information, see Canned ACL in the
* Amazon S3 User Guide.
*
* When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web
* Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the
* ACL on the object. By default, all objects are private. Only the owner has full access control. For more
* information, see Access
* Control List (ACL) Overview and Managing ACLs Using the
* REST API in the Amazon S3 User Guide.
*
*
* If the bucket that you're uploading 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. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web
* Services accounts) fail and return a 400 error with the error code
* AccessControlListNotSupported. For more information, see Controlling
* ownership of objects and disabling ACLs in the Amazon S3 User Guide.
*
*
*
* -
*
* 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;
}
/**
*
* The bucket name to which the PUT action was initiated.
*
*
* Directory buckets - When you use this operation with a directory bucket, you must use virtual-hosted-style
* requests in the format Bucket-name.s3express-zone-id.region-code.amazonaws.com
* . Path-style requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability
* Zone or Local Zone). Bucket names must follow the format
* bucket-base-name--zone-id--x-s3 (for example,
* DOC-EXAMPLE-BUCKET--usw2-az1--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 bucket name to which the PUT action was initiated.
*
* Directory buckets - When you use this operation with a directory bucket, you must use
* virtual-hosted-style requests in the format
* Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style
* requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone
* or Local Zone). Bucket names must follow the format
* bucket-base-name--zone-id--x-s3 (for example,
* DOC-EXAMPLE-BUCKET--usw2-az1--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 bucket() {
return bucket;
}
/**
*
* Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
*
*
* @return Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
*/
public final String cacheControl() {
return cacheControl;
}
/**
*
* Specifies presentational information for the object. For more information, see https://www.rfc-editor.org/rfc/rfc6266#section-4.
*
*
* @return Specifies presentational information for the object. For more information, see https://www.rfc-editor.org/rfc/rfc6266#section-4.
*/
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 more information, see https://www.rfc-editor.org/rfc/rfc9110.html#field.content-encoding.
*
*
* @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 more information,
* see https://www.rfc-editor.org
* /rfc/rfc9110.html#field.content-encoding.
*/
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;
}
/**
*
* Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.
* For more information, see https://www.rfc
* -editor.org/rfc/rfc9110.html#name-content-length.
*
*
* @return Size of the body in bytes. This parameter is useful when the size of the body cannot be determined
* automatically. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length.
*/
public final Long contentLength() {
return contentLength;
}
/**
*
* The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can
* be used as a message integrity check to verify that the data is the same data that was originally sent. Although
* it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For more
* information about REST request authentication, see REST Authentication.
*
*
*
* The Content-MD5 or x-amz-sdk-checksum-algorithm header is required for any request to
* upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see
* Uploading objects to an Object Lock enabled bucket in the Amazon S3 User Guide.
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* @return The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This
* header can be used as a message integrity check to verify that the data is the same data that was
* originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end
* integrity check. For more information about REST request authentication, see REST
* Authentication.
*
* The Content-MD5 or x-amz-sdk-checksum-algorithm header is required for any
* request to upload an object with a retention period configured using Amazon S3 Object Lock. For more
* information, see Uploading objects to an Object Lock enabled bucket in the Amazon S3 User Guide.
*
*
*
* This functionality is not supported for directory buckets.
*
*/
public final String contentMD5() {
return contentMD5;
}
/**
*
* A standard MIME type describing the format of the contents. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type.
*
*
* @return A standard MIME type describing the format of the contents. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type.
*/
public final String contentType() {
return contentType;
}
/**
*
* Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not
* provide any additional functionality if you don't use the SDK. When you send this header, there must be a
* corresponding x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise,
* Amazon S3 fails the request with the HTTP status code 400 Bad Request.
*
*
* For the x-amz-checksum-algorithm header, replace algorithm with the
* supported algorithm from the following list:
*
*
* -
*
* CRC32
*
*
* -
*
* CRC32C
*
*
* -
*
* SHA1
*
*
* -
*
* SHA256
*
*
*
*
* For more information, see Checking object
* integrity in the Amazon S3 User Guide.
*
*
* If the individual checksum value you provide through x-amz-checksum-algorithm doesn't match
* the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided
* ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in
* x-amz-checksum-algorithm .
*
*
*
* The Content-MD5 or x-amz-sdk-checksum-algorithm header is required for any request to
* upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see
* Uploading objects to an Object Lock enabled bucket in the Amazon S3 User Guide.
*
*
*
* 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 used to create the checksum for the object when you use the SDK. This header will
* not provide any additional functionality if you don't use the SDK. When you send this header, there must
* be a corresponding x-amz-checksum-algorithm or x-amz-trailer header
* sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.
*
* For the x-amz-checksum-algorithm header, replace algorithm
* with the supported algorithm from the following list:
*
*
* -
*
* CRC32
*
*
* -
*
* CRC32C
*
*
* -
*
* SHA1
*
*
* -
*
* SHA256
*
*
*
*
* For more information, see Checking
* object integrity in the Amazon S3 User Guide.
*
*
* If the individual checksum value you provide through x-amz-checksum-algorithm
* doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3
* ignores any provided ChecksumAlgorithm parameter and uses the checksum algorithm that
* matches the provided value in x-amz-checksum-algorithm .
*
*
*
* The Content-MD5 or x-amz-sdk-checksum-algorithm header is required for any
* request to upload an object with a retention period configured using Amazon S3 Object Lock. For more
* information, see Uploading objects to an Object Lock enabled bucket in the Amazon S3 User Guide.
*
*
*
* 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 used to create the checksum for the object when you use the SDK. This header will not
* provide any additional functionality if you don't use the SDK. When you send this header, there must be a
* corresponding x-amz-checksum-algorithm or x-amz-trailer header sent. Otherwise,
* Amazon S3 fails the request with the HTTP status code 400 Bad Request.
*
*
* For the x-amz-checksum-algorithm header, replace algorithm with the
* supported algorithm from the following list:
*
*
* -
*
* CRC32
*
*
* -
*
* CRC32C
*
*
* -
*
* SHA1
*
*
* -
*
* SHA256
*
*
*
*
* For more information, see Checking object
* integrity in the Amazon S3 User Guide.
*
*
* If the individual checksum value you provide through x-amz-checksum-algorithm doesn't match
* the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any provided
* ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided value in
* x-amz-checksum-algorithm .
*
*
*
* The Content-MD5 or x-amz-sdk-checksum-algorithm header is required for any request to
* upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see
* Uploading objects to an Object Lock enabled bucket in the Amazon S3 User Guide.
*
*
*
* 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 used to create the checksum for the object when you use the SDK. This header will
* not provide any additional functionality if you don't use the SDK. When you send this header, there must
* be a corresponding x-amz-checksum-algorithm or x-amz-trailer header
* sent. Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.
*
* For the x-amz-checksum-algorithm header, replace algorithm
* with the supported algorithm from the following list:
*
*
* -
*
* CRC32
*
*
* -
*
* CRC32C
*
*
* -
*
* SHA1
*
*
* -
*
* SHA256
*
*
*
*
* For more information, see Checking
* object integrity in the Amazon S3 User Guide.
*
*
* If the individual checksum value you provide through x-amz-checksum-algorithm
* doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3
* ignores any provided ChecksumAlgorithm parameter and uses the checksum algorithm that
* matches the provided value in x-amz-checksum-algorithm .
*
*
*
* The Content-MD5 or x-amz-sdk-checksum-algorithm header is required for any
* request to upload an object with a retention period configured using Amazon S3 Object Lock. For more
* information, see Uploading objects to an Object Lock enabled bucket in the Amazon S3 User Guide.
*
*
*
* 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;
}
/**
*
* This header can be used as a data integrity check to verify that the data received is the same data that was
* originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more
* information, see Checking object
* integrity in the Amazon S3 User Guide.
*
*
* @return This header can be used as a data integrity check to verify that the data received is the same data that
* was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For
* more information, see Checking
* object integrity in the Amazon S3 User Guide.
*/
public final String checksumCRC32() {
return checksumCRC32;
}
/**
*
* This header can be used as a data integrity check to verify that the data received is the same data that was
* originally sent. This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more
* information, see Checking object
* integrity in the Amazon S3 User Guide.
*
*
* @return This header can be used as a data integrity check to verify that the data received is the same data that
* was originally sent. This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For
* more information, see Checking
* object integrity in the Amazon S3 User Guide.
*/
public final String checksumCRC32C() {
return checksumCRC32C;
}
/**
*
* This header can be used as a data integrity check to verify that the data received is the same data that was
* originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more
* information, see Checking object
* integrity in the Amazon S3 User Guide.
*
*
* @return This header can be used as a data integrity check to verify that the data received is the same data that
* was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For
* more information, see Checking
* object integrity in the Amazon S3 User Guide.
*/
public final String checksumSHA1() {
return checksumSHA1;
}
/**
*
* This header can be used as a data integrity check to verify that the data received is the same data that was
* originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more
* information, see Checking object
* integrity in the Amazon S3 User Guide.
*
*
* @return This header can be used as a data integrity check to verify that the data received is the same data that
* was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For
* more information, see Checking
* object integrity in the Amazon S3 User Guide.
*/
public final String checksumSHA256() {
return checksumSHA256;
}
/**
*
* The date and time at which the object is no longer cacheable. For more information, see https://www.rfc-editor.org/rfc/rfc7234#section-5.3.
*
*
* @return The date and time at which the object is no longer cacheable. For more information, see https://www.rfc-editor.org/rfc/rfc7234#section-5.3.
*/
public final Instant expires() {
return expires;
}
/**
*
* Uploads the object only if the ETag (entity tag) value provided during the WRITE operation matches the ETag of
* the object in S3. If the ETag values do not match, the operation returns a 412 Precondition Failed
* error.
*
*
* If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict
* response. On a 409 failure you should fetch the object's ETag and retry the upload.
*
*
* Expects the ETag value as a string.
*
*
* For more information about conditional requests, see RFC 7232,
* or Conditional
* requests in the Amazon S3 User Guide.
*
*
* @return Uploads the object only if the ETag (entity tag) value provided during the WRITE operation matches the
* ETag of the object in S3. If the ETag values do not match, the operation returns a
* 412 Precondition Failed error.
*
* If a conflicting operation occurs during the upload S3 returns a
* 409 ConditionalRequestConflict response. On a 409 failure you should fetch the object's ETag
* and retry the upload.
*
*
* Expects the ETag value as a string.
*
*
* For more information about conditional requests, see RFC
* 7232, or Conditional
* requests in the Amazon S3 User Guide.
*/
public final String ifMatch() {
return ifMatch;
}
/**
*
* Uploads the object only if the object key name does not already exist in the bucket specified. Otherwise, Amazon
* S3 returns a 412 Precondition Failed error.
*
*
* If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict
* response. On a 409 failure you should retry the upload.
*
*
* Expects the '*' (asterisk) character.
*
*
* For more information about conditional requests, see RFC 7232,
* or Conditional
* requests in the Amazon S3 User Guide.
*
*
* @return Uploads the object only if the object key name does not already exist in the bucket specified. Otherwise,
* Amazon S3 returns a 412 Precondition Failed error.
*
* If a conflicting operation occurs during the upload S3 returns a
* 409 ConditionalRequestConflict response. On a 409 failure you should retry the upload.
*
*
* Expects the '*' (asterisk) character.
*
*
* For more information about conditional requests, see RFC
* 7232, or Conditional
* requests in the Amazon S3 User Guide.
*/
public final String ifNoneMatch() {
return ifNoneMatch;
}
/**
*
* 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;
}
/**
*
* Object key for which the PUT action was initiated.
*
*
* @return Object key for which the PUT action was initiated.
*/
public final String key() {
return key;
}
/**
*
* Specifies the offset for appending data to existing objects in bytes. The offset must be equal to the size of the
* existing object being appended to. If no object exists, setting this header to 0 will create a new object.
*
*
*
* This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory
* buckets.
*
*
*
* @return Specifies the offset for appending data to existing objects in bytes. The offset must be equal to the
* size of the existing object being appended to. If no object exists, setting this header to 0 will create
* a new object.
*
* This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in
* directory buckets.
*
*/
public final Long writeOffsetBytes() {
return writeOffsetBytes;
}
/**
* 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;
}
/**
*
* The server-side encryption algorithm that was used when you store this object in Amazon S3 (for example,
* AES256, aws:kms, aws:kms:dsse).
*
*
* -
*
* General purpose buckets - You have four mutually exclusive options to protect data using server-side
* encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption
* key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and
* customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using Amazon S3 managed
* keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest by using server-side
* encryption with other key options. For more information, see Using Server-Side
* Encryption in the Amazon S3 User Guide.
*
*
* -
*
* Directory buckets - For directory buckets, there are only two supported options for server-side
* encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side
* encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption uses
* the desired encryption configuration and you don't override the bucket default encryption in your
* CreateSession requests or PUT object requests. Then, new objects are automatically
* encrypted with the desired encryption settings. For more information, see Protecting data
* with server-side encryption in the Amazon S3 User Guide. For more information about the encryption
* overriding behaviors in directory buckets, see Specifying
* server-side encryption with KMS for new object uploads.
*
*
* In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the REST
* API, the encryption request headers must match the encryption settings that are specified in the
* CreateSession request. You can't override the values of the encryption settings (
* x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id,
* x-amz-server-side-encryption-context, and
* x-amz-server-side-encryption-bucket-key-enabled) that are specified in the
* CreateSession request. You don't need to explicitly specify these encryption settings values in
* Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the
* CreateSession request to protect new objects in the directory bucket.
*
*
*
* When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token refreshes
* automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use
* the bucket's default encryption configuration for the CreateSession request. It's not supported to
* override the encryption settings values in the CreateSession request. So in the Zonal endpoint API
* calls (except CopyObject and UploadPartCopy), the
* encryption request headers must match the default encryption configuration of the directory bucket.
*
*
*
*
* 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 that was used when you store this object in Amazon S3 (for example,
* AES256, aws:kms, aws:kms:dsse).
*
* -
*
* General purpose buckets - You have four mutually exclusive options to protect data using
* server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys.
* Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS
* keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side
* encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to
* encrypt data at rest by using server-side encryption with other key options. For more information, see Using Server-Side
* Encryption in the Amazon S3 User Guide.
*
*
* -
*
* Directory buckets - For directory buckets, there are only two supported options for server-side
* encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and
* server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's
* default encryption uses the desired encryption configuration and you don't override the bucket default
* encryption in your CreateSession requests or PUT object requests. Then, new
* objects are automatically encrypted with the desired encryption settings. For more information, see Protecting
* data with server-side encryption in the Amazon S3 User Guide. For more information about the
* encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
*
*
* In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using
* the REST API, the encryption request headers must match the encryption settings that are specified in the
* CreateSession request. You can't override the values of the encryption settings (
* x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id,
* x-amz-server-side-encryption-context, and
* x-amz-server-side-encryption-bucket-key-enabled) that are specified in the
* CreateSession request. You don't need to explicitly specify these encryption settings values
* in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the
* CreateSession request to protect new objects in the directory bucket.
*
*
*
* When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token
* refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web
* Services SDKs use the bucket's default encryption configuration for the CreateSession
* request. It's not supported to override the encryption settings values in the CreateSession
* request. So in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), the
* encryption request headers must match the default encryption configuration of the directory bucket.
*
*
* @see ServerSideEncryption
*/
public final ServerSideEncryption serverSideEncryption() {
return ServerSideEncryption.fromValue(serverSideEncryption);
}
/**
*
* The server-side encryption algorithm that was used when you store this object in Amazon S3 (for example,
* AES256, aws:kms, aws:kms:dsse).
*
*
* -
*
* General purpose buckets - You have four mutually exclusive options to protect data using server-side
* encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the encryption
* key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or DSSE-KMS), and
* customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using Amazon S3 managed
* keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest by using server-side
* encryption with other key options. For more information, see Using Server-Side
* Encryption in the Amazon S3 User Guide.
*
*
* -
*
* Directory buckets - For directory buckets, there are only two supported options for server-side
* encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side
* encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption uses
* the desired encryption configuration and you don't override the bucket default encryption in your
* CreateSession requests or PUT object requests. Then, new objects are automatically
* encrypted with the desired encryption settings. For more information, see Protecting data
* with server-side encryption in the Amazon S3 User Guide. For more information about the encryption
* overriding behaviors in directory buckets, see Specifying
* server-side encryption with KMS for new object uploads.
*
*
* In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the REST
* API, the encryption request headers must match the encryption settings that are specified in the
* CreateSession request. You can't override the values of the encryption settings (
* x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id,
* x-amz-server-side-encryption-context, and
* x-amz-server-side-encryption-bucket-key-enabled) that are specified in the
* CreateSession request. You don't need to explicitly specify these encryption settings values in
* Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the
* CreateSession request to protect new objects in the directory bucket.
*
*
*
* When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token refreshes
* automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web Services SDKs use
* the bucket's default encryption configuration for the CreateSession request. It's not supported to
* override the encryption settings values in the CreateSession request. So in the Zonal endpoint API
* calls (except CopyObject and UploadPartCopy), the
* encryption request headers must match the default encryption configuration of the directory bucket.
*
*
*
*
* 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 that was used when you store this object in Amazon S3 (for example,
* AES256, aws:kms, aws:kms:dsse).
*
* -
*
* General purpose buckets - You have four mutually exclusive options to protect data using
* server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys.
* Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS
* keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side
* encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to
* encrypt data at rest by using server-side encryption with other key options. For more information, see Using Server-Side
* Encryption in the Amazon S3 User Guide.
*
*
* -
*
* Directory buckets - For directory buckets, there are only two supported options for server-side
* encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and
* server-side encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's
* default encryption uses the desired encryption configuration and you don't override the bucket default
* encryption in your CreateSession requests or PUT object requests. Then, new
* objects are automatically encrypted with the desired encryption settings. For more information, see Protecting
* data with server-side encryption in the Amazon S3 User Guide. For more information about the
* encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
*
*
* In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using
* the REST API, the encryption request headers must match the encryption settings that are specified in the
* CreateSession request. You can't override the values of the encryption settings (
* x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id,
* x-amz-server-side-encryption-context, and
* x-amz-server-side-encryption-bucket-key-enabled) that are specified in the
* CreateSession request. You don't need to explicitly specify these encryption settings values
* in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the
* CreateSession request to protect new objects in the directory bucket.
*
*
*
* When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token
* refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web
* Services SDKs use the bucket's default encryption configuration for the CreateSession
* request. It's not supported to override the encryption settings values in the CreateSession
* request. So in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), the
* encryption request headers must match the default encryption configuration of the directory bucket.
*
*
* @see ServerSideEncryption
*/
public final String serverSideEncryptionAsString() {
return serverSideEncryption;
}
/**
*
* By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class
* provides high durability and high availability. Depending on performance needs, you can specify a different
* Storage Class. For more information, see Storage Classes in the
* Amazon S3 User Guide.
*
*
*
* -
*
* For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects.
*
*
* -
*
* Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
*
*
*
*
*
* 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 By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD
* storage class provides high durability and high availability. Depending on performance needs, you can
* specify a different Storage Class. For more information, see Storage Classes in
* the Amazon S3 User Guide.
*
* -
*
* For directory buckets, only the S3 Express One Zone storage class is supported to store newly created
* objects.
*
*
* -
*
* Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
*
*
*
* @see StorageClass
*/
public final StorageClass storageClass() {
return StorageClass.fromValue(storageClass);
}
/**
*
* By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class
* provides high durability and high availability. Depending on performance needs, you can specify a different
* Storage Class. For more information, see Storage Classes in the
* Amazon S3 User Guide.
*
*
*
* -
*
* For directory buckets, only the S3 Express One Zone storage class is supported to store newly created objects.
*
*
* -
*
* Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
*
*
*
*
*
* 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 By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD
* storage class provides high durability and high availability. Depending on performance needs, you can
* specify a different Storage Class. For more information, see Storage Classes in
* the Amazon S3 User Guide.
*
* -
*
* For directory buckets, only the S3 Express One Zone storage class is supported to store newly created
* objects.
*
*
* -
*
* Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
*
*
*
* @see StorageClass
*/
public final String storageClassAsString() {
return storageClass;
}
/**
*
* If the bucket is configured as a website, redirects requests for this object to another object in the same bucket
* or to an external URL. Amazon S3 stores the value of this header in the object metadata. For information about
* object metadata, see Object Key and
* Metadata in the Amazon S3 User Guide.
*
*
* In the following example, the request header sets the redirect to an object (anotherPage.html) in the same
* bucket:
*
*
* x-amz-website-redirect-location: /anotherPage.html
*
*
* In the following example, the request header sets the object redirect to another website:
*
*
* x-amz-website-redirect-location: http://www.example.com/
*
*
* For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3 and
* How to Configure Website Page
* Redirects in the Amazon S3 User Guide.
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* @return If the bucket is configured as a website, redirects requests for this object to another object in the
* same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For
* information about object metadata, see Object Key and Metadata in
* the Amazon S3 User Guide.
*
* In the following example, the request header sets the redirect to an object (anotherPage.html) in the
* same bucket:
*
*
* x-amz-website-redirect-location: /anotherPage.html
*
*
* In the following example, the request header sets the object redirect to another website:
*
*
* x-amz-website-redirect-location: http://www.example.com/
*
*
* For more information about website hosting in Amazon S3, see Hosting Websites on Amazon
* S3 and How to
* Configure Website Page Redirects in the Amazon S3 User Guide.
*
*
*
* 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).
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* @return Specifies the algorithm to use when encrypting the object (for example, AES256).
*
* This functionality is not supported for directory buckets.
*
*/
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 for directory buckets.
*
*
*
* @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 for directory buckets.
*
*/
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 for directory buckets.
*
*
*
* @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 for directory buckets.
*
*/
public final String sseCustomerKeyMD5() {
return sseCustomerKeyMD5;
}
/**
*
* Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't
* exist in the same account that's issuing the command, you must use the full Key ARN not the Key ID.
*
*
* General purpose buckets - If you specify x-amz-server-side-encryption with
* aws:kms or aws:kms:dsse, this header specifies the ID (Key ID, Key ARN, or Key Alias)
* of the KMS key to use. If you specify x-amz-server-side-encryption:aws:kms or
* x-amz-server-side-encryption:aws:kms:dsse, but do not provide
* x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key (
* aws/s3) to protect the data.
*
*
* Directory buckets - If you specify x-amz-server-side-encryption with aws:kms,
* the x-amz-server-side-encryption-aws-kms-key-id header is implicitly assigned the ID of the KMS
* symmetric encryption customer managed key that's configured for your directory bucket's default encryption
* setting. If you want to specify the x-amz-server-side-encryption-aws-kms-key-id header explicitly,
* you can only specify it with the ID (Key ID or Key ARN) of the KMS customer managed key that's configured for
* your directory bucket's default encryption setting. Otherwise, you get an HTTP 400 Bad Request
* error. Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Your SSE-KMS
* configuration can only support 1 customer managed key
* per directory bucket for the lifetime of the bucket. The Amazon Web Services
* managed key (aws/s3) isn't supported.
*
*
* @return Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key
* doesn't exist in the same account that's issuing the command, you must use the full Key ARN not the Key
* ID.
*
* General purpose buckets - If you specify x-amz-server-side-encryption with
* aws:kms or aws:kms:dsse, this header specifies the ID (Key ID, Key ARN, or Key
* Alias) of the KMS key to use. If you specify x-amz-server-side-encryption:aws:kms or
* x-amz-server-side-encryption:aws:kms:dsse, but do not provide
* x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed
* key (aws/s3) to protect the data.
*
*
* Directory buckets - If you specify x-amz-server-side-encryption with
* aws:kms, the x-amz-server-side-encryption-aws-kms-key-id header is implicitly
* assigned the ID of the KMS symmetric encryption customer managed key that's configured for your directory
* bucket's default encryption setting. If you want to specify the
* x-amz-server-side-encryption-aws-kms-key-id header explicitly, you can only specify it with
* the ID (Key ID or Key ARN) of the KMS customer managed key that's configured for your directory bucket's
* default encryption setting. Otherwise, you get an HTTP 400 Bad Request error. Only use the
* key ID or key ARN. The key alias format of the KMS key isn't supported. Your SSE-KMS configuration can
* only support 1 customer managed
* key per directory bucket for the lifetime of the bucket. The Amazon Web
* Services managed key (aws/s3) isn't supported.
*/
public final String ssekmsKeyId() {
return ssekmsKeyId;
}
/**
*
* Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for object
* encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which contains the
* encryption context as key-value pairs. This value is stored as object metadata and automatically gets passed on
* to Amazon Web Services KMS for future GetObject operations on this object.
*
*
* General purpose buckets - This value must be explicitly added during CopyObject operations if
* you want an additional encryption context for your object. For more information, see Encryption context in the Amazon S3 User Guide.
*
*
* Directory buckets - You can optionally provide an explicit encryption context value. The value must match
* the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption context value is
* not supported.
*
*
* @return Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use for
* object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which
* contains the encryption context as key-value pairs. This value is stored as object metadata and
* automatically gets passed on to Amazon Web Services KMS for future GetObject operations on
* this object.
*
* General purpose buckets - This value must be explicitly added during CopyObject
* operations if you want an additional encryption context for your object. For more information, see
* Encryption context in the Amazon S3 User Guide.
*
*
* Directory buckets - You can optionally provide an explicit encryption context value. The value
* must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional
* encryption context value is not supported.
*/
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).
*
*
* General purpose buckets - Setting this header to true causes Amazon S3 to use an S3 Bucket
* Key for object encryption with SSE-KMS. Also, specifying this header with a PUT action doesn't affect
* bucket-level settings for S3 Bucket Key.
*
*
* Directory buckets - S3 Bucket Keys are always enabled for GET and PUT operations
* in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy SSE-KMS encrypted
* objects from general purpose buckets to directory buckets, from directory buckets to general purpose buckets, or
* between directory buckets, through CopyObject, UploadPartCopy, the Copy
* operation in Batch Operations, or the import jobs. In this case,
* Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.
*
*
* @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).
*
* General purpose buckets - Setting this header to true causes Amazon S3 to use an S3
* Bucket Key for object encryption with SSE-KMS. Also, specifying this header with a PUT action doesn't
* affect bucket-level settings for S3 Bucket Key.
*
*
* Directory buckets - S3 Bucket Keys are always enabled for GET and PUT
* operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy
* SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to
* general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy
* operation in Batch Operations, or the import jobs. In
* this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.
*/
public final Boolean bucketKeyEnabled() {
return bucketKeyEnabled;
}
/**
* 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. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* @return The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example,
* "Key1=Value1")
*
* This functionality is not supported for directory buckets.
*
*/
public final String tagging() {
return tagging;
}
/**
*
* The Object Lock mode that you want to apply to this object.
*
*
*
* 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 this object.
*
* 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 this object.
*
*
*
* 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 this object.
*
* This functionality is not supported for directory buckets.
*
* @see ObjectLockMode
*/
public final String objectLockModeAsString() {
return objectLockMode;
}
/**
*
* The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp parameter.
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* @return The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp
* parameter.
*
* This functionality is not supported for directory buckets.
*
*/
public final Instant objectLockRetainUntilDate() {
return objectLockRetainUntilDate;
}
/**
*
* Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock in the Amazon S3 User
* Guide.
*
*
*
* 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 a legal hold will be applied to this object. For more information about S3 Object Lock,
* see Object Lock in the
* Amazon S3 User Guide.
*
* This functionality is not supported for directory buckets.
*
* @see ObjectLockLegalHoldStatus
*/
public final ObjectLockLegalHoldStatus objectLockLegalHoldStatus() {
return ObjectLockLegalHoldStatus.fromValue(objectLockLegalHoldStatus);
}
/**
*
* Specifies whether a legal hold will be applied to this object. For more information about S3 Object Lock, see Object Lock in the Amazon S3 User
* Guide.
*
*
*
* 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 a legal hold will be applied to this object. For more information about S3 Object Lock,
* see Object Lock in the
* Amazon S3 User Guide.
*
* This functionality is not supported for directory buckets.
*
* @see ObjectLockLegalHoldStatus
*/
public final String objectLockLegalHoldStatusAsString() {
return objectLockLegalHoldStatus;
}
/**
*
* The account ID of the expected bucket owner. If the account ID that you provide does not match the actual owner
* of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
*
*
* @return The account ID of the expected bucket owner. If the account ID that you provide does not match the actual
* owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access
* denied).
*/
public final String expectedBucketOwner() {
return expectedBucketOwner;
}
@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(bucket());
hashCode = 31 * hashCode + Objects.hashCode(cacheControl());
hashCode = 31 * hashCode + Objects.hashCode(contentDisposition());
hashCode = 31 * hashCode + Objects.hashCode(contentEncoding());
hashCode = 31 * hashCode + Objects.hashCode(contentLanguage());
hashCode = 31 * hashCode + Objects.hashCode(contentLength());
hashCode = 31 * hashCode + Objects.hashCode(contentMD5());
hashCode = 31 * hashCode + Objects.hashCode(contentType());
hashCode = 31 * hashCode + Objects.hashCode(checksumAlgorithmAsString());
hashCode = 31 * hashCode + Objects.hashCode(checksumCRC32());
hashCode = 31 * hashCode + Objects.hashCode(checksumCRC32C());
hashCode = 31 * hashCode + Objects.hashCode(checksumSHA1());
hashCode = 31 * hashCode + Objects.hashCode(checksumSHA256());
hashCode = 31 * hashCode + Objects.hashCode(expires());
hashCode = 31 * hashCode + Objects.hashCode(ifMatch());
hashCode = 31 * hashCode + Objects.hashCode(ifNoneMatch());
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(key());
hashCode = 31 * hashCode + Objects.hashCode(writeOffsetBytes());
hashCode = 31 * hashCode + Objects.hashCode(hasMetadata() ? metadata() : null);
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(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());
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 PutObjectRequest)) {
return false;
}
PutObjectRequest other = (PutObjectRequest) obj;
return Objects.equals(aclAsString(), other.aclAsString()) && Objects.equals(bucket(), other.bucket())
&& Objects.equals(cacheControl(), other.cacheControl())
&& Objects.equals(contentDisposition(), other.contentDisposition())
&& Objects.equals(contentEncoding(), other.contentEncoding())
&& Objects.equals(contentLanguage(), other.contentLanguage())
&& Objects.equals(contentLength(), other.contentLength()) && Objects.equals(contentMD5(), other.contentMD5())
&& Objects.equals(contentType(), other.contentType())
&& Objects.equals(checksumAlgorithmAsString(), other.checksumAlgorithmAsString())
&& Objects.equals(checksumCRC32(), other.checksumCRC32())
&& Objects.equals(checksumCRC32C(), other.checksumCRC32C())
&& Objects.equals(checksumSHA1(), other.checksumSHA1())
&& Objects.equals(checksumSHA256(), other.checksumSHA256()) && Objects.equals(expires(), other.expires())
&& Objects.equals(ifMatch(), other.ifMatch()) && Objects.equals(ifNoneMatch(), other.ifNoneMatch())
&& Objects.equals(grantFullControl(), other.grantFullControl()) && Objects.equals(grantRead(), other.grantRead())
&& Objects.equals(grantReadACP(), other.grantReadACP()) && Objects.equals(grantWriteACP(), other.grantWriteACP())
&& Objects.equals(key(), other.key()) && Objects.equals(writeOffsetBytes(), other.writeOffsetBytes())
&& hasMetadata() == other.hasMetadata() && Objects.equals(metadata(), other.metadata())
&& 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(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());
}
/**
* 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("PutObjectRequest").add("ACL", aclAsString()).add("Bucket", bucket())
.add("CacheControl", cacheControl()).add("ContentDisposition", contentDisposition())
.add("ContentEncoding", contentEncoding()).add("ContentLanguage", contentLanguage())
.add("ContentLength", contentLength()).add("ContentMD5", contentMD5()).add("ContentType", contentType())
.add("ChecksumAlgorithm", checksumAlgorithmAsString()).add("ChecksumCRC32", checksumCRC32())
.add("ChecksumCRC32C", checksumCRC32C()).add("ChecksumSHA1", checksumSHA1())
.add("ChecksumSHA256", checksumSHA256()).add("Expires", expires()).add("IfMatch", ifMatch())
.add("IfNoneMatch", ifNoneMatch()).add("GrantFullControl", grantFullControl()).add("GrantRead", grantRead())
.add("GrantReadACP", grantReadACP()).add("GrantWriteACP", grantWriteACP()).add("Key", key())
.add("WriteOffsetBytes", writeOffsetBytes()).add("Metadata", hasMetadata() ? metadata() : null)
.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("RequestPayer", requestPayerAsString())
.add("Tagging", tagging()).add("ObjectLockMode", objectLockModeAsString())
.add("ObjectLockRetainUntilDate", objectLockRetainUntilDate())
.add("ObjectLockLegalHoldStatus", objectLockLegalHoldStatusAsString())
.add("ExpectedBucketOwner", expectedBucketOwner()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ACL":
return Optional.ofNullable(clazz.cast(aclAsString()));
case "Bucket":
return Optional.ofNullable(clazz.cast(bucket()));
case "CacheControl":
return Optional.ofNullable(clazz.cast(cacheControl()));
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 "ContentLength":
return Optional.ofNullable(clazz.cast(contentLength()));
case "ContentMD5":
return Optional.ofNullable(clazz.cast(contentMD5()));
case "ContentType":
return Optional.ofNullable(clazz.cast(contentType()));
case "ChecksumAlgorithm":
return Optional.ofNullable(clazz.cast(checksumAlgorithmAsString()));
case "ChecksumCRC32":
return Optional.ofNullable(clazz.cast(checksumCRC32()));
case "ChecksumCRC32C":
return Optional.ofNullable(clazz.cast(checksumCRC32C()));
case "ChecksumSHA1":
return Optional.ofNullable(clazz.cast(checksumSHA1()));
case "ChecksumSHA256":
return Optional.ofNullable(clazz.cast(checksumSHA256()));
case "Expires":
return Optional.ofNullable(clazz.cast(expires()));
case "IfMatch":
return Optional.ofNullable(clazz.cast(ifMatch()));
case "IfNoneMatch":
return Optional.ofNullable(clazz.cast(ifNoneMatch()));
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 "Key":
return Optional.ofNullable(clazz.cast(key()));
case "WriteOffsetBytes":
return Optional.ofNullable(clazz.cast(writeOffsetBytes()));
case "Metadata":
return Optional.ofNullable(clazz.cast(metadata()));
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 "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()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Map> memberNameToFieldInitializer() {
Map> map = new HashMap<>();
map.put("x-amz-acl", ACL_FIELD);
map.put("Bucket", BUCKET_FIELD);
map.put("Cache-Control", CACHE_CONTROL_FIELD);
map.put("Content-Disposition", CONTENT_DISPOSITION_FIELD);
map.put("Content-Encoding", CONTENT_ENCODING_FIELD);
map.put("Content-Language", CONTENT_LANGUAGE_FIELD);
map.put("Content-Length", CONTENT_LENGTH_FIELD);
map.put("Content-MD5", CONTENT_MD5_FIELD);
map.put("Content-Type", CONTENT_TYPE_FIELD);
map.put("x-amz-sdk-checksum-algorithm", CHECKSUM_ALGORITHM_FIELD);
map.put("x-amz-checksum-crc32", CHECKSUM_CRC32_FIELD);
map.put("x-amz-checksum-crc32c", CHECKSUM_CRC32_C_FIELD);
map.put("x-amz-checksum-sha1", CHECKSUM_SHA1_FIELD);
map.put("x-amz-checksum-sha256", CHECKSUM_SHA256_FIELD);
map.put("Expires", EXPIRES_FIELD);
map.put("If-Match", IF_MATCH_FIELD);
map.put("If-None-Match", IF_NONE_MATCH_FIELD);
map.put("x-amz-grant-full-control", GRANT_FULL_CONTROL_FIELD);
map.put("x-amz-grant-read", GRANT_READ_FIELD);
map.put("x-amz-grant-read-acp", GRANT_READ_ACP_FIELD);
map.put("x-amz-grant-write-acp", GRANT_WRITE_ACP_FIELD);
map.put("Key", KEY_FIELD);
map.put("x-amz-write-offset-bytes", WRITE_OFFSET_BYTES_FIELD);
map.put("x-amz-meta-", METADATA_FIELD);
map.put("x-amz-server-side-encryption", SERVER_SIDE_ENCRYPTION_FIELD);
map.put("x-amz-storage-class", STORAGE_CLASS_FIELD);
map.put("x-amz-website-redirect-location", WEBSITE_REDIRECT_LOCATION_FIELD);
map.put("x-amz-server-side-encryption-customer-algorithm", SSE_CUSTOMER_ALGORITHM_FIELD);
map.put("x-amz-server-side-encryption-customer-key", SSE_CUSTOMER_KEY_FIELD);
map.put("x-amz-server-side-encryption-customer-key-MD5", SSE_CUSTOMER_KEY_MD5_FIELD);
map.put("x-amz-server-side-encryption-aws-kms-key-id", SSEKMS_KEY_ID_FIELD);
map.put("x-amz-server-side-encryption-context", SSEKMS_ENCRYPTION_CONTEXT_FIELD);
map.put("x-amz-server-side-encryption-bucket-key-enabled", BUCKET_KEY_ENABLED_FIELD);
map.put("x-amz-request-payer", REQUEST_PAYER_FIELD);
map.put("x-amz-tagging", TAGGING_FIELD);
map.put("x-amz-object-lock-mode", OBJECT_LOCK_MODE_FIELD);
map.put("x-amz-object-lock-retain-until-date", OBJECT_LOCK_RETAIN_UNTIL_DATE_FIELD);
map.put("x-amz-object-lock-legal-hold", OBJECT_LOCK_LEGAL_HOLD_STATUS_FIELD);
map.put("x-amz-expected-bucket-owner", EXPECTED_BUCKET_OWNER_FIELD);
return Collections.unmodifiableMap(map);
}
private static Function getter(Function g) {
return obj -> g.apply((PutObjectRequest) 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 ACL to apply to the object. For more information, see Canned ACL in the
* Amazon S3 User Guide.
*
*
* When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web
* Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL
* on the object. By default, all objects are private. Only the owner has full access control. For more
* information, see Access Control
* List (ACL) Overview and Managing ACLs Using the REST
* API in the Amazon S3 User Guide.
*
*
* If the bucket that you're uploading 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. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services
* accounts) fail and return a 400 error with the error code
* AccessControlListNotSupported. For more information, see Controlling
* ownership of objects and disabling ACLs in the Amazon S3 User Guide.
*
*
*
* -
*
* This functionality is not supported for directory buckets.
*
*
* -
*
* This functionality is not supported for Amazon S3 on Outposts.
*
*
*
*
*
* @param acl
* The canned ACL to apply to the object. For more information, see Canned ACL in
* the Amazon S3 User Guide.
*
* When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web
* Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to
* the ACL on the object. By default, all objects are private. Only the owner has full access control.
* For more information, see Access Control List (ACL)
* Overview and Managing ACLs Using the
* REST API in the Amazon S3 User Guide.
*
*
* If the bucket that you're uploading 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. PUT requests that contain other ACLs (for example, custom grants to
* certain Amazon Web Services accounts) fail and return a 400 error with the error code
* AccessControlListNotSupported. For more information, see Controlling
* ownership of objects and disabling ACLs in the Amazon S3 User Guide.
*
*
*
* -
*
* 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 ACL to apply to the object. For more information, see Canned ACL in the
* Amazon S3 User Guide.
*
*
* When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web
* Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to the ACL
* on the object. By default, all objects are private. Only the owner has full access control. For more
* information, see Access Control
* List (ACL) Overview and Managing ACLs Using the REST
* API in the Amazon S3 User Guide.
*
*
* If the bucket that you're uploading 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. PUT requests that contain other ACLs (for example, custom grants to certain Amazon Web Services
* accounts) fail and return a 400 error with the error code
* AccessControlListNotSupported. For more information, see Controlling
* ownership of objects and disabling ACLs in the Amazon S3 User Guide.
*
*
*
* -
*
* This functionality is not supported for directory buckets.
*
*
* -
*
* This functionality is not supported for Amazon S3 on Outposts.
*
*
*
*
*
* @param acl
* The canned ACL to apply to the object. For more information, see Canned ACL in
* the Amazon S3 User Guide.
*
* When adding a new object, you can use headers to grant ACL-based permissions to individual Amazon Web
* Services accounts or to predefined groups defined by Amazon S3. These permissions are then added to
* the ACL on the object. By default, all objects are private. Only the owner has full access control.
* For more information, see Access Control List (ACL)
* Overview and Managing ACLs Using the
* REST API in the Amazon S3 User Guide.
*
*
* If the bucket that you're uploading 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. PUT requests that contain other ACLs (for example, custom grants to
* certain Amazon Web Services accounts) fail and return a 400 error with the error code
* AccessControlListNotSupported. For more information, see Controlling
* ownership of objects and disabling ACLs in the Amazon S3 User Guide.
*
*
*
* -
*
* 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);
/**
*
* The bucket name to which the PUT action was initiated.
*
*
* Directory buckets - When you use this operation with a directory bucket, you must use
* virtual-hosted-style requests in the format
* Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style
* requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability Zone or
* Local Zone). Bucket names must follow the format bucket-base-name--zone-id--x-s3
* (for example, DOC-EXAMPLE-BUCKET--usw2-az1--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 bucket
* The bucket name to which the PUT action was initiated.
*
* Directory buckets - When you use this operation with a directory bucket, you must use
* virtual-hosted-style requests in the format
* Bucket-name.s3express-zone-id.region-code.amazonaws.com. Path-style
* requests are not supported. Directory bucket names must be unique in the chosen Zone (Availability
* Zone or Local Zone). Bucket names must follow the format
* bucket-base-name--zone-id--x-s3 (for example,
* DOC-EXAMPLE-BUCKET--usw2-az1--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 bucket(String bucket);
/**
*
* Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.9.
*
*
* @param cacheControl
* Can be used to specify caching behavior along the request/reply chain. For more information, see http://www.w3.org/Protocols/rfc2616
* /rfc2616-sec14.html#sec14.9.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder cacheControl(String cacheControl);
/**
*
* Specifies presentational information for the object. For more information, see https://www.rfc-editor.org/rfc/rfc6266#section-4.
*
*
* @param contentDisposition
* Specifies presentational information for the object. For more information, see https://www.rfc-editor.org/rfc/rfc6266#section-4.
* @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 more information, see https://www.rfc-editor.org/rfc/rfc9110
* .html#field.content-encoding.
*
*
* @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 more
* information, see https://www
* .rfc-editor.org/rfc/rfc9110.html#field.content-encoding.
* @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);
/**
*
* Size of the body in bytes. This parameter is useful when the size of the body cannot be determined
* automatically. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length.
*
*
* @param contentLength
* Size of the body in bytes. This parameter is useful when the size of the body cannot be determined
* automatically. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-length.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder contentLength(Long contentLength);
/**
*
* The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header
* can be used as a message integrity check to verify that the data is the same data that was originally sent.
* Although it is optional, we recommend using the Content-MD5 mechanism as an end-to-end integrity check. For
* more information about REST request authentication, see REST Authentication.
*
*
*
* The Content-MD5 or x-amz-sdk-checksum-algorithm header is required for any request
* to upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see
* Uploading objects to an Object Lock enabled bucket in the Amazon S3 User Guide.
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* @param contentMD5
* The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This
* header can be used as a message integrity check to verify that the data is the same data that was
* originally sent. Although it is optional, we recommend using the Content-MD5 mechanism as an
* end-to-end integrity check. For more information about REST request authentication, see REST
* Authentication.
*
* The Content-MD5 or x-amz-sdk-checksum-algorithm header is required for any
* request to upload an object with a retention period configured using Amazon S3 Object Lock. For more
* information, see Uploading objects to an Object Lock enabled bucket in the Amazon S3 User Guide.
*
*
*
* This functionality is not supported for directory buckets.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder contentMD5(String contentMD5);
/**
*
* A standard MIME type describing the format of the contents. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type.
*
*
* @param contentType
* A standard MIME type describing the format of the contents. For more information, see https://www.rfc-editor.org/rfc/rfc9110.html#name-content-type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder contentType(String contentType);
/**
*
* Indicates the algorithm used to create the checksum for the object when you use the SDK. This header will not
* provide any additional functionality if you don't use the SDK. When you send this header, there must be a
* corresponding x-amz-checksum-algorithm or x-amz-trailer header sent.
* Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.
*
*
* For the x-amz-checksum-algorithm header, replace algorithm with
* the supported algorithm from the following list:
*
*
* -
*
* CRC32
*
*
* -
*
* CRC32C
*
*
* -
*
* SHA1
*
*
* -
*
* SHA256
*
*
*
*
* For more information, see Checking object
* integrity in the Amazon S3 User Guide.
*
*
* If the individual checksum value you provide through x-amz-checksum-algorithm doesn't
* match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any
* provided ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided
* value in x-amz-checksum-algorithm .
*
*
*
* The Content-MD5 or x-amz-sdk-checksum-algorithm header is required for any request
* to upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see
* Uploading objects to an Object Lock enabled bucket in the Amazon S3 User Guide.
*
*
*
* 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 used to create the checksum for the object when you use the SDK. This header
* will not provide any additional functionality if you don't use the SDK. When you send this header,
* there must be a corresponding x-amz-checksum-algorithm or
* x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status
* code 400 Bad Request.
*
* For the x-amz-checksum-algorithm header, replace algorithm
* with the supported algorithm from the following list:
*
*
* -
*
* CRC32
*
*
* -
*
* CRC32C
*
*
* -
*
* SHA1
*
*
* -
*
* SHA256
*
*
*
*
* For more information, see Checking
* object integrity in the Amazon S3 User Guide.
*
*
* If the individual checksum value you provide through x-amz-checksum-algorithm
* doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon
* S3 ignores any provided ChecksumAlgorithm parameter and uses the checksum algorithm that
* matches the provided value in x-amz-checksum-algorithm .
*
*
*
* The Content-MD5 or x-amz-sdk-checksum-algorithm header is required for any
* request to upload an object with a retention period configured using Amazon S3 Object Lock. For more
* information, see Uploading objects to an Object Lock enabled bucket in the Amazon S3 User Guide.
*
*
*
* 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 used to create the checksum for the object when you use the SDK. This header will not
* provide any additional functionality if you don't use the SDK. When you send this header, there must be a
* corresponding x-amz-checksum-algorithm or x-amz-trailer header sent.
* Otherwise, Amazon S3 fails the request with the HTTP status code 400 Bad Request.
*
*
* For the x-amz-checksum-algorithm header, replace algorithm with
* the supported algorithm from the following list:
*
*
* -
*
* CRC32
*
*
* -
*
* CRC32C
*
*
* -
*
* SHA1
*
*
* -
*
* SHA256
*
*
*
*
* For more information, see Checking object
* integrity in the Amazon S3 User Guide.
*
*
* If the individual checksum value you provide through x-amz-checksum-algorithm doesn't
* match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon S3 ignores any
* provided ChecksumAlgorithm parameter and uses the checksum algorithm that matches the provided
* value in x-amz-checksum-algorithm .
*
*
*
* The Content-MD5 or x-amz-sdk-checksum-algorithm header is required for any request
* to upload an object with a retention period configured using Amazon S3 Object Lock. For more information, see
* Uploading objects to an Object Lock enabled bucket in the Amazon S3 User Guide.
*
*
*
* 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 used to create the checksum for the object when you use the SDK. This header
* will not provide any additional functionality if you don't use the SDK. When you send this header,
* there must be a corresponding x-amz-checksum-algorithm or
* x-amz-trailer header sent. Otherwise, Amazon S3 fails the request with the HTTP status
* code 400 Bad Request.
*
* For the x-amz-checksum-algorithm header, replace algorithm
* with the supported algorithm from the following list:
*
*
* -
*
* CRC32
*
*
* -
*
* CRC32C
*
*
* -
*
* SHA1
*
*
* -
*
* SHA256
*
*
*
*
* For more information, see Checking
* object integrity in the Amazon S3 User Guide.
*
*
* If the individual checksum value you provide through x-amz-checksum-algorithm
* doesn't match the checksum algorithm you set through x-amz-sdk-checksum-algorithm, Amazon
* S3 ignores any provided ChecksumAlgorithm parameter and uses the checksum algorithm that
* matches the provided value in x-amz-checksum-algorithm .
*
*
*
* The Content-MD5 or x-amz-sdk-checksum-algorithm header is required for any
* request to upload an object with a retention period configured using Amazon S3 Object Lock. For more
* information, see Uploading objects to an Object Lock enabled bucket in the Amazon S3 User Guide.
*
*
*
* 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);
/**
*
* This header can be used as a data integrity check to verify that the data received is the same data that was
* originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the object. For more
* information, see Checking object
* integrity in the Amazon S3 User Guide.
*
*
* @param checksumCRC32
* This header can be used as a data integrity check to verify that the data received is the same data
* that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32 checksum of the
* object. For more information, see Checking
* object integrity in the Amazon S3 User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder checksumCRC32(String checksumCRC32);
/**
*
* This header can be used as a data integrity check to verify that the data received is the same data that was
* originally sent. This header specifies the base64-encoded, 32-bit CRC-32C checksum of the object. For more
* information, see Checking object
* integrity in the Amazon S3 User Guide.
*
*
* @param checksumCRC32C
* This header can be used as a data integrity check to verify that the data received is the same data
* that was originally sent. This header specifies the base64-encoded, 32-bit CRC-32C checksum of the
* object. For more information, see Checking
* object integrity in the Amazon S3 User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder checksumCRC32C(String checksumCRC32C);
/**
*
* This header can be used as a data integrity check to verify that the data received is the same data that was
* originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object. For more
* information, see Checking object
* integrity in the Amazon S3 User Guide.
*
*
* @param checksumSHA1
* This header can be used as a data integrity check to verify that the data received is the same data
* that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the
* object. For more information, see Checking
* object integrity in the Amazon S3 User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder checksumSHA1(String checksumSHA1);
/**
*
* This header can be used as a data integrity check to verify that the data received is the same data that was
* originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object. For more
* information, see Checking object
* integrity in the Amazon S3 User Guide.
*
*
* @param checksumSHA256
* This header can be used as a data integrity check to verify that the data received is the same data
* that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the
* object. For more information, see Checking
* object integrity in the Amazon S3 User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder checksumSHA256(String checksumSHA256);
/**
*
* The date and time at which the object is no longer cacheable. For more information, see https://www.rfc-editor.org/rfc/rfc7234#section-5.3.
*
*
* @param expires
* The date and time at which the object is no longer cacheable. For more information, see https://www.rfc-editor.org/rfc/rfc7234#section-5.3.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder expires(Instant expires);
/**
*
* Uploads the object only if the ETag (entity tag) value provided during the WRITE operation matches the ETag
* of the object in S3. If the ETag values do not match, the operation returns a
* 412 Precondition Failed error.
*
*
* If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict
* response. On a 409 failure you should fetch the object's ETag and retry the upload.
*
*
* Expects the ETag value as a string.
*
*
* For more information about conditional requests, see RFC
* 7232, or Conditional
* requests in the Amazon S3 User Guide.
*
*
* @param ifMatch
* Uploads the object only if the ETag (entity tag) value provided during the WRITE operation matches the
* ETag of the object in S3. If the ETag values do not match, the operation returns a
* 412 Precondition Failed error.
*
* If a conflicting operation occurs during the upload S3 returns a
* 409 ConditionalRequestConflict response. On a 409 failure you should fetch the object's
* ETag and retry the upload.
*
*
* Expects the ETag value as a string.
*
*
* For more information about conditional requests, see RFC
* 7232, or Conditional
* requests in the Amazon S3 User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ifMatch(String ifMatch);
/**
*
* Uploads the object only if the object key name does not already exist in the bucket specified. Otherwise,
* Amazon S3 returns a 412 Precondition Failed error.
*
*
* If a conflicting operation occurs during the upload S3 returns a 409 ConditionalRequestConflict
* response. On a 409 failure you should retry the upload.
*
*
* Expects the '*' (asterisk) character.
*
*
* For more information about conditional requests, see RFC
* 7232, or Conditional
* requests in the Amazon S3 User Guide.
*
*
* @param ifNoneMatch
* Uploads the object only if the object key name does not already exist in the bucket specified.
* Otherwise, Amazon S3 returns a 412 Precondition Failed error.
*
* If a conflicting operation occurs during the upload S3 returns a
* 409 ConditionalRequestConflict response. On a 409 failure you should retry the upload.
*
*
* Expects the '*' (asterisk) character.
*
*
* For more information about conditional requests, see RFC
* 7232, or Conditional
* requests in the Amazon S3 User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder ifNoneMatch(String ifNoneMatch);
/**
*
* 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);
/**
*
* Object key for which the PUT action was initiated.
*
*
* @param key
* Object key for which the PUT action was initiated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder key(String key);
/**
*
* Specifies the offset for appending data to existing objects in bytes. The offset must be equal to the size of
* the existing object being appended to. If no object exists, setting this header to 0 will create a new
* object.
*
*
*
* This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory
* buckets.
*
*
*
* @param writeOffsetBytes
* Specifies the offset for appending data to existing objects in bytes. The offset must be equal to the
* size of the existing object being appended to. If no object exists, setting this header to 0 will
* create a new object.
*
* This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in
* directory buckets.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder writeOffsetBytes(Long writeOffsetBytes);
/**
*
* 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);
/**
*
* The server-side encryption algorithm that was used when you store this object in Amazon S3 (for example,
* AES256, aws:kms, aws:kms:dsse).
*
*
* -
*
* General purpose buckets - You have four mutually exclusive options to protect data using server-side
* encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the
* encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or
* DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using
* Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest by
* using server-side encryption with other key options. For more information, see Using Server-Side
* Encryption in the Amazon S3 User Guide.
*
*
* -
*
* Directory buckets - For directory buckets, there are only two supported options for server-side
* encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side
* encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption
* uses the desired encryption configuration and you don't override the bucket default encryption in your
* CreateSession requests or PUT object requests. Then, new objects are automatically
* encrypted with the desired encryption settings. For more information, see Protecting
* data with server-side encryption in the Amazon S3 User Guide. For more information about the
* encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
*
*
* In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the
* REST API, the encryption request headers must match the encryption settings that are specified in the
* CreateSession request. You can't override the values of the encryption settings (
* x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id,
* x-amz-server-side-encryption-context, and
* x-amz-server-side-encryption-bucket-key-enabled) that are specified in the
* CreateSession request. You don't need to explicitly specify these encryption settings values in
* Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the
* CreateSession request to protect new objects in the directory bucket.
*
*
*
* When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token
* refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web
* Services SDKs use the bucket's default encryption configuration for the CreateSession request.
* It's not supported to override the encryption settings values in the CreateSession request. So
* in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), the
* encryption request headers must match the default encryption configuration of the directory bucket.
*
*
*
*
* @param serverSideEncryption
* The server-side encryption algorithm that was used when you store this object in Amazon S3 (for
* example, AES256, aws:kms, aws:kms:dsse).
*
* -
*
* General purpose buckets - You have four mutually exclusive options to protect data using
* server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys.
* Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS
* keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with
* server-side encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell
* Amazon S3 to encrypt data at rest by using server-side encryption with other key options. For more
* information, see Using
* Server-Side Encryption in the Amazon S3 User Guide.
*
*
* -
*
* Directory buckets - For directory buckets, there are only two supported options for
* server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (
* AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We
* recommend that the bucket's default encryption uses the desired encryption configuration and you don't
* override the bucket default encryption in your CreateSession requests or PUT
* object requests. Then, new objects are automatically encrypted with the desired encryption settings.
* For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more
* information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
*
*
* In the Zonal endpoint API calls (except CopyObject and UploadPartCopy)
* using the REST API, the encryption request headers must match the encryption settings that are
* specified in the CreateSession request. You can't override the values of the encryption
* settings (x-amz-server-side-encryption,
* x-amz-server-side-encryption-aws-kms-key-id,
* x-amz-server-side-encryption-context, and
* x-amz-server-side-encryption-bucket-key-enabled) that are specified in the
* CreateSession request. You don't need to explicitly specify these encryption settings
* values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the
* CreateSession request to protect new objects in the directory bucket.
*
*
*
* When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session
* token refreshes automatically to avoid service interruptions when a session expires. The CLI or the
* Amazon Web Services SDKs use the bucket's default encryption configuration for the
* CreateSession request. It's not supported to override the encryption settings values in
* the CreateSession request. So in the Zonal endpoint API calls (except CopyObject and UploadPartCopy),
* the encryption request headers must match the default encryption configuration of the directory
* bucket.
*
*
* @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 that was used when you store this object in Amazon S3 (for example,
* AES256, aws:kms, aws:kms:dsse).
*
*
* -
*
* General purpose buckets - You have four mutually exclusive options to protect data using server-side
* encryption in Amazon S3, depending on how you choose to manage the encryption keys. Specifically, the
* encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS keys (SSE-KMS or
* DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with server-side encryption by using
* Amazon S3 managed keys (SSE-S3) by default. You can optionally tell Amazon S3 to encrypt data at rest by
* using server-side encryption with other key options. For more information, see Using Server-Side
* Encryption in the Amazon S3 User Guide.
*
*
* -
*
* Directory buckets - For directory buckets, there are only two supported options for server-side
* encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (AES256) and server-side
* encryption with KMS keys (SSE-KMS) (aws:kms). We recommend that the bucket's default encryption
* uses the desired encryption configuration and you don't override the bucket default encryption in your
* CreateSession requests or PUT object requests. Then, new objects are automatically
* encrypted with the desired encryption settings. For more information, see Protecting
* data with server-side encryption in the Amazon S3 User Guide. For more information about the
* encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
*
*
* In the Zonal endpoint API calls (except CopyObject and UploadPartCopy) using the
* REST API, the encryption request headers must match the encryption settings that are specified in the
* CreateSession request. You can't override the values of the encryption settings (
* x-amz-server-side-encryption, x-amz-server-side-encryption-aws-kms-key-id,
* x-amz-server-side-encryption-context, and
* x-amz-server-side-encryption-bucket-key-enabled) that are specified in the
* CreateSession request. You don't need to explicitly specify these encryption settings values in
* Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the
* CreateSession request to protect new objects in the directory bucket.
*
*
*
* When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session token
* refreshes automatically to avoid service interruptions when a session expires. The CLI or the Amazon Web
* Services SDKs use the bucket's default encryption configuration for the CreateSession request.
* It's not supported to override the encryption settings values in the CreateSession request. So
* in the Zonal endpoint API calls (except CopyObject and UploadPartCopy), the
* encryption request headers must match the default encryption configuration of the directory bucket.
*
*
*
*
* @param serverSideEncryption
* The server-side encryption algorithm that was used when you store this object in Amazon S3 (for
* example, AES256, aws:kms, aws:kms:dsse).
*
* -
*
* General purpose buckets - You have four mutually exclusive options to protect data using
* server-side encryption in Amazon S3, depending on how you choose to manage the encryption keys.
* Specifically, the encryption key options are Amazon S3 managed keys (SSE-S3), Amazon Web Services KMS
* keys (SSE-KMS or DSSE-KMS), and customer-provided keys (SSE-C). Amazon S3 encrypts data with
* server-side encryption by using Amazon S3 managed keys (SSE-S3) by default. You can optionally tell
* Amazon S3 to encrypt data at rest by using server-side encryption with other key options. For more
* information, see Using
* Server-Side Encryption in the Amazon S3 User Guide.
*
*
* -
*
* Directory buckets - For directory buckets, there are only two supported options for
* server-side encryption: server-side encryption with Amazon S3 managed keys (SSE-S3) (
* AES256) and server-side encryption with KMS keys (SSE-KMS) (aws:kms). We
* recommend that the bucket's default encryption uses the desired encryption configuration and you don't
* override the bucket default encryption in your CreateSession requests or PUT
* object requests. Then, new objects are automatically encrypted with the desired encryption settings.
* For more information, see Protecting data with server-side encryption in the Amazon S3 User Guide. For more
* information about the encryption overriding behaviors in directory buckets, see Specifying server-side encryption with KMS for new object uploads.
*
*
* In the Zonal endpoint API calls (except CopyObject and UploadPartCopy)
* using the REST API, the encryption request headers must match the encryption settings that are
* specified in the CreateSession request. You can't override the values of the encryption
* settings (x-amz-server-side-encryption,
* x-amz-server-side-encryption-aws-kms-key-id,
* x-amz-server-side-encryption-context, and
* x-amz-server-side-encryption-bucket-key-enabled) that are specified in the
* CreateSession request. You don't need to explicitly specify these encryption settings
* values in Zonal endpoint API calls, and Amazon S3 will use the encryption settings values from the
* CreateSession request to protect new objects in the directory bucket.
*
*
*
* When you use the CLI or the Amazon Web Services SDKs, for CreateSession, the session
* token refreshes automatically to avoid service interruptions when a session expires. The CLI or the
* Amazon Web Services SDKs use the bucket's default encryption configuration for the
* CreateSession request. It's not supported to override the encryption settings values in
* the CreateSession request. So in the Zonal endpoint API calls (except CopyObject and UploadPartCopy),
* the encryption request headers must match the default encryption configuration of the directory
* bucket.
*
*
* @see ServerSideEncryption
* @return Returns a reference to this object so that method calls can be chained together.
* @see ServerSideEncryption
*/
Builder serverSideEncryption(ServerSideEncryption serverSideEncryption);
/**
*
* By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage
* class provides high durability and high availability. Depending on performance needs, you can specify a
* different Storage Class. For more information, see Storage Classes in the
* Amazon S3 User Guide.
*
*
*
* -
*
* For directory buckets, only the S3 Express One Zone storage class is supported to store newly created
* objects.
*
*
* -
*
* Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
*
*
*
*
*
* @param storageClass
* By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD
* storage class provides high durability and high availability. Depending on performance needs, you can
* specify a different Storage Class. For more information, see Storage Classes in
* the Amazon S3 User Guide.
*
* -
*
* For directory buckets, only the S3 Express One Zone storage class is supported to store newly created
* objects.
*
*
* -
*
* Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
*
*
*
* @see StorageClass
* @return Returns a reference to this object so that method calls can be chained together.
* @see StorageClass
*/
Builder storageClass(String storageClass);
/**
*
* By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD storage
* class provides high durability and high availability. Depending on performance needs, you can specify a
* different Storage Class. For more information, see Storage Classes in the
* Amazon S3 User Guide.
*
*
*
* -
*
* For directory buckets, only the S3 Express One Zone storage class is supported to store newly created
* objects.
*
*
* -
*
* Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
*
*
*
*
*
* @param storageClass
* By default, Amazon S3 uses the STANDARD Storage Class to store newly created objects. The STANDARD
* storage class provides high durability and high availability. Depending on performance needs, you can
* specify a different Storage Class. For more information, see Storage Classes in
* the Amazon S3 User Guide.
*
* -
*
* For directory buckets, only the S3 Express One Zone storage class is supported to store newly created
* objects.
*
*
* -
*
* Amazon S3 on Outposts only uses the OUTPOSTS Storage Class.
*
*
*
* @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 bucket is configured as a website, redirects requests for this object to another object in the same
* bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata. For
* information about object metadata, see Object Key and Metadata in the
* Amazon S3 User Guide.
*
*
* In the following example, the request header sets the redirect to an object (anotherPage.html) in the same
* bucket:
*
*
* x-amz-website-redirect-location: /anotherPage.html
*
*
* In the following example, the request header sets the object redirect to another website:
*
*
* x-amz-website-redirect-location: http://www.example.com/
*
*
* For more information about website hosting in Amazon S3, see Hosting Websites on Amazon S3
* and How to Configure
* Website Page Redirects in the Amazon S3 User Guide.
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* @param websiteRedirectLocation
* If the bucket is configured as a website, redirects requests for this object to another object in the
* same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
* For information about object metadata, see Object Key and Metadata
* in the Amazon S3 User Guide.
*
* In the following example, the request header sets the redirect to an object (anotherPage.html) in the
* same bucket:
*
*
* x-amz-website-redirect-location: /anotherPage.html
*
*
* In the following example, the request header sets the object redirect to another website:
*
*
* x-amz-website-redirect-location: http://www.example.com/
*
*
* For more information about website hosting in Amazon S3, see Hosting Websites on Amazon
* S3 and How to
* Configure Website Page Redirects in the Amazon S3 User Guide.
*
*
*
* 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).
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* @param sseCustomerAlgorithm
* Specifies the algorithm to use when encrypting the object (for example, AES256).
*
*
* This functionality is not supported for directory buckets.
*
* @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 for directory buckets.
*
*
*
* @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 for directory buckets.
*
* @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 for directory buckets.
*
*
*
* @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 for directory buckets.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder sseCustomerKeyMD5(String sseCustomerKeyMD5);
/**
*
* Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key doesn't
* exist in the same account that's issuing the command, you must use the full Key ARN not the Key ID.
*
*
* General purpose buckets - If you specify x-amz-server-side-encryption with
* aws:kms or aws:kms:dsse, this header specifies the ID (Key ID, Key ARN, or Key
* Alias) of the KMS key to use. If you specify x-amz-server-side-encryption:aws:kms or
* x-amz-server-side-encryption:aws:kms:dsse, but do not provide
* x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services managed key
* (aws/s3) to protect the data.
*
*
* Directory buckets - If you specify x-amz-server-side-encryption with aws:kms
* , the x-amz-server-side-encryption-aws-kms-key-id header is implicitly assigned the ID of the
* KMS symmetric encryption customer managed key that's configured for your directory bucket's default
* encryption setting. If you want to specify the x-amz-server-side-encryption-aws-kms-key-id
* header explicitly, you can only specify it with the ID (Key ID or Key ARN) of the KMS customer managed key
* that's configured for your directory bucket's default encryption setting. Otherwise, you get an HTTP
* 400 Bad Request error. Only use the key ID or key ARN. The key alias format of the KMS key isn't
* supported. Your SSE-KMS configuration can only support 1 customer managed
* key per directory bucket for the lifetime of the bucket. The Amazon Web
* Services managed key (aws/s3) isn't supported.
*
*
* @param ssekmsKeyId
* Specifies the KMS key ID (Key ID, Key ARN, or Key Alias) to use for object encryption. If the KMS key
* doesn't exist in the same account that's issuing the command, you must use the full Key ARN not the
* Key ID.
*
* General purpose buckets - If you specify x-amz-server-side-encryption with
* aws:kms or aws:kms:dsse, this header specifies the ID (Key ID, Key ARN, or
* Key Alias) of the KMS key to use. If you specify x-amz-server-side-encryption:aws:kms or
* x-amz-server-side-encryption:aws:kms:dsse, but do not provide
* x-amz-server-side-encryption-aws-kms-key-id, Amazon S3 uses the Amazon Web Services
* managed key (aws/s3) to protect the data.
*
*
* Directory buckets - If you specify x-amz-server-side-encryption with
* aws:kms, the x-amz-server-side-encryption-aws-kms-key-id header is
* implicitly assigned the ID of the KMS symmetric encryption customer managed key that's configured for
* your directory bucket's default encryption setting. If you want to specify the
* x-amz-server-side-encryption-aws-kms-key-id header explicitly, you can only specify it
* with the ID (Key ID or Key ARN) of the KMS customer managed key that's configured for your directory
* bucket's default encryption setting. Otherwise, you get an HTTP 400 Bad Request error.
* Only use the key ID or key ARN. The key alias format of the KMS key isn't supported. Your SSE-KMS
* configuration can only support 1 customer
* managed key per directory bucket for the lifetime of the bucket. The Amazon Web
* Services managed key (aws/s3) isn't supported.
* @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 as an additional encryption context to use for
* object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON, which
* contains the encryption context as key-value pairs. This value is stored as object metadata and automatically
* gets passed on to Amazon Web Services KMS for future GetObject operations on this object.
*
*
* General purpose buckets - This value must be explicitly added during CopyObject
* operations if you want an additional encryption context for your object. For more information, see Encryption context in the Amazon S3 User Guide.
*
*
* Directory buckets - You can optionally provide an explicit encryption context value. The value must
* match the default encryption context - the bucket Amazon Resource Name (ARN). An additional encryption
* context value is not supported.
*
*
* @param ssekmsEncryptionContext
* Specifies the Amazon Web Services KMS Encryption Context as an additional encryption context to use
* for object encryption. The value of this header is a Base64-encoded string of a UTF-8 encoded JSON,
* which contains the encryption context as key-value pairs. This value is stored as object metadata and
* automatically gets passed on to Amazon Web Services KMS for future GetObject operations
* on this object.
*
* General purpose buckets - This value must be explicitly added during CopyObject
* operations if you want an additional encryption context for your object. For more information, see Encryption context in the Amazon S3 User Guide.
*
*
* Directory buckets - You can optionally provide an explicit encryption context value. The value
* must match the default encryption context - the bucket Amazon Resource Name (ARN). An additional
* encryption context value is not supported.
* @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).
*
*
* General purpose buckets - Setting this header to true causes Amazon S3 to use an S3
* Bucket Key for object encryption with SSE-KMS. Also, specifying this header with a PUT action doesn't affect
* bucket-level settings for S3 Bucket Key.
*
*
* Directory buckets - S3 Bucket Keys are always enabled for GET and PUT
* operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy
* SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to
* general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the Copy
* operation in Batch Operations, or the import jobs. In this
* case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.
*
*
* @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).
*
* General purpose buckets - Setting this header to true causes Amazon S3 to use an
* S3 Bucket Key for object encryption with SSE-KMS. Also, specifying this header with a PUT action
* doesn't affect bucket-level settings for S3 Bucket Key.
*
*
* Directory buckets - S3 Bucket Keys are always enabled for GET and PUT
* operations in a directory bucket and can’t be disabled. S3 Bucket Keys aren't supported, when you copy
* SSE-KMS encrypted objects from general purpose buckets to directory buckets, from directory buckets to
* general purpose buckets, or between directory buckets, through CopyObject, UploadPartCopy, the
* Copy operation in Batch Operations, or the import jobs. In
* this case, Amazon S3 makes a call to KMS every time a copy request is made for a KMS-encrypted object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder bucketKeyEnabled(Boolean bucketKeyEnabled);
/**
* 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. The tag-set must be encoded as URL Query parameters. (For example, "Key1=Value1")
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* @param tagging
* The tag-set for the object. The tag-set must be encoded as URL Query parameters. (For example,
* "Key1=Value1")
*
* This functionality is not supported for directory buckets.
*
* @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 this object.
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* @param objectLockMode
* The Object Lock mode that you want to apply to this object.
*
* 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 this object.
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* @param objectLockMode
* The Object Lock mode that you want to apply to this object.
*
* 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 this object's Object Lock to expire. Must be formatted as a timestamp
* parameter.
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* @param objectLockRetainUntilDate
* The date and time when you want this object's Object Lock to expire. Must be formatted as a timestamp
* parameter.
*
* 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 a legal hold will be applied to this object. For more information about S3 Object Lock, see
* Object Lock in the Amazon
* S3 User Guide.
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* @param objectLockLegalHoldStatus
* Specifies whether a legal hold will be applied to this object. For more information about S3 Object
* Lock, see Object Lock
* in the Amazon S3 User Guide.
*
* 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 a legal hold will be applied to this object. For more information about S3 Object Lock, see
* Object Lock in the Amazon
* S3 User Guide.
*
*
*
* This functionality is not supported for directory buckets.
*
*
*
* @param objectLockLegalHoldStatus
* Specifies whether a legal hold will be applied to this object. For more information about S3 Object
* Lock, see Object Lock
* in the Amazon S3 User Guide.
*
* 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 bucket owner. If the account ID that you provide does not match the actual
* owner of the bucket, the request fails with the HTTP status code 403 Forbidden (access denied).
*
*
* @param expectedBucketOwner
* The account ID of the expected bucket owner. If the account ID that you provide does not match the
* actual owner of the 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);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends S3Request.BuilderImpl implements Builder {
private String acl;
private String bucket;
private String cacheControl;
private String contentDisposition;
private String contentEncoding;
private String contentLanguage;
private Long contentLength;
private String contentMD5;
private String contentType;
private String checksumAlgorithm;
private String checksumCRC32;
private String checksumCRC32C;
private String checksumSHA1;
private String checksumSHA256;
private Instant expires;
private String ifMatch;
private String ifNoneMatch;
private String grantFullControl;
private String grantRead;
private String grantReadACP;
private String grantWriteACP;
private String key;
private Long writeOffsetBytes;
private Map metadata = DefaultSdkAutoConstructMap.getInstance();
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 requestPayer;
private String tagging;
private String objectLockMode;
private Instant objectLockRetainUntilDate;
private String objectLockLegalHoldStatus;
private String expectedBucketOwner;
private BuilderImpl() {
}
private BuilderImpl(PutObjectRequest model) {
super(model);
acl(model.acl);
bucket(model.bucket);
cacheControl(model.cacheControl);
contentDisposition(model.contentDisposition);
contentEncoding(model.contentEncoding);
contentLanguage(model.contentLanguage);
contentLength(model.contentLength);
contentMD5(model.contentMD5);
contentType(model.contentType);
checksumAlgorithm(model.checksumAlgorithm);
checksumCRC32(model.checksumCRC32);
checksumCRC32C(model.checksumCRC32C);
checksumSHA1(model.checksumSHA1);
checksumSHA256(model.checksumSHA256);
expires(model.expires);
ifMatch(model.ifMatch);
ifNoneMatch(model.ifNoneMatch);
grantFullControl(model.grantFullControl);
grantRead(model.grantRead);
grantReadACP(model.grantReadACP);
grantWriteACP(model.grantWriteACP);
key(model.key);
writeOffsetBytes(model.writeOffsetBytes);
metadata(model.metadata);
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);
requestPayer(model.requestPayer);
tagging(model.tagging);
objectLockMode(model.objectLockMode);
objectLockRetainUntilDate(model.objectLockRetainUntilDate);
objectLockLegalHoldStatus(model.objectLockLegalHoldStatus);
expectedBucketOwner(model.expectedBucketOwner);
}
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 getBucket() {
return bucket;
}
public final void setBucket(String bucket) {
this.bucket = bucket;
}
@Override
public final Builder bucket(String bucket) {
this.bucket = bucket;
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 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 Long getContentLength() {
return contentLength;
}
public final void setContentLength(Long contentLength) {
this.contentLength = contentLength;
}
@Override
public final Builder contentLength(Long contentLength) {
this.contentLength = contentLength;
return this;
}
public final String getContentMD5() {
return contentMD5;
}
public final void setContentMD5(String contentMD5) {
this.contentMD5 = contentMD5;
}
@Override
public final Builder contentMD5(String contentMD5) {
this.contentMD5 = contentMD5;
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;
}
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 getChecksumCRC32() {
return checksumCRC32;
}
public final void setChecksumCRC32(String checksumCRC32) {
this.checksumCRC32 = checksumCRC32;
}
@Override
public final Builder checksumCRC32(String checksumCRC32) {
this.checksumCRC32 = checksumCRC32;
return this;
}
public final String getChecksumCRC32C() {
return checksumCRC32C;
}
public final void setChecksumCRC32C(String checksumCRC32C) {
this.checksumCRC32C = checksumCRC32C;
}
@Override
public final Builder checksumCRC32C(String checksumCRC32C) {
this.checksumCRC32C = checksumCRC32C;
return this;
}
public final String getChecksumSHA1() {
return checksumSHA1;
}
public final void setChecksumSHA1(String checksumSHA1) {
this.checksumSHA1 = checksumSHA1;
}
@Override
public final Builder checksumSHA1(String checksumSHA1) {
this.checksumSHA1 = checksumSHA1;
return this;
}
public final String getChecksumSHA256() {
return checksumSHA256;
}
public final void setChecksumSHA256(String checksumSHA256) {
this.checksumSHA256 = checksumSHA256;
}
@Override
public final Builder checksumSHA256(String checksumSHA256) {
this.checksumSHA256 = checksumSHA256;
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 getIfMatch() {
return ifMatch;
}
public final void setIfMatch(String ifMatch) {
this.ifMatch = ifMatch;
}
@Override
public final Builder ifMatch(String ifMatch) {
this.ifMatch = ifMatch;
return this;
}
public final String getIfNoneMatch() {
return ifNoneMatch;
}
public final void setIfNoneMatch(String ifNoneMatch) {
this.ifNoneMatch = ifNoneMatch;
}
@Override
public final Builder ifNoneMatch(String ifNoneMatch) {
this.ifNoneMatch = ifNoneMatch;
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 String getKey() {
return key;
}
public final void setKey(String key) {
this.key = key;
}
@Override
public final Builder key(String key) {
this.key = key;
return this;
}
public final Long getWriteOffsetBytes() {
return writeOffsetBytes;
}
public final void setWriteOffsetBytes(Long writeOffsetBytes) {
this.writeOffsetBytes = writeOffsetBytes;
}
@Override
public final Builder writeOffsetBytes(Long writeOffsetBytes) {
this.writeOffsetBytes = writeOffsetBytes;
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 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 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;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public PutObjectRequest build() {
return new PutObjectRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}