Interface GetObjectResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<GetObjectResponse.Builder,
,GetObjectResponse> S3Response.Builder
,SdkBuilder<GetObjectResponse.Builder,
,GetObjectResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
GetObjectResponse
-
Method Summary
Modifier and TypeMethodDescriptionacceptRanges
(String acceptRanges) Indicates that a range of bytes was specified in the request.bucketKeyEnabled
(Boolean bucketKeyEnabled) Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).cacheControl
(String cacheControl) Specifies caching behavior along the request/reply chain.checksumCRC32
(String checksumCRC32) The base64-encoded, 32-bit CRC32 checksum of the object.checksumCRC32C
(String checksumCRC32C) The base64-encoded, 32-bit CRC32C checksum of the object.checksumSHA1
(String checksumSHA1) The base64-encoded, 160-bit SHA-1 digest of the object.checksumSHA256
(String checksumSHA256) The base64-encoded, 256-bit SHA-256 digest of the object.contentDisposition
(String contentDisposition) Specifies presentational information for the object.contentEncoding
(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.contentLanguage
(String contentLanguage) The language the content is in.contentLength
(Long contentLength) Size of the body in bytes.contentRange
(String contentRange) The portion of the object returned in the response.contentType
(String contentType) A standard MIME type describing the format of the object data.deleteMarker
(Boolean deleteMarker) Indicates whether the object retrieved was (true) or was not (false) a Delete Marker.An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.expiration
(String expiration) If the object expiration is configured (seePutBucketLifecycleConfiguration
), the response includes this header.The date and time at which the object is no longer cacheable.lastModified
(Instant lastModified) Date and time when the object was last modified.A map of metadata to store with the object in S3.missingMeta
(Integer missingMeta) This is set to the number of metadata entries not returned in the headers that are prefixed withx-amz-meta-
.objectLockLegalHoldStatus
(String objectLockLegalHoldStatus) Indicates whether this object has an active legal hold.objectLockLegalHoldStatus
(ObjectLockLegalHoldStatus objectLockLegalHoldStatus) Indicates whether this object has an active legal hold.objectLockMode
(String objectLockMode) The Object Lock mode that's currently in place for this object.objectLockMode
(ObjectLockMode objectLockMode) The Object Lock mode that's currently in place for this object.objectLockRetainUntilDate
(Instant objectLockRetainUntilDate) The date and time when this object's Object Lock will expire.partsCount
(Integer partsCount) The count of parts this object has.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
(ReplicationStatus replicationStatus) Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.requestCharged
(String requestCharged) Sets the value of the RequestCharged property for this object.requestCharged
(RequestCharged requestCharged) Sets the value of the RequestCharged property for this object.Provides information about object restoration action and expiration time of the restored object copy.serverSideEncryption
(String serverSideEncryption) The server-side encryption algorithm used when you store this object in Amazon S3 (for example,AES256
,aws:kms
,aws:kms:dsse
).serverSideEncryption
(ServerSideEncryption serverSideEncryption) The server-side encryption algorithm used when you store this object in Amazon S3 (for example,AES256
,aws:kms
,aws:kms:dsse
).sseCustomerAlgorithm
(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.sseCustomerKeyMD5
(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.ssekmsKeyId
(String ssekmsKeyId) If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.storageClass
(String storageClass) Provides storage class information of the object.storageClass
(StorageClass storageClass) Provides storage class information of the object.The number of tags, if any, on the object, when you have the relevant permission to read object tags.Version ID of the object.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.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.s3.model.S3Response.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
Method Details
-
deleteMarker
Indicates whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.
-
If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes
x-amz-delete-marker: true
in the response. -
If the specified version in the request is a delete marker, the response returns a
405 Method Not Allowed
error and theLast-Modified: timestamp
response header.
- Parameters:
deleteMarker
- Indicates whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.-
If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes
x-amz-delete-marker: true
in the response. -
If the specified version in the request is a delete marker, the response returns a
405 Method Not Allowed
error and theLast-Modified: timestamp
response header.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
acceptRanges
Indicates that a range of bytes was specified in the request.
- Parameters:
acceptRanges
- Indicates that a range of bytes was specified in the request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
expiration
If the object expiration is configured (see
PutBucketLifecycleConfiguration
), the response includes this header. It includes theexpiry-date
andrule-id
key-value pairs providing object expiration information. The value of therule-id
is URL-encoded.This functionality is not supported for directory buckets.
- Parameters:
expiration
- If the object expiration is configured (seePutBucketLifecycleConfiguration
), the response includes this header. It includes theexpiry-date
andrule-id
key-value pairs providing object expiration information. The value of therule-id
is URL-encoded.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
restore
Provides information about object restoration action and expiration time of the restored object copy.
This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
- Parameters:
restore
- Provides information about object restoration action and expiration time of the restored object copy.This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
lastModified
Date and time when the object was last modified.
General purpose buckets - When you specify a
versionId
of the object in your request, if the specified version in the request is a delete marker, the response returns a405 Method Not Allowed
error and theLast-Modified: timestamp
response header.- Parameters:
lastModified
- Date and time when the object was last modified.General purpose buckets - When you specify a
versionId
of the object in your request, if the specified version in the request is a delete marker, the response returns a405 Method Not Allowed
error and theLast-Modified: timestamp
response header.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
contentLength
Size of the body in bytes.
- Parameters:
contentLength
- Size of the body in bytes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
checksumCRC32
The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
- Parameters:
checksumCRC32
- The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
checksumCRC32C
The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
- Parameters:
checksumCRC32C
- The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
checksumSHA1
The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
- Parameters:
checksumSHA1
- The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
checksumSHA256
The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.
- Parameters:
checksumSHA256
- The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
missingMeta
This is set to the number of metadata entries not returned in the headers that are prefixed with
x-amz-meta-
. 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.
- Parameters:
missingMeta
- This is set to the number of metadata entries not returned in the headers that are prefixed withx-amz-meta-
. 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:
- Returns a reference to this object so that method calls can be chained together.
-
versionId
Version ID of the object.
This functionality is not supported for directory buckets.
- Parameters:
versionId
- Version ID of the object.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
cacheControl
Specifies caching behavior along the request/reply chain.
- Parameters:
cacheControl
- Specifies caching behavior along the request/reply chain.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
contentDisposition
Specifies presentational information for the object.
- Parameters:
contentDisposition
- Specifies presentational information for the object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
contentLanguage
The language the content is in.
- Parameters:
contentLanguage
- The language the content is in.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
contentRange
The portion of the object returned in the response.
- Parameters:
contentRange
- The portion of the object returned in the response.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
contentType
A standard MIME type describing the format of the object data.
- Parameters:
contentType
- A standard MIME type describing the format of the object data.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
expires
The date and time at which the object is no longer cacheable.
- Parameters:
expires
- The date and time at which the object is no longer cacheable.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
serverSideEncryption
The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
AES256
,aws:kms
,aws:kms:dsse
).For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (
AES256
) is supported.- Parameters:
serverSideEncryption
- The server-side encryption algorithm used when you store this object in Amazon S3 (for example,AES256
,aws:kms
,aws:kms:dsse
).For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (
AES256
) is supported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
serverSideEncryption
The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
AES256
,aws:kms
,aws:kms:dsse
).For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (
AES256
) is supported.- Parameters:
serverSideEncryption
- The server-side encryption algorithm used when you store this object in Amazon S3 (for example,AES256
,aws:kms
,aws:kms:dsse
).For directory buckets, only server-side encryption with Amazon S3 managed keys (SSE-S3) (
AES256
) is supported.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
metadata
A map of metadata to store with the object in S3.
- Parameters:
metadata
- A map of metadata to store with the object in S3.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
ssekmsKeyId
If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.
This functionality is not supported for directory buckets.
- Parameters:
ssekmsKeyId
- If present, indicates the ID of the Key Management Service (KMS) symmetric encryption customer managed key that was used for the object.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
bucketKeyEnabled
Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
This functionality is not supported for directory buckets.
- Parameters:
bucketKeyEnabled
- Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
storageClass
Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
- Parameters:
storageClass
- Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
storageClass
Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
- Parameters:
storageClass
- Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.Directory buckets - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
requestCharged
Sets the value of the RequestCharged property for this object.- Parameters:
requestCharged
- The new value for the RequestCharged property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
requestCharged
Sets the value of the RequestCharged property for this object.- Parameters:
requestCharged
- The new value for the RequestCharged property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
replicationStatus
Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.
This functionality is not supported for directory buckets.
- Parameters:
replicationStatus
- Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
replicationStatus
Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.
This functionality is not supported for directory buckets.
- Parameters:
replicationStatus
- Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.- Parameters:
partsCount
- The count of parts this object has. This value is only returned if you specifypartNumber
in your request and the object was uploaded as a multipart upload.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagCount
The number of tags, if any, on the object, when you have the relevant permission to read object tags.
You can use GetObjectTagging to retrieve the tag set associated with an object.
This functionality is not supported for directory buckets.
- Parameters:
tagCount
- The number of tags, if any, on the object, when you have the relevant permission to read object tags.You can use GetObjectTagging to retrieve the tag set associated with an object.
This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
objectLockMode
The Object Lock mode that's currently in place for this object.
This functionality is not supported for directory buckets.
- Parameters:
objectLockMode
- The Object Lock mode that's currently in place for this object.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
objectLockMode
The Object Lock mode that's currently in place for this object.
This functionality is not supported for directory buckets.
- Parameters:
objectLockMode
- The Object Lock mode that's currently in place for this object.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
objectLockRetainUntilDate
The date and time when this object's Object Lock will expire.
This functionality is not supported for directory buckets.
- Parameters:
objectLockRetainUntilDate
- The date and time when this object's Object Lock will expire.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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.
This functionality is not supported for directory buckets.
- Parameters:
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.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
This functionality is not supported for directory buckets.
- Parameters:
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.This functionality is not supported for directory buckets.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-