software.amazon.awssdk.services.s3.model

Interface GetObjectResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetObjectResponse.Builder,GetObjectResponse>, S3Response.Builder, SdkBuilder<GetObjectResponse.Builder,GetObjectResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetObjectResponse

public static interface GetObjectResponse.Builder
extends S3Response.Builder, SdkPojo, CopyableBuilder<GetObjectResponse.Builder,GetObjectResponse>

Method Summary

Modifier and Type	Method and Description
GetObjectResponse.Builder	acceptRanges(String acceptRanges) Indicates that a range of bytes was specified.
GetObjectResponse.Builder	cacheControl(String cacheControl) Specifies caching behavior along the request/reply chain.
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 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) Last modified 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 operation 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 AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) 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.

Methods inherited from interface software.amazon.awssdk.services.s3.model.S3Response.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

deleteMarker

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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

acceptRanges

GetObjectResponse.Builder acceptRanges(String acceptRanges)

Indicates that a range of bytes was specified.

Parameters:

acceptRanges - Indicates that a range of bytes was specified.

Returns:

Returns a reference to this object so that method calls can be chained together.

expiration

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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

restore

GetObjectResponse.Builder restore(String restore)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

lastModified

GetObjectResponse.Builder lastModified(Instant lastModified)

Last modified date of the object

Parameters:

lastModified - Last modified date of the object

Returns:

Returns a reference to this object so that method calls can be chained together.

contentLength

GetObjectResponse.Builder contentLength(Long 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

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

Parameters:

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

missingMeta

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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

versionId

GetObjectResponse.Builder versionId(String versionId)

Version of the object.

Parameters:

versionId - Version of the object.

Returns:

Returns a reference to this object so that method calls can be chained together.

cacheControl

GetObjectResponse.Builder cacheControl(String 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

GetObjectResponse.Builder contentDisposition(String 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

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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

contentLanguage

GetObjectResponse.Builder contentLanguage(String 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

GetObjectResponse.Builder contentRange(String 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

GetObjectResponse.Builder contentType(String 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

GetObjectResponse.Builder expires(Instant 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

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.

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

serverSideEncryption

GetObjectResponse.Builder serverSideEncryption(String serverSideEncryption)

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

Parameters:

serverSideEncryption - The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServerSideEncryption, 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).

Parameters:

serverSideEncryption - The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ServerSideEncryption, ServerSideEncryption

metadata

GetObjectResponse.Builder metadata(Map<String,String> 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

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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

sseCustomerKeyMD5

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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

ssekmsKeyId

GetObjectResponse.Builder ssekmsKeyId(String ssekmsKeyId)

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

Parameters:

ssekmsKeyId - If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.

Returns:

Returns a reference to this object so that method calls can be chained together.

storageClass

GetObjectResponse.Builder storageClass(String storageClass)

Provides storage class information of the object. Amazon S3 returns this header for all objects except for Standard storage class objects.

Parameters:

storageClass - Provides storage class information of the object. Amazon S3 returns this header for all objects except for Standard storage class objects.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StorageClass, StorageClass

storageClass

GetObjectResponse.Builder storageClass(StorageClass storageClass)

Provides storage class information of the object. Amazon S3 returns this header for all objects except for Standard storage class objects.

Parameters:

storageClass - Provides storage class information of the object. Amazon S3 returns this header for all objects except for Standard storage class objects.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

StorageClass, StorageClass

requestCharged

GetObjectResponse.Builder requestCharged(String 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, RequestCharged

requestCharged

GetObjectResponse.Builder requestCharged(RequestCharged 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, RequestCharged

replicationStatus

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.

Parameters:

replicationStatus - Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

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

Parameters:

replicationStatus - Amazon S3 can return this if your request involves a bucket that is either a source or destination in a replication rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ReplicationStatus, ReplicationStatus

partsCount

GetObjectResponse.Builder partsCount(Integer partsCount)

The count of parts this object has.

Parameters:

partsCount - The count of parts this object has.

Returns:

Returns a reference to this object so that method calls can be chained together.

tagCount

GetObjectResponse.Builder tagCount(Integer tagCount)

The number of tags, if any, on the object.

Parameters:

tagCount - The number of tags, if any, on the object.

Returns:

Returns a reference to this object so that method calls can be chained together.

objectLockMode

GetObjectResponse.Builder objectLockMode(String objectLockMode)

The Object Lock mode currently in place for this object.

Parameters:

objectLockMode - The Object Lock mode currently in place for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ObjectLockMode, ObjectLockMode

objectLockMode

GetObjectResponse.Builder objectLockMode(ObjectLockMode objectLockMode)

The Object Lock mode currently in place for this object.

Parameters:

objectLockMode - The Object Lock mode currently in place for this object.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ObjectLockMode, ObjectLockMode

objectLockRetainUntilDate

GetObjectResponse.Builder objectLockRetainUntilDate(Instant objectLockRetainUntilDate)

The date and time when this object's Object Lock will expire.

Parameters:

objectLockRetainUntilDate - The date and time when this object's Object Lock will expire.

Returns:

Returns a reference to this object so that method calls can be chained together.

objectLockLegalHoldStatus

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.

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

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

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ObjectLockLegalHoldStatus, ObjectLockLegalHoldStatus