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

Interface HeadObjectRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<HeadObjectRequest.Builder,HeadObjectRequest>, S3Request.Builder, SdkBuilder<HeadObjectRequest.Builder,HeadObjectRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

HeadObjectRequest

@Mutable
 @NotThreadSafe
public static interface HeadObjectRequest.Builder
extends S3Request.Builder, SdkPojo, CopyableBuilder<HeadObjectRequest.Builder,HeadObjectRequest>

Method Summary

Modifier and Type	Method and Description
HeadObjectRequest.Builder	bucket(String bucket) The name of the bucket that contains the object.
HeadObjectRequest.Builder	checksumMode(ChecksumMode checksumMode) To retrieve the checksum, this parameter must be enabled.
HeadObjectRequest.Builder	checksumMode(String checksumMode) To retrieve the checksum, this parameter must be enabled.
HeadObjectRequest.Builder	expectedBucketOwner(String expectedBucketOwner) The account ID of the expected bucket owner.
HeadObjectRequest.Builder	ifMatch(String ifMatch) Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.
HeadObjectRequest.Builder	ifModifiedSince(Instant ifModifiedSince) Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.
HeadObjectRequest.Builder	ifNoneMatch(String ifNoneMatch) Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.
HeadObjectRequest.Builder	ifUnmodifiedSince(Instant ifUnmodifiedSince) Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.
HeadObjectRequest.Builder	key(String key) The object key.
HeadObjectRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
HeadObjectRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
HeadObjectRequest.Builder	partNumber(Integer partNumber) Part number of the object being read.
HeadObjectRequest.Builder	range(String range) HeadObject returns only the metadata for an object.
HeadObjectRequest.Builder	requestPayer(RequestPayer requestPayer) Sets the value of the RequestPayer property for this object.
HeadObjectRequest.Builder	requestPayer(String requestPayer) Sets the value of the RequestPayer property for this object.
HeadObjectRequest.Builder	responseCacheControl(String responseCacheControl) Sets the Cache-Control header of the response.
HeadObjectRequest.Builder	responseContentDisposition(String responseContentDisposition) Sets the Content-Disposition header of the response.
HeadObjectRequest.Builder	responseContentEncoding(String responseContentEncoding) Sets the Content-Encoding header of the response.
HeadObjectRequest.Builder	responseContentLanguage(String responseContentLanguage) Sets the Content-Language header of the response.
HeadObjectRequest.Builder	responseContentType(String responseContentType) Sets the Content-Type header of the response.
HeadObjectRequest.Builder	responseExpires(Instant responseExpires) Sets the Expires header of the response.
HeadObjectRequest.Builder	sseCustomerAlgorithm(String sseCustomerAlgorithm) Specifies the algorithm to use when encrypting the object (for example, AES256).
HeadObjectRequest.Builder	sseCustomerKey(String sseCustomerKey) Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.
HeadObjectRequest.Builder	sseCustomerKeyMD5(String sseCustomerKeyMD5) Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
HeadObjectRequest.Builder	versionId(String versionId) Version ID used to reference a specific version of the object.

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

build

Methods inherited from interface com.ibm.cos.v2.awscore.AwsRequest.Builder

overrideConfiguration

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

bucket

HeadObjectRequest.Builder bucket(String bucket)

The name of the bucket that contains the object.

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, amzn-s3-demo-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 for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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.

Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

Parameters:

bucket - The name of the bucket that contains the object.

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, amzn-s3-demo-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 for general purpose buckets, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. When you use this action with an access point for directory buckets, you must provide the access point name in place of the bucket name. 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.

Object Lambda access points are not supported by directory buckets.

S3 on Outposts - When you use this action with 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, the destination bucket must be the Outposts access point ARN or the access point alias. For more information about S3 on Outposts, see What is S3 on Outposts? in the Amazon S3 User Guide.

Returns:

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

ifMatch

HeadObjectRequest.Builder ifMatch(String ifMatch)

Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.

If both of the If-Match and If-Unmodified-Since headers are present in the request as follows:

• If-Match condition evaluates to true, and;

• If-Unmodified-Since condition evaluates to false;

Then Amazon S3 returns 200 OK and the data requested.

For more information about conditional requests, see RFC 7232.

Parameters:

ifMatch - Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.

If both of the If-Match and If-Unmodified-Since headers are present in the request as follows:

• If-Match condition evaluates to true, and;

• If-Unmodified-Since condition evaluates to false;

Then Amazon S3 returns 200 OK and the data requested.

For more information about conditional requests, see RFC 7232.

Returns:

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

ifModifiedSince

HeadObjectRequest.Builder ifModifiedSince(Instant ifModifiedSince)

Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.

If both of the If-None-Match and If-Modified-Since headers are present in the request as follows:

• If-None-Match condition evaluates to false, and;

• If-Modified-Since condition evaluates to true;

Then Amazon S3 returns the 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

Parameters:

ifModifiedSince - Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.

If both of the If-None-Match and If-Modified-Since headers are present in the request as follows:

• If-None-Match condition evaluates to false, and;

• If-Modified-Since condition evaluates to true;

Then Amazon S3 returns the 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

Returns:

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

ifNoneMatch

HeadObjectRequest.Builder ifNoneMatch(String ifNoneMatch)

Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.

If both of the If-None-Match and If-Modified-Since headers are present in the request as follows:

• If-None-Match condition evaluates to false, and;

• If-Modified-Since condition evaluates to true;

Then Amazon S3 returns the 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

Parameters:

ifNoneMatch - Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.

If both of the If-None-Match and If-Modified-Since headers are present in the request as follows:

• If-None-Match condition evaluates to false, and;

• If-Modified-Since condition evaluates to true;

Then Amazon S3 returns the 304 Not Modified response code.

For more information about conditional requests, see RFC 7232.

Returns:

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

ifUnmodifiedSince

HeadObjectRequest.Builder ifUnmodifiedSince(Instant ifUnmodifiedSince)

Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.

If both of the If-Match and If-Unmodified-Since headers are present in the request as follows:

• If-Match condition evaluates to true, and;

• If-Unmodified-Since condition evaluates to false;

Then Amazon S3 returns 200 OK and the data requested.

For more information about conditional requests, see RFC 7232.

Parameters:

ifUnmodifiedSince - Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.

If both of the If-Match and If-Unmodified-Since headers are present in the request as follows:

• If-Match condition evaluates to true, and;

• If-Unmodified-Since condition evaluates to false;

Then Amazon S3 returns 200 OK and the data requested.

For more information about conditional requests, see RFC 7232.

Returns:

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

key

HeadObjectRequest.Builder key(String key)

The object key.

Parameters:

key - The object key.

Returns:

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

range

HeadObjectRequest.Builder range(String range)

HeadObject returns only the metadata for an object. If the Range is satisfiable, only the ContentLength is affected in the response. If the Range is not satisfiable, S3 returns a 416 - Requested Range Not Satisfiable error.

Parameters:

range - HeadObject returns only the metadata for an object. If the Range is satisfiable, only the ContentLength is affected in the response. If the Range is not satisfiable, S3 returns a 416 - Requested Range Not Satisfiable error.

Returns:

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

responseCacheControl

HeadObjectRequest.Builder responseCacheControl(String responseCacheControl)

Sets the Cache-Control header of the response.

Parameters:

responseCacheControl - Sets the Cache-Control header of the response.

Returns:

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

responseContentDisposition

HeadObjectRequest.Builder responseContentDisposition(String responseContentDisposition)

Sets the Content-Disposition header of the response.

Parameters:

responseContentDisposition - Sets the Content-Disposition header of the response.

Returns:

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

responseContentEncoding

HeadObjectRequest.Builder responseContentEncoding(String responseContentEncoding)

Sets the Content-Encoding header of the response.

Parameters:

responseContentEncoding - Sets the Content-Encoding header of the response.

Returns:

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

responseContentLanguage

HeadObjectRequest.Builder responseContentLanguage(String responseContentLanguage)

Sets the Content-Language header of the response.

Parameters:

responseContentLanguage - Sets the Content-Language header of the response.

Returns:

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

responseContentType

HeadObjectRequest.Builder responseContentType(String responseContentType)

Sets the Content-Type header of the response.

Parameters:

responseContentType - Sets the Content-Type header of the response.

Returns:

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

responseExpires

HeadObjectRequest.Builder responseExpires(Instant responseExpires)

Sets the Expires header of the response.

Parameters:

responseExpires - Sets the Expires header of the response.

Returns:

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

versionId

HeadObjectRequest.Builder versionId(String versionId)

Version ID used to reference a specific version of the object.

For directory buckets in this API operation, only the null value of the version ID is supported.

Parameters:

versionId - Version ID used to reference a specific version of the object.

For directory buckets in this API operation, only the null value of the version ID is supported.

Returns:

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

sseCustomerAlgorithm

HeadObjectRequest.Builder sseCustomerAlgorithm(String sseCustomerAlgorithm)

Specifies the algorithm to use when encrypting the object (for example, AES256).

This functionality is not supported for directory buckets.

Parameters:

sseCustomerAlgorithm - Specifies the algorithm to use when encrypting the object (for example, AES256).

This functionality is not supported for directory buckets.

Returns:

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

sseCustomerKey

HeadObjectRequest.Builder sseCustomerKey(String sseCustomerKey)

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon 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.

Parameters:

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.

Returns:

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

sseCustomerKeyMD5

HeadObjectRequest.Builder sseCustomerKeyMD5(String sseCustomerKeyMD5)

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

This functionality is not supported for directory buckets.

Parameters:

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.

Returns:

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

requestPayer

HeadObjectRequest.Builder requestPayer(String requestPayer)

Sets the value of the RequestPayer property for this object.

Parameters:

requestPayer - The new value for the RequestPayer property for this object.

Returns:

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

See Also:

RequestPayer, RequestPayer

requestPayer

HeadObjectRequest.Builder requestPayer(RequestPayer requestPayer)

Sets the value of the RequestPayer property for this object.

Parameters:

requestPayer - The new value for the RequestPayer property for this object.

Returns:

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

See Also:

RequestPayer, RequestPayer

partNumber

HeadObjectRequest.Builder partNumber(Integer partNumber)

Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.

Parameters:

partNumber - Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.

Returns:

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

expectedBucketOwner

HeadObjectRequest.Builder expectedBucketOwner(String 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).

Parameters:

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

Returns:

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

checksumMode

HeadObjectRequest.Builder checksumMode(String checksumMode)

To retrieve the checksum, this parameter must be enabled.

General purpose buckets - If you enable checksum mode and the object is uploaded with a checksum and encrypted with an Key Management Service (KMS) key, you must have permission to use the kms:Decrypt action to retrieve the checksum.

Directory buckets - If you enable ChecksumMode and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.

Parameters:

checksumMode - To retrieve the checksum, this parameter must be enabled.

General purpose buckets - If you enable checksum mode and the object is uploaded with a checksum and encrypted with an Key Management Service (KMS) key, you must have permission to use the kms:Decrypt action to retrieve the checksum.

Directory buckets - If you enable ChecksumMode and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.

Returns:

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

See Also:

ChecksumMode, ChecksumMode

checksumMode

HeadObjectRequest.Builder checksumMode(ChecksumMode checksumMode)

To retrieve the checksum, this parameter must be enabled.

General purpose buckets - If you enable checksum mode and the object is uploaded with a checksum and encrypted with an Key Management Service (KMS) key, you must have permission to use the kms:Decrypt action to retrieve the checksum.

Directory buckets - If you enable ChecksumMode and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.

Parameters:

checksumMode - To retrieve the checksum, this parameter must be enabled.

General purpose buckets - If you enable checksum mode and the object is uploaded with a checksum and encrypted with an Key Management Service (KMS) key, you must have permission to use the kms:Decrypt action to retrieve the checksum.

Directory buckets - If you enable ChecksumMode and the object is encrypted with Amazon Web Services Key Management Service (Amazon Web Services KMS), you must also have the kms:GenerateDataKey and kms:Decrypt permissions in IAM identity-based policies and KMS key policies for the KMS key to retrieve the checksum of the object.

Returns:

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

See Also:

ChecksumMode, ChecksumMode

overrideConfiguration

HeadObjectRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

HeadObjectRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.