| Modifier and Type | Class and Description |
|---|---|
class |
FifoCache<T>
A bounded cache that has a FIFO eviction policy when the cache is full.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
AwsCrtS3V4aSigner
Deprecated.
Use
com.ibm.cos.v2.http.auth.aws.signer.AwsV4aHttpSigner from the 'http-auth-aws' module. |
interface |
AwsCrtV4aSigner
Deprecated.
Use
com.ibm.cos.v2.http.auth.aws.signer.AwsV4aHttpSigner from the 'http-auth-aws' module. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
AwsClient
Interface for an AWS Client that extends SdkClient.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AwsAsyncClientHandler
Async client handler for AWS SDK clients.
|
class |
AwsSyncClientHandler
Client handler for AWS SDK clients.
|
| Modifier and Type | Class and Description |
|---|---|
class |
CachedTokenRefresher<TokenT extends SdkToken>
Class to cache Tokens which are supplied by the Suppliers while constructing this class.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
SdkClient
All SDK service client interfaces should extend this interface.
|
interface |
SdkPlugin
A plugin modifies a client's configuration when the client is created or at request execution
time.
|
| Modifier and Type | Class and Description |
|---|---|
class |
SdkAsyncClientHandler
Default implementation of
AsyncClientHandler. |
class |
SdkSyncClientHandler
Client handler for SDK clients.
|
| Modifier and Type | Class and Description |
|---|---|
class |
SdkIdentityProperty |
| Modifier and Type | Class and Description |
|---|---|
class |
AmazonAsyncHttpClient |
class |
AmazonSyncHttpClient |
class |
IdempotentAsyncResponseHandler<T,R>
Wrapper for a
TransformingAsyncResponseHandler that allows attachment to an external scope and given a way
of evaluating whether that scope has changed or not will only allow prepare() to be called on its delegate once
per state change and will cache and reserve the future that is returned by the delegate the rest of the time. |
| Modifier and Type | Class and Description |
|---|---|
class |
ClockSkewAdjuster
Suggests a clock skew adjustment that should be applied to future requests.
|
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultSystemUserAgent
Common system level user agent properties that can either be accessed as a string or as individual values.
|
class |
SdkUserAgentBuilder
Responsible for building user agent strings for different use cases.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AsyncWaiterExecutor<T>
Executes async waiter operations
|
class |
DefaultAsyncWaiter<T>
Default implementation of the generic
AsyncWaiter. |
class |
DefaultWaiter<T>
Default implementation of the generic
Waiter. |
class |
WaiterExecutor<T>
Executes sync waiter operations
|
| Modifier and Type | Class and Description |
|---|---|
class |
ClockSkew
Utility methods for checking and reacting to the current client-side clock being different from the service-side clock.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
TokenBucketExceptionCostFunction
A function used by
TokenBucketRetryCondition to determine how many tokens should be removed from the bucket when an
exception is encountered. |
| Modifier and Type | Class and Description |
|---|---|
class |
SdkUserAgent
Deprecated.
|
interface |
SystemUserAgent
Common system level user agent properties that can either be accessed as a string or as individual values.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
SdkHttpClient
Interface to take a representation of an HTTP request, make an HTTP call, and return a representation of an HTTP response.
|
interface |
SdkHttpService
Service Provider interface for HTTP implementations.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
SdkAsyncHttpClient
Interface to take a representation of an HTTP request, asynchronously make an HTTP call, and return a representation of an
HTTP response.
|
interface |
SdkAsyncHttpService
Service Provider interface for Async HTTP implementations.
|
| Modifier and Type | Class and Description |
|---|---|
class |
FifoCache<T>
A bounded cache that has a FIFO eviction policy when the cache is full.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
AsyncSignedRequest
Represents a request with async payload that has been signed by
HttpSigner. |
interface |
AsyncSignRequest<IdentityT extends Identity>
Input parameters to sign a request with async payload, using
HttpSigner. |
interface |
BaseSignedRequest<PayloadT>
/**
Base interface to a request that has been signed by
HttpSigner, independent of payload type. |
interface |
BaseSignRequest<PayloadT,IdentityT extends Identity>
Base interface to represent input parameters to sign a request using
HttpSigner, independent of payload type. |
interface |
SignedRequest
Represents a request with sync payload that has been signed by
HttpSigner. |
class |
SignerProperty<T>
A strongly-typed property for input to an
HttpSigner. |
interface |
SignRequest<IdentityT extends Identity>
Input parameters to sign a request with sync payload, using
HttpSigner. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
AwsCredentialsIdentity
Provides access to the AWS credentials used for accessing services: AWS access key ID and secret access key.
|
interface |
AwsSessionCredentialsIdentity
A special type of
AwsCredentialsIdentity that provides a session token to be used in service authentication. |
interface |
Identity
Interface to represent who is using the SDK, i.e., the identity of the caller, used for authentication.
|
class |
IdentityProperty<T>
A strongly-typed property for input to an
IdentityProvider. |
interface |
IdentityProvider<IdentityT extends Identity>
Interface for loading
Identity that is used for authentication. |
interface |
ResolveIdentityRequest
A request to resolve an
Identity. |
interface |
TokenIdentity
Provides token which is used to securely authorize requests to services that use token based auth, e.g., OAuth.
|
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultResolveIdentityRequest |
| Modifier and Type | Class and Description |
|---|---|
static class |
LowCopyListMap.ForBuildable |
| Modifier and Type | Interface and Description |
|---|---|
interface |
MetricPublisher
Interface to report and publish the collected SDK metric events to external
sources.
|
| Modifier and Type | Class and Description |
|---|---|
class |
AwsJsonProtocolFactory
Factory to generate the various JSON protocol handlers and generators to be used for
communicating with the service.
|
| Modifier and Type | Class and Description |
|---|---|
class |
JsonProtocolUnmarshaller
Unmarshaller implementation for both JSON RPC and REST JSON services.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
AdaptiveRetryStrategy
The adaptive retry strategy is a
RetryStrategy when executing against a very resource-constrained set of resources. |
interface |
LegacyRetryStrategy
The legacy retry strategy is a
RetryStrategy for normal use-cases. |
interface |
StandardRetryStrategy
The standard retry strategy is the recommended
RetryStrategy for normal use-cases. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
AcquireInitialTokenRequest
Encapsulates the abstract scope to start the attempts about to be executed using a retry strategy.
|
interface |
AcquireInitialTokenResponse
Encapsulates the response from the
RetryStrategy to the request to start the attempts to be executed. |
interface |
BackoffStrategy
Determines how long to wait before each execution attempt.
|
interface |
RecordSuccessRequest
Request that the calling code makes to the
RetryStrategy using
RetryStrategy.recordSuccess(RecordSuccessRequest) to notify that the attempted execution succeeded. |
interface |
RecordSuccessResponse
Response given to the calling code by the
RetryStrategy after calling
RetryStrategy.recordSuccess(RecordSuccessRequest). |
interface |
RefreshRetryTokenRequest
Request that the calling code makes to the
RetryStrategy using
RetryStrategy.refreshRetryToken(RefreshRetryTokenRequest) to notify that the attempted execution failed and the
RetryToken needs to be refreshed. |
interface |
RefreshRetryTokenResponse
Response from the
RetryStrategy after calling RetryStrategy.refreshRetryToken(RefreshRetryTokenRequest). |
interface |
RetryStrategy
A strategy used by an SDK to determine when something should be retried.
|
interface |
RetryToken
An opaque token representing an in-progress execution.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
S3AsyncClient
Service client for accessing Amazon S3 asynchronously.
|
interface |
S3Client
Service client for accessing Amazon S3.
|
class |
S3Configuration |
class |
S3Utilities
Utilities for working with Amazon S3 objects.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
S3Presigner
Enables signing an S3
SdkRequest so that it can be executed without requiring any additional authentication on the
part of the caller. |
| Modifier and Type | Class and Description |
|---|---|
class |
AbortMultipartUploadPresignRequest
A request to pre-sign a
AbortMultipartUploadRequest so that it can be executed at a later time without requiring
additional signing or authentication. |
class |
CompleteMultipartUploadPresignRequest
A request to pre-sign a
CompleteMultipartUploadRequest so that it can be executed at a later time without requiring
additional signing or authentication. |
class |
CreateMultipartUploadPresignRequest
A request to pre-sign a
CreateMultipartUploadRequest so that it can be executed at a later time without requiring
additional signing or authentication. |
class |
DeleteObjectPresignRequest
A request to pre-sign a
DeleteObjectRequest so that it can be executed at a later time without requiring additional
signing or authentication. |
class |
GetObjectPresignRequest
A request to pre-sign a
GetObjectRequest so that it can be executed at a later time without requiring additional
signing or authentication. |
class |
PresignedAbortMultipartUploadRequest
A pre-signed
AbortMultipartUploadRequest that can be executed at a later time without requiring additional signing
or authentication. |
class |
PresignedCompleteMultipartUploadRequest
A pre-signed
CompleteMultipartUploadRequest that can be executed at a later time without requiring additional signing
or authentication. |
class |
PresignedCreateMultipartUploadRequest
A pre-signed
CreateMultipartUploadRequest that can be executed at a later time without requiring additional signing or
authentication. |
class |
PresignedDeleteObjectRequest
A pre-signed a
DeleteObjectRequest that can be executed at a later time without requiring additional signing or
authentication. |
class |
PresignedGetObjectRequest
A pre-signed a
GetObjectRequest that can be executed at a later time without requiring additional signing or
authentication. |
class |
PresignedPutObjectRequest
A pre-signed a
PutObjectRequest that can be executed at a later time without requiring additional signing or
authentication. |
class |
PresignedUploadPartRequest
A pre-signed
UploadPartRequest that can be executed at a later time without requiring additional signing or
authentication. |
class |
PutObjectPresignRequest
A request to pre-sign a
PutObjectRequest so that it can be executed at a later time without requiring additional
signing or authentication. |
class |
UploadPartPresignRequest
A request to pre-sign a
UploadPartRequest so that it can be executed at a later time without requiring additional
signing or authentication. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
S3AsyncWaiter
Waiter utility class that polls a resource until a desired state is reached or until it is determined that the
resource will never enter into the desired state.
|
interface |
S3Waiter
Waiter utility class that polls a resource until a desired state is reached or until it is determined that the
resource will never enter into the desired state.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
S3TransferManager
The S3 Transfer Manager offers a simple API that allows you to transfer a single object or a set of objects to and
from Amazon S3 with enhanced throughput and reliability.
|
| Modifier and Type | Class and Description |
|---|---|
class |
DefaultTransferProgress
An SDK-internal implementation of
TransferProgress. |
| Modifier and Type | Interface and Description |
|---|---|
interface |
FileDownload
A download transfer of a single object from S3.
|
| Modifier and Type | Interface and Description |
|---|---|
static interface |
TransferListener.Context.BytesTransferred
Additional bytes have been submitted or received.
|
static interface |
TransferListener.Context.TransferComplete
The transfer has completed successfully.
|
static interface |
TransferListener.Context.TransferFailed
The transfer failed.
|
static interface |
TransferListener.Context.TransferInitiated
A new transfer has been initiated.
|
interface |
TransferProgress
TransferProgress is a stateful representation of the progress of a transfer initiated by S3TransferManager. |
interface |
TransferProgressSnapshot
TransferProgressSnapshot is an immutable, point-in-time representation of the progress of a given transfer
initiated by S3TransferManager. |
| Modifier and Type | Class and Description |
|---|---|
class |
DateUtils
Utilities for parsing and formatting dates.
|
| Modifier and Type | Class and Description |
|---|---|
class |
LruCache<K,V>
A thread-safe LRU (Least Recently Used) cache implementation that returns the value for a specified key,
retrieving it by either getting the stored value from the cache or using a supplied function to calculate that value
and add it to the cache.
|
Copyright © 2026. All rights reserved.