HeadObjectResponse (IBM COS Java SDK

java.lang.Object
- com.ibm.cos.v2.core.SdkResponse
- - com.ibm.cos.v2.awscore.AwsResponse
  - - com.ibm.cos.v2.services.s3.model.S3Response
    - - com.ibm.cos.v2.services.s3.model.HeadObjectResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<HeadObjectResponse.Builder,HeadObjectResponse>

@Generated(value="com.ibm.cos.v2:codegen")
public final class HeadObjectResponse
extends S3Response
implements ToCopyableBuilder<HeadObjectResponse.Builder,HeadObjectResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface HeadObjectResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`HeadObjectResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
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`	`checksumCRC64NVME()` The Base64 encoded, 64-bit `CRC64NVME` checksum of the object.
`String`	`checksumSHA1()` The Base64 encoded, 160-bit `SHA1` digest of the object.
`String`	`checksumSHA256()` The Base64 encoded, 256-bit `SHA256` digest of the object.
`ChecksumType`	`checksumType()` The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects.
`String`	`checksumTypeAsString()` The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects.
`String`	`contentDisposition()` Specifies presentational information for the object.
`String`	`contentEncoding()` Indicates 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`	`contentRange()` The portion of the object returned in the response for a `GET` request.
`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)` Indicates whether some other object is "equal to" this one by SDK fields.
`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 `PutBucketLifecycleConfiguration` ), the response includes this header.
`Instant`	`expires()` Deprecated. Usage of the Expires field is deprecated in favor of the more flexible and less error prone ExpiresString
`String`	`expiresString()` The date and time at which the object is no longer cacheable
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkResponse`.
`int`	`hashCode()`
`boolean`	`hasMetadata()` For responses, this returns true if the service returned a value for the Metadata property.
`String`	`ibmRestoredCopyStorageClass()` IBM-specific
`String`	`ibmTransition()` IBM-specific
`Instant`	`lastModified()` Date and time when the object was last modified.
`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.
`Instant`	`retentionExpirationDate()` IBM-specific
`Integer`	`retentionLegalHoldCount()` IBM-specific
`Long`	`retentionPeriod()` IBM-specific
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends HeadObjectResponse.Builder>`	`serializableBuilderClass()`
`ServerSideEncryption`	`serverSideEncryption()` The server-side encryption algorithm used when you store this object in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
`String`	`serverSideEncryptionAsString()` The server-side encryption algorithm used when you store 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 to confirm the encryption algorithm that's used.
`String`	`sseCustomerKeyMD5()` If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.
`String`	`ssekmsKeyId()` If present, indicates the ID of the KMS key that was used for object encryption.
`StorageClass`	`storageClass()` Provides storage class information of the object.
`String`	`storageClassAsString()` Provides storage class information of the object.
`HeadObjectResponse.Builder`	`toBuilder()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()` Returns a string representation of this object.
`String`	`versionId()` Version ID 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.

Methods inherited from class com.ibm.cos.v2.services.s3.model.S3Response
responseMetadata

Methods inherited from class com.ibm.cos.v2.core.SdkResponse
sdkHttpResponse

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ibm.cos.v2.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - deleteMarker
```
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.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    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.
    This functionality is not supported for directory buckets.
  - acceptRanges
```
public final String acceptRanges()
```
    Indicates that a range of bytes was specified.
    
    Returns:
    
    Indicates that a range of bytes was specified.
  - expiration
```
public final String expiration()
```
    If the object expiration is configured (see PutBucketLifecycleConfiguration ), 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.
    
    Object expiration information is not returned in directory buckets and this header returns the value " NotImplemented" in all responses for directory buckets.
    
    Returns:
    
    If the object expiration is configured (see PutBucketLifecycleConfiguration ), 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.
    
    Object expiration information is not returned in directory buckets and this header returns the value " NotImplemented" in all responses for directory buckets.
  - restore
```
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.
    
    This functionality is not supported for directory buckets. Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
    
    Returns:
    
    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.
    
    This functionality is not supported for directory buckets. Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
  - archiveStatus
```
public final ArchiveStatus archiveStatus()
```
    The archive state of the head object.
    
    This functionality is not supported for directory buckets.
    
    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().
    
    Returns:
    
    The archive state of the head object.
    
    This functionality is not supported for directory buckets.
    
    See Also:
    
    ArchiveStatus
  - archiveStatusAsString
```
public final String archiveStatusAsString()
```
    The archive state of the head object.
    
    This functionality is not supported for directory buckets.
    
    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().
    
    Returns:
    
    The archive state of the head object.
    
    This functionality is not supported for directory buckets.
    
    See Also:
    
    ArchiveStatus
  - lastModified
```
public final Instant lastModified()
```
    Date and time when the object was last modified.
    
    Returns:
    
    Date and time when the object was last modified.
  - contentLength
```
public final Long contentLength()
```
    Size of the body in bytes.
    
    Returns:
    
    Size of the body in bytes.
  - checksumCRC32
```
public final String checksumCRC32()
```
    The Base64 encoded, 32-bit CRC32 checksum of the object. This checksum is only be present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
    
    Returns:
    
    The Base64 encoded, 32-bit CRC32 checksum of the object. This checksum is only be present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
  - checksumCRC32C
```
public final String checksumCRC32C()
```
    The Base64 encoded, 32-bit CRC32C checksum of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
    
    Returns:
    
    The Base64 encoded, 32-bit CRC32C checksum of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
  - checksumCRC64NVME
```
public final String checksumCRC64NVME()
```
    The Base64 encoded, 64-bit CRC64NVME checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    Returns:
    
    The Base64 encoded, 64-bit CRC64NVME checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
  - checksumSHA1
```
public final String checksumSHA1()
```
    The Base64 encoded, 160-bit SHA1 digest of the object. This will only be present if the object was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
    
    Returns:
    
    The Base64 encoded, 160-bit SHA1 digest of the object. This will only be present if the object was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
  - checksumSHA256
```
public final String checksumSHA256()
```
    The Base64 encoded, 256-bit SHA256 digest of the object. This will only be present if the object was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
    
    Returns:
    
    The Base64 encoded, 256-bit SHA256 digest of the object. This will only be present if the object was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
  - checksumType
```
public final ChecksumType checksumType()
```
    The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header response to verify that the checksum type that is received is the same checksum type that was specified in CreateMultipartUpload request. For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    If the service returns an enum value that is not available in the current SDK version, checksumType will return ChecksumType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumTypeAsString().
    
    Returns:
    
    The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header response to verify that the checksum type that is received is the same checksum type that was specified in CreateMultipartUpload request. For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    See Also:
    
    ChecksumType
  - checksumTypeAsString
```
public final String checksumTypeAsString()
```
    The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header response to verify that the checksum type that is received is the same checksum type that was specified in CreateMultipartUpload request. For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    If the service returns an enum value that is not available in the current SDK version, checksumType will return ChecksumType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumTypeAsString().
    
    Returns:
    
    The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header response to verify that the checksum type that is received is the same checksum type that was specified in CreateMultipartUpload request. For more information, see Checking object integrity in the Amazon S3 User Guide.
    
    See Also:
    
    ChecksumType
  - eTag
```
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.
    
    Returns:
    
    An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
  - missingMeta
```
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.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    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.
    
    This functionality is not supported for directory buckets.
  - versionId
```
public final String versionId()
```
    Version ID of the object.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    Version ID of the object.
    
    This functionality is not supported for directory buckets.
  - cacheControl
```
public final String cacheControl()
```
    Specifies caching behavior along the request/reply chain.
    
    Returns:
    
    Specifies caching behavior along the request/reply chain.
  - contentDisposition
```
public final String contentDisposition()
```
    Specifies presentational information for the object.
    
    Returns:
    
    Specifies presentational information for the object.
  - contentEncoding
```
public final String contentEncoding()
```
    Indicates 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.
    
    Returns:
    
    Indicates 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.
  - contentLanguage
```
public final String contentLanguage()
```
    The language the content is in.
    
    Returns:
    
    The language the content is in.
  - contentType
```
public final String contentType()
```
    A standard MIME type describing the format of the object data.
    
    Returns:
    
    A standard MIME type describing the format of the object data.
  - contentRange
```
public final String contentRange()
```
    The portion of the object returned in the response for a GET request.
    
    Returns:
    
    The portion of the object returned in the response for a GET request.
  - expires
```
@Deprecated
public final Instant expires()
```
    Deprecated. Usage of the Expires field is deprecated in favor of the more flexible and less error prone ExpiresString
    
    The date and time at which the object is no longer cacheable.
    
    Returns:
    
    The date and time at which the object is no longer cacheable.
  - websiteRedirectLocation
```
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.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    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.
    
    This functionality is not supported for directory buckets.
  - serverSideEncryption
```
public final ServerSideEncryption serverSideEncryption()
```
    The server-side encryption algorithm used when you store 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().
    
    Returns:
    
    The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).
    
    See Also:
    
    ServerSideEncryption
  - serverSideEncryptionAsString
```
public final String serverSideEncryptionAsString()
```
    The server-side encryption algorithm used when you store 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().
    
    Returns:
    
    The server-side encryption algorithm used when you store this object in Amazon S3 (for example, AES256, aws:kms, aws:kms:dsse).
    
    See Also:
    
    ServerSideEncryption
  - hasMetadata
```
public final boolean hasMetadata()
```
    For responses, this returns true if the service returned a value for the Metadata property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - metadata
```
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.
    
    Returns:
    
    A map of metadata to store with the object in S3.
  - sseCustomerAlgorithm
```
public final String sseCustomerAlgorithm()
```
    If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.
    
    This functionality is not supported for directory buckets.
  - sseCustomerKeyMD5
```
public final String sseCustomerKeyMD5()
```
    If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.
    
    This functionality is not supported for directory buckets.
  - ssekmsKeyId
```
public final String ssekmsKeyId()
```
    If present, indicates the ID of the KMS key that was used for object encryption.
    
    Returns:
    
    If present, indicates the ID of the KMS key that was used for object encryption.
  - bucketKeyEnabled
```
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).
    
    Returns:
    
    Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
  - storageClass
```
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.
    
    Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
    
    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().
    
    Returns:
    
    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.
    
    Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
    
    See Also:
    
    StorageClass
  - storageClassAsString
```
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.
    
    Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
    
    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().
    
    Returns:
    
    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.
    
    Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
    
    See Also:
    
    StorageClass
  - requestCharged
```
public final RequestCharged requestCharged()
```
    Returns the value of the RequestCharged property for this object.
    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().
    
    Returns:
    
    The value of the RequestCharged property for this object.
    
    See Also:
    
    RequestCharged
  - requestChargedAsString
```
public final String requestChargedAsString()
```
    Returns the value of the RequestCharged property for this object.
    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().
    
    Returns:
    
    The value of the RequestCharged property for this object.
    
    See Also:
    
    RequestCharged
  - replicationStatus
```
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.
    
    This functionality is not supported for directory buckets.
    
    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().
    Returns:
    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.
    
    This functionality is not supported for directory buckets.
    See Also:
    
    ReplicationStatus
  - replicationStatusAsString
```
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.
    
    This functionality is not supported for directory buckets.
    
    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().
    Returns:
    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.
    
    This functionality is not supported for directory buckets.
    See Also:
    
    ReplicationStatus
  - partsCount
```
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.
    
    Returns:
    
    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.
  - objectLockMode
```
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.
    
    This functionality is not supported for directory buckets.
    
    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().
    
    Returns:
    
    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.
    
    This functionality is not supported for directory buckets.
    
    See Also:
    
    ObjectLockMode
  - objectLockModeAsString
```
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.
    
    This functionality is not supported for directory buckets.
    
    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().
    
    Returns:
    
    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.
    
    This functionality is not supported for directory buckets.
    
    See Also:
    
    ObjectLockMode
  - objectLockRetainUntilDate
```
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.
    
    This functionality is not supported for directory buckets.
    
    Returns:
    
    The date and time when the Object Lock retention period expires. This header is only returned if the requester has the s3:GetObjectRetention permission.
    
    This functionality is not supported for directory buckets.
  - objectLockLegalHoldStatus
```
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.
    
    This functionality is not supported for directory buckets.
    
    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().
    
    Returns:
    
    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.
    
    This functionality is not supported for directory buckets.
    
    See Also:
    
    ObjectLockLegalHoldStatus
  - objectLockLegalHoldStatusAsString
```
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.
    
    This functionality is not supported for directory buckets.
    
    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().
    
    Returns:
    
    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.
    
    This functionality is not supported for directory buckets.
    
    See Also:
    
    ObjectLockLegalHoldStatus
  - expiresString
```
public final String expiresString()
```
    The date and time at which the object is no longer cacheable
    
    Returns:
    
    The date and time at which the object is no longer cacheable
  - ibmTransition
```
public final String ibmTransition()
```
    IBM-specific
    
    Returns:
    
    The IBM Transition ID (x-ibm-transition) header
  - ibmRestoredCopyStorageClass
```
public final String ibmRestoredCopyStorageClass()
```
    IBM-specific
    
    Returns:
    
    The IBM Restored Copy storage class header
  - retentionExpirationDate
```
public final Instant retentionExpirationDate()
```
    IBM-specific
    
    Returns:
    
    The IBM Retention Expiration Date header
  - retentionLegalHoldCount
```
public final Integer retentionLegalHoldCount()
```
    IBM-specific
    
    Returns:
    
    The IBM Retention Legal Hold Count header
  - retentionPeriod
```
public final Long retentionPeriod()
```
    IBM-specific
    
    Returns:
    
    The IBM Retention Period header
  - toBuilder
```
public HeadObjectResponse.Builder 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 interface ToCopyableBuilder<HeadObjectResponse.Builder,HeadObjectResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
    
    Returns:
    
    a builder for type T
  - builder
```
public static HeadObjectResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends HeadObjectResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    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 an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - toString
```
public final String 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Description copied from class: SdkResponse
    
    Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkResponse
    
    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
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo
    
    Returns:
    
    The mapping between the field name and its corresponding field.

Class HeadObjectResponse

Nested Class Summary

Method Summary

Methods inherited from class com.ibm.cos.v2.services.s3.model.S3Response

Methods inherited from class com.ibm.cos.v2.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface com.ibm.cos.v2.utils.builder.ToCopyableBuilder

Method Detail

deleteMarker

acceptRanges

expiration

restore

archiveStatus

archiveStatusAsString

lastModified

contentLength

checksumCRC32

checksumCRC32C

checksumCRC64NVME

checksumSHA1

checksumSHA256

checksumType

checksumTypeAsString

eTag

missingMeta

versionId

cacheControl

contentDisposition

contentEncoding

contentLanguage

contentType

contentRange

expires

websiteRedirectLocation

serverSideEncryption

serverSideEncryptionAsString

hasMetadata

metadata

sseCustomerAlgorithm

sseCustomerKeyMD5

ssekmsKeyId

bucketKeyEnabled

storageClass

storageClassAsString

requestCharged

requestChargedAsString

replicationStatus

replicationStatusAsString

partsCount

objectLockMode

objectLockModeAsString

objectLockRetainUntilDate

objectLockLegalHoldStatus

objectLockLegalHoldStatusAsString

expiresString

ibmTransition

ibmRestoredCopyStorageClass

retentionExpirationDate

retentionLegalHoldCount

retentionPeriod

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField