public static interface GetObjectResponse.Builder extends S3Response.Builder, SdkPojo, CopyableBuilder<GetObjectResponse.Builder,GetObjectResponse>
Modifier and Type | Method and Description |
---|---|
GetObjectResponse.Builder |
acceptRanges(String acceptRanges)
Indicates that a range of bytes was specified.
|
GetObjectResponse.Builder |
bucketKeyEnabled(Boolean bucketKeyEnabled)
Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS
(SSE-KMS).
|
GetObjectResponse.Builder |
cacheControl(String cacheControl)
Specifies caching behavior along the request/reply chain.
|
GetObjectResponse.Builder |
checksumCRC32(String checksumCRC32)
The base64-encoded, 32-bit CRC32 checksum of the object.
|
GetObjectResponse.Builder |
checksumCRC32C(String checksumCRC32C)
The base64-encoded, 32-bit CRC32C checksum of the object.
|
GetObjectResponse.Builder |
checksumSHA1(String checksumSHA1)
The base64-encoded, 160-bit SHA-1 digest of the object.
|
GetObjectResponse.Builder |
checksumSHA256(String checksumSHA256)
The base64-encoded, 256-bit SHA-256 digest of the object.
|
GetObjectResponse.Builder |
contentDisposition(String contentDisposition)
Specifies presentational information for the object.
|
GetObjectResponse.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.
|
GetObjectResponse.Builder |
contentLanguage(String contentLanguage)
The language the content is in.
|
GetObjectResponse.Builder |
contentLength(Long contentLength)
Size of the body in bytes.
|
GetObjectResponse.Builder |
contentRange(String contentRange)
The portion of the object returned in the response.
|
GetObjectResponse.Builder |
contentType(String contentType)
A standard MIME type describing the format of the object data.
|
GetObjectResponse.Builder |
deleteMarker(Boolean deleteMarker)
Specifies whether the object retrieved was (true) or was not (false) a Delete Marker.
|
GetObjectResponse.Builder |
eTag(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.
|
GetObjectResponse.Builder |
expiration(String expiration)
If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header.
|
GetObjectResponse.Builder |
expires(Instant expires)
The date and time at which the object is no longer cacheable.
|
GetObjectResponse.Builder |
lastModified(Instant lastModified)
Creation date of the object.
|
GetObjectResponse.Builder |
metadata(Map<String,String> metadata)
A map of metadata to store with the object in S3.
|
GetObjectResponse.Builder |
missingMeta(Integer missingMeta)
This is set to the number of metadata entries not returned in
x-amz-meta headers. |
GetObjectResponse.Builder |
objectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus)
Indicates whether this object has an active legal hold.
|
GetObjectResponse.Builder |
objectLockLegalHoldStatus(String objectLockLegalHoldStatus)
Indicates whether this object has an active legal hold.
|
GetObjectResponse.Builder |
objectLockMode(ObjectLockMode objectLockMode)
The Object Lock mode currently in place for this object.
|
GetObjectResponse.Builder |
objectLockMode(String objectLockMode)
The Object Lock mode currently in place for this object.
|
GetObjectResponse.Builder |
objectLockRetainUntilDate(Instant objectLockRetainUntilDate)
The date and time when this object's Object Lock will expire.
|
GetObjectResponse.Builder |
partsCount(Integer partsCount)
The count of parts this object has.
|
GetObjectResponse.Builder |
replicationStatus(ReplicationStatus replicationStatus)
Amazon S3 can return this if your request involves a bucket that is either a source or destination in a
replication rule.
|
GetObjectResponse.Builder |
replicationStatus(String replicationStatus)
Amazon S3 can return this if your request involves a bucket that is either a source or destination in a
replication rule.
|
GetObjectResponse.Builder |
requestCharged(RequestCharged requestCharged)
Sets the value of the RequestCharged property for this object.
|
GetObjectResponse.Builder |
requestCharged(String requestCharged)
Sets the value of the RequestCharged property for this object.
|
GetObjectResponse.Builder |
restore(String restore)
Provides information about object restoration action and expiration time of the restored object copy.
|
GetObjectResponse.Builder |
serverSideEncryption(ServerSideEncryption serverSideEncryption)
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256,
aws:kms).
|
GetObjectResponse.Builder |
serverSideEncryption(String serverSideEncryption)
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256,
aws:kms).
|
GetObjectResponse.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.
|
GetObjectResponse.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.
|
GetObjectResponse.Builder |
ssekmsKeyId(String ssekmsKeyId)
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS)
symmetric customer managed key that was used for the object.
|
GetObjectResponse.Builder |
storageClass(StorageClass storageClass)
Provides storage class information of the object.
|
GetObjectResponse.Builder |
storageClass(String storageClass)
Provides storage class information of the object.
|
GetObjectResponse.Builder |
tagCount(Integer tagCount)
The number of tags, if any, on the object.
|
GetObjectResponse.Builder |
versionId(String versionId)
Version of the object.
|
GetObjectResponse.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
GetObjectResponse.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.GetObjectResponse.Builder acceptRanges(String acceptRanges)
Indicates that a range of bytes was specified.
acceptRanges
- Indicates that a range of bytes was specified.GetObjectResponse.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.GetObjectResponse.Builder restore(String restore)
Provides information about object restoration action and expiration time of the restored object copy.
restore
- Provides information about object restoration action and expiration time of the restored object copy.GetObjectResponse.Builder lastModified(Instant lastModified)
Creation date of the object.
lastModified
- Creation date of the object.GetObjectResponse.Builder contentLength(Long contentLength)
Size of the body in bytes.
contentLength
- Size of the body in bytes.GetObjectResponse.Builder eTag(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.
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.GetObjectResponse.Builder checksumCRC32(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.
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.GetObjectResponse.Builder checksumCRC32C(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.
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.GetObjectResponse.Builder checksumSHA1(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.
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.GetObjectResponse.Builder checksumSHA256(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.
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.GetObjectResponse.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.GetObjectResponse.Builder versionId(String versionId)
Version of the object.
versionId
- Version of the object.GetObjectResponse.Builder cacheControl(String cacheControl)
Specifies caching behavior along the request/reply chain.
cacheControl
- Specifies caching behavior along the request/reply chain.GetObjectResponse.Builder contentDisposition(String contentDisposition)
Specifies presentational information for the object.
contentDisposition
- Specifies presentational information for the object.GetObjectResponse.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.GetObjectResponse.Builder contentLanguage(String contentLanguage)
The language the content is in.
contentLanguage
- The language the content is in.GetObjectResponse.Builder contentRange(String contentRange)
The portion of the object returned in the response.
contentRange
- The portion of the object returned in the response.GetObjectResponse.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.GetObjectResponse.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.GetObjectResponse.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.GetObjectResponse.Builder serverSideEncryption(String serverSideEncryption)
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
serverSideEncryption
- The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256,
aws:kms).ServerSideEncryption
,
ServerSideEncryption
GetObjectResponse.Builder serverSideEncryption(ServerSideEncryption serverSideEncryption)
The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).
serverSideEncryption
- The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256,
aws:kms).ServerSideEncryption
,
ServerSideEncryption
GetObjectResponse.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.GetObjectResponse.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.GetObjectResponse.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.GetObjectResponse.Builder ssekmsKeyId(String ssekmsKeyId)
If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.
ssekmsKeyId
- If present, specifies the ID of the Amazon Web Services Key Management Service (Amazon Web Services
KMS) symmetric customer managed key that was used for the object.GetObjectResponse.Builder bucketKeyEnabled(Boolean bucketKeyEnabled)
Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services KMS (SSE-KMS).
bucketKeyEnabled
- Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services
KMS (SSE-KMS).GetObjectResponse.Builder storageClass(String storageClass)
Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
storageClass
- Provides storage class information of the object. Amazon S3 returns this header for all objects except
for S3 Standard storage class objects.StorageClass
,
StorageClass
GetObjectResponse.Builder storageClass(StorageClass storageClass)
Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
storageClass
- Provides storage class information of the object. Amazon S3 returns this header for all objects except
for S3 Standard storage class objects.StorageClass
,
StorageClass
GetObjectResponse.Builder requestCharged(String requestCharged)
requestCharged
- The new value for the RequestCharged property for this object.RequestCharged
,
RequestCharged
GetObjectResponse.Builder requestCharged(RequestCharged requestCharged)
requestCharged
- The new value for the RequestCharged property for this object.RequestCharged
,
RequestCharged
GetObjectResponse.Builder replicationStatus(String replicationStatus)
Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.
replicationStatus
- Amazon S3 can return this if your request involves a bucket that is either a source or destination in
a replication rule.ReplicationStatus
,
ReplicationStatus
GetObjectResponse.Builder replicationStatus(ReplicationStatus replicationStatus)
Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.
replicationStatus
- Amazon S3 can return this if your request involves a bucket that is either a source or destination in
a replication rule.ReplicationStatus
,
ReplicationStatus
GetObjectResponse.Builder partsCount(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.
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.GetObjectResponse.Builder tagCount(Integer tagCount)
The number of tags, if any, on the object.
tagCount
- The number of tags, if any, on the object.GetObjectResponse.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
GetObjectResponse.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
GetObjectResponse.Builder objectLockRetainUntilDate(Instant objectLockRetainUntilDate)
The date and time when this object's Object Lock will expire.
objectLockRetainUntilDate
- The date and time when this object's Object Lock will expire.GetObjectResponse.Builder objectLockLegalHoldStatus(String objectLockLegalHoldStatus)
Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an object's legal hold status.
objectLockLegalHoldStatus
- Indicates whether this object has an active legal hold. This field is only returned if you have
permission to view an object's legal hold status.ObjectLockLegalHoldStatus
,
ObjectLockLegalHoldStatus
GetObjectResponse.Builder objectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus)
Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an object's legal hold status.
objectLockLegalHoldStatus
- Indicates whether this object has an active legal hold. This field is only returned if you have
permission to view an object's legal hold status.ObjectLockLegalHoldStatus
,
ObjectLockLegalHoldStatus
Copyright © 2023. All rights reserved.