public static interface HeadObjectResponse.Builder extends S3Response.Builder, SdkPojo, CopyableBuilder<HeadObjectResponse.Builder,HeadObjectResponse>
Modifier and Type | Method and Description |
---|---|
HeadObjectResponse.Builder |
acceptRanges(String acceptRanges)
|
HeadObjectResponse.Builder |
cacheControl(String cacheControl)
Specifies caching behavior along the request/reply chain.
|
HeadObjectResponse.Builder |
contentDisposition(String contentDisposition)
Specifies presentational information for the object.
|
HeadObjectResponse.Builder |
contentEncoding(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.
|
HeadObjectResponse.Builder |
contentLanguage(String contentLanguage)
The language the content is in.
|
HeadObjectResponse.Builder |
contentLength(Long contentLength)
Size of the body in bytes.
|
HeadObjectResponse.Builder |
contentType(String contentType)
A standard MIME type describing the format of the object data.
|
HeadObjectResponse.Builder |
deleteMarker(Boolean deleteMarker)
Specifies whether the object retrieved was (true) or was not (false) a Delete Marker.
|
HeadObjectResponse.Builder |
eTag(String eTag)
An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL
|
HeadObjectResponse.Builder |
expiration(String expiration)
If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header.
|
HeadObjectResponse.Builder |
expires(Instant expires)
The date and time at which the object is no longer cacheable.
|
HeadObjectResponse.Builder |
lastModified(Instant lastModified)
Last modified date of the object
|
HeadObjectResponse.Builder |
metadata(Map<String,String> metadata)
A map of metadata to store with the object in S3.
|
HeadObjectResponse.Builder |
missingMeta(Integer missingMeta)
This is set to the number of metadata entries not returned in x-amz-meta headers.
|
HeadObjectResponse.Builder |
objectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus)
The Legal Hold status for the specified object.
|
HeadObjectResponse.Builder |
objectLockLegalHoldStatus(String objectLockLegalHoldStatus)
The Legal Hold status for the specified object.
|
HeadObjectResponse.Builder |
objectLockMode(ObjectLockMode objectLockMode)
The object lock mode currently in place for this object.
|
HeadObjectResponse.Builder |
objectLockMode(String objectLockMode)
The object lock mode currently in place for this object.
|
HeadObjectResponse.Builder |
objectLockRetainUntilDate(Instant objectLockRetainUntilDate)
The date and time when this object's object lock expires.
|
HeadObjectResponse.Builder |
partsCount(Integer partsCount)
The count of parts this object has.
|
HeadObjectResponse.Builder |
replicationStatus(ReplicationStatus replicationStatus)
|
HeadObjectResponse.Builder |
replicationStatus(String replicationStatus)
|
HeadObjectResponse.Builder |
requestCharged(RequestCharged requestCharged)
Sets the value of the RequestCharged property for this object.
|
HeadObjectResponse.Builder |
requestCharged(String requestCharged)
Sets the value of the RequestCharged property for this object.
|
HeadObjectResponse.Builder |
restore(String restore)
Provides information about object restoration operation and expiration time of the restored object copy.
|
HeadObjectResponse.Builder |
serverSideEncryption(ServerSideEncryption serverSideEncryption)
The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
|
HeadObjectResponse.Builder |
serverSideEncryption(String serverSideEncryption)
The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
|
HeadObjectResponse.Builder |
sseCustomerAlgorithm(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.
|
HeadObjectResponse.Builder |
sseCustomerKeyMD5(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.
|
HeadObjectResponse.Builder |
ssekmsKeyId(String ssekmsKeyId)
If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for
the object.
|
HeadObjectResponse.Builder |
storageClass(StorageClass storageClass)
|
HeadObjectResponse.Builder |
storageClass(String storageClass)
|
HeadObjectResponse.Builder |
versionId(String versionId)
Version of the object.
|
HeadObjectResponse.Builder |
websiteRedirectLocation(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.
|
build, responseMetadata, responseMetadata
sdkHttpResponse, sdkHttpResponse
equalsBySdkFields, sdkFields
copy
applyMutation, build
HeadObjectResponse.Builder deleteMarker(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.
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.HeadObjectResponse.Builder acceptRanges(String acceptRanges)
acceptRanges
- HeadObjectResponse.Builder expiration(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.
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.HeadObjectResponse.Builder restore(String restore)
Provides information about object restoration operation and expiration time of the restored object copy.
restore
- Provides information about object restoration operation and expiration time of the restored object
copy.HeadObjectResponse.Builder lastModified(Instant lastModified)
Last modified date of the object
lastModified
- Last modified date of the objectHeadObjectResponse.Builder contentLength(Long contentLength)
Size of the body in bytes.
contentLength
- Size of the body in bytes.HeadObjectResponse.Builder eTag(String eTag)
An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at a URL
eTag
- An ETag is an opaque identifier assigned by a web server to a specific version of a resource found at
a URLHeadObjectResponse.Builder missingMeta(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.
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.HeadObjectResponse.Builder versionId(String versionId)
Version of the object.
versionId
- Version of the object.HeadObjectResponse.Builder cacheControl(String cacheControl)
Specifies caching behavior along the request/reply chain.
cacheControl
- Specifies caching behavior along the request/reply chain.HeadObjectResponse.Builder contentDisposition(String contentDisposition)
Specifies presentational information for the object.
contentDisposition
- Specifies presentational information for the object.HeadObjectResponse.Builder contentEncoding(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.
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.HeadObjectResponse.Builder contentLanguage(String contentLanguage)
The language the content is in.
contentLanguage
- The language the content is in.HeadObjectResponse.Builder contentType(String contentType)
A standard MIME type describing the format of the object data.
contentType
- A standard MIME type describing the format of the object data.HeadObjectResponse.Builder expires(Instant expires)
The date and time at which the object is no longer cacheable.
expires
- The date and time at which the object is no longer cacheable.HeadObjectResponse.Builder websiteRedirectLocation(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.
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.HeadObjectResponse.Builder serverSideEncryption(String serverSideEncryption)
The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
serverSideEncryption
- The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).ServerSideEncryption
,
ServerSideEncryption
HeadObjectResponse.Builder serverSideEncryption(ServerSideEncryption serverSideEncryption)
The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).
serverSideEncryption
- The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).ServerSideEncryption
,
ServerSideEncryption
HeadObjectResponse.Builder metadata(Map<String,String> metadata)
A map of metadata to store with the object in S3.
metadata
- A map of metadata to store with the object in S3.HeadObjectResponse.Builder sseCustomerAlgorithm(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.
sseCustomerAlgorithm
- If server-side encryption with a customer-provided encryption key was requested, the response will
include this header confirming the encryption algorithm used.HeadObjectResponse.Builder sseCustomerKeyMD5(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.
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.HeadObjectResponse.Builder ssekmsKeyId(String ssekmsKeyId)
If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was used for the object.
ssekmsKeyId
- If present, specifies the ID of the AWS Key Management Service (KMS) master encryption key that was
used for the object.HeadObjectResponse.Builder storageClass(String storageClass)
storageClass
- StorageClass
,
StorageClass
HeadObjectResponse.Builder storageClass(StorageClass storageClass)
storageClass
- StorageClass
,
StorageClass
HeadObjectResponse.Builder requestCharged(String requestCharged)
requestCharged
- The new value for the RequestCharged property for this object.RequestCharged
,
RequestCharged
HeadObjectResponse.Builder requestCharged(RequestCharged requestCharged)
requestCharged
- The new value for the RequestCharged property for this object.RequestCharged
,
RequestCharged
HeadObjectResponse.Builder replicationStatus(String replicationStatus)
replicationStatus
- ReplicationStatus
,
ReplicationStatus
HeadObjectResponse.Builder replicationStatus(ReplicationStatus replicationStatus)
replicationStatus
- ReplicationStatus
,
ReplicationStatus
HeadObjectResponse.Builder partsCount(Integer partsCount)
The count of parts this object has.
partsCount
- The count of parts this object has.HeadObjectResponse.Builder objectLockMode(String objectLockMode)
The object lock mode currently in place for this object.
objectLockMode
- The object lock mode currently in place for this object.ObjectLockMode
,
ObjectLockMode
HeadObjectResponse.Builder objectLockMode(ObjectLockMode objectLockMode)
The object lock mode currently in place for this object.
objectLockMode
- The object lock mode currently in place for this object.ObjectLockMode
,
ObjectLockMode
HeadObjectResponse.Builder objectLockRetainUntilDate(Instant objectLockRetainUntilDate)
The date and time when this object's object lock expires.
objectLockRetainUntilDate
- The date and time when this object's object lock expires.HeadObjectResponse.Builder objectLockLegalHoldStatus(String objectLockLegalHoldStatus)
The Legal Hold status for the specified object.
objectLockLegalHoldStatus
- The Legal Hold status for the specified object.ObjectLockLegalHoldStatus
,
ObjectLockLegalHoldStatus
HeadObjectResponse.Builder objectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus)
The Legal Hold status for the specified object.
objectLockLegalHoldStatus
- The Legal Hold status for the specified object.ObjectLockLegalHoldStatus
,
ObjectLockLegalHoldStatus
Copyright © 2019. All rights reserved.