@Generated(value="software.amazon.awssdk:codegen") public final class GetObjectRequest extends S3Request implements ToCopyableBuilder<GetObjectRequest.Builder,GetObjectRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
GetObjectRequest.Builder |
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.
|
overrideConfiguration
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
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.
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.
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.
public final Instant ifModifiedSince()
Return the object only if it has been modified since the specified time; otherwise, return a 304 (not modified) error.
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.
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.
public final String key()
Key of the object to get.
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.
Amazon S3 doesn't support retrieving multiple ranges of data per GET
request.
public final String responseCacheControl()
Sets the Cache-Control
header of the response.
Cache-Control
header of the response.public final String responseContentDisposition()
Sets the Content-Disposition
header of the response
Content-Disposition
header of the responsepublic final String responseContentEncoding()
Sets the Content-Encoding
header of the response.
Content-Encoding
header of the response.public final String responseContentLanguage()
Sets the Content-Language
header of the response.
Content-Language
header of the response.public final String responseContentType()
Sets the Content-Type
header of the response.
Content-Type
header of the response.public final Instant responseExpires()
Sets the Expires
header of the response.
Expires
header of the response.public final String versionId()
VersionId used to reference a specific version of the object.
public final String sseCustomerAlgorithm()
Specifies the algorithm to use to when decrypting the object (for example, AES256).
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.
x-amz-server-side-encryption-customer-algorithm
header.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.
public final RequestPayer requestPayer()
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()
.
RequestPayer
public final String requestPayerAsString()
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()
.
RequestPayer
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.
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).
403 Forbidden
(access denied).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()
.
ChecksumMode
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()
.
ChecksumMode
public GetObjectRequest.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<GetObjectRequest.Builder,GetObjectRequest>
toBuilder
in class S3Request
public static GetObjectRequest.Builder builder()
public static Class<? extends GetObjectRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField
in class SdkRequest
Copyright © 2023. All rights reserved.