Package | Description |
---|---|
com.ibm.cloud.objectstorage.services.s3 |
Synchronous client for accessing Amazon S3.
|
com.ibm.cloud.objectstorage.services.s3.internal | |
com.ibm.cloud.objectstorage.services.s3.internal.crypto.v1 | |
com.ibm.cloud.objectstorage.services.s3.model |
Classes modeling the various types represented by Amazon S3.
|
com.ibm.cloud.objectstorage.services.s3.transfer |
Transfer management.
|
com.ibm.cloud.objectstorage.services.s3.transfer.internal |
Modifier and Type | Method and Description |
---|---|
S3Object |
AmazonS3Client.getObject(GetObjectRequest getObjectRequest) |
S3Object |
AbstractAmazonS3.getObject(GetObjectRequest getObjectRequest) |
S3Object |
AmazonS3.getObject(GetObjectRequest getObjectRequest)
Retrieves objects from Amazon S3.
|
ObjectMetadata |
AmazonS3Client.getObject(GetObjectRequest getObjectRequest,
File destinationFile) |
ObjectMetadata |
AbstractAmazonS3.getObject(GetObjectRequest getObjectRequest,
File destinationFile) |
ObjectMetadata |
AmazonS3.getObject(GetObjectRequest getObjectRequest,
File destinationFile)
Retrieves objects from Amazon S3.
|
Modifier and Type | Method and Description |
---|---|
static GetObjectMetadataRequest |
RequestCopyUtils.createGetObjectMetadataRequestFrom(GetObjectRequest getObjectRequest)
Creates a #GetObjectMetadataRequest by copying values for common members
from the input #GetObjectRequest.
|
static long |
ServiceUtils.getLastByteInPart(AmazonS3 s3,
GetObjectRequest getObjectRequest,
Integer partNumber)
Returns the last byte number in a part of an object.
|
abstract S3Object |
S3Direct.getObject(GetObjectRequest req) |
S3Object |
S3DirectSpi.getObject(GetObjectRequest req) |
abstract ObjectMetadata |
S3Direct.getObject(GetObjectRequest req,
File dest) |
ObjectMetadata |
S3DirectSpi.getObject(GetObjectRequest req,
File dest) |
static Integer |
ServiceUtils.getPartCount(GetObjectRequest getObjectRequest,
AmazonS3 s3)
Returns the part count of the object represented by the getObjectRequest.
|
static long |
ServiceUtils.getPartSize(GetObjectRequest getObjectRequest,
AmazonS3 s3,
int partNumber)
Returns the part size of the part
|
boolean |
SkipMd5CheckStrategy.skipClientSideValidation(GetObjectRequest request,
ObjectMetadata returnedMetadata)
Conveience method to determine whether to do client side validation of a GetObject call based
on both the request and the response.
|
boolean |
SkipMd5CheckStrategy.skipClientSideValidationPerRequest(GetObjectRequest request)
Based on the given
GetObjectRequest , returns whether the specified request should
skip MD5 check on the requested object content. |
Modifier and Type | Method and Description |
---|---|
abstract S3Object |
S3CryptoModule.getObjectSecurely(GetObjectRequest req) |
S3Object |
CryptoModuleDispatcher.getObjectSecurely(GetObjectRequest req) |
abstract ObjectMetadata |
S3CryptoModule.getObjectSecurely(GetObjectRequest req,
File dest) |
ObjectMetadata |
CryptoModuleDispatcher.getObjectSecurely(GetObjectRequest req,
File destinationFile) |
Modifier and Type | Class and Description |
---|---|
class |
EncryptedGetObjectRequest
An extension of
GetObjectRequest to allow additional encryption
material description to be specified on a per-request basis. |
Modifier and Type | Method and Description |
---|---|
GetObjectRequest |
GetObjectRequest.withBucketName(String bucketName)
The bucket name containing the object.
|
GetObjectRequest |
GetObjectRequest.withKey(String key)
Sets the key under which the object to be downloaded is stored.
|
GetObjectRequest |
GetObjectRequest.withMatchingETagConstraint(String eTag)
Sets a single ETag constraint to this request.
|
GetObjectRequest |
GetObjectRequest.withModifiedSinceConstraint(Date date)
Sets the optional modified constraint that restricts this request
to executing only if the object has been modified after the
specified date.
|
GetObjectRequest |
GetObjectRequest.withNonmatchingETagConstraint(String eTag)
Sets a single ETag constraint to this request.
|
GetObjectRequest |
GetObjectRequest.withPartNumber(Integer partNumber)
Sets the optional part number that indicates the part to be downloaded in a multipart object.
|
GetObjectRequest |
GetObjectRequest.withProgressListener(ProgressListener progressListener)
Deprecated.
|
GetObjectRequest |
GetObjectRequest.withRange(long start)
Sets the optional inclusive start range within the desired object that the
rest of which will be downloaded by this request.
|
GetObjectRequest |
GetObjectRequest.withRange(long start,
long end)
Sets the optional inclusive byte range within the desired object that
will be downloaded by this request.
|
GetObjectRequest |
GetObjectRequest.withRequesterPays(boolean isRequesterPays)
Used for conducting this operation from a Requester Pays Bucket.
|
GetObjectRequest |
GetObjectRequest.withResponseHeaders(ResponseHeaderOverrides responseHeaders)
Sets the headers to be overridden in the service response and returns
this object, for method chaining.
|
GetObjectRequest |
GetObjectRequest.withS3ObjectId(S3ObjectId s3ObjectId)
Fluent API to set the S3 object id for this request.
|
GetObjectRequest |
GetObjectRequest.withSSECustomerKey(SSECustomerKey sseKey)
Sets the optional customer-provided server-side encryption key to use to
decrypt this object, and returns the updated GetObjectRequest so that
additional method calls may be chained together.
|
GetObjectRequest |
GetObjectRequest.withUnmodifiedSinceConstraint(Date date)
Sets the optional unmodified constraint that restricts this request
to executing only if the object has not been modified after
the specified date.
|
GetObjectRequest |
GetObjectRequest.withVersionId(String versionId)
Sets the optional version ID specifying which version of the object to
download and returns this object, enabling additional method calls to be
chained together.
|
GetObjectRequest |
GetObjectRequest.withWormMirrorDestination(String wormMirrorDestination)
Sets the optional mirror-destination value for WORM mirroring
and returns the updated GetObjectRequest so that additional
method calls may be chained together.
|
Modifier and Type | Method and Description |
---|---|
Download |
TransferManager.download(GetObjectRequest getObjectRequest,
File file)
Schedules a new transfer to download data from Amazon S3 and save it to
the specified file.
|
Download |
TransferManager.download(GetObjectRequest getObjectRequest,
File file,
long timeoutMillis)
Schedules a new transfer to download data from Amazon S3 and save it to
the specified file.
|
Download |
TransferManager.download(GetObjectRequest getObjectRequest,
File file,
S3ProgressListener progressListener)
Schedules a new transfer to download data from Amazon S3 and save it to
the specified file.
|
Download |
TransferManager.download(GetObjectRequest getObjectRequest,
File file,
S3ProgressListener progressListener,
long timeoutMillis)
Schedules a new transfer to download data from Amazon S3 and save it to
the specified file.
|
Download |
TransferManager.download(GetObjectRequest getObjectRequest,
File file,
S3ProgressListener progressListener,
long timeoutMillis,
boolean resumeOnRetry)
Schedules a new transfer to download data from Amazon S3 and save it to
the specified file.
|
Modifier and Type | Method and Description |
---|---|
static boolean |
TransferManagerUtils.isDownloadParallelizable(AmazonS3 s3,
GetObjectRequest getObjectRequest,
Integer partCount)
Returns true if the specified download request can use parallel part
downloads for increased performance.
|
Constructor and Description |
---|
DownloadImpl(String description,
TransferProgress transferProgress,
ProgressListenerChain progressListenerChain,
S3Object s3Object,
TransferStateChangeListener listener,
GetObjectRequest getObjectRequest,
File file)
Deprecated.
|
DownloadImpl(String description,
TransferProgress transferProgress,
ProgressListenerChain progressListenerChain,
S3Object s3Object,
TransferStateChangeListener listener,
GetObjectRequest getObjectRequest,
File file,
ObjectMetadata objectMetadata,
boolean isDownloadParallel) |
Copyright © 2024. All rights reserved.