com.ibm.cos.v2.services.s3.model

Interface PutObjectResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<PutObjectResponse.Builder,PutObjectResponse>, S3Response.Builder, SdkBuilder<PutObjectResponse.Builder,PutObjectResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

PutObjectResponse

@Mutable
 @NotThreadSafe
public static interface PutObjectResponse.Builder
extends S3Response.Builder, SdkPojo, CopyableBuilder<PutObjectResponse.Builder,PutObjectResponse>

Method Summary

Modifier and Type	Method and 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	checksumCRC64NVME(String checksumCRC64NVME) The Base64 encoded, 64-bit CRC64NVME checksum of the object.
PutObjectResponse.Builder	checksumSHA1(String checksumSHA1) The Base64 encoded, 160-bit SHA1 digest of the object.
PutObjectResponse.Builder	checksumSHA256(String checksumSHA256) The Base64 encoded, 256-bit SHA256 digest of the object.
PutObjectResponse.Builder	checksumType(ChecksumType checksumType) This header specifies the checksum type of the object, which determines how part-level checksums are combined to create an object-level checksum for multipart objects.
PutObjectResponse.Builder	checksumType(String checksumType) This header specifies the checksum type of the object, which determines how part-level checksums are combined to create an object-level checksum for multipart objects.
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(RequestCharged requestCharged) Sets the value of the RequestCharged property for this object.
PutObjectResponse.Builder	requestCharged(String requestCharged) Sets the value of the RequestCharged property for this object.
PutObjectResponse.Builder	serverSideEncryption(ServerSideEncryption serverSideEncryption) The server-side encryption algorithm used when you store this object in Amazon S3.
PutObjectResponse.Builder	serverSideEncryption(String serverSideEncryption) The server-side encryption algorithm used when you store this object in Amazon S3.
PutObjectResponse.Builder	size(Long size) The size of the object in bytes.
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) If present, indicates the ID of the KMS key that was used for object encryption.
PutObjectResponse.Builder	versionId(String versionId) Version ID of the object.

Methods inherited from interface com.ibm.cos.v2.services.s3.model.S3Response.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface com.ibm.cos.v2.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface com.ibm.cos.v2.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface com.ibm.cos.v2.utils.builder.CopyableBuilder

copy

Methods inherited from interface com.ibm.cos.v2.utils.builder.SdkBuilder

applyMutation, build

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 and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL-encoded.

Object expiration information is not returned in directory buckets and this header returns the value " NotImplemented" in all responses 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 the expiry-date and rule-id key-value pairs that provide information about object expiration. The value of the rule-id is URL-encoded.

Object expiration information is not returned in directory buckets and this header returns the value " NotImplemented" in all responses 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 checksum is only be present if the checksum 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 checksum is only be present if the checksum 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 checksum is only present if the checksum 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 checksum is only present if the checksum 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.

checksumCRC64NVME

PutObjectResponse.Builder checksumCRC64NVME(String checksumCRC64NVME)

The Base64 encoded, 64-bit CRC64NVME checksum of the object. This header is present if the object was uploaded with the CRC64NVME checksum algorithm, or if it was uploaded without a checksum (and Amazon S3 added the default checksum, CRC64NVME, to the uploaded object). For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

Parameters:

checksumCRC64NVME - The Base64 encoded, 64-bit CRC64NVME checksum of the object. This header is present if the object was uploaded with the CRC64NVME checksum algorithm, or if it was uploaded without a checksum (and Amazon S3 added the default checksum, CRC64NVME, to the uploaded object). 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 SHA1 digest of the object. This will only be present if the object 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 SHA1 digest of the object. This will only be present if the object 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 SHA256 digest of the object. This will only be present if the object 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 SHA256 digest of the object. This will only be present if the object 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.

checksumType

PutObjectResponse.Builder checksumType(String checksumType)

This header specifies the checksum type of the object, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. For PutObject uploads, the checksum type is always FULL_OBJECT. You can use this header as a data integrity check to verify that the checksum type that is received is the same checksum that was specified. For more information, see Checking object integrity in the Amazon S3 User Guide.

Parameters:

checksumType - This header specifies the checksum type of the object, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. For PutObject uploads, the checksum type is always FULL_OBJECT. You can use this header as a data integrity check to verify that the checksum type that is received is the same checksum that was specified. For more information, 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.

See Also:

ChecksumType, ChecksumType

checksumType

PutObjectResponse.Builder checksumType(ChecksumType checksumType)

This header specifies the checksum type of the object, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. For PutObject uploads, the checksum type is always FULL_OBJECT. You can use this header as a data integrity check to verify that the checksum type that is received is the same checksum that was specified. For more information, see Checking object integrity in the Amazon S3 User Guide.

Parameters:

checksumType - This header specifies the checksum type of the object, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. For PutObject uploads, the checksum type is always FULL_OBJECT. You can use this header as a data integrity check to verify that the checksum type that is received is the same checksum that was specified. For more information, 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.

See Also:

ChecksumType, ChecksumType

serverSideEncryption

PutObjectResponse.Builder serverSideEncryption(String serverSideEncryption)

The server-side encryption algorithm used when you store this object in Amazon S3.

Parameters:

serverSideEncryption - The server-side encryption algorithm used when you store this object in Amazon S3.

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.

Parameters:

serverSideEncryption - The server-side encryption algorithm used when you store this object in Amazon S3.

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 present, indicates the ID of the KMS key that was used for object encryption.

Parameters:

ssekmsKeyId - If present, indicates the ID of the KMS key that was used for object encryption.

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

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

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

Parameters:

bucketKeyEnabled - Indicates whether the uploaded object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).

Returns:

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

size

PutObjectResponse.Builder size(Long size)

The size of the object in bytes. This value is only be present if you append to an object.

This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in directory buckets.

Parameters:

size - The size of the object in bytes. This value is only be present if you append to an object.

This functionality is only supported for objects in the Amazon S3 Express One Zone storage class in 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