software.amazon.awssdk.services.s3.model

Interface GetObjectRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<GetObjectRequest.Builder,GetObjectRequest>, S3Request.Builder, SdkBuilder<GetObjectRequest.Builder,GetObjectRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

GetObjectRequest

public static interface GetObjectRequest.Builder
extends S3Request.Builder, SdkPojo, CopyableBuilder<GetObjectRequest.Builder,GetObjectRequest>

Method Summary

Modifier and Type	Method and Description
GetObjectRequest.Builder	bucket(String bucket) The bucket name containing the object.
GetObjectRequest.Builder	ifMatch(String ifMatch) Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).
GetObjectRequest.Builder	ifModifiedSince(Instant ifModifiedSince) Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).
GetObjectRequest.Builder	ifNoneMatch(String ifNoneMatch) Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).
GetObjectRequest.Builder	ifUnmodifiedSince(Instant ifUnmodifiedSince) Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).
GetObjectRequest.Builder	key(String key) Key of the object to get.
GetObjectRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
GetObjectRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
GetObjectRequest.Builder	partNumber(Integer partNumber) Part number of the object being read.
GetObjectRequest.Builder	range(String range) Downloads the specified range bytes of an object.
GetObjectRequest.Builder	requestPayer(RequestPayer requestPayer) Sets the value of the RequestPayer property for this object.
GetObjectRequest.Builder	requestPayer(String requestPayer) Sets the value of the RequestPayer property for this object.
GetObjectRequest.Builder	responseCacheControl(String responseCacheControl) Sets the Cache-Control header of the response.
GetObjectRequest.Builder	responseContentDisposition(String responseContentDisposition) Sets the Content-Disposition header of the response
GetObjectRequest.Builder	responseContentEncoding(String responseContentEncoding) Sets the Content-Encoding header of the response.
GetObjectRequest.Builder	responseContentLanguage(String responseContentLanguage) Sets the Content-Language header of the response.
GetObjectRequest.Builder	responseContentType(String responseContentType) Sets the Content-Type header of the response.
GetObjectRequest.Builder	responseExpires(Instant responseExpires) Sets the Expires header of the response.
GetObjectRequest.Builder	sseCustomerAlgorithm(String sseCustomerAlgorithm) Specifies the algorithm to use to when encrypting the object (for example, AES256).
GetObjectRequest.Builder	sseCustomerKey(String sseCustomerKey) Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data.
GetObjectRequest.Builder	sseCustomerKeyMD5(String sseCustomerKeyMD5) Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
GetObjectRequest.Builder	versionId(String versionId) VersionId used to reference a specific version of the object.

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

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

bucket

GetObjectRequest.Builder bucket(String bucket)

The bucket name containing the object.

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

Parameters:

bucket - The bucket name containing the object.

When using this API with an access point, you must direct requests to the access point hostname. The access point hostname takes the form AccessPointName-AccountId.s3-accesspoint.Region.amazonaws.com. When using this operation using an access point through the AWS SDKs, you provide the access point ARN in place of the bucket name. For more information about access point ARNs, see Using Access Points in the Amazon Simple Storage Service Developer Guide.

Returns:

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

ifMatch

GetObjectRequest.Builder ifMatch(String ifMatch)

Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).

Parameters:

ifMatch - Return the object only if its entity tag (ETag) is the same as the one specified, otherwise return a 412 (precondition failed).

Returns:

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

ifModifiedSince

GetObjectRequest.Builder ifModifiedSince(Instant ifModifiedSince)

Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

Parameters:

ifModifiedSince - Return the object only if it has been modified since the specified time, otherwise return a 304 (not modified).

Returns:

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

ifNoneMatch

GetObjectRequest.Builder ifNoneMatch(String ifNoneMatch)

Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).

Parameters:

ifNoneMatch - Return the object only if its entity tag (ETag) is different from the one specified, otherwise return a 304 (not modified).

Returns:

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

ifUnmodifiedSince

GetObjectRequest.Builder ifUnmodifiedSince(Instant ifUnmodifiedSince)

Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).

Parameters:

ifUnmodifiedSince - Return the object only if it has not been modified since the specified time, otherwise return a 412 (precondition failed).

Returns:

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

key

GetObjectRequest.Builder key(String key)

Key of the object to get.

Parameters:

key - Key of the object to get.

Returns:

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

range

GetObjectRequest.Builder range(String range)

Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://www.w3.org/Protocols/rfc2616/ rfc2616-sec14.html#sec14.35.

Amazon S3 doesn't support retrieving multiple ranges of data per GET request.

Parameters:

range - Downloads the specified range bytes of an object. For more information about the HTTP Range header, see https://www.w3.org/Protocols /rfc2616/rfc2616-sec14.html#sec14.35.

Amazon S3 doesn't support retrieving multiple ranges of data per GET request.

Returns:

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

responseCacheControl

GetObjectRequest.Builder responseCacheControl(String responseCacheControl)

Sets the Cache-Control header of the response.

Parameters:

responseCacheControl - Sets the Cache-Control header of the response.

Returns:

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

responseContentDisposition

GetObjectRequest.Builder responseContentDisposition(String responseContentDisposition)

Sets the Content-Disposition header of the response

Parameters:

responseContentDisposition - Sets the Content-Disposition header of the response

Returns:

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

responseContentEncoding

GetObjectRequest.Builder responseContentEncoding(String responseContentEncoding)

Sets the Content-Encoding header of the response.

Parameters:

responseContentEncoding - Sets the Content-Encoding header of the response.

Returns:

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

responseContentLanguage

GetObjectRequest.Builder responseContentLanguage(String responseContentLanguage)

Sets the Content-Language header of the response.

Parameters:

responseContentLanguage - Sets the Content-Language header of the response.

Returns:

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

responseContentType

GetObjectRequest.Builder responseContentType(String responseContentType)

Sets the Content-Type header of the response.

Parameters:

responseContentType - Sets the Content-Type header of the response.

Returns:

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

responseExpires

GetObjectRequest.Builder responseExpires(Instant responseExpires)

Sets the Expires header of the response.

Parameters:

responseExpires - Sets the Expires header of the response.

Returns:

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

versionId

GetObjectRequest.Builder versionId(String versionId)

VersionId used to reference a specific version of the object.

Parameters:

versionId - VersionId used to reference a specific version of the object.

Returns:

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

sseCustomerAlgorithm

GetObjectRequest.Builder sseCustomerAlgorithm(String sseCustomerAlgorithm)

Specifies the algorithm to use to when encrypting the object (for example, AES256).

Parameters:

sseCustomerAlgorithm - Specifies the algorithm to use to when encrypting the object (for example, AES256).

Returns:

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

sseCustomerKey

GetObjectRequest.Builder sseCustomerKey(String sseCustomerKey)

Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

Parameters:

sseCustomerKey - Specifies the customer-provided encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then it is discarded; Amazon S3 does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.

Returns:

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

sseCustomerKeyMD5

GetObjectRequest.Builder sseCustomerKeyMD5(String sseCustomerKeyMD5)

Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

Parameters:

sseCustomerKeyMD5 - Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321. Amazon S3 uses this header for a message integrity check to ensure that the encryption key was transmitted without error.

Returns:

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

requestPayer

GetObjectRequest.Builder requestPayer(String requestPayer)

Sets the value of the RequestPayer property for this object.

Parameters:

requestPayer - The new value for the RequestPayer property for this object.

Returns:

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

See Also:

RequestPayer, RequestPayer

requestPayer

GetObjectRequest.Builder requestPayer(RequestPayer requestPayer)

Sets the value of the RequestPayer property for this object.

Parameters:

requestPayer - The new value for the RequestPayer property for this object.

Returns:

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

See Also:

RequestPayer, RequestPayer

partNumber

GetObjectRequest.Builder partNumber(Integer partNumber)

Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.

Parameters:

partNumber - Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' GET request for the part specified. Useful for downloading just a part of an object.

Returns:

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

overrideConfiguration

GetObjectRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

GetObjectRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder