GetObjectRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.s3.model.S3Request
    - - software.amazon.awssdk.services.s3.model.GetObjectRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetObjectRequest.Builder,GetObjectRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetObjectRequest
extends S3Request
implements ToCopyableBuilder<GetObjectRequest.Builder,GetObjectRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetObjectRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetObjectRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`bucket()` The bucket name containing the object.
`static GetObjectRequest.Builder`	`builder()`
`ChecksumMode`	`checksumMode()` To retrieve the checksum, this mode must be enabled.
`String`	`checksumModeAsString()` To retrieve the checksum, this mode must be enabled.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`expectedBucketOwner()` The account ID of the expected bucket owner.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`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.
`Instant`	`ifModifiedSince()` Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.
`String`	`ifNoneMatch()` Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.
`Instant`	`ifUnmodifiedSince()` Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.
`String`	`key()` Key of the object to get.
`Integer`	`partNumber()` Part number of the object being read.
`String`	`range()` Downloads the specified range bytes of an object.
`RequestPayer`	`requestPayer()` Returns the value of the RequestPayer property for this object.
`String`	`requestPayerAsString()` Returns the value of the RequestPayer property for this object.
`String`	`responseCacheControl()` Sets the `Cache-Control` header of the response.
`String`	`responseContentDisposition()` Sets the `Content-Disposition` header of the response
`String`	`responseContentEncoding()` Sets the `Content-Encoding` header of the response.
`String`	`responseContentLanguage()` Sets the `Content-Language` header of the response.
`String`	`responseContentType()` Sets the `Content-Type` header of the response.
`Instant`	`responseExpires()` Sets the `Expires` header of the response.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetObjectRequest.Builder>`	`serializableBuilderClass()`
`String`	`sseCustomerAlgorithm()` Specifies the algorithm to use to when decrypting the object (for example, AES256).
`String`	`sseCustomerKey()` Specifies the customer-provided encryption key for Amazon S3 used to encrypt the data.
`String`	`sseCustomerKeyMD5()` Specifies the 128-bit MD5 digest of the encryption key according to RFC 1321.
`GetObjectRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`versionId()` VersionId used to reference a specific version of the object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - bucket
```
public final 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.
    
    Returns:
    
    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.
  - ifMatch
```
public final 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.
    
    Returns:
    
    Return the object only if its entity tag (ETag) is the same as the one specified; otherwise, return a 412 (precondition failed) error.
  - ifModifiedSince
```
public final Instant ifModifiedSince()
```
    Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.
    
    Returns:
    
    Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.
  - ifNoneMatch
```
public final String ifNoneMatch()
```
    Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.
    
    Returns:
    
    Return the object only if its entity tag (ETag) is different from the one specified; otherwise, return a 304 (not modified) error.
  - ifUnmodifiedSince
```
public final Instant ifUnmodifiedSince()
```
    Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.
    
    Returns:
    
    Return the object only if it has not been modified since the specified time; otherwise, return a 412 (precondition failed) error.
  - key
```
public final String key()
```
    Key of the object to get.
    
    Returns:
    
    Key of the object to get.
  - range
```
public final 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.
    
    Returns:
    
    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.
  - responseCacheControl
```
public final String responseCacheControl()
```
    Sets the Cache-Control header of the response.
    
    Returns:
    
    Sets the Cache-Control header of the response.
  - responseContentDisposition
```
public final String responseContentDisposition()
```
    Sets the Content-Disposition header of the response
    
    Returns:
    
    Sets the Content-Disposition header of the response
  - responseContentEncoding
```
public final String responseContentEncoding()
```
    Sets the Content-Encoding header of the response.
    
    Returns:
    
    Sets the Content-Encoding header of the response.
  - responseContentLanguage
```
public final String responseContentLanguage()
```
    Sets the Content-Language header of the response.
    
    Returns:
    
    Sets the Content-Language header of the response.
  - responseContentType
```
public final String responseContentType()
```
    Sets the Content-Type header of the response.
    
    Returns:
    
    Sets the Content-Type header of the response.
  - responseExpires
```
public final Instant responseExpires()
```
    Sets the Expires header of the response.
    
    Returns:
    
    Sets the Expires header of the response.
  - versionId
```
public final String versionId()
```
    VersionId used to reference a specific version of the object.
    
    Returns:
    
    VersionId used to reference a specific version of the object.
  - sseCustomerAlgorithm
```
public final String sseCustomerAlgorithm()
```
    Specifies the algorithm to use to when decrypting the object (for example, AES256).
    
    Returns:
    
    Specifies the algorithm to use to when decrypting the object (for example, AES256).
  - sseCustomerKey
```
public final 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.
    
    Returns:
    
    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.
  - sseCustomerKeyMD5
```
public final 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.
    
    Returns:
    
    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.
  - requestPayer
```
public final RequestPayer requestPayer()
```
    Returns the value of the RequestPayer property for this object.
    If the service returns an enum value that is not available in the current SDK version, requestPayer will return RequestPayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestPayerAsString().
    
    Returns:
    
    The value of the RequestPayer property for this object.
    
    See Also:
    
    RequestPayer
  - requestPayerAsString
```
public final String requestPayerAsString()
```
    Returns the value of the RequestPayer property for this object.
    If the service returns an enum value that is not available in the current SDK version, requestPayer will return RequestPayer.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from requestPayerAsString().
    
    Returns:
    
    The value of the RequestPayer property for this object.
    
    See Also:
    
    RequestPayer
  - partNumber
```
public final 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.
    
    Returns:
    
    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.
  - expectedBucketOwner
```
public final 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).
    
    Returns:
    
    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).
  - checksumMode
```
public final ChecksumMode checksumMode()
```
    To retrieve the checksum, this mode must be enabled.
    
    If the service returns an enum value that is not available in the current SDK version, checksumMode will return ChecksumMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumModeAsString().
    
    Returns:
    
    To retrieve the checksum, this mode must be enabled.
    
    See Also:
    
    ChecksumMode
  - checksumModeAsString
```
public final String checksumModeAsString()
```
    To retrieve the checksum, this mode must be enabled.
    
    If the service returns an enum value that is not available in the current SDK version, checksumMode will return ChecksumMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from checksumModeAsString().
    
    Returns:
    
    To retrieve the checksum, this mode must be enabled.
    
    See Also:
    
    ChecksumMode
  - toBuilder
```
public GetObjectRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetObjectRequest.Builder,GetObjectRequest>
    
    Specified by:
    
    toBuilder in class S3Request
  - builder
```
public static GetObjectRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetObjectRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class GetObjectRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

bucket

ifMatch

ifModifiedSince

ifNoneMatch

ifUnmodifiedSince

key

range

responseCacheControl

responseContentDisposition

responseContentEncoding

responseContentLanguage

responseContentType

responseExpires

versionId

sseCustomerAlgorithm

sseCustomerKey

sseCustomerKeyMD5

requestPayer

requestPayerAsString

partNumber

expectedBucketOwner

checksumMode

checksumModeAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields