Class HeadObjectRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<HeadObjectRequest.Builder,
HeadObjectRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
bucket()
The name of the bucket that contains the object.static HeadObjectRequest.Builder
builder()
final ChecksumMode
To retrieve the checksum, this parameter must be enabled.final String
To retrieve the checksum, this parameter must be enabled.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The account ID of the expected bucket owner.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
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.final Instant
Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.final String
Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.final Instant
Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.final String
key()
The object key.final Integer
Part number of the object being read.final String
range()
HeadObject returns only the metadata for an object.final RequestPayer
Returns the value of the RequestPayer property for this object.final String
Returns the value of the RequestPayer property for this object.static Class
<? extends HeadObjectRequest.Builder> final String
Specifies the algorithm to use when encrypting the object (for example, AES256).final String
Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.final String
Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
Version ID used to reference a specific version of the object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the formatbucket_base_name--az-id--x-s3
(for example,DOC-EXAMPLE-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, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - 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.- Returns:
- 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-az_id.region.amazonaws.com
. Path-style requests are not supported. Directory bucket names must be unique in the chosen Availability Zone. Bucket names must follow the formatbucket_base_name--az-id--x-s3
(for example,DOC-EXAMPLE-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, you must provide the alias of the access point in place of the bucket name or specify the access point ARN. 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.
Access points and Object Lambda access points are not supported by directory buckets.
S3 on Outposts - 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.
-
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
andIf-Unmodified-Since
headers are present in the request as follows:-
If-Match
condition evaluates totrue
, and; -
If-Unmodified-Since
condition evaluates tofalse
;
Then Amazon S3 returns
200 OK
and the data requested.For more information about conditional requests, see RFC 7232.
- Returns:
- 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
andIf-Unmodified-Since
headers are present in the request as follows:-
If-Match
condition evaluates totrue
, and; -
If-Unmodified-Since
condition evaluates tofalse
;
Then Amazon S3 returns
200 OK
and the data requested.For more information about conditional requests, see RFC 7232.
-
-
-
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
andIf-Modified-Since
headers are present in the request as follows:-
If-None-Match
condition evaluates tofalse
, and; -
If-Modified-Since
condition evaluates totrue
;
Then Amazon S3 returns the
304 Not Modified
response code.For more information about conditional requests, see RFC 7232.
- Returns:
- 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
andIf-Modified-Since
headers are present in the request as follows:-
If-None-Match
condition evaluates tofalse
, and; -
If-Modified-Since
condition evaluates totrue
;
Then Amazon S3 returns the
304 Not Modified
response code.For more information about conditional requests, see RFC 7232.
-
-
-
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
andIf-Modified-Since
headers are present in the request as follows:-
If-None-Match
condition evaluates tofalse
, and; -
If-Modified-Since
condition evaluates totrue
;
Then Amazon S3 returns the
304 Not Modified
response code.For more information about conditional requests, see RFC 7232.
- Returns:
- 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
andIf-Modified-Since
headers are present in the request as follows:-
If-None-Match
condition evaluates tofalse
, and; -
If-Modified-Since
condition evaluates totrue
;
Then Amazon S3 returns the
304 Not Modified
response code.For more information about conditional requests, see RFC 7232.
-
-
-
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
andIf-Unmodified-Since
headers are present in the request as follows:-
If-Match
condition evaluates totrue
, and; -
If-Unmodified-Since
condition evaluates tofalse
;
Then Amazon S3 returns
200 OK
and the data requested.For more information about conditional requests, see RFC 7232.
- Returns:
- 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
andIf-Unmodified-Since
headers are present in the request as follows:-
If-Match
condition evaluates totrue
, and; -
If-Unmodified-Since
condition evaluates tofalse
;
Then Amazon S3 returns
200 OK
and the data requested.For more information about conditional requests, see RFC 7232.
-
-
-
key
The object key.
- Returns:
- The object key.
-
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 a416 - Requested Range Not Satisfiable
error.- Returns:
- 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 a416 - Requested Range Not Satisfiable
error.
-
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:
- 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.
-
sseCustomerAlgorithm
Specifies the algorithm to use when encrypting the object (for example, AES256).
This functionality is not supported for directory buckets.
- Returns:
- Specifies the algorithm to use when encrypting the object (for example, AES256).
This functionality is not supported for directory buckets.
-
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:
- 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.
-
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:
- 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.
-
requestPayer
Returns the value of the RequestPayer property for this object.If the service returns an enum value that is not available in the current SDK version,
requestPayer
will returnRequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequestPayerAsString()
.- Returns:
- The value of the RequestPayer property for this object.
- See Also:
-
requestPayerAsString
Returns the value of the RequestPayer property for this object.If the service returns an enum value that is not available in the current SDK version,
requestPayer
will returnRequestPayer.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromrequestPayerAsString()
.- Returns:
- The value of the RequestPayer property for this object.
- See Also:
-
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:
- 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.
-
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:
- 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).
-
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 thekms: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 returnChecksumMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchecksumModeAsString()
.- Returns:
- 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 thekms:Decrypt
action for the request to succeed. - See Also:
-
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 thekms: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 returnChecksumMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromchecksumModeAsString()
.- Returns:
- 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 thekms:Decrypt
action for the request to succeed. - See Also:
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<HeadObjectRequest.Builder,
HeadObjectRequest> - Specified by:
toBuilder
in classS3Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-