| Package | Description |
|---|---|
| com.ibm.cos.v2.services.s3 | |
| com.ibm.cos.v2.services.s3.model | |
| com.ibm.cos.v2.services.s3.presigner.model | |
| com.ibm.cos.v2.transfer.s3.model |
| Modifier and Type | Method and Description |
|---|---|
default ResponseInputStream<GetObjectResponse> |
S3Client.getObject(Consumer<GetObjectRequest.Builder> getObjectRequest)
Retrieves an object from Amazon S3.
|
default <ReturnT> CompletableFuture<ReturnT> |
S3AsyncClient.getObject(Consumer<GetObjectRequest.Builder> getObjectRequest,
AsyncResponseTransformer<GetObjectResponse,ReturnT> asyncResponseTransformer)
Retrieves an object from Amazon S3.
|
default GetObjectResponse |
S3Client.getObject(Consumer<GetObjectRequest.Builder> getObjectRequest,
Path destinationPath)
Retrieves an object from Amazon S3.
|
default CompletableFuture<GetObjectResponse> |
S3AsyncClient.getObject(Consumer<GetObjectRequest.Builder> getObjectRequest,
Path destinationPath)
Retrieves an object from Amazon S3.
|
default <ReturnT> ReturnT |
S3Client.getObject(Consumer<GetObjectRequest.Builder> getObjectRequest,
ResponseTransformer<GetObjectResponse,ReturnT> responseTransformer)
Retrieves an object from Amazon S3.
|
default ResponseBytes<GetObjectResponse> |
S3Client.getObjectAsBytes(Consumer<GetObjectRequest.Builder> getObjectRequest)
Retrieves an object from Amazon S3.
|
| Modifier and Type | Method and Description |
|---|---|
GetObjectRequest.Builder |
GetObjectRequest.Builder.bucket(String bucket)
The bucket name containing the object.
|
static GetObjectRequest.Builder |
GetObjectRequest.builder() |
GetObjectRequest.Builder |
GetObjectRequest.Builder.checksumMode(ChecksumMode checksumMode)
To retrieve the checksum, this mode must be enabled.
|
GetObjectRequest.Builder |
GetObjectRequest.Builder.checksumMode(String checksumMode)
To retrieve the checksum, this mode must be enabled.
|
GetObjectRequest.Builder |
GetObjectRequest.Builder.expectedBucketOwner(String expectedBucketOwner)
The account ID of the expected bucket owner.
|
GetObjectRequest.Builder |
GetObjectRequest.Builder.ifMatch(String ifMatch)
Return the object only if its entity tag (ETag) is the same as the one specified in this header; otherwise,
return a
412 Precondition Failed error. |
GetObjectRequest.Builder |
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. |
GetObjectRequest.Builder |
GetObjectRequest.Builder.ifNoneMatch(String ifNoneMatch)
Return the object only if its entity tag (ETag) is different from the one specified in this header;
otherwise, return a
304 Not Modified error. |
GetObjectRequest.Builder |
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. |
GetObjectRequest.Builder |
GetObjectRequest.Builder.key(String key)
Key of the object to get.
|
GetObjectRequest.Builder |
GetObjectRequest.Builder.overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
GetObjectRequest.Builder |
GetObjectRequest.Builder.overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
GetObjectRequest.Builder |
GetObjectRequest.Builder.partNumber(Integer partNumber)
Part number of the object being read.
|
GetObjectRequest.Builder |
GetObjectRequest.Builder.range(String range)
Downloads the specified byte range of an object.
|
GetObjectRequest.Builder |
GetObjectRequest.Builder.requestPayer(RequestPayer requestPayer)
Sets the value of the RequestPayer property for this object.
|
GetObjectRequest.Builder |
GetObjectRequest.Builder.requestPayer(String requestPayer)
Sets the value of the RequestPayer property for this object.
|
GetObjectRequest.Builder |
GetObjectRequest.Builder.responseCacheControl(String responseCacheControl)
Sets the
Cache-Control header of the response. |
GetObjectRequest.Builder |
GetObjectRequest.Builder.responseContentDisposition(String responseContentDisposition)
Sets the
Content-Disposition header of the response. |
GetObjectRequest.Builder |
GetObjectRequest.Builder.responseContentEncoding(String responseContentEncoding)
Sets the
Content-Encoding header of the response. |
GetObjectRequest.Builder |
GetObjectRequest.Builder.responseContentLanguage(String responseContentLanguage)
Sets the
Content-Language header of the response. |
GetObjectRequest.Builder |
GetObjectRequest.Builder.responseContentType(String responseContentType)
Sets the
Content-Type header of the response. |
GetObjectRequest.Builder |
GetObjectRequest.Builder.responseExpires(Instant responseExpires)
Sets the
Expires header of the response. |
GetObjectRequest.Builder |
GetObjectRequest.Builder.sseCustomerAlgorithm(String sseCustomerAlgorithm)
Specifies the algorithm to use when decrypting the object (for example,
AES256). |
GetObjectRequest.Builder |
GetObjectRequest.Builder.sseCustomerKey(String sseCustomerKey)
Specifies the customer-provided encryption key that you originally provided for Amazon S3 to encrypt the data
before storing it.
|
GetObjectRequest.Builder |
GetObjectRequest.Builder.sseCustomerKeyMD5(String sseCustomerKeyMD5)
Specifies the 128-bit MD5 digest of the customer-provided encryption key according to RFC 1321.
|
GetObjectRequest.Builder |
GetObjectRequest.toBuilder() |
GetObjectRequest.Builder |
GetObjectRequest.Builder.versionId(String versionId)
Version ID used to reference a specific version of the object.
|
| Modifier and Type | Method and Description |
|---|---|
static Class<? extends GetObjectRequest.Builder> |
GetObjectRequest.serializableBuilderClass() |
| Modifier and Type | Method and Description |
|---|---|
default GetObjectPresignRequest.Builder |
GetObjectPresignRequest.Builder.getObjectRequest(Consumer<GetObjectRequest.Builder> getObjectRequest)
Configure the
GetObjectRequest that should be presigned. |
| Modifier and Type | Method and Description |
|---|---|
default DownloadRequest.UntypedBuilder |
DownloadRequest.UntypedBuilder.getObjectRequest(Consumer<GetObjectRequest.Builder> getObjectRequestBuilder)
The
GetObjectRequest request that should be used for the download |
default DownloadRequest.TypedBuilder<T> |
DownloadRequest.TypedBuilder.getObjectRequest(Consumer<GetObjectRequest.Builder> getObjectRequestBuilder)
The
GetObjectRequest request that should be used for the download |
default DownloadFileRequest.Builder |
DownloadFileRequest.Builder.getObjectRequest(Consumer<GetObjectRequest.Builder> getObjectRequestBuilder)
The
GetObjectRequest request that should be used for the download |
Copyright © 2026. All rights reserved.