@Generated(value="software.amazon.awssdk:codegen") public final class HeadObjectResponse extends S3Response implements ToCopyableBuilder<HeadObjectResponse.Builder,HeadObjectResponse>
Modifier and Type | Class and Description |
---|---|
static interface |
HeadObjectResponse.Builder |
Modifier and Type | Method and Description |
---|---|
String |
acceptRanges()
Indicates that a range of bytes was specified.
|
ArchiveStatus |
archiveStatus()
The archive state of the head object.
|
String |
archiveStatusAsString()
The archive state of the head object.
|
Boolean |
bucketKeyEnabled()
Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS)
keys (SSE-KMS).
|
static HeadObjectResponse.Builder |
builder() |
String |
cacheControl()
Specifies caching behavior along the request/reply chain.
|
String |
checksumCRC32()
The base64-encoded, 32-bit CRC32 checksum of the object.
|
String |
checksumCRC32C()
The base64-encoded, 32-bit CRC32C checksum of the object.
|
String |
checksumSHA1()
The base64-encoded, 160-bit SHA-1 digest of the object.
|
String |
checksumSHA256()
The base64-encoded, 256-bit SHA-256 digest of the object.
|
String |
contentDisposition()
Specifies presentational information for the object.
|
String |
contentEncoding()
Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be
applied to obtain the media-type referenced by the Content-Type header field.
|
String |
contentLanguage()
The language the content is in.
|
Long |
contentLength()
Size of the body in bytes.
|
String |
contentType()
A standard MIME type describing the format of the object data.
|
Boolean |
deleteMarker()
Specifies whether the object retrieved was (true) or was not (false) a Delete Marker.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
String |
eTag()
An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found
at a URL.
|
String |
expiration()
If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header.
|
Instant |
expires()
The date and time at which the object is no longer cacheable.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasMetadata()
For responses, this returns true if the service returned a value for the Metadata property.
|
Instant |
lastModified()
Creation date of the object.
|
Map<String,String> |
metadata()
A map of metadata to store with the object in S3.
|
Integer |
missingMeta()
This is set to the number of metadata entries not returned in
x-amz-meta headers. |
ObjectLockLegalHoldStatus |
objectLockLegalHoldStatus()
Specifies whether a legal hold is in effect for this object.
|
String |
objectLockLegalHoldStatusAsString()
Specifies whether a legal hold is in effect for this object.
|
ObjectLockMode |
objectLockMode()
The Object Lock mode, if any, that's in effect for this object.
|
String |
objectLockModeAsString()
The Object Lock mode, if any, that's in effect for this object.
|
Instant |
objectLockRetainUntilDate()
The date and time when the Object Lock retention period expires.
|
Integer |
partsCount()
The count of parts this object has.
|
ReplicationStatus |
replicationStatus()
Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a
replication rule.
|
String |
replicationStatusAsString()
Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a
replication rule.
|
RequestCharged |
requestCharged()
Returns the value of the RequestCharged property for this object.
|
String |
requestChargedAsString()
Returns the value of the RequestCharged property for this object.
|
String |
restore()
If the object is an archived object (an object whose storage class is GLACIER), the response includes this header
if either the archive restoration is in progress (see RestoreObject or an archive
copy is already restored.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends HeadObjectResponse.Builder> |
serializableBuilderClass() |
ServerSideEncryption |
serverSideEncryption()
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
AES256 , aws:kms , aws:kms:dsse ). |
String |
serverSideEncryptionAsString()
The server-side encryption algorithm used when storing this object in Amazon S3 (for example,
AES256 , aws:kms , aws:kms:dsse ). |
String |
sseCustomerAlgorithm()
If server-side encryption with a customer-provided encryption key was requested, the response will include this
header confirming the encryption algorithm used.
|
String |
sseCustomerKeyMD5()
If server-side encryption with a customer-provided encryption key was requested, the response will include this
header to provide round-trip message integrity verification of the customer-provided encryption key.
|
String |
ssekmsKeyId()
If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that
was used for the object.
|
StorageClass |
storageClass()
Provides storage class information of the object.
|
String |
storageClassAsString()
Provides storage class information of the object.
|
HeadObjectResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
String |
versionId()
Version of the object.
|
String |
websiteRedirectLocation()
If the bucket is configured as a website, redirects requests for this object to another object in the same bucket
or to an external URL.
|
responseMetadata
sdkHttpResponse
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final Boolean deleteMarker()
Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.
public final String acceptRanges()
Indicates that a range of bytes was specified.
public final String expiration()
If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes
the expiry-date
and rule-id
key-value pairs providing object expiration information.
The value of the rule-id
is URL-encoded.
expiry-date
and rule-id
key-value pairs providing object
expiration information. The value of the rule-id
is URL-encoded.public final String restore()
If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.
If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:
x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"
If the object restoration is in progress, the header returns the value ongoing-request="true"
.
For more information about archiving objects, see Transitioning Objects: General Considerations.
If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:
x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"
If the object restoration is in progress, the header returns the value
ongoing-request="true"
.
For more information about archiving objects, see Transitioning Objects: General Considerations.
public final ArchiveStatus archiveStatus()
The archive state of the head object.
If the service returns an enum value that is not available in the current SDK version, archiveStatus
will return ArchiveStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
archiveStatusAsString()
.
ArchiveStatus
public final String archiveStatusAsString()
The archive state of the head object.
If the service returns an enum value that is not available in the current SDK version, archiveStatus
will return ArchiveStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
archiveStatusAsString()
.
ArchiveStatus
public final Instant lastModified()
Creation date of the object.
public final Long contentLength()
Size of the body in bytes.
public final String checksumCRC32()
The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
public final String checksumCRC32C()
The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
public final String checksumSHA1()
The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
public final String checksumSHA256()
The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. With multipart uploads, this may not be a checksum value of the object. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
public final String eTag()
An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
public final Integer missingMeta()
This is set to the number of metadata entries not returned in x-amz-meta
headers. This can happen if
you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example,
using SOAP, you can create metadata whose values are not legal HTTP headers.
x-amz-meta
headers. This can
happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST
API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.public final String versionId()
Version of the object.
public final String cacheControl()
Specifies caching behavior along the request/reply chain.
public final String contentDisposition()
Specifies presentational information for the object.
public final String contentEncoding()
Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
public final String contentLanguage()
The language the content is in.
public final String contentType()
A standard MIME type describing the format of the object data.
public final Instant expires()
The date and time at which the object is no longer cacheable.
public final String websiteRedirectLocation()
If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.
public final ServerSideEncryption serverSideEncryption()
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256
, aws:kms
, aws:kms:dsse
).
If the service returns an enum value that is not available in the current SDK version,
serverSideEncryption
will return ServerSideEncryption.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from serverSideEncryptionAsString()
.
AES256
, aws:kms
, aws:kms:dsse
).ServerSideEncryption
public final String serverSideEncryptionAsString()
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256
, aws:kms
, aws:kms:dsse
).
If the service returns an enum value that is not available in the current SDK version,
serverSideEncryption
will return ServerSideEncryption.UNKNOWN_TO_SDK_VERSION
. The raw value
returned by the service is available from serverSideEncryptionAsString()
.
AES256
, aws:kms
, aws:kms:dsse
).ServerSideEncryption
public final boolean hasMetadata()
isEmpty()
method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final Map<String,String> metadata()
A map of metadata to store with the object in S3.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasMetadata()
method.
public final String sseCustomerAlgorithm()
If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.
public final String sseCustomerKeyMD5()
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.
public final String ssekmsKeyId()
If present, specifies the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.
public final Boolean bucketKeyEnabled()
Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
public final StorageClass storageClass()
Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
For more information, see Storage Classes.
If the service returns an enum value that is not available in the current SDK version, storageClass
will
return StorageClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
storageClassAsString()
.
For more information, see Storage Classes.
StorageClass
public final String storageClassAsString()
Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
For more information, see Storage Classes.
If the service returns an enum value that is not available in the current SDK version, storageClass
will
return StorageClass.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available from
storageClassAsString()
.
For more information, see Storage Classes.
StorageClass
public final RequestCharged requestCharged()
If the service returns an enum value that is not available in the current SDK version, requestCharged
will return RequestCharged.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from requestChargedAsString()
.
RequestCharged
public final String requestChargedAsString()
If the service returns an enum value that is not available in the current SDK version, requestCharged
will return RequestCharged.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from requestChargedAsString()
.
RequestCharged
public final ReplicationStatus replicationStatus()
Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.
In replication, you have a source bucket on which you configure replication and destination bucket or buckets
where Amazon S3 stores object replicas. When you request an object (GetObject
) or object metadata (
HeadObject
) from these buckets, Amazon S3 will return the x-amz-replication-status
header in the response as follows:
If requesting an object from the source bucket, Amazon S3 will return the
x-amz-replication-status
header if the object in your request is eligible for replication.
For example, suppose that in your replication configuration, you specify object prefix TaxDocs
requesting Amazon S3 to replicate objects with key prefix TaxDocs
. Any objects you upload with this
key name prefix, for example TaxDocs/document1.pdf
, are eligible for replication. For any object
request with this key name prefix, Amazon S3 will return the x-amz-replication-status
header with
value PENDING, COMPLETED or FAILED indicating object replication status.
If requesting an object from a destination bucket, Amazon S3 will return the
x-amz-replication-status
header with value REPLICA if the object in your request is a replica that
Amazon S3 created and there is no replica modification replication in progress.
When replicating objects to multiple destination buckets, the x-amz-replication-status
header
acts differently. The header of the source object will only return a value of COMPLETED when replication is
successful to all destinations. The header will remain at value PENDING until replication has completed for all
destinations. If one or more destinations fails replication the header will return FAILED.
For more information, see Replication.
If the service returns an enum value that is not available in the current SDK version, replicationStatus
will return ReplicationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from replicationStatusAsString()
.
In replication, you have a source bucket on which you configure replication and destination bucket or
buckets where Amazon S3 stores object replicas. When you request an object (GetObject
) or
object metadata (HeadObject
) from these buckets, Amazon S3 will return the
x-amz-replication-status
header in the response as follows:
If requesting an object from the source bucket, Amazon S3 will return the
x-amz-replication-status
header if the object in your request is eligible for replication.
For example, suppose that in your replication configuration, you specify object prefix
TaxDocs
requesting Amazon S3 to replicate objects with key prefix TaxDocs
. Any
objects you upload with this key name prefix, for example TaxDocs/document1.pdf
, are
eligible for replication. For any object request with this key name prefix, Amazon S3 will return the
x-amz-replication-status
header with value PENDING, COMPLETED or FAILED indicating object
replication status.
If requesting an object from a destination bucket, Amazon S3 will return the
x-amz-replication-status
header with value REPLICA if the object in your request is a
replica that Amazon S3 created and there is no replica modification replication in progress.
When replicating objects to multiple destination buckets, the
x-amz-replication-status
header acts differently. The header of the source object will only
return a value of COMPLETED when replication is successful to all destinations. The header will remain at
value PENDING until replication has completed for all destinations. If one or more destinations fails
replication the header will return FAILED.
For more information, see Replication.
ReplicationStatus
public final String replicationStatusAsString()
Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.
In replication, you have a source bucket on which you configure replication and destination bucket or buckets
where Amazon S3 stores object replicas. When you request an object (GetObject
) or object metadata (
HeadObject
) from these buckets, Amazon S3 will return the x-amz-replication-status
header in the response as follows:
If requesting an object from the source bucket, Amazon S3 will return the
x-amz-replication-status
header if the object in your request is eligible for replication.
For example, suppose that in your replication configuration, you specify object prefix TaxDocs
requesting Amazon S3 to replicate objects with key prefix TaxDocs
. Any objects you upload with this
key name prefix, for example TaxDocs/document1.pdf
, are eligible for replication. For any object
request with this key name prefix, Amazon S3 will return the x-amz-replication-status
header with
value PENDING, COMPLETED or FAILED indicating object replication status.
If requesting an object from a destination bucket, Amazon S3 will return the
x-amz-replication-status
header with value REPLICA if the object in your request is a replica that
Amazon S3 created and there is no replica modification replication in progress.
When replicating objects to multiple destination buckets, the x-amz-replication-status
header
acts differently. The header of the source object will only return a value of COMPLETED when replication is
successful to all destinations. The header will remain at value PENDING until replication has completed for all
destinations. If one or more destinations fails replication the header will return FAILED.
For more information, see Replication.
If the service returns an enum value that is not available in the current SDK version, replicationStatus
will return ReplicationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from replicationStatusAsString()
.
In replication, you have a source bucket on which you configure replication and destination bucket or
buckets where Amazon S3 stores object replicas. When you request an object (GetObject
) or
object metadata (HeadObject
) from these buckets, Amazon S3 will return the
x-amz-replication-status
header in the response as follows:
If requesting an object from the source bucket, Amazon S3 will return the
x-amz-replication-status
header if the object in your request is eligible for replication.
For example, suppose that in your replication configuration, you specify object prefix
TaxDocs
requesting Amazon S3 to replicate objects with key prefix TaxDocs
. Any
objects you upload with this key name prefix, for example TaxDocs/document1.pdf
, are
eligible for replication. For any object request with this key name prefix, Amazon S3 will return the
x-amz-replication-status
header with value PENDING, COMPLETED or FAILED indicating object
replication status.
If requesting an object from a destination bucket, Amazon S3 will return the
x-amz-replication-status
header with value REPLICA if the object in your request is a
replica that Amazon S3 created and there is no replica modification replication in progress.
When replicating objects to multiple destination buckets, the
x-amz-replication-status
header acts differently. The header of the source object will only
return a value of COMPLETED when replication is successful to all destinations. The header will remain at
value PENDING until replication has completed for all destinations. If one or more destinations fails
replication the header will return FAILED.
For more information, see Replication.
ReplicationStatus
public final Integer partsCount()
The count of parts this object has. This value is only returned if you specify partNumber
in your
request and the object was uploaded as a multipart upload.
partNumber
in
your request and the object was uploaded as a multipart upload.public final ObjectLockMode objectLockMode()
The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has
the s3:GetObjectRetention
permission. For more information about S3 Object Lock, see Object Lock.
If the service returns an enum value that is not available in the current SDK version, objectLockMode
will return ObjectLockMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from objectLockModeAsString()
.
s3:GetObjectRetention
permission. For more information about S3 Object
Lock, see Object Lock.ObjectLockMode
public final String objectLockModeAsString()
The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has
the s3:GetObjectRetention
permission. For more information about S3 Object Lock, see Object Lock.
If the service returns an enum value that is not available in the current SDK version, objectLockMode
will return ObjectLockMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available
from objectLockModeAsString()
.
s3:GetObjectRetention
permission. For more information about S3 Object
Lock, see Object Lock.ObjectLockMode
public final Instant objectLockRetainUntilDate()
The date and time when the Object Lock retention period expires. This header is only returned if the requester
has the s3:GetObjectRetention
permission.
s3:GetObjectRetention
permission.public final ObjectLockLegalHoldStatus objectLockLegalHoldStatus()
Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has
the s3:GetObjectLegalHold
permission. This header is not returned if the specified version of this
object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.
If the service returns an enum value that is not available in the current SDK version,
objectLockLegalHoldStatus
will return ObjectLockLegalHoldStatus.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from objectLockLegalHoldStatusAsString()
.
s3:GetObjectLegalHold
permission. This header is not returned if the
specified version of this object has never had a legal hold applied. For more information about S3 Object
Lock, see Object Lock.ObjectLockLegalHoldStatus
public final String objectLockLegalHoldStatusAsString()
Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has
the s3:GetObjectLegalHold
permission. This header is not returned if the specified version of this
object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.
If the service returns an enum value that is not available in the current SDK version,
objectLockLegalHoldStatus
will return ObjectLockLegalHoldStatus.UNKNOWN_TO_SDK_VERSION
. The raw
value returned by the service is available from objectLockLegalHoldStatusAsString()
.
s3:GetObjectLegalHold
permission. This header is not returned if the
specified version of this object has never had a legal hold applied. For more information about S3 Object
Lock, see Object Lock.ObjectLockLegalHoldStatus
public HeadObjectResponse.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<HeadObjectResponse.Builder,HeadObjectResponse>
toBuilder
in class AwsResponse
public static HeadObjectResponse.Builder builder()
public static Class<? extends HeadObjectResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsResponse
public final boolean equals(Object obj)
equals
in class AwsResponse
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 SdkResponse
Copyright © 2023. All rights reserved.