Package software.amazon.awssdk.services.s3.model

Class HeadObjectResponse

java.lang.Object

software.amazon.awssdk.AmazonWebServiceResult<ResponseMetadata>

software.amazon.awssdk.services.s3.model.HeadObjectResponse

All Implemented Interfaces:

ToCopyableBuilder<HeadObjectResponse.Builder,HeadObjectResponse>

@Generated("software.amazon.awssdk:codegen")
public class HeadObjectResponse
extends AmazonWebServiceResult<ResponseMetadata>
implements ToCopyableBuilder<HeadObjectResponse.Builder,HeadObjectResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HeadObjectResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	acceptRanges()
static HeadObjectResponse.Builder	builder()
String	cacheControl()	Specifies caching behavior along the request/reply chain.
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)
String	eTag()	An 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.
Date	expires()	The date and time at which the object is no longer cacheable.
int	hashCode()
Date	lastModified()	Last modified 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.
Integer	partsCount()	The count of parts this object has.
String	replicationStatus()
String	requestCharged()
String	restore()	Provides information about object restoration operation and expiration time of the restored object copy.
static Class<? extends HeadObjectResponse.Builder>	serializableBuilderClass()
String	serverSideEncryption()	The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
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 AWS Key Management Service (KMS) master encryption key that was used for the object.
String	storageClass()
HeadObjectResponse.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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.

Methods inherited from class software.amazon.awssdk.AmazonWebServiceResult

setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

deleteMarker

public 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.

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.

acceptRanges

public String acceptRanges()

Returns:

expiration

public 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.

Returns:

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.

restore

public String restore()

Provides information about object restoration operation and expiration time of the restored object copy.

Returns:

Provides information about object restoration operation and expiration time of the restored object copy.

lastModified

public Date lastModified()

Last modified date of the object

Returns:

Last modified date of the object

contentLength

public Long contentLength()

Size of the body in bytes.

Returns:

Size of the body in bytes.

eTag

public String eTag()

An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL

Returns:

An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL

missingMeta

public 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.

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.

versionId

public String versionId()

Version of the object.

Returns:

Version of the object.

cacheControl

public String cacheControl()

Specifies caching behavior along the request/reply chain.

Returns:

Specifies caching behavior along the request/reply chain.

contentDisposition

public String contentDisposition()

Specifies presentational information for the object.

Returns:

Specifies presentational information for the object.

contentEncoding

public 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.

Returns:

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.

contentLanguage

public String contentLanguage()

The language the content is in.

Returns:

The language the content is in.

contentType

public 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.

expires

public Date expires()

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 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.

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.

serverSideEncryption

public String serverSideEncryption()

The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

Returns:

The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

See Also:

ServerSideEncryption

metadata

public Map<String,String> metadata()

A map of metadata to store with the object in S3.

Returns:

A map of metadata to store with the object in S3.

sseCustomerAlgorithm

public 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.

Returns:

If server-side encryption with a customer-provided encryption key was requested, the response will include this header confirming the encryption algorithm used.

sseCustomerKeyMD5

public 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.

Returns:

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.

ssekmsKeyId

public String ssekmsKeyId()

If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.

Returns:

If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.

storageClass

public String storageClass()

Returns:

See Also:

StorageClass

requestCharged

public String requestCharged()

Returns:

See Also:

RequestCharged

replicationStatus

public String replicationStatus()

Returns:

See Also:

ReplicationStatus

partsCount

public Integer partsCount()

The count of parts this object has.

Returns:

The count of parts this object has.

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>

Returns:

a builder for type T

builder

public static HeadObjectResponse.Builder builder()

serializableBuilderClass

public static Class<? extends HeadObjectResponse.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object