software.amazon.awssdk.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

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 containing the object.
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).
HeadObjectRequest.Builder	ifModifiedSince(Instant ifModifiedSince) Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).
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).
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).
HeadObjectRequest.Builder	key(String key) The object key.
HeadObjectRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
HeadObjectRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
HeadObjectRequest.Builder	partNumber(Integer partNumber) Part number of the object being read.
HeadObjectRequest.Builder	range(String range) Downloads the specified range bytes of 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	sseCustomerAlgorithm(String sseCustomerAlgorithm) Specifies the algorithm to use to when encrypting the object (e.g., 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) VersionId used to reference a specific version of the object.

Methods inherited from interface software.amazon.awssdk.services.s3.model.S3Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

bucket

HeadObjectRequest.Builder bucket(String bucket)

The name of the bucket containing the object.

Parameters:

bucket - The name of the bucket containing the object.

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

Parameters:

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

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

Parameters:

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

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

Parameters:

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

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

Parameters:

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

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)

Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

Parameters:

range - Downloads the specified range bytes of an object. For more information about the HTTP Range header, go to http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35.

Returns:

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

versionId

HeadObjectRequest.Builder versionId(String versionId)

VersionId used to reference a specific version of the object.

Parameters:

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

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 to when encrypting the object (e.g., AES256).

Parameters:

sseCustomerAlgorithm - Specifies the algorithm to use to when encrypting the object (e.g., AES256).

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

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

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 the encryption key was transmitted without error.

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 the encryption key was transmitted without error.

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.

overrideConfiguration

HeadObjectRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

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

Specified by:

overrideConfiguration in interface AwsRequest.Builder