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.
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 subscription implementations.
Abstract base class for topic implementations.
AckID is the identifier of a message for purposes of acknowledgement.
Represents an acknowledgment or negative acknowledgment for a message.
Represents a substrate-neutral IAM action.
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
Super-simple class to provide instances of AliTransformer that are specific to a given bucket.
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 provider for registry requests.
HTTP request interceptor that strips Authorization headers when the request target is not the
registry host.
AWS implementation of AsyncBlobStore
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 Elastic Container Registry (ECR) implementation.
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
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.
Codec providers the utility for encoding and decoding the data between java native types to the
target types such as substrate specific types.
Pre-defined compute service actions for IAM policies.
Condition operators for IAM policy conditions.
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
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.
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>.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.
Encoder defines methods for encoding various data types into a target format.
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.
Utility class for handling and propagating exceptions in the Substrate SDK.
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.
GCP Artifact Registry implementation.
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.
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.
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
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.
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).
OCI Registry API v2 HTTP client; handles auth and registry operations.
Target platform for multi-arch image selection (e.g. linux/amd64), used when pulling images.
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
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 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.
QueryRunner stores the information about how to query/scan the data from the tablestore. and
exposes a run method to execute the query and get the data.
QueryRunner for Firestore that creates streaming query clients.
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.
Interface for building Provider instances which is implemented by abstract class for service.
Base interface for services backed by substrate-specific implementations.
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.
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.
High-level client for receiving messages from a pubsub subscription.
Builder for creating SubscriptionClient instances.
High-level client for publishing messages to a pubsub topic.
Builder for creating TopicClient instances.
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