| 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 | |
| com.ibm.cloud.objectstorage.services.s3.waiters |
| Modifier and Type | Method and Description |
|---|---|
ObjectMetadata |
AbstractAmazonS3.getObject(GetObjectRequest getObjectRequest,
File destinationFile) |
ObjectMetadata |
AmazonS3Client.getObject(GetObjectRequest getObjectRequest,
File destinationFile) |
ObjectMetadata |
AmazonS3.getObject(GetObjectRequest getObjectRequest,
File destinationFile)
Retrieves objects from Amazon S3.
|
ObjectMetadata |
AbstractAmazonS3.getObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest) |
ObjectMetadata |
AmazonS3Client.getObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest) |
ObjectMetadata |
AmazonS3.getObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest)
The HEAD action retrieves metadata from an object without returning the object itself.
|
ObjectMetadata |
AbstractAmazonS3.getObjectMetadata(String bucketName,
String key) |
ObjectMetadata |
AmazonS3Client.getObjectMetadata(String bucketName,
String key) |
ObjectMetadata |
AmazonS3.getObjectMetadata(String bucketName,
String key)
Gets the metadata for the specified Amazon S3 object without
actually fetching the object itself.
|
| Modifier and Type | Method and Description |
|---|---|
protected static void |
AmazonS3Client.populateRequestMetadata(Request<?> request,
ObjectMetadata metadata)
Populates the specified request object with the appropriate headers from
the
ObjectMetadata object. |
PutObjectResult |
AbstractAmazonS3.putObject(String bucketName,
String key,
InputStream input,
ObjectMetadata metadata) |
PutObjectResult |
AmazonS3Client.putObject(String bucketName,
String key,
InputStream input,
ObjectMetadata metadata) |
PutObjectResult |
AmazonS3.putObject(String bucketName,
String key,
InputStream input,
ObjectMetadata metadata)
Uploads the specified input stream and object metadata to Amazon S3 under
the specified bucket and key name.
|
| Modifier and Type | Method and Description |
|---|---|
abstract ObjectMetadata |
S3Direct.getObject(GetObjectRequest req,
File dest) |
ObjectMetadata |
S3DirectSpi.getObject(GetObjectRequest req,
File dest) |
abstract ObjectMetadata |
S3Direct.getObjectMetadata(GetObjectMetadataRequest req) |
ObjectMetadata |
UploadObjectStrategy.invokeServiceCall(Request<RequestT> request)
Implement the behavior for making a http call to the S3 service.
|
| Modifier and Type | Method and Description |
|---|---|
AmazonWebServiceResponse<ObjectMetadata> |
S3MetadataResponseHandler.handle(HttpResponse response) |
| Modifier and Type | Method and Description |
|---|---|
ResponseT |
UploadObjectStrategy.createResult(ObjectMetadata metadata,
String contentMd5)
Create and return the result object using the object metadata and content md5
|
protected void |
AbstractS3ResponseHandler.populateObjectMetadata(HttpResponse response,
ObjectMetadata metadata)
Populates the specified S3ObjectMetadata object with all object metadata
pulled from the headers in the specified response.
|
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.skipClientSideValidation(PresignedUrlDownloadRequest request,
ObjectMetadata returnedMetadata)
Conveience method to determine whether to do client side validation of a
PresignedUrlDownloadRequest call based
on both the request and the response. |
boolean |
SkipMd5CheckStrategy.skipClientSideValidationPerGetResponse(ObjectMetadata metadata)
Determines whether the client should use the
Headers.ETAG header returned by S3 to
validate the integrity of the message client side based on the server response. |
boolean |
SkipMd5CheckStrategy.skipClientSideValidationPerPutResponse(ObjectMetadata metadata)
Determines whether the client should use the
Headers.ETAG header returned by S3 to
validate the integrity of the message client side based on the server response. |
boolean |
SkipMd5CheckStrategy.skipClientSideValidationPerUploadPartResponse(ObjectMetadata metadata)
Determines whether the client should use the
Headers.ETAG header returned by S3 to
validate the integrity of the message client side based on the server response. |
| Modifier and Type | Method and Description |
|---|---|
abstract ObjectMetadata |
S3CryptoModule.getObjectSecurely(GetObjectRequest req,
File dest) |
ObjectMetadata |
CryptoModuleDispatcher.getObjectSecurely(GetObjectRequest req,
File destinationFile) |
protected ObjectMetadata |
S3CryptoModuleBase.updateMetadataWithContentCryptoMaterial(ObjectMetadata metadata,
File file,
com.ibm.cloud.objectstorage.services.s3.internal.crypto.v1.ContentCryptoMaterial instruction) |
| Modifier and Type | Method and Description |
|---|---|
protected long |
S3CryptoModuleBase.plaintextLength(AbstractPutObjectRequest request,
ObjectMetadata metadata)
Returns the plaintext length from the request and metadata; or -1 if
unknown.
|
protected ObjectMetadata |
S3CryptoModuleBase.updateMetadataWithContentCryptoMaterial(ObjectMetadata metadata,
File file,
com.ibm.cloud.objectstorage.services.s3.internal.crypto.v1.ContentCryptoMaterial instruction) |
| Modifier and Type | Field and Description |
|---|---|
ObjectMetadata |
InitiateMultipartUploadRequest.objectMetadata
Additional information about the new object being created, such as
content type, content encoding, user metadata, etc.
|
| Modifier and Type | Method and Description |
|---|---|
ObjectMetadata |
ObjectMetadata.clone()
Returns a clone of this
ObjectMetadata. |
ObjectMetadata |
PutObjectResult.getMetadata()
Returns the metadata retrieved as a response to
AmazonS3Client.putObject(PutObjectRequest) operation. |
ObjectMetadata |
PresignedUrlUploadRequest.getMetadata()
Gets the optional metadata instructing Amazon S3 how to handle the
uploaded data (e.g.
|
ObjectMetadata |
PresignedUrlUploadResult.getMetadata()
Returns the metadata retrieved as a response to
AmazonS3Client.upload(PresignedUrlUploadRequest) operation. |
ObjectMetadata |
AbstractPutObjectRequest.getMetadata()
Gets the optional metadata instructing Amazon S3 how to handle the
uploaded data (e.g.
|
ObjectMetadata |
WriteGetObjectResponseRequest.getMetadata()
A map of metadata to store with the object in S3.
|
ObjectMetadata |
CopyObjectRequest.getNewObjectMetadata()
Gets the optional object metadata to set for the new, copied object.
|
ObjectMetadata |
UploadPartRequest.getObjectMetadata()
Returns the additional information about the part being uploaded.
|
ObjectMetadata |
S3Object.getObjectMetadata()
Gets the metadata stored by Amazon S3 for this object.
|
ObjectMetadata |
InitiateMultipartUploadRequest.getObjectMetadata()
Returns the additional information about the new object being created,
such as content type, content encoding, user metadata, etc.
|
ObjectMetadata |
UploadObjectRequest.getUploadPartMetadata()
Gets the optional metadata to be included in each UploadPart request.
|
| Modifier and Type | Method and Description |
|---|---|
void |
PutObjectResult.setMetadata(ObjectMetadata metadata)
Sets the metadata retrieved as a response to
AmazonS3Client.putObject(PutObjectRequest) operation. |
void |
PresignedUrlUploadRequest.setMetadata(ObjectMetadata metadata)
Sets the optional metadata instructing Amazon S3 how to handle the
uploaded data (e.g.
|
void |
PresignedUrlUploadResult.setMetadata(ObjectMetadata metadata)
Sets the metadata retrieved as a response to
AmazonS3Client.upload(PresignedUrlUploadRequest) operation. |
void |
AbstractPutObjectRequest.setMetadata(ObjectMetadata metadata)
Sets the optional metadata instructing Amazon S3 how to handle the
uploaded data (e.g.
|
void |
WriteGetObjectResponseRequest.setMetadata(ObjectMetadata metadata)
Set a map of metadata to store with the object in S3.
|
void |
CopyObjectRequest.setNewObjectMetadata(ObjectMetadata newObjectMetadata)
Sets the object metadata to use for the new, copied object.
|
void |
UploadPartRequest.setObjectMetadata(ObjectMetadata objectMetadata)
Sets the additional information about the part being uploaded.
|
void |
S3Object.setObjectMetadata(ObjectMetadata metadata)
Sets the object metadata for this object.
|
void |
InitiateMultipartUploadRequest.setObjectMetadata(ObjectMetadata objectMetadata)
Sets the additional information about the new object being created, such
as content type, content encoding, user metadata, etc.
|
void |
UploadObjectRequest.setUploadPartMetadata(ObjectMetadata partUploadMetadata)
Sets the optional metadata to be included in each UploadPart request.
|
PresignedUrlUploadRequest |
PresignedUrlUploadRequest.withMetadata(ObjectMetadata metadata)
Sets the optional metadata instructing Amazon S3 how to handle the
uploaded data (e.g.
|
PresignedUrlUploadResult |
PresignedUrlUploadResult.withMetadata(ObjectMetadata metadata)
Sets the metadata retrieved as a response to
AmazonS3Client.upload(PresignedUrlUploadRequest) operation. |
PutObjectRequest |
PutObjectRequest.withMetadata(ObjectMetadata metadata) |
WriteGetObjectResponseRequest |
WriteGetObjectResponseRequest.withMetadata(ObjectMetadata metadata)
Set a map of metadata to store with the object in S3.
|
<T extends AbstractPutObjectRequest> |
AbstractPutObjectRequest.withMetadata(ObjectMetadata metadata)
Sets the optional metadata instructing Amazon S3 how to handle the
uploaded data (e.g.
|
CopyObjectRequest |
CopyObjectRequest.withNewObjectMetadata(ObjectMetadata newObjectMetadata)
Sets the object metadata to use for the new, copied object and returns
this object, enabling additional method calls to be chained together.
|
UploadPartRequest |
UploadPartRequest.withObjectMetadata(ObjectMetadata objectMetadata)
Fluent API for
UploadPartRequest.setObjectMetadata(ObjectMetadata). |
InitiateMultipartUploadRequest |
InitiateMultipartUploadRequest.withObjectMetadata(ObjectMetadata objectMetadata)
Sets the additional information about the new object being created, such
as content type, content encoding, user metadata, etc.
|
<T extends UploadObjectRequest> |
UploadObjectRequest.withUploadPartMetadata(ObjectMetadata partUploadMetadata)
Fluent API for
UploadObjectRequest.setUploadPartMetadata(ObjectMetadata). |
| Constructor and Description |
|---|
AbstractPutObjectRequest(String bucketName,
String key,
InputStream input,
ObjectMetadata metadata)
Constructs a new
AbstractPutObjectRequest object to upload a stream of data to
the specified bucket and key. |
EncryptedInitiateMultipartUploadRequest(String bucketName,
String key,
ObjectMetadata objectMetadata) |
EncryptedPutObjectRequest(String bucketName,
String key,
InputStream input,
ObjectMetadata metadata) |
InitiateMultipartUploadRequest(String bucketName,
String key,
ObjectMetadata objectMetadata)
Constructs a request to initiate a new multipart upload in the specified
bucket, stored by the specified key, and with the additional specified
object metadata.
|
PutObjectRequest(String bucketName,
String key,
InputStream input,
ObjectMetadata metadata)
Constructs a new
PutObjectRequest object to upload a stream of data to
the specified bucket and key. |
UploadObjectRequest(String bucketName,
String key,
InputStream input,
ObjectMetadata metadata) |
| Modifier and Type | Method and Description |
|---|---|
ObjectMetadata |
Download.getObjectMetadata()
Returns the ObjectMetadata for the object being downloaded.
|
| Modifier and Type | Method and Description |
|---|---|
void |
ObjectMetadataProvider.provideObjectMetadata(File file,
ObjectMetadata metadata) |
Upload |
TransferManager.upload(String bucketName,
String key,
InputStream input,
ObjectMetadata objectMetadata)
Schedules a new transfer to upload data to Amazon S3.
|
| Modifier and Type | Method and Description |
|---|---|
ObjectMetadata |
DownloadImpl.getObjectMetadata()
Returns the ObjectMetadata for the object being downloaded.
|
| Modifier and Type | Method and Description |
|---|---|
static Long |
TransferManagerUtils.getContentLengthFromContentRange(ObjectMetadata metadata)
Returns the content length of the object if response contains the Content-Range header
and is well formed.
|
| Constructor and Description |
|---|
CopyCallable(TransferManager transferManager,
ExecutorService threadPool,
CopyImpl copy,
CopyObjectRequest copyObjectRequest,
ObjectMetadata metadata,
ProgressListenerChain progressListenerChain) |
DownloadImpl(String description,
TransferProgress transferProgress,
ProgressListenerChain progressListenerChain,
S3Object s3Object,
TransferStateChangeListener listener,
GetObjectRequest getObjectRequest,
File file,
ObjectMetadata objectMetadata,
boolean isDownloadParallel) |
| Modifier and Type | Method and Description |
|---|---|
ObjectMetadata |
HeadObjectFunction.apply(GetObjectMetadataRequest headObjectRequest)
Makes a call to the operation specified by the waiter by taking the
corresponding request and returns the corresponding result
|
Copyright © 2024. All rights reserved.