| Package | Description |
|---|---|
| com.ibm.cloud.objectstorage | |
| com.ibm.cloud.objectstorage.auth.presign | |
| com.ibm.cloud.objectstorage.client | |
| com.ibm.cloud.objectstorage.event | |
| com.ibm.cloud.objectstorage.handlers | |
| com.ibm.cloud.objectstorage.http | |
| com.ibm.cloud.objectstorage.internal | |
| com.ibm.cloud.objectstorage.retry | |
| 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.util | |
| com.ibm.cloud.objectstorage.waiters |
| Modifier and Type | Field and Description |
|---|---|
static AmazonWebServiceRequest |
AmazonWebServiceRequest.NOOP |
| Modifier and Type | Method and Description |
|---|---|
protected <T extends AmazonWebServiceRequest> |
AmazonWebServiceClient.beforeClientExecution(T request)
Notify request handlers that we are about to start execution.
|
protected <T extends AmazonWebServiceRequest> |
AmazonWebServiceClient.beforeMarshalling(T request)
Runs the
beforeMarshalling method of any
RequestHandler2s associated with this client. |
protected <T extends AmazonWebServiceRequest> |
AmazonWebServiceRequest.copyBaseTo(T target)
Copies the internal state of this base class to that of the target request.
|
<T extends AmazonWebServiceRequest> |
AmazonWebServiceRequest.withGeneralProgressListener(ProgressListener progressListener)
Sets the optional progress listener for receiving updates about the progress of the request,
and returns a reference to this object so that method calls can be chained together.
|
<T extends AmazonWebServiceRequest> |
AmazonWebServiceRequest.withRequestCredentialsProvider(AWSCredentialsProvider credentialsProvider)
Sets the optional credentials provider to use for this request, overriding the default credentials
provider at the client level.
|
<T extends AmazonWebServiceRequest> |
AmazonWebServiceRequest.withRequestMetricCollector(RequestMetricCollector metricCollector)
Specifies a request level metric collector which takes precedence over the ones at the http
client level and AWS SDK level.
|
<T extends AmazonWebServiceRequest> |
AmazonWebServiceRequest.withSdkClientExecutionTimeout(int sdkClientExecutionTimeout)
Sets the amount of time (in milliseconds) to allow the client to complete the execution of
an API call.
|
<T extends AmazonWebServiceRequest> |
AmazonWebServiceRequest.withSdkRequestTimeout(int sdkRequestTimeout)
Sets the amount of time to wait (in milliseconds) for the request to complete before giving
up and timing out.
|
| Modifier and Type | Method and Description |
|---|---|
AmazonWebServiceRequest |
AmazonWebServiceRequest.clone()
Creates a shallow clone of this object for all fields except the handler context.
|
AmazonWebServiceRequest |
AmazonWebServiceRequest.getCloneRoot()
Returns the root object from which the current object was cloned; or null if there isn't one.
|
AmazonWebServiceRequest |
AmazonWebServiceRequest.getCloneSource()
Returns the source object from which the current object was cloned; or null if there isn't
one.
|
AmazonWebServiceRequest |
Request.getOriginalRequest()
Returns the original, user facing request object which this internal
request object is representing.
|
AmazonWebServiceRequest |
DefaultRequest.getOriginalRequest()
Returns the original, user facing request object which this internal
request object is representing.
|
| Modifier and Type | Method and Description |
|---|---|
protected ExecutionContext |
AmazonWebServiceClient.createExecutionContext(AmazonWebServiceRequest req) |
protected ExecutionContext |
AmazonWebServiceClient.createExecutionContext(AmazonWebServiceRequest req,
SignerProvider signerProvider) |
protected boolean |
AmazonWebServiceClient.isRequestMetricsEnabled(AmazonWebServiceRequest req)
Returns true if request metric collection is applicable to the given
request; false otherwise.
|
| Constructor and Description |
|---|
DefaultRequest(AmazonWebServiceRequest originalRequest,
String serviceName)
Constructs a new DefaultRequest with the specified service name and the
original, user facing request object.
|
| Modifier and Type | Class and Description |
|---|---|
static class |
PresignerFacade.PresigningRequest
Empty request object useful for setting request level credentials without having the user facing presiging request extend
from
AmazonWebServiceRequest. |
| Modifier and Type | Method and Description |
|---|---|
protected <T extends AmazonWebServiceRequest> |
ClientHandlerImpl.beforeMarshalling(T request)
Runs the
beforeMarshalling method of any RequestHandler2s associated with
this client. |
| Modifier and Type | Method and Description |
|---|---|
static InputStream |
ProgressInputStream.inputStreamForRequest(InputStream is,
AmazonWebServiceRequest req)
Deprecated.
|
static InputStream |
ProgressInputStream.inputStreamForResponse(InputStream is,
AmazonWebServiceRequest req)
Returns an input stream for response progress tracking purposes.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
AsyncHandler<REQUEST extends AmazonWebServiceRequest,RESULT>
Callback interface for notification on web service requests executed with the
asynchronous clients in the AWS SDK for Java.
|
| Modifier and Type | Method and Description |
|---|---|
AmazonWebServiceRequest |
IRequestHandler2.beforeExecution(AmazonWebServiceRequest request)
Runs any additional processing logic on the specified request object as soon as the request
is provided to the service client.
|
AmazonWebServiceRequest |
StackedRequestHandler.beforeExecution(AmazonWebServiceRequest origRequest) |
AmazonWebServiceRequest |
RequestHandler2.beforeExecution(AmazonWebServiceRequest request) |
AmazonWebServiceRequest |
IRequestHandler2.beforeMarshalling(AmazonWebServiceRequest request)
Runs any additional processing logic on the specified request object before it is marshaled
into an HTTP request.
|
AmazonWebServiceRequest |
StackedRequestHandler.beforeMarshalling(AmazonWebServiceRequest origRequest) |
AmazonWebServiceRequest |
RequestHandler2.beforeMarshalling(AmazonWebServiceRequest request) |
| Modifier and Type | Method and Description |
|---|---|
AmazonWebServiceRequest |
IRequestHandler2.beforeExecution(AmazonWebServiceRequest request)
Runs any additional processing logic on the specified request object as soon as the request
is provided to the service client.
|
AmazonWebServiceRequest |
StackedRequestHandler.beforeExecution(AmazonWebServiceRequest origRequest) |
AmazonWebServiceRequest |
RequestHandler2.beforeExecution(AmazonWebServiceRequest request) |
AmazonWebServiceRequest |
IRequestHandler2.beforeMarshalling(AmazonWebServiceRequest request)
Runs any additional processing logic on the specified request object before it is marshaled
into an HTTP request.
|
AmazonWebServiceRequest |
StackedRequestHandler.beforeMarshalling(AmazonWebServiceRequest origRequest) |
AmazonWebServiceRequest |
RequestHandler2.beforeMarshalling(AmazonWebServiceRequest request) |
| Modifier and Type | Method and Description |
|---|---|
ResponseMetadata |
AmazonHttpClient.getResponseMetadataForRequest(AmazonWebServiceRequest request)
Returns additional response metadata for an executed request.
|
| Constructor and Description |
|---|
AmazonWebServiceRequestAdapter(AmazonWebServiceRequest request) |
| Modifier and Type | Method and Description |
|---|---|
long |
RetryPolicy.BackoffStrategy.delayBeforeNextRetry(AmazonWebServiceRequest originalRequest,
AmazonClientException exception,
int retriesAttempted)
Returns the delay (in milliseconds) before next retry attempt.
|
boolean |
PredefinedRetryPolicies.SDKDefaultRetryCondition.shouldRetry(AmazonWebServiceRequest originalRequest,
AmazonClientException exception,
int retriesAttempted) |
boolean |
RetryPolicy.RetryCondition.shouldRetry(AmazonWebServiceRequest originalRequest,
AmazonClientException exception,
int retriesAttempted)
Returns whether a failed request should be retried according to the
given request context.
|
| Modifier and Type | Method and Description |
|---|---|
protected <X extends AmazonWebServiceRequest> |
UploadObjectObserver.appendUserAgent(X request,
String userAgent)
Appends the given user agent to the given request.
|
protected <X extends AmazonWebServiceRequest> |
AmazonS3Client.createRequest(String bucketName,
String key,
X originalRequest,
HttpMethodName httpMethod)
Creates and initializes a new request object for the specified S3
resource.
|
protected <X extends AmazonWebServiceRequest> |
AmazonS3Client.createRequest(String bucketName,
String key,
X originalRequest,
HttpMethodName httpMethod,
URI endpoint) |
| Modifier and Type | Method and Description |
|---|---|
S3ResponseMetadata |
AbstractAmazonS3.getCachedResponseMetadata(AmazonWebServiceRequest request) |
S3ResponseMetadata |
AmazonS3Client.getCachedResponseMetadata(AmazonWebServiceRequest request) |
S3ResponseMetadata |
AmazonS3.getCachedResponseMetadata(AmazonWebServiceRequest request)
Gets additional metadata for a previously executed successful request.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
CompleteMultipartUploadRetryCondition.shouldRetry(AmazonWebServiceRequest originalRequest,
AmazonClientException exception,
int retriesAttempted) |
| Modifier and Type | Method and Description |
|---|---|
protected com.ibm.cloud.objectstorage.services.s3.internal.crypto.v1.ContentCryptoMaterial |
S3CryptoModuleBase.createContentCryptoMaterial(AmazonWebServiceRequest req)
Creates and returns a non-null content crypto material for the given
request.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AbortMultipartUploadRequest
The AbortMultipartUploadRequest contains the parameters used for the
AbortMultipartUpload method.
|
class |
AbstractPutObjectRequest
Abstract base class for a put object or put object like request.
|
class |
AddLegalHoldRequest
Request object containing all the options for adding a legal hold to an object.
|
class |
CompleteMultipartUploadRequest
Container for the parameters of the CompleteMultipartUpload operation.
|
class |
CopyObjectRequest
Provides options for copying an Amazon S3 object
from a source location to a new destination.
|
class |
CopyPartRequest
Provides options for copying an Amazon S3 object from a source location to a
part of a multipart upload.
|
class |
CreateBucketRequest
Provides options for creating an Amazon S3 bucket.
|
class |
DeleteBucketAnalyticsConfigurationRequest
Request object to delete an analytics configuration.
|
class |
DeleteBucketCrossOriginConfigurationRequest
Request object for the parameters to delete a bucket's cross origin configuration.
|
class |
DeleteBucketInventoryConfigurationRequest
Request object to delete an inventory configuration.
|
class |
DeleteBucketLifecycleConfigurationRequest
Request object for the parameters to delete a bucket's lifecycle configuration.
|
class |
DeleteBucketMetricsConfigurationRequest
Request object to delete a metrics configuration from a bucket.
|
class |
DeleteBucketPolicyRequest
Deletes the policy associated with the specified bucket.
|
class |
DeleteBucketReplicationConfigurationRequest
Request object for the parameters to delete a bucket's replication
configuration.
|
class |
DeleteBucketRequest
Provides options for deleting a specified bucket.
|
class |
DeleteBucketWebsiteConfigurationRequest
Request object for the parameters to delete a bucket's website configuration.
|
class |
DeleteLegalHoldRequest
Request object containing all the options for deleting a legal hold from an object.
|
class |
DeleteObjectRequest
Provides options for deleting a specified object in a specified bucket.
|
class |
DeleteObjectsRequest
Provides options for deleting multiple objects in a specified bucket.
|
class |
DeletePublicAccessBlockRequest |
class |
DeleteVersionRequest
Provides options for deleting a specific version of an object in the specified bucket.
|
class |
EncryptedGetObjectRequest
An extension of
GetObjectRequest to allow additional encryption
material description to be specified on a per-request basis. |
class |
EncryptedInitiateMultipartUploadRequest
This class is an extension of
InitiateMultipartUploadRequest to allow
additional crypto related attributes to be specified. |
class |
EncryptedPutObjectRequest
This class is an extension of
PutObjectRequest to allow additional
encryption material description to be specified on a per-request basis.In
particular, EncryptedPutObjectRequest is only recognized by
AmazonS3EncryptionClient. |
class |
ExtendObjectRetentionRequest
Request object containing all the options for extending the retention period
of a protected object.
|
class |
GeneratePresignedUrlRequest
Contains options to generate a pre-signed URL for an Amazon S3 resource.
|
class |
GenericBucketRequest
Generic request container for web service requests on buckets.
|
class |
GetBucketAccelerateConfigurationRequest
Request object for the parameters to get a bucket's accelerate configuration.
|
class |
GetBucketAclRequest
Request object containing all the options for requesting a bucket's Access Control List (ACL).
|
class |
GetBucketAnalyticsConfigurationRequest
Request object to get an analytics configuration.
|
class |
GetBucketCrossOriginConfigurationRequest
Request object for the parameters to get a bucket's cross origin configuration.
|
class |
GetBucketFaspConnectionInfoRequest
Request object for the parameters to get a bucket's FASP info.
|
class |
GetBucketInventoryConfigurationRequest
Request object to retrieve an inventory configuration.
|
class |
GetBucketLifecycleConfigurationRequest
Request object for the parameters to get a bucket's lifecycle configuration.
|
class |
GetBucketLocationRequest
Provides options for requesting an Amazon S3 bucket's location.
|
class |
GetBucketLoggingConfigurationRequest
Request object for the parameters to get a bucket's logging configuration.
|
class |
GetBucketMetricsConfigurationRequest
Request object to retrieve metrics configuration from a bucket.
|
class |
GetBucketNotificationConfigurationRequest
Request object for the parameters to get a bucket's notification
configuration.
|
class |
GetBucketPolicyRequest
Gets the policy for the specified bucket.
|
class |
GetBucketProtectionConfigurationRequest
Request object for the parameters to get a bucket's protection configuration.
|
class |
GetBucketReplicationConfigurationRequest
Request object for the parameters to get a bucket's replication
configuration.
|
class |
GetBucketVersioningConfigurationRequest
Request object for the parameters to get a bucket's versioning configuration.
|
class |
GetBucketWebsiteConfigurationRequest
Request object for the parameters to retrieve a bucket's website
configuration.
|
class |
GetObjectAclRequest
Provide options to get an object ACL.
|
class |
GetObjectLegalHoldRequest
Gets an object's current Legal Hold status.
|
class |
GetObjectLockConfigurationRequest
Gets the Object Lock configuration for a bucket.
|
class |
GetObjectMetadataRequest
The HEAD action retrieves metadata from an object without returning the object itself.
|
class |
GetObjectRequest
Retrieves objects from Amazon S3.
|
class |
GetObjectRetentionRequest
Retrieves an object's retention settings.
|
class |
GetPublicAccessBlockRequest |
class |
GetS3AccountOwnerRequest
Request object for retrieving S3 account owner.
|
class |
HeadBucketRequest
Request object for checking if the bucket exists and the user has access to
the given bucket.
|
class |
InitiateMultipartUploadRequest
The InitiateMultipartUploadRequest contains the parameters used for the
InitiateMultipartUpload method.
|
class |
ListBucketAnalyticsConfigurationsRequest
Request object to list the analytics configurations of a bucket.
|
class |
ListBucketInventoryConfigurationsRequest
Request object to list inventory configurations of a bucket.
|
class |
ListBucketMetricsConfigurationsRequest
Request object to list the metrics configurations of a bucket.
|
class |
ListBucketsExtendedRequest
Request to retrieve a listing of buckets from Cloud Object Storage.
|
class |
ListBucketsRequest
Request object for listing all the Amazon S3 buckets owned by a user.
|
class |
ListLegalHoldsRequest
Request object containing all the options for requesting an object's legal holds.
|
class |
ListMultipartUploadsRequest
Container for the parameters of the ListMultipartUploads operation.
|
class |
ListNextBatchOfObjectsRequest
Request object for parameters of listing next batch of objects.
|
class |
ListObjectsRequest
Contains options to return a list of summary information about the objects in the specified
bucket.
|
class |
ListObjectsV2Request
Request to retrieve a listing of objects in an S3 bucket.
|
class |
ListPartsRequest
Container for the the parameters of the ListParts operation.
|
class |
PresignedUrlDownloadRequest
Request class to download objects using presigned urls.
|
class |
PresignedUrlUploadRequest
Request class to upload a object to S3 using presigned urls.
|
class |
PutInstructionFileRequest
Used to create a new instruction file, typically used to share an encrypted
S3 object with partners via re-encrypting the CEK of the specified S3 object
with a partner-specific public key.
|
class |
PutObjectRequest
Uploads a new object to the specified Amazon S3 bucket.
|
class |
RestoreObjectRequest
Request object containing all the options for restoring an object, which was transitioned to the Amazon Glacier
from S3 when it was expired.
|
class |
SetBucketAccelerateConfigurationRequest
Contains options for setting the accelerate configuration for a bucket.
|
class |
SetBucketAclRequest
Request object containing all the options for setting a bucket's Access Control List (ACL).
|
class |
SetBucketAnalyticsConfigurationRequest
Request object to set analytics configuration to a bucket.
|
class |
SetBucketCrossOriginConfigurationRequest
Contains options for setting the cross origin configuration for a bucket.
|
class |
SetBucketInventoryConfigurationRequest
Request object to set an inventory configuration to a bucket.
|
class |
SetBucketLifecycleConfigurationRequest
Contains options for setting the lifecycle configuration for a bucket.
|
class |
SetBucketLoggingConfigurationRequest
Contains options for setting the logging configuration for a bucket.
|
class |
SetBucketMetricsConfigurationRequest
Request object to set metrics configuration to a bucket.
|
class |
SetBucketNotificationConfigurationRequest
Contains options for setting the notification configuration for a bucket.
|
class |
SetBucketPolicyRequest
Sets the policy associated with the specified bucket.
|
class |
SetBucketProtectionConfigurationRequest
Request object to set protection configuration to a bucket.
|
class |
SetBucketReplicationConfigurationRequest |
class |
SetBucketVersioningConfigurationRequest
Contains options for setting the versioning configuration for a bucket.
|
class |
SetBucketWebsiteConfigurationRequest
Request object for the parameters to set a bucket's website configuration.
|
class |
SetObjectAclRequest
Request object containing all the options for setting a object's Access
Control List (ACL).
|
class |
SetObjectLegalHoldRequest
Applies a Legal Hold configuration to the specified object.
|
class |
SetObjectLockConfigurationRequest
Places an Object Lock configuration on the specified bucket.
|
class |
SetObjectRetentionRequest
Places an Object Retention configuration on an object.
|
class |
SetPublicAccessBlockRequest |
class |
UploadObjectRequest
Used to request the client-side encryption and upload of a large S3 object
via pipelined parallel multi-part uploads.
|
class |
UploadPartRequest
Contains the parameters used for the UploadPart operation on Amazon S3.
|
class |
WriteGetObjectResponseRequest |
| Modifier and Type | Method and Description |
|---|---|
static <X extends AmazonWebServiceRequest> |
TransferManager.appendMultipartUserAgent(X request) |
static <X extends AmazonWebServiceRequest> |
TransferManager.appendSingleObjectUserAgent(X request) |
| Modifier and Type | Method and Description |
|---|---|
static AWSCredentialsProvider |
CredentialUtils.getCredentialsProvider(AmazonWebServiceRequest req,
AWSCredentialsProvider base)
Returns the credentials provider that will be used to fetch the
credentials when signing the request.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
Waiter<Input extends AmazonWebServiceRequest> |
class |
WaiterBuilder<Input extends AmazonWebServiceRequest,Output> |
class |
WaiterExecution<Input extends AmazonWebServiceRequest,Output> |
class |
WaiterExecutionBuilder<Input extends AmazonWebServiceRequest,Output> |
class |
WaiterHandler<Input extends AmazonWebServiceRequest>
Callbacks are executed synchronously.
|
class |
WaiterImpl<Input extends AmazonWebServiceRequest,Output> |
class |
WaiterParameters<Input extends AmazonWebServiceRequest> |
| Modifier and Type | Method and Description |
|---|---|
AmazonWebServiceRequest |
PollingStrategyContext.getOriginalRequest() |
| Modifier and Type | Method and Description |
|---|---|
void |
NoOpWaiterHandler.onWaitSuccess(AmazonWebServiceRequest request) |
Copyright © 2024. All rights reserved.