All Classes and Interfaces
Class
Description
Baseline blob store for async api calls.
Base class for substrate-specific implementations.
Base class for substrate-specific implementations.AbstractBlobStore This class serves the purpose
of providing common (i.e. substrate-agnostic) functionality
Base class for database backup and restore implementations.
AbstractDBBackupRestore.Builder<T extends AbstractDBBackupRestore,B extends AbstractDBBackupRestore.Builder<T,B>>
Builder base class for AbstractDBBackupRestore implementations.
Base class for substrate-specific implementations.
Abstract base class for Identity and Access Management (IAM) implementations.
Abstract builder class for AbstractIam implementations.
Base class for key management provider implementations.
Builder for provider implementations of
AbstractKms.Abstract registry driver.
Abstract builder for registry implementations.
Abstract base class for Security Token Service (STS) implementations.
Abstract builder class for AbstractSts implementations.
Abstract base class for Security Token Service (STS) verifier implementations.
AbstractStsVerifier.Builder<A extends AbstractStsVerifier,T extends AbstractStsVerifier.Builder<A,T>>
Abstract builder for AbstractStsVerifier implementations.
Abstract base class for subscription implementations.
Abstract base class for topic implementations.
AckID is the identifier of a message for purposes of acknowledgement.
A single ack or nack operation on a message.
Represents a substrate-neutral IAM action.
Alibaba Cloud OSS native async implementation of AsyncBlobStore.
Abstract base for Alibaba SMQ (MNS) topic (publisher) implementations.
How message bodies are placed on the SMQ wire, and the round-trip contract for readers.
AliBaseTopic.Builder<TBuilder extends AliBaseTopic.Builder<TBuilder,TTopic>,TTopic extends AliBaseTopic<TTopic>>
Base builder shared by the SMQ publisher builders.
An implementation of the
AbstractBlobClient for Ali OSS AliBlobClient is service client
for interacting with Alibaba Cloud Blob Storage.Alibaba implementation of BlobStore
Alibaba Cloud implementation of database backup and restore operations.
Builder for AliDBBackupRestore.
Alibaba implementation of DocStore with table-store
DocumentIterator backed by the Tablestore native GetRange API (see
QueryRunner).Alibaba Cloud implementation of key management, backed by the KMS OpenAPI client.
Alibaba Tablestore pagination token.
Retryability helpers for Alibaba Cloud SDK exceptions.
Alibaba SMQ (MNS) queue publisher.
Builder for
AliSmqQueue.Alibaba SMQ (MNS) topic publisher.
Builder for
AliSmqTopic.Alibaba Cloud implementation of the STS verifier.
Alibaba SMQ (MNS) subscription.
SMQ receipt-handle-backed
AckID.Builder for
AliSubscription.Super-simple class to provide instances of AliTransformer that are specific to a given bucket.
Environment-specific configuration for the examples.
API for async interaction with a backing blob storage engine.
Entry point for async Client code to interact with the Blob storage.
Parses HTTP WWW-Authenticate header to determine authentication requirements.
Authentication schemes supported by OCI registries.
HTTP request interceptor that strips Authorization headers when the request target is not the
registry host.
AWS implementation of AsyncBlobStore
Abstract base class for AWS topic implementations (SQS and SNS).
Base64EncodingStrategy is an enum of strategies for when to base64 message bodies.
AwsBaseTopic.Builder<TBuilder extends AwsBaseTopic.Builder<TBuilder,TTopic>,TTopic extends AwsBaseTopic<TTopic>>
Base builder class for AWS topic implementations.
Result of message body encoding operation.
Metadata keys used for setting message attributes on AWS messages (SQS and SNS).
TopicOptions contains configuration options for topics.
An implementation of the
AbstractBlobClient for AWS S3.AWS implementation of BlobStore
AWS implementation of database backup and restore operations using AWS Backup service.
Builder for AwsDBBackupRestore.
Translates substrate-neutral PolicyDocument to AWS IAM policy format.
AWS KMS implementation of
AbstractKms.AWS Elastic Container Registry (ECR) implementation.
Classifies AWS SDK exceptions as retryable using the SDK's own native signals.
Translates a
RetryConfig into AWS SDK client retry and timeout settings.AWS SNS implementation of AbstractTopic.
AWS SQS implementation of AbstractTopic.
AWS implementation of the STS verifier.
AWS-specific implementation of AckID that wraps the receipt handle string.
Super-simple class to provide instances of AwsTransformer that are specific to a given bucket.
Represents a backup of a database table.
Represents the status of a backup operation.
A batching system that efficiently groups individual items together and processes them in
batches.
Configuration options that govern how the
Batcher behaves.Interface for items that can report their byte size.
Handles OAuth2 Bearer Token exchange for OCI registries.
Class used to build BlobClient service instances.
Entry point for Client code to interact with the Blob service.
Helper class for combining the configuration inputs for BlobClient or AsyncBlobClient instances.
Contains the fields necessary to uniquely identify a blob
Blob info data object
Iterator object to retrieve BlobInfo list
Iterator object to retrieve BlobInfo list
Blob metadata data object
Iterator that retrieves
BlobMetadata versions for an exact key.Iterator that retrieves
BlobMetadata versions for an exact key.Span names emitted by the BlobStore tracing layer when wrapping public operations on
AbstractBlobStore, AbstractBlobClient, and AbstractAsyncBlobStore.This interface defines the providing common (i.e. substrate-agnostic) functionality for blob
store
An async wrapper around AbstractBlobStore that implements AsyncBlobStore.
Helper for validating input for BlobStore operations.
Entry point for Client code to interact with the Blob storage.
Bucket-level versioning configuration.
The versioning state of a bucket.
Checksum reported by the cloud store for a blob.
Supported checksum algorithms for upload integrity validation.
End-to-end Cloud Native Auth (CNA) example.
Codec providers the utility for encoding and decoding the data between java native types to the
target types such as substrate specific types.
Provides the mapping of various error codes to SDK's exceptions.
Provides the mapping of various error codes to SDK's exceptions
Pre-defined compute service actions for IAM policies.
Request attribute evaluated by a
KeyCondition.Condition operators for IAM policy conditions.
Comparison applied by a
KeyCondition to a request attribute.Consumer that wraps another Consumer of a different type, and uses a conversion function to map
between source and target types
Entry point for container registry; high-level API for pulling images and extracting filesystems.
POJO for copyFrom requests.
POJO for copy requests.
Wrapper object for copy result data
Request to create a symmetric key.
Result of creating a key.
Optional configuration for identity creation operations.
Cloud-agnostic representation of credential scope restrictions for downs-coped credentials based
on access boundary or policies.
Represents a condition that must be met for a rule to apply.
Represents a single rule in a credential scope.
The CredentialsOverrider is used when the service wants to override the default
credentialsOverrider in the given environment.
Cross-cloud example: a workload on a source substrate accessing a bucket on a target substrate.
Client for performing database backup and restore operations across multiple cloud providers.
Builder class for constructing DBBackupRestoreClient instances.
Decoder defines methods for decoding a given format of data to the java native types such as User
defined classes or the
Map<String, Object>.Request to decrypt a ciphertext produced by
encrypt.Result of decrypting a ciphertext.
Wrapper object for directory download data
Wrapper object for directory download result metadata
Wrapper object for directory upload data
Wrapper object for directory upload result data
DocStoreClient provides a unified interface for document/kv store operations across multiple
cloud providers.
Builder class for creating DocStoreClient instances with fluent configuration.
Wrapper object for download data
Wrapper object for download result metadata
Represents the effect of a policy statement.
Whether a
KeyGrant allows or denies its actions.Encoder defines methods for encoding various data types into a target format.
Request to encrypt a small payload directly with a key.
Result of encrypting a payload.
Provides the mapping of various error codes to SDK's exceptions
Provides the mapping of various error codes to SDK's exceptions
Maps Alibaba Cloud HBR exceptions to MultiCloudJ exception types.
Provides the mapping of various AWS Backup error codes to SDK's exceptions.
Provides the mapping of various error codes to SDK's exceptions
Provides the mapping of various error codes to SDK's exceptions
Maps Google Cloud status codes to appropriate SubstrateSdkException types.
Maps AWS IAM error codes to SubstrateSdkException types.
Maps Alibaba SMQ (MNS) service error codes (the
Code value in the error response) to
multicloudj exceptions.Maps AWS SQS and SNS error codes to SubstrateSdkException types.
Builds
SubstrateSdkException instances for provider implementations.Whether imported key material expires.
An object representing a failed blob download attempt
An object representing a failed blob upload attempt
FSCodec provides utility methods for encoding and decoding data between Java native types and
Google Cloud Firestore's protobuf-based value types.
GCP Firestore implementation of database backup and restore operations.
Builder for FSDBBackupRestore.
Google Cloud Firestore implementation of the AbstractDocStore.
Builder for creating FSDocStore instances.
Iterator for Firestore query results.
Firestore pagination token implementation.
GCP implementation of AsyncBlobStore
An implementation of the
AbstractBlobClient for GCP Cloud Storage.GCP implementation of BlobStore
Translates substrate-neutral PolicyDocument actions to GCP IAM roles.
Cloud KMS implementation of
AbstractKms.GCP Artifact Registry implementation.
Classifies GCP SDK exceptions as retryable using the SDK's own native signals.
Translates a
RetryConfig into GCP client RetrySettings.GCP implementation of the STS signer.
GCP implementation of the STS verifier.
GCP-specific implementation of AckID that wraps the acknowledgment ID string.
Builder for creating GcpTopic instances.
Super-simple class to provide instances of GcpTransformer that are specific to a given bucket.
Result object containing subscription attributes that are common across all Pub/Sub providers.
Request for the parameters needed to import key material into a key.
Pre-defined IAM service actions for IAM policies.
Entry point for client code to interact with Identity and Access Management (IAM) services in a
substrate-agnostic way.
Builder class for IamClient.
Identity defines the contract for IAM operations across cloud providers.
Interface for a container image; implementations are provided by the registry driver.
Parsed image reference for OCI Registry API v2.
Request to import wrapped key material into a key created with
KeyOrigin.EXTERNAL.Parameters for importing key material: the caller wraps the material with
ImportParameters.getWrappingPublicKey() using ImportParameters.getWrappingAlgorithm() and passes the result, together
with ImportParameters.getImportToken(), to importKeyMaterial before ImportParameters.getTokenExpiry().InMemory implementation of BlobStore for testing purposes
Portable permissions that a
KeyGrant can give on a key.Restriction on when a
KeyGrant applies: the request attribute identified by KeyCondition.getAttribute() (and KeyCondition.getKey() where the attribute needs one) must satisfy KeyCondition.getOperator() against at least one of KeyCondition.getValues().One rule of a
KeyPolicy: KeyGrant.getEffect() the KeyGrant.getActions() on the key for
the KeyGrant.getPrincipals(), when every one of the KeyGrant.getConditions() holds.Portable control-plane operations on keys held by a cloud key management service.
Source of a key's material.
Access policy attached to a key.
Identity that a
KeyGrant applies to.Reference to a key, or to a single version of a key, in the key management service.
Cryptographic configuration of the key material held by a key.
Lifecycle state of a key.
Cryptographic operations a key is permitted to perform.
Entry point for client code to manage keys in a cloud key management service in a
substrate-agnostic way.
Builder class for KmsClient.
Interface for a single image layer; implementations are provided by the registry driver.
Request object for paginated list operations
Response object for paginated list operations that includes the blob list, truncation status, and
pagination token
Wrapper object for list filters
Request object for listing versions of a specific blob.
ListDecoderCallback providers the callback function which should be called by the decodeList
implementation of a given provider.
Main class demonstrating DBBackupRestore operations across different cloud providers.
Main class demonstrating DocStore operations across different cloud providers.
Main class demonstrating IAM operations across different cloud providers.
Main class demonstrating Container Registry operations across different cloud providers.
Parsed OCI manifest from the registry.
Entry in an OCI image index (platform + digest).
Layer information including digest and media type.
MapDecoderCallback providers the callback function which should be called by the decodeMap
implementation of a given provider.
Message represents a message in the pubsub system.
Builder for creating Message instances.
Utility class for common message operations across all cloud providers.
Centralized observability utility for SDK service implementations.
Holds process-wide observability defaults for the SDK.
One of the individual "parts" of a multipartUpload
This object stores the identifying information for a multipart upload request.
A request object for initiating a multipartUpload request
The response object returned from completing a multipartUpload
Configuration for object lock (WORM protection) when uploading objects.
Object lock information for a blob (retrieved from metadata).
Configuration for updating per-object retention via
BlobStore.updateObjectRetention(String, String, ObjectRetentionConfig).State-dependent rules shared by every provider's
doUpdateObjectRetention hook so AWS,
GCP, and the in-memory provider surface uniform exception types and messages.OCI Registry API v2 HTTP transport; handles auth negotiation and registry operations.
Per-operation observability context attached to SDK requests.
Builds and configures Alibaba OSS SDK clients (sync
OSSClient and async
OSSAsyncClient) from the MultiCloudJ builder configuration.Builds the transport
HttpClient for a specific client kind (sync or async) from the
resolved connection options.Target platform for multi-arch image selection (e.g. linux/amd64), used when pulling images.
The subset of the
KeyPolicy model a provider can enforce natively.Represents a substrate-neutral policy document containing multiple statements.
The types of supported presigned URL operations
This object contains the information necessary to generate Presigned URLs for upload/download
requests
Response from a presign operation, containing the presigned URL, the headers the substrate
signed into the URL (which the uploader must replay verbatim), and the expiration time.
Kind of identity a
KeyPrincipal identifies.Where cryptographic operations with the key material are performed.
Interface representing a provider in the SDK.
Interface for building Provider instances which is implemented by abstract class for service.
This class will attempt to find a BlobStore provider in the classpath by providerId
This class will attempt to find an IAM provider in the classpath by providerId
This class will attempt to find a KMS provider in the classpath by providerId
This class will attempt to find a PubSub provider in the classpath by providerId.
Finds a registry provider by provider ID (ServiceLoader).
Query provides a fluent interface for building and executing queries against document stores.
Translates a docstore query's filter set into the primitives a Tablestore GetRange request needs:
a primary-key range
[inclusiveStart, exclusiveEnd), a scan Direction, and a
server-side column ColumnValueFilter.The translated GetRange inputs.
Executes a query against the Tablestore native GetRange API (over the base table or a secondary
index by name), producing a resumable
PrimaryKey cursor.QueryRunner for Firestore that creates streaming query clients.
Options for one read operation, with unset values inherited from the client configuration.
Represents a database restore operation.
Request object for restoring a backup to a database table.
Represents the status of a restore operation.
Retention mode for WORM (Write Once Read Many) protection.
Cloud-agnostic retry configuration for MultiCloudJ services.
Retry mode determining the delay calculation strategy between retry attempts.
Object-metadata keys under which the SDK persists observability identifiers from the
OperationContext onto a stored object during upload.Interface for building Provider instances which is implemented by abstract class for service.
Base interface for services backed by substrate-specific implementations.
SignOptions carries optional, substrate-agnostic knobs that influence how a cloud native auth
request is constructed and signed.
Builds an Alibaba SMQ (MNS)
MNSClient from a multicloudj endpoint, credentials, and an
optional proxy.Maps a multicloudj
CredentialsOverrider to an Alibaba credentials provider for the SMQ
(MNS) CloudAccount.Utility class for building SNS clients with common configuration.
SpannerCodec provides utility methods for encoding and decoding data between Java native types
and Google Cloud Spanner's value types.
SpannerDecoder implements the Decoder interface for Google Cloud Spanner.
SpannerEncoder implements the Encoder interface for Google Cloud Spanner.
ListEncoder is a specialized encoder for encoding list elements.
MapEncoder is a specialized encoder for encoding map entries.
Utility class for building SQS clients with common configuration.
Represents a single statement within a policy document.
Custom builder for Statement to handle conditions.
Pre-defined storage service actions for IAM policies.
StsClient class in the Portable Client for interacting with Security Token Service (STS) in a
substrate agnostic way.
Builder class for StsClient.
StsUtilities class provides portable offline Utility functions which utilize the Security Token
Service (STS) in a substrate agnostic way.
Builder class for StsUtilities.
StsVerifier provides portable validation of cloud native auth signed requests.
Builder class for StsVerifier.
High-level client for receiving messages from a pubsub subscription.
Builder for creating SubscriptionClient instances.
Base exception for all multicloudj SDK exceptions.
High-level client for publishing messages to a pubsub topic.
Builder for creating TopicClient instances.
Policy controlling whether SDK operations create OpenTelemetry spans.
Exception thrown when a transaction fails due to conflicts, cancellations, or other
transaction-related issues.
Configuration for trust relationships in identity creation.
Builder class for TrustConfiguration.
The response object returned after uploading an individual part of a multipartUpload
Wrapper object for upload data
Wrapper object for upload result data
ValidateOptions carries optional, substrate-agnostic knobs that influence how a signed cloud
native auth request is validated by a verifier.
Builder for
ValidateOptions.Algorithm used to wrap (encrypt) key material before it is imported.
Size of the RSA public key used to wrap key material before it is imported.