Interface PutObjectResponse.Builder
-
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<PutObjectResponse.Builder,PutObjectResponse>
,S3Response.Builder
,SdkBuilder<PutObjectResponse.Builder,PutObjectResponse>
,SdkPojo
,SdkResponse.Builder
- Enclosing class:
- PutObjectResponse
public static interface PutObjectResponse.Builder extends S3Response.Builder, SdkPojo, CopyableBuilder<PutObjectResponse.Builder,PutObjectResponse>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description PutObjectResponse.Builder
bucketKeyEnabled(Boolean bucketKeyEnabled)
Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).PutObjectResponse.Builder
checksumCRC32(String checksumCRC32)
The base64-encoded, 32-bit CRC32 checksum of the object.PutObjectResponse.Builder
checksumCRC32C(String checksumCRC32C)
The base64-encoded, 32-bit CRC32C checksum of the object.PutObjectResponse.Builder
checksumSHA1(String checksumSHA1)
The base64-encoded, 160-bit SHA-1 digest of the object.PutObjectResponse.Builder
checksumSHA256(String checksumSHA256)
The base64-encoded, 256-bit SHA-256 digest of the object.PutObjectResponse.Builder
eTag(String eTag)
Entity tag for the uploaded object.PutObjectResponse.Builder
expiration(String expiration)
If the expiration is configured for the object (see PutBucketLifecycleConfiguration) in the Amazon S3 User Guide, the response includes this header.PutObjectResponse.Builder
requestCharged(String requestCharged)
Sets the value of the RequestCharged property for this object.PutObjectResponse.Builder
requestCharged(RequestCharged requestCharged)
Sets the value of the RequestCharged property for this object.PutObjectResponse.Builder
serverSideEncryption(String serverSideEncryption)
The server-side encryption algorithm used when you store this object in Amazon S3 (for example,AES256
,aws:kms
,aws:kms:dsse
).PutObjectResponse.Builder
serverSideEncryption(ServerSideEncryption serverSideEncryption)
The server-side encryption algorithm used when you store this object in Amazon S3 (for example,AES256
,aws:kms
,aws:kms:dsse
).PutObjectResponse.Builder
sseCustomerAlgorithm(String sseCustomerAlgorithm)
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.PutObjectResponse.Builder
sseCustomerKeyMD5(String sseCustomerKeyMD5)
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.PutObjectResponse.Builder
ssekmsEncryptionContext(String ssekmsEncryptionContext)
If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption.PutObjectResponse.Builder
ssekmsKeyId(String ssekmsKeyId)
Ifx-amz-server-side-encryption
has a valid value ofaws:kms
oraws:kms:dsse
, this header indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.PutObjectResponse.Builder
versionId(String versionId)
Version ID of the object.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.s3.model.S3Response.Builder
build, responseMetadata, responseMetadata
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
-
-
-
Method Detail
-
expiration
PutObjectResponse.Builder expiration(String expiration)
If the expiration is configured for the object (see PutBucketLifecycleConfiguration) in the Amazon S3 User Guide, the response includes this header. It includes the
expiry-date
andrule-id
key-value pairs that provide information about object expiration. The value of therule-id
is URL-encoded.This functionality is not supported for directory buckets.
- Parameters:
expiration
- If the expiration is configured for the object (see PutBucketLifecycleConfiguration) in the Amazon S3 User Guide, the response includes this header. It includes theexpiry-date
andrule-id
key-value pairs that provide information about object expiration. The value of therule-id
is URL-encoded.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
eTag
PutObjectResponse.Builder eTag(String eTag)
Entity tag for the uploaded object.
General purpose buckets - To ensure that data is not corrupted traversing the network, for objects where the ETag is the MD5 digest of the object, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.
Directory buckets - The ETag for the object in a directory bucket isn't the MD5 digest of the object.
- Parameters:
eTag
- Entity tag for the uploaded object.General purpose buckets - To ensure that data is not corrupted traversing the network, for objects where the ETag is the MD5 digest of the object, you can calculate the MD5 while putting an object to Amazon S3 and compare the returned ETag to the calculated MD5 value.
Directory buckets - The ETag for the object in a directory bucket isn't the MD5 digest of the object.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
checksumCRC32
PutObjectResponse.Builder checksumCRC32(String checksumCRC32)
The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
- Parameters:
checksumCRC32
- The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
checksumCRC32C
PutObjectResponse.Builder checksumCRC32C(String checksumCRC32C)
The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
- Parameters:
checksumCRC32C
- The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
checksumSHA1
PutObjectResponse.Builder checksumSHA1(String checksumSHA1)
The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
- Parameters:
checksumSHA1
- The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
checksumSHA256
PutObjectResponse.Builder checksumSHA256(String checksumSHA256)
The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
- Parameters:
checksumSHA256
- The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
serverSideEncryption
PutObjectResponse.Builder serverSideEncryption(String serverSideEncryption)
The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
AES256
,aws:kms
,aws:kms:dsse
).For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (
AES256
) is supported.- Parameters:
serverSideEncryption
- The server-side encryption algorithm used when you store this object in Amazon S3 (for example,AES256
,aws:kms
,aws:kms:dsse
).For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (
AES256
) is supported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ServerSideEncryption
,ServerSideEncryption
-
serverSideEncryption
PutObjectResponse.Builder serverSideEncryption(ServerSideEncryption serverSideEncryption)
The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
AES256
,aws:kms
,aws:kms:dsse
).For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (
AES256
) is supported.- Parameters:
serverSideEncryption
- The server-side encryption algorithm used when you store this object in Amazon S3 (for example,AES256
,aws:kms
,aws:kms:dsse
).For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (
AES256
) is supported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
ServerSideEncryption
,ServerSideEncryption
-
versionId
PutObjectResponse.Builder versionId(String versionId)
Version ID of the object.
If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects. For more information about versioning, see Adding Objects to Versioning-Enabled Buckets in the Amazon S3 User Guide. For information about returning the versioning state of a bucket, see GetBucketVersioning.
This functionality is not supported for directory buckets.
- Parameters:
versionId
- Version ID of the object.If you enable versioning for a bucket, Amazon S3 automatically generates a unique version ID for the object being stored. Amazon S3 returns this ID in the response. When you enable versioning for a bucket, if Amazon S3 receives multiple write requests for the same object simultaneously, it stores all of the objects. For more information about versioning, see Adding Objects to Versioning-Enabled Buckets in the Amazon S3 User Guide. For information about returning the versioning state of a bucket, see GetBucketVersioning.
This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sseCustomerAlgorithm
PutObjectResponse.Builder sseCustomerAlgorithm(String sseCustomerAlgorithm)
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.
This functionality is not supported for directory buckets.
- Parameters:
sseCustomerAlgorithm
- If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sseCustomerKeyMD5
PutObjectResponse.Builder sseCustomerKeyMD5(String sseCustomerKeyMD5)
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.
This functionality is not supported for directory buckets.
- Parameters:
sseCustomerKeyMD5
- If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ssekmsKeyId
PutObjectResponse.Builder ssekmsKeyId(String ssekmsKeyId)
If
x-amz-server-side-encryption
has a valid value ofaws:kms
oraws:kms:dsse
, this header indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.This functionality is not supported for directory buckets.
- Parameters:
ssekmsKeyId
- Ifx-amz-server-side-encryption
has a valid value ofaws:kms
oraws:kms:dsse
, this header indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ssekmsEncryptionContext
PutObjectResponse.Builder ssekmsEncryptionContext(String ssekmsEncryptionContext)
If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for future
GetObject
orCopyObject
operations on this object.This functionality is not supported for directory buckets.
- Parameters:
ssekmsEncryptionContext
- If present, indicates the Amazon Web Services KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs. This value is stored as object metadata and automatically gets passed on to Amazon Web Services KMS for futureGetObject
orCopyObject
operations on this object.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
bucketKeyEnabled
PutObjectResponse.Builder bucketKeyEnabled(Boolean bucketKeyEnabled)
Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
This functionality is not supported for directory buckets.
- Parameters:
bucketKeyEnabled
- Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
requestCharged
PutObjectResponse.Builder requestCharged(String requestCharged)
Sets the value of the RequestCharged property for this object.- Parameters:
requestCharged
- The new value for the RequestCharged property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
RequestCharged
,RequestCharged
-
requestCharged
PutObjectResponse.Builder requestCharged(RequestCharged requestCharged)
Sets the value of the RequestCharged property for this object.- Parameters:
requestCharged
- The new value for the RequestCharged property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
RequestCharged
,RequestCharged
-
-