Package 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 Details

    • bucket

      GetObjectRequest.Builder bucket(String bucket)

      The bucket name containing the object.

      When using this action 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

      When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.

      When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User Guide.

      Parameters:
      bucket - The bucket name containing the object.

      When using this action 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 action with an access point through the Amazon Web Services 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 S3 User Guide.

      When using an Object Lambda access point the hostname takes the form AccessPointName-AccountId.s3-object-lambda.Region.amazonaws.com.

      When you use this action with Amazon S3 on Outposts, you must direct requests to the S3 on Outposts hostname. The S3 on Outposts hostname takes the form AccessPointName-AccountId.outpostID.s3-outposts.Region.amazonaws.com . When you use this action with S3 on Outposts through the Amazon Web Services SDKs, you provide the Outposts access point ARN in place of the bucket name. For more information about S3 on Outposts ARNs, see What is S3 on Outposts? in the Amazon S3 User 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) error.

      Parameters:
      ifMatch - Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.
      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) error.

      Parameters:
      ifModifiedSince - Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.
      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) error.

      Parameters:
      ifNoneMatch - Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.
      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) error.

      Parameters:
      ifUnmodifiedSince - Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.
      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.rfc-editor.org/rfc/rfc9110.html#name -range.

      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.rfc-editor.org/rfc/rfc9110 .html#name-range.

      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 decrypting the object (for example, AES256).

      Parameters:
      sseCustomerAlgorithm - Specifies the algorithm to use to when decrypting 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 used to encrypt the data. This value is used to decrypt the object when recovering it and must match the one used when storing the data. 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 used to encrypt the data. This value is used to decrypt the object when recovering it and must match the one used when storing the data. 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

      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:

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

    • expectedBucketOwner

      GetObjectRequest.Builder expectedBucketOwner(String expectedBucketOwner)

      The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).

      Parameters:
      expectedBucketOwner - The account ID of the expected bucket owner. If the bucket is owned by a different account, the request fails with the HTTP status code 403 Forbidden (access denied).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • checksumMode

      GetObjectRequest.Builder checksumMode(String checksumMode)

      To retrieve the checksum, this mode must be enabled.

      Parameters:
      checksumMode - To retrieve the checksum, this mode must be enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • checksumMode

      GetObjectRequest.Builder checksumMode(ChecksumMode checksumMode)

      To retrieve the checksum, this mode must be enabled.

      Parameters:
      checksumMode - To retrieve the checksum, this mode must be enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      GetObjectRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetObjectRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.