All Classes and Interfaces

Class	Description
AbstractCommandRunner	Execute the command and parse results throwing DataApiResponseException when needed.
AnsiUtils	Helper to log with colors.
ApiData	Represents a segment of the response payload for a JSON API, encapsulating the data returned from a query or operation.
ApiError	Encapsulates error details from a JSON API response.
ApiResponse	Represents the generic response structure for API calls.
ApiResponseHttp	Response HTTP.
Assert	Syntaxic sugar for common validations.
AstraApiEndpoint	Create an endpoint to connect to a database.
AstraDBAdmin	Main Client for AstraDB, it implements administration and Data Api Operations.
AstraDBDatabaseAdmin	Implementation of the DatabaseAdmin interface for Astra.
AuthenticationException	Specialized Error.
AWSEmbeddingHeadersProvider	Implementation of the Embedding Auth Provider for AWS.
BulkWriteOptions	Options used in the `bulkWrite` command.
BulkWriteOptions.Builder	Builder for creating FindOneAndUpdateOptions instances with a fluent API.
BulkWriteResult	Store the list of responses returned by the bulk write.
Collection<T>	A Data API collection, the main object to interact with the Data API, especially for DDL operations.
CollectionIdTypes	List of possible types for the collection 'defaultId'.
CollectionInfo	Represents the Collection definition with its name and metadata.
CollectionOptions	Set of options to define and initialize a collection.
CollectionOptions.CollectionOptionsBuilder	Builder for CollectionInfo.
CollectionOptions.DefaultIdOptions	Subclass representing the indexing options.
CollectionOptions.IndexingOptions	Subclass representing the indexing options.
CollectionOptions.Parameters	Subclass representing a parameters for LLM Services
CollectionOptions.Service	Subclass representing the services options.
CollectionOptions.VectorOptions	Subclass representing the vector options.
Command	Represent a command to be executed against the Data API.
Command.CommandSerializer	Custom serializer for Command class.
CommandObserver	Defines the contract for observers that react to command executions within the DataApiClient.
CommandOptions<T>	Options that will be provided to all commands for this collection.
CommandRunner	Use to initialize the HTTPClient.
CompletableFutures	Utilities to work with Async functions.
CountDocumentsOptions	List Options for a FindOne command.
CustomEJsonCalendarDeserializer	Custom deserializer for EJson Date type.
CustomEJsonCalendarSerializer	Custom Serializer for EJson Date type.
CustomEJsonDateDeserializer	Custom deserializer for EJson Date type.
CustomEJsonDateSerializer	Custom Serializer for EJson Date type.
CustomEJsonInstantDeserializer	Custom deserializer for EJson Date type.
CustomEJsonInstantSerializer	Custom Serializer for EJson Date type.
CustomObjectIdDeserializer	Custom deserializer for EJson Date type.
CustomObjectIdSerializer	Object Id Could be objectId|uuid|uuidv6|uuidv7
CustomUuidDeserializer	Custom deserializer for EJson Date type.
CustomUuidSerializer	Object Id Could be objectId|uuid|uuidv6|uuidv7
CustomUuidv6Serializer	Object Id Could be objectId|uuid|uuidv6|uuidv7
CustomUuidv7Serializer	Object Id Could be objectId|uuid|uuidv6|uuidv7
DataAPIClient	Serves as the primary entry point to the Data API client, offering streamlined access to the functionalities provided by the Data API, whether deployed within Astra environments or on-premise DataStax Enterprise installations.
DataAPIClients	Provides utility methods for initializing and configuring clients to interact with the Data API.
DataAPIDatabaseAdmin	Implementation of Client.
DataApiException	Represents a runtime exception that occurs within the Data API client.
DataAPIFaultyResponseException	Represents a specific kind of DataApiException that is thrown when the response received from the Data API does not match the expected format or content.
DataAPIKeywords	Constants in the JSON API.
DataAPIOptions	Options to set up the client for DataApiClient.
DataAPIOptions.DataAPIClientOptionsBuilder	Builder for the DataAPIClientOptions.
DataAPIOptions.DataAPIDestination	Represent the destination of the data API.
DataAPIOptions.HttpProxy	Subclass to represent an http proxy.
DataApiResponseException	Extends DataApiException to specifically address errors encountered during the processing of responses from the Data API.
Database	A Data API database.
DatabaseAdmin	Defines the core client interface for interacting with the Data API, focusing on CRUD (Create, Read, Update, Delete) operations for namespaces.
DatabaseInfo	Bean representing the database information.
DeleteManyOptions	Options to delete many documents.
DeleteOneOptions	Options to delete One document.
DeleteOneOptions.Builder	Deprecated.
DeleteResult	Hold the result of delete commands (deleteOne, deleteMany).
DistinctIterable<T,F>	Iterator to get all distinct value for a particular field.
DistinctIterator<T,F>	Iterator to retrieve distinct values of a field in a document.
Document	Represents a document without schema constraints as a Map<String, Object>.
EmbeddingAPIKeyHeaderProvider	Default header when working with an embedding service provider.
EmbeddingHeadersProvider	To use the interface embeddings API the user needs to be authenticated against the embedding provider
EmbeddingProvider	Class representing the Embedding Provider returned by findEmbeddingProviders command.
EmbeddingProvider.AuthenticationMethod	Authentication method.
EmbeddingProvider.Model	Model for the service.
EmbeddingProvider.Parameter	Parameters for the service.
EmbeddingProvider.Token	Token method.
EmbeddingProvider.Validation	Validation Component for the parameter.
EstimatedCountDocumentsOptions	List Options for a FindOne command.
ExecutionInfos	Encapsulates detailed information about the execution of a command, including the original request, the raw response, HTTP response details, and timing information.
ExecutionInfos.DataApiExecutionInfoBuilder	Builder class for execution information
Filter	Filter Builder.
FilterBuilder	Helper to build a where clause in natural language (fluent API).
FilterOperator	Ease process of creating a where clause.
Filters	Helper to create Filter
FindEmbeddingProvidersResult	Wrapper to get information about the findEmbeddingProviders.
FindIterable<T>	Represents the result of a 'find' command executed on a collection, providing an iterable interface to navigate through the result set.
FindIterator<T>	Implementing a custom iterator that will load next page if needed when hitting the last item of page.
FindOneAndDeleteOptions	Options to find one and delete.
FindOneAndReplaceOptions	Options used in the `findAndReplace` command.
FindOneAndReplaceResult<T>	Store the result of a findOneAndReplace operation.
FindOneAndUpdateOptions	List options for a findOneAndUpdate command.
FindOneAndUpdateOptions.Builder	Deprecated.
FindOneOptions	List Options for a FindOne command.
FindOptions	List Options for a FindOne command.
HttpClientOptions	Options to set up http Client.
InsertManyOptions	Options for InsertMany
InsertManyOptions.Builder	Deprecated.
InsertManyResult	Represents the result returned by command 'insertMany()', mainly the insertedIds.
InsertOneOptions	Options for InsertOne
InsertOneResult	Represents the result returned by command 'insertOne()', mainly the insertedI
JsonUtils	Custom implementation of serialization : faster + no jackson dependency
KeyspaceInformation	Represents the keyspace definition with its name and metadata.
KeyspaceInformation.ReplicationStrategy	Replication strategies
KeyspaceOptions	Options to create a Namespace.
LoggingCommandObserver	Implements a CommandObserver that logs command execution details.
NamespaceInformation	Deprecated. use KeyspaceInformation instead
NamespaceInformation.ReplicationStrategy	Replication strategies
NamespaceOptions	Deprecated. use KeyspaceOptions instead
ObjectId	A globally unique identifier for objects.
OptionsUtils	Reuse of treatments for options
Page<R>	Hold results for paging
PageableIterable<T>	Helping Iteration on Pages and Documents for DataApi.
Projection	Encode the presence of a field in the result.
Projections	Encode the presence of a field in the result.
ReplaceOneOptions	Options for the replaceOne operation.
ReplaceOneOptions.Builder	Deprecated.
RetryHttpClient	Http Client using JDK11 client with a retry mechanism.
ReturnDocument	Enum to define the return document option.
SimilarityMetric	Similarity metric.
Sort	Class to help building a projection.
SortOrder	Encode the sort order in results.
Sorts	Utility class to hold the sort options for a query.
StaticTokenProvider	Static token, never expires..
TokenProvider	To work the APi needs a token.
TooManyDocumentsToCountException	Error when too many documents in the collection
Update	Encore the update document
UpdateManyOptions	Options for the updateOne operation
UpdateManyOptions.Builder	Deprecated.
UpdateOneOptions	Options for the updateOne operation
UpdateOneOptions.Builder	Deprecated.
UpdateResult	Return update result.
Updates	Helper for Syntax with updates.
UsernamePasswordTokenProvider	Creating a token with base64 encoded credentials.
UUIDv6	Materializing the UUIDv6 as a specialization class to drive serialization and deserialization.
UUIDv7	Materializing the UUIDv6 as a specialization class to drive serialization and deserialization.