public static interface HeadObjectRequest.Builder extends S3Request.Builder, SdkPojo, CopyableBuilder<HeadObjectRequest.Builder,HeadObjectRequest>
Modifier and Type | Method and Description |
---|---|
HeadObjectRequest.Builder |
bucket(String bucket)
The name of the bucket containing 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) |
HeadObjectRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
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 |
sseCustomerAlgorithm(String sseCustomerAlgorithm)
Specifies the algorithm to use to 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)
VersionId used to reference a specific version of the object.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
HeadObjectRequest.Builder bucket(String bucket)
The name of the bucket containing the object.
When using this action with an access point, 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.
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.
bucket
- The name of the bucket containing the object.
When using this action with an access point, 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.
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.
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.
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.
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.
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.
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.
key
- The object key.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.
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.HeadObjectRequest.Builder versionId(String versionId)
VersionId used to reference a specific version of the object.
versionId
- VersionId used to reference a specific version of the object.HeadObjectRequest.Builder sseCustomerAlgorithm(String sseCustomerAlgorithm)
Specifies the algorithm to use to when encrypting the object (for example, AES256).
sseCustomerAlgorithm
- Specifies the algorithm to use to 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. 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.
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.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.
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.HeadObjectRequest.Builder requestPayer(String requestPayer)
requestPayer
- The new value for the RequestPayer property for this object.RequestPayer
,
RequestPayer
HeadObjectRequest.Builder requestPayer(RequestPayer requestPayer)
requestPayer
- The new value for the RequestPayer property for this object.RequestPayer
,
RequestPayer
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.
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.HeadObjectRequest.Builder expectedBucketOwner(String expectedBucketOwner)
The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails
with the HTTP status code 403 Forbidden
(access denied).
expectedBucketOwner
- The account ID of the expected bucket owner. If the bucket is owned by a different account, the
request fails with the HTTP status code 403 Forbidden
(access denied).HeadObjectRequest.Builder checksumMode(String checksumMode)
To retrieve the checksum, this parameter must be enabled.
In addition, if you enable ChecksumMode
and the object is encrypted with Amazon Web Services Key
Management Service (Amazon Web Services KMS), you must have permission to use the kms:Decrypt
action for the request to succeed.
checksumMode
- To retrieve the checksum, this parameter must be enabled.
In addition, if you enable ChecksumMode
and the object is encrypted with Amazon Web
Services Key Management Service (Amazon Web Services KMS), you must have permission to use the
kms:Decrypt
action for the request to succeed.
ChecksumMode
,
ChecksumMode
HeadObjectRequest.Builder checksumMode(ChecksumMode checksumMode)
To retrieve the checksum, this parameter must be enabled.
In addition, if you enable ChecksumMode
and the object is encrypted with Amazon Web Services Key
Management Service (Amazon Web Services KMS), you must have permission to use the kms:Decrypt
action for the request to succeed.
checksumMode
- To retrieve the checksum, this parameter must be enabled.
In addition, if you enable ChecksumMode
and the object is encrypted with Amazon Web
Services Key Management Service (Amazon Web Services KMS), you must have permission to use the
kms:Decrypt
action for the request to succeed.
ChecksumMode
,
ChecksumMode
HeadObjectRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
HeadObjectRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2023. All rights reserved.