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 |
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).
|
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 (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 API 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 operation with an access point through the AWS 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 Simple Storage Service Developer Guide.
When using this API 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 using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer Guide.
bucket
- The name of the bucket containing the object.
When using this API 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 operation with an access point through the AWS 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 Simple Storage Service Developer Guide.
When using this API 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 using this operation using S3 on Outposts through the AWS SDKs, you provide the Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using S3 on Outposts in the Amazon Simple Storage Service Developer 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).
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).
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).
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).
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.
key
- The object key.HeadObjectRequest.Builder range(String range)
Downloads the specified range bytes of an object. For more information about the HTTP Range header, see http://www.w3.org/Protocols/rfc2616/ rfc2616-sec14.html#sec14.35.
Amazon S3 doesn't support retrieving multiple ranges of data per GET
request.
range
- Downloads the specified range bytes of an object. For more information about the HTTP Range header,
see http://www.w3.org/Protocols
/rfc2616/rfc2616-sec14.html#sec14.35.
Amazon S3 doesn't support retrieving multiple ranges of data per GET
request.
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 will
fail with an HTTP 403 (Access Denied)
error.
expectedBucketOwner
- The account id of the expected bucket owner. If the bucket is owned by a different account, the
request will fail with an HTTP 403 (Access Denied)
error.HeadObjectRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration
in interface AwsRequest.Builder
HeadObjectRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration
in interface AwsRequest.Builder
Copyright © 2021. All rights reserved.