@Generated(value="software.amazon.awssdk:codegen") public final class HeadObjectRequest extends S3Request implements ToCopyableBuilder<HeadObjectRequest.Builder,HeadObjectRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
HeadObjectRequest.Builder |
Modifier and Type | Method and Description |
---|---|
String |
bucket()
The name of the bucket containing the object.
|
static HeadObjectRequest.Builder |
builder() |
ChecksumMode |
checksumMode()
To retrieve the checksum, this parameter must be enabled.
|
String |
checksumModeAsString()
To retrieve the checksum, this parameter must be enabled.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
expectedBucketOwner()
The account ID of the expected bucket owner.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
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.
|
Instant |
ifModifiedSince()
Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified)
error.
|
String |
ifNoneMatch()
Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not
modified) error.
|
Instant |
ifUnmodifiedSince()
Return the object only if it has not been modified since the specified time; otherwise, return a 412
(precondition failed) error.
|
String |
key()
The object key.
|
Integer |
partNumber()
Part number of the object being read.
|
String |
range()
Because
HeadObject returns only the metadata for an object, this parameter has no effect. |
RequestPayer |
requestPayer()
Returns the value of the RequestPayer property for this object.
|
String |
requestPayerAsString()
Returns the value of the RequestPayer property for this object.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends HeadObjectRequest.Builder> |
serializableBuilderClass() |
String |
sseCustomerAlgorithm()
Specifies the algorithm to use to when encrypting the object (for example, AES256).
|
String |
sseCustomerKey()
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.
|
String |
sseCustomerKeyMD5()
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
|
HeadObjectRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
versionId()
VersionId used to reference a specific version of the object.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final 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 using 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 using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts bucket
ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on Outposts in
the Amazon S3 User Guide.
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 using 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 using this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the
Outposts bucket ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see Using Amazon S3 on
Outposts in the Amazon S3 User Guide.
public final 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.
public final Instant ifModifiedSince()
Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.
public final String ifNoneMatch()
Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.
public final Instant ifUnmodifiedSince()
Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.
public final String key()
The object key.
public final String range()
Because HeadObject
returns only the metadata for an object, this parameter has no effect.
HeadObject
returns only the metadata for an object, this parameter has no effect.public final String versionId()
VersionId used to reference a specific version of the object.
public final String sseCustomerAlgorithm()
Specifies the algorithm to use to when encrypting the object (for example, AES256).
public final 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.
x-amz-server-side-encryption-customer-algorithm
header.public final 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.
public final RequestPayer requestPayer()
If the service returns an enum value that is not available in the current SDK version, requestPayer
will
return RequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
requestPayerAsString()
.
RequestPayer
public final String requestPayerAsString()
If the service returns an enum value that is not available in the current SDK version, requestPayer
will
return RequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
requestPayerAsString()
.
RequestPayer
public final 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.
public final 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).
403 Forbidden
(access denied).public final 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.
If the service returns an enum value that is not available in the current SDK version, checksumMode
will
return ChecksumMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
checksumModeAsString()
.
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
public final String checksumModeAsString()
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.
If the service returns an enum value that is not available in the current SDK version, checksumMode
will
return ChecksumMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
checksumModeAsString()
.
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
public HeadObjectRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<HeadObjectRequest.Builder,HeadObjectRequest>
toBuilder
in class S3Request
public static HeadObjectRequest.Builder builder()
public static Class<? extends HeadObjectRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2023. All rights reserved.