Index

A B C D E F G H I J K L M N O P Q R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractCommandRunner - Class in com.datastax.astra.internal.command

Execute the command and parse results throwing DataApiResponseException when needed.

AbstractCommandRunner() - Constructor for class com.datastax.astra.internal.command.AbstractCommandRunner

Default constructor.

active - Variable in class com.datastax.astra.client.model.PageableIterable

The iterable is active and progressing on the results.

addToSet(String, Object) - Method in class com.datastax.astra.client.model.Update

Builder pattern

addToSet(String, Object) - Static method in class com.datastax.astra.client.model.Updates

Initialize an with the key and value.

AFTER - Enum constant in enum com.datastax.astra.client.model.ReturnDocument

if set to after, the command will return the document after the update

all() - Method in class com.datastax.astra.client.model.DistinctIterable

Will exhaust the list and put all value in memory.

all() - Method in class com.datastax.astra.client.model.FindIterable

Will exhaust the list and put all value in memory.

all(String, Object...) - Static method in class com.datastax.astra.client.model.Filters

Build a filter with the `$all` operator.

ALL - Enum constant in enum com.datastax.astra.client.model.DataAPIKeywords

ALL.

allDone(List<CompletionStage<T>>) - Static method in class com.datastax.astra.internal.utils.CompletableFutures

Merge multiple CompletionStage in a single one

and(Filter...) - Static method in class com.datastax.astra.client.model.Filters

Creates a filter that performs a logical AND of the provided list of filters.

and(Iterable<Filter>) - Static method in class com.datastax.astra.client.model.Filters

Creates a filter that performs a logical AND of the provided list of filters.

ANSI_CYAN - Static variable in class com.datastax.astra.internal.utils.AnsiUtils

Color.

ANSI_GREEN - Static variable in class com.datastax.astra.internal.utils.AnsiUtils

Color.

ANSI_MAGENTA - Static variable in class com.datastax.astra.internal.utils.AnsiUtils

Color.

ANSI_RESET - Static variable in class com.datastax.astra.internal.utils.AnsiUtils

Color.

ANSI_YELLOW - Static variable in class com.datastax.astra.internal.utils.AnsiUtils

Color.

AnsiUtils - Class in com.datastax.astra.internal.utils

Helper to log with colors.

ApiData - Class in com.datastax.astra.internal.api

Represents a segment of the response payload for a JSON API, encapsulating the data returned from a query or operation.

ApiData() - Constructor for class com.datastax.astra.internal.api.ApiData

Default constructor for ApiData.

ApiError - Class in com.datastax.astra.internal.api

Encapsulates error details from a JSON API response.

ApiError() - Constructor for class com.datastax.astra.internal.api.ApiError

Default constructor for ApiError.

ApiResponse - Class in com.datastax.astra.internal.api

Represents the generic response structure for API calls.

ApiResponse() - Constructor for class com.datastax.astra.internal.api.ApiResponse

Default constructor for ApiResponse.

ApiResponseHttp - Class in com.datastax.astra.internal.api

Response HTTP.

ApiResponseHttp(String, int) - Constructor for class com.datastax.astra.internal.api.ApiResponseHttp

Defaut constructor.

ApiResponseHttp(String, int, Map<String, String>) - Constructor for class com.datastax.astra.internal.api.ApiResponseHttp

Full constructor.

append(String, Object) - Method in class com.datastax.astra.client.model.Command

Builder pattern, update documents.

append(String, Object) - Method in class com.datastax.astra.client.model.Document

Put the given key/value pair into this Document and return this.

appendIfNotNull(String, Object) - Method in class com.datastax.astra.client.model.Document

Put the given key/value pair into this Document and return this only if the value is not null

ascending(String) - Static method in class com.datastax.astra.client.model.Sorts

Build a sort clause ascending.

ASCENDING - Enum constant in enum com.datastax.astra.client.model.SortOrder

Value for ascending order.

Assert - Class in com.datastax.astra.internal.utils

Syntaxic sugar for common validations.

ASTRA - Enum constant in enum com.datastax.astra.client.DataAPIOptions.DataAPIDestination

Astra Production environment

ASTRA_DEV - Enum constant in enum com.datastax.astra.client.DataAPIOptions.DataAPIDestination

Astra Development environment

ASTRA_TEST - Enum constant in enum com.datastax.astra.client.DataAPIOptions.DataAPIDestination

Astra Test environment

AstraApiEndpoint - Class in com.datastax.astra.internal.api

Create an endpoint to connect to a database.

AstraApiEndpoint() - Constructor for class com.datastax.astra.internal.api.AstraApiEndpoint

Default constructor.

AstraApiEndpoint(UUID, String, AstraEnvironment) - Constructor for class com.datastax.astra.internal.api.AstraApiEndpoint

Constructor with chunk of the URL.

AstraDBAdmin - Class in com.datastax.astra.client.admin

Main Client for AstraDB, it implements administration and Data Api Operations.

AstraDBAdmin(String, AstraEnvironment, DataAPIOptions) - Constructor for class com.datastax.astra.client.admin.AstraDBAdmin

Initialization with an authentication token and target environment, Use this constructor for testing purpose.

AstraDBDatabaseAdmin - Class in com.datastax.astra.client.admin

Implementation of the DatabaseAdmin interface for Astra.

AstraDBDatabaseAdmin(Database) - Constructor for class com.datastax.astra.client.admin.AstraDBDatabaseAdmin

Initialize a database admin from token and database id.

AstraDBDatabaseAdmin(String, UUID, AstraEnvironment, DataAPIOptions) - Constructor for class com.datastax.astra.client.admin.AstraDBDatabaseAdmin

Initialize a database admin from token and database id.

AUTHENTICATION_METHOD_HEADER - Static variable in class com.datastax.astra.client.model.EmbeddingProvider

Keys for the supported authentication methods

AUTHENTICATION_METHOD_NONE - Static variable in class com.datastax.astra.client.model.EmbeddingProvider

Keys for the supported authentication methods

AUTHENTICATION_METHOD_SHARED_SECRET - Static variable in class com.datastax.astra.client.model.EmbeddingProvider

Keys for the supported authentication methods

AuthenticationException - Exception Class in com.datastax.astra.client.exception

Specialized Error.

AuthenticationException(String) - Constructor for exception class com.datastax.astra.client.exception.AuthenticationException

Constructor with message

AuthenticationMethod() - Constructor for class com.datastax.astra.client.model.EmbeddingProvider.AuthenticationMethod

Default constructor.

available() - Method in class com.datastax.astra.client.model.FindIterator

Gets the number of results available locally without blocking, which may be 0.

AWSEmbeddingHeadersProvider - Class in com.datastax.astra.client.auth

Implementation of the Embedding Auth Provider for AWS.

AWSEmbeddingHeadersProvider(String, String) - Constructor for class com.datastax.astra.client.auth.AWSEmbeddingHeadersProvider

Constructor.

B

BEFORE - Enum constant in enum com.datastax.astra.client.model.ReturnDocument

if set to before, the command will return the document before the update

build() - Method in class com.datastax.astra.client.DataAPIOptions.DataAPIClientOptionsBuilder

Build the options.

build() - Method in class com.datastax.astra.client.model.CollectionOptions.CollectionOptionsBuilder

Build the output.

build() - Method in class com.datastax.astra.internal.command.ExecutionInfos.DataApiExecutionInfoBuilder

Invoke constructor with the builder.

builder() - Static method in class com.datastax.astra.client.DataAPIOptions

Initializer for the builder.

builder() - Static method in class com.datastax.astra.client.model.CollectionOptions

Gets a builder.

builder() - Static method in class com.datastax.astra.internal.command.ExecutionInfos

Initialize our custom builder.

builtHttpRequest(String, String, String, String, String) - Method in class com.datastax.astra.internal.http.RetryHttpClient

Help to build the HTTP request.

bulkWrite(List<Command>) - Method in class com.datastax.astra.client.Collection

Deprecated, for removal: This API element is subject to removal in a future version.

bulkWrite(List<Command>, BulkWriteOptions) - Method in class com.datastax.astra.client.Collection

Deprecated, for removal: This API element is subject to removal in a future version.

BulkWriteOptions - Class in com.datastax.astra.client.model

Options used in the `bulkWrite` command.

BulkWriteOptions() - Constructor for class com.datastax.astra.client.model.BulkWriteOptions

Default constructor.

BulkWriteOptions.Builder - Class in com.datastax.astra.client.model

Builder for creating FindOneAndUpdateOptions instances with a fluent API.

BulkWriteResult - Class in com.datastax.astra.client.model

Store the list of responses returned by the bulk write.

BulkWriteResult(int) - Constructor for class com.datastax.astra.client.model.BulkWriteResult

Constructor with the number of operations.

C

CASSANDRA - Enum constant in enum com.datastax.astra.client.DataAPIOptions.DataAPIDestination

Local installation of Apache Cassandra

chunkSize(int) - Static method in class com.datastax.astra.client.model.InsertManyOptions.Builder

Deprecated.

Initializes the building process with chunkSize options.

chunkSize(int) - Method in class com.datastax.astra.client.model.InsertManyOptions

Setter for chunkSize.

clear() - Method in class com.datastax.astra.client.model.Document

close() - Method in class com.datastax.astra.client.model.PageableIterable

When no more items available.

collection - Variable in class com.datastax.astra.client.model.PageableIterable

Reference to the collection in use.

Collection<T> - Class in com.datastax.astra.client

A Data API collection, the main object to interact with the Data API, especially for DDL operations.

Collection(Database, String, CommandOptions<?>, Class<T>) - Constructor for class com.datastax.astra.client.Collection

Constructs an instance of a collection within the specified database.

collectionExists(String) - Method in class com.datastax.astra.client.Database

Evaluate if a collection exists.

CollectionIdTypes - Enum in com.datastax.astra.client.model

List of possible types for the collection 'defaultId'.

CollectionInfo - Class in com.datastax.astra.client.model

Represents the Collection definition with its name and metadata.

CollectionInfo() - Constructor for class com.datastax.astra.client.model.CollectionInfo

Default constructor.

CollectionOptions - Class in com.datastax.astra.client.model

Set of options to define and initialize a collection.

CollectionOptions() - Constructor for class com.datastax.astra.client.model.CollectionOptions

Default constructor.

CollectionOptions.CollectionOptionsBuilder - Class in com.datastax.astra.client.model

Builder for CollectionInfo.

CollectionOptions.DefaultIdOptions - Class in com.datastax.astra.client.model

Subclass representing the indexing options.

CollectionOptions.IndexingOptions - Class in com.datastax.astra.client.model

Subclass representing the indexing options.

CollectionOptions.Parameters - Class in com.datastax.astra.client.model

Subclass representing a parameters for LLM Services

CollectionOptions.Service - Class in com.datastax.astra.client.model

Subclass representing the services options.

CollectionOptions.VectorOptions - Class in com.datastax.astra.client.model

Subclass representing the vector options.

CollectionOptionsBuilder() - Constructor for class com.datastax.astra.client.model.CollectionOptions.CollectionOptionsBuilder

Default constructor.

com.datastax.astra.client - package com.datastax.astra.client

Entrypoint and core classes for the client.

com.datastax.astra.client.admin - package com.datastax.astra.client.admin

Administration classes to manage Databases and Namespaces.

com.datastax.astra.client.auth - package com.datastax.astra.client.auth

Internal technical classes to authenticate against API endpoint.

com.datastax.astra.client.exception - package com.datastax.astra.client.exception

Exceptions specialized checked and unchecked thrown by the client.

com.datastax.astra.client.model - package com.datastax.astra.client.model

Domain model classes with Requests, Results, Options and Iterables.

com.datastax.astra.internal - package com.datastax.astra.internal

Internal technical classes

com.datastax.astra.internal.api - package com.datastax.astra.internal.api

Internal technical classes to marshall API responses

com.datastax.astra.internal.command - package com.datastax.astra.internal.command

Internal technical classes to run commands against the API.

com.datastax.astra.internal.http - package com.datastax.astra.internal.http

Internal technical classes to execute HTTP requests.

com.datastax.astra.internal.utils - package com.datastax.astra.internal.utils

Internal technical classes for low-level utilities

Command - Class in com.datastax.astra.client.model

Represent a command to be executed against the Data API.

Command() - Constructor for class com.datastax.astra.client.model.Command

Default constructor.

Command(String) - Constructor for class com.datastax.astra.client.model.Command

Constructor with a name.

Command(String, Document) - Constructor for class com.datastax.astra.client.model.Command

Specialization of the command.

Command.CommandSerializer - Class in com.datastax.astra.client.model

Custom serializer for Command class.

CommandObserver - Interface in com.datastax.astra.internal.command

Defines the contract for observers that react to command executions within the DataApiClient.

commandOptions - Variable in class com.datastax.astra.internal.command.AbstractCommandRunner

Default command options when not override

CommandOptions<T> - Class in com.datastax.astra.client.model

Options that will be provided to all commands for this collection.

CommandOptions() - Constructor for class com.datastax.astra.client.model.CommandOptions

Default Constructor.

CommandRunner - Interface in com.datastax.astra.client.model

Use to initialize the HTTPClient.

CommandSerializer() - Constructor for class com.datastax.astra.client.model.Command.CommandSerializer

Default constructor.

CommandSerializer(Class<Command>) - Constructor for class com.datastax.astra.client.model.Command.CommandSerializer

Constructor with the class in used.

compareTo(ObjectId) - Method in class com.datastax.astra.client.model.ObjectId

CompletableFutures - Class in com.datastax.astra.internal.utils

Utilities to work with Async functions.

concurrency(int) - Static method in class com.datastax.astra.client.model.BulkWriteOptions.Builder

Initializes the building process with concurrency options.

concurrency(int) - Method in class com.datastax.astra.client.model.BulkWriteOptions

Setter for concurrency.

concurrency(int) - Static method in class com.datastax.astra.client.model.InsertManyOptions.Builder

Deprecated.

Initializes the building process with concurrency options.

concurrency(int) - Method in class com.datastax.astra.client.model.InsertManyOptions

Setter for concurrency.

CONTAIN_ENTRY - Enum constant in enum com.datastax.astra.client.model.FilterOperator

Contains Entry.

CONTAIN_KEY - Enum constant in enum com.datastax.astra.client.model.FilterOperator

Contains Key.

CONTAINS - Enum constant in enum com.datastax.astra.client.model.FilterOperator

Contains.

containsKey(Object) - Method in class com.datastax.astra.client.model.Document

containsValue(Object) - Method in class com.datastax.astra.client.model.Document

CONTENT_TYPE_GRAPHQL - Static variable in class com.datastax.astra.internal.http.RetryHttpClient

Headers, Api is usig JSON

CONTENT_TYPE_JSON - Static variable in class com.datastax.astra.internal.http.RetryHttpClient

Headers, Api is usig JSON

convertValue(Object, Class<T>) - Static method in class com.datastax.astra.internal.utils.JsonUtils

Jackson deserialization.

COSINE - Enum constant in enum com.datastax.astra.client.model.SimilarityMetric

Distance with cosine.

countDocuments(int) - Method in class com.datastax.astra.client.Collection

Counts the number of documents in the collection.

countDocuments(Filter, int) - Method in class com.datastax.astra.client.Collection

Implementation of the @see Collection.countDocuments(Filter, int, CountDocumentsOptions) method with default options.

countDocuments(Filter, int, CountDocumentsOptions) - Method in class com.datastax.astra.client.Collection

Counts the number of documents in the collection with a filter.

CountDocumentsOptions - Class in com.datastax.astra.client.model

List Options for a FindOne command.

CountDocumentsOptions() - Constructor for class com.datastax.astra.client.model.CountDocumentsOptions

Default constructor.

create() - Static method in class com.datastax.astra.client.model.Document

Create a document with no attributes.

create() - Static method in class com.datastax.astra.client.model.Update

Allow to creat a new instance.

create(Object) - Static method in class com.datastax.astra.client.model.Document

Create a document with an id.

create(String) - Static method in class com.datastax.astra.client.DataAPIClients

Creates a DataAPIClient configured for interaction with Astra, DataStax's cloud-native database as a service.

create(String) - Static method in class com.datastax.astra.client.model.Command

Create an empty command from its name.

createCollection(String) - Method in class com.datastax.astra.client.Database

Create a new collection with the given name.

createCollection(String, int, SimilarityMetric) - Method in class com.datastax.astra.client.Database

Create a default new collection for vector.

createCollection(String, int, SimilarityMetric, Class<T>) - Method in class com.datastax.astra.client.Database

Create a default new collection for vector.

createCollection(String, CollectionOptions) - Method in class com.datastax.astra.client.Database

Create a new collection with the given name.

createCollection(String, CollectionOptions, CommandOptions<?>) - Method in class com.datastax.astra.client.Database

Create a new collection with the given name.

createCollection(String, CollectionOptions, CommandOptions<?>, Class<T>) - Method in class com.datastax.astra.client.Database

Create a new collection with the selected options

createCollection(String, CollectionOptions, Class<T>) - Method in class com.datastax.astra.client.Database

Create a new collection with the given name.

createCollection(String, Class<T>) - Method in class com.datastax.astra.client.Database

Create a new collection with the given name.

createDatabase(String) - Method in class com.datastax.astra.client.admin.AstraDBAdmin

Create new database with a name on free tier.

createDatabase(String, CloudProviderType, String) - Method in class com.datastax.astra.client.admin.AstraDBAdmin

Create new database with a name on the specified cloud provider and region.

createDatabase(String, CloudProviderType, String, boolean) - Method in class com.datastax.astra.client.admin.AstraDBAdmin

Create new database with a name on the specified cloud provider and region.

createDefaultLocalDatabase() - Static method in class com.datastax.astra.client.DataAPIClients

Creates and configures a Database client specifically designed for interaction with a local instance of Stargate.

createForAstraDev(String) - Static method in class com.datastax.astra.client.DataAPIClients

Creates a DataAPIClient configured for interacting with Astra in a development environment.

createForAstraTest(String) - Static method in class com.datastax.astra.client.DataAPIClients

Creates a DataAPIClient specifically configured for interacting with Astra in a test environment.

createForLocal() - Static method in class com.datastax.astra.client.DataAPIClients

Creates and configures a DataAPIClient for interaction with a local instance of Stargate, a data gateway for working with Apache Cassandra®.

createKeyspace(String) - Method in interface com.datastax.astra.client.admin.DatabaseAdmin

Syntax Sugar, retro compatible.

createKeyspace(String, boolean) - Method in class com.datastax.astra.client.admin.AstraDBDatabaseAdmin

createKeyspace(String, boolean) - Method in class com.datastax.astra.client.admin.DataAPIDatabaseAdmin

Create a Keyspace providing a name.

createKeyspace(String, boolean) - Method in interface com.datastax.astra.client.admin.DatabaseAdmin

Create a Keyspace providing a name.

createKeyspace(String, KeyspaceOptions) - Method in class com.datastax.astra.client.admin.DataAPIDatabaseAdmin

Allow to create a keyspace with full-fledged definition

createKeyspaceAsync(String) - Method in interface com.datastax.astra.client.admin.DatabaseAdmin

Create a keyspace providing a name.

createNamespace(String) - Method in class com.datastax.astra.client.admin.AstraDBDatabaseAdmin

Syntax Sugar, retro compatible.

createNamespace(String) - Method in interface com.datastax.astra.client.admin.DatabaseAdmin

Deprecated.

Use DatabaseAdmin.createKeyspace(String) ()} instead.

createNamespace(String, boolean) - Method in class com.datastax.astra.client.admin.AstraDBDatabaseAdmin

Create a Keyspace providing a name.

createNamespace(String, boolean) - Method in class com.datastax.astra.client.admin.DataAPIDatabaseAdmin

Deprecated.

createNamespace(String, boolean) - Method in interface com.datastax.astra.client.admin.DatabaseAdmin

Deprecated.

Use DatabaseAdmin.createKeyspace(String, boolean) instead.

createNamespace(String, NamespaceOptions) - Method in class com.datastax.astra.client.admin.DataAPIDatabaseAdmin

Deprecated.

use DataAPIDatabaseAdmin.createKeyspace(String, KeyspaceOptions) instead

createNamespaceAsync(String) - Method in interface com.datastax.astra.client.admin.DatabaseAdmin

Deprecated.

Use DatabaseAdmin.createKeyspaceAsync(String) instead.

currentPage - Variable in class com.datastax.astra.client.model.PageableIterable

The current page in use.

currentPageAvailable - Variable in class com.datastax.astra.client.model.PageableIterable

Number of items still available to retrieve in this page.

currentPageIterator - Variable in class com.datastax.astra.client.model.DistinctIterable

Iterator on fields.

currentPageIterator - Variable in class com.datastax.astra.client.model.FindIterable

Iterator on documents.

CustomEJsonCalendarDeserializer - Class in com.datastax.astra.internal.utils

Custom deserializer for EJson Date type.

CustomEJsonCalendarDeserializer() - Constructor for class com.datastax.astra.internal.utils.CustomEJsonCalendarDeserializer

Default constructor.

CustomEJsonCalendarSerializer - Class in com.datastax.astra.internal.utils

Custom Serializer for EJson Date type.

CustomEJsonCalendarSerializer() - Constructor for class com.datastax.astra.internal.utils.CustomEJsonCalendarSerializer

Default constructor.

CustomEJsonCalendarSerializer(Class<Calendar>) - Constructor for class com.datastax.astra.internal.utils.CustomEJsonCalendarSerializer

Constructor with type

CustomEJsonDateDeserializer - Class in com.datastax.astra.internal.utils

Custom deserializer for EJson Date type.

CustomEJsonDateDeserializer() - Constructor for class com.datastax.astra.internal.utils.CustomEJsonDateDeserializer

Default constructor.

CustomEJsonDateSerializer - Class in com.datastax.astra.internal.utils

Custom Serializer for EJson Date type.

CustomEJsonDateSerializer() - Constructor for class com.datastax.astra.internal.utils.CustomEJsonDateSerializer

Default constructor.

CustomEJsonDateSerializer(Class<Date>) - Constructor for class com.datastax.astra.internal.utils.CustomEJsonDateSerializer

Constructor with type

CustomEJsonInstantDeserializer - Class in com.datastax.astra.internal.utils

Custom deserializer for EJson Date type.

CustomEJsonInstantDeserializer() - Constructor for class com.datastax.astra.internal.utils.CustomEJsonInstantDeserializer

Default constructor.

CustomEJsonInstantSerializer - Class in com.datastax.astra.internal.utils

Custom Serializer for EJson Date type.

CustomEJsonInstantSerializer() - Constructor for class com.datastax.astra.internal.utils.CustomEJsonInstantSerializer

Default constructor.

CustomEJsonInstantSerializer(Class<Instant>) - Constructor for class com.datastax.astra.internal.utils.CustomEJsonInstantSerializer

Constructor with type

CustomObjectIdDeserializer - Class in com.datastax.astra.internal.utils

Custom deserializer for EJson Date type.

CustomObjectIdDeserializer() - Constructor for class com.datastax.astra.internal.utils.CustomObjectIdDeserializer

Default constructor.

CustomObjectIdSerializer - Class in com.datastax.astra.internal.utils

Object Id Could be objectId|uuid|uuidv6|uuidv7

CustomObjectIdSerializer() - Constructor for class com.datastax.astra.internal.utils.CustomObjectIdSerializer

Default constructor.

CustomObjectIdSerializer(Class<ObjectId>) - Constructor for class com.datastax.astra.internal.utils.CustomObjectIdSerializer

Constructor with type

CustomUuidDeserializer - Class in com.datastax.astra.internal.utils

Custom deserializer for EJson Date type.

CustomUuidDeserializer() - Constructor for class com.datastax.astra.internal.utils.CustomUuidDeserializer

Default constructor.

CustomUuidSerializer - Class in com.datastax.astra.internal.utils

Object Id Could be objectId|uuid|uuidv6|uuidv7

CustomUuidSerializer() - Constructor for class com.datastax.astra.internal.utils.CustomUuidSerializer

Default constructor.

CustomUuidSerializer(Class<UUID>) - Constructor for class com.datastax.astra.internal.utils.CustomUuidSerializer

Constructor with type

CustomUuidv6Serializer - Class in com.datastax.astra.internal.utils

Object Id Could be objectId|uuid|uuidv6|uuidv7

CustomUuidv6Serializer() - Constructor for class com.datastax.astra.internal.utils.CustomUuidv6Serializer

Default constructor.

CustomUuidv6Serializer(Class<UUIDv6>) - Constructor for class com.datastax.astra.internal.utils.CustomUuidv6Serializer

Constructor with type

CustomUuidv7Serializer - Class in com.datastax.astra.internal.utils

Object Id Could be objectId|uuid|uuidv6|uuidv7

CustomUuidv7Serializer() - Constructor for class com.datastax.astra.internal.utils.CustomUuidv7Serializer

Default constructor.

CustomUuidv7Serializer(Class<UUIDv7>) - Constructor for class com.datastax.astra.internal.utils.CustomUuidv7Serializer

Constructor with type

cyan(String) - Static method in class com.datastax.astra.internal.utils.AnsiUtils

write cyan.

D

DataAPIClient - Class in com.datastax.astra.client

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.

DataAPIClient(String) - Constructor for class com.datastax.astra.client.DataAPIClient

Constructs a DataAPIClient instance using the specified authentication token.

DataAPIClient(String, DataAPIOptions) - Constructor for class com.datastax.astra.client.DataAPIClient

Constructs a DataAPIClient with specified authentication token and HTTP client configuration options.

DataAPIClientOptionsBuilder() - Constructor for class com.datastax.astra.client.DataAPIOptions.DataAPIClientOptionsBuilder

Default constructor.

DataAPIClients - Class in com.datastax.astra.client

Provides utility methods for initializing and configuring clients to interact with the Data API.

DataAPIDatabaseAdmin - Class in com.datastax.astra.client.admin

Implementation of Client.

DataAPIDatabaseAdmin(Database) - Constructor for class com.datastax.astra.client.admin.DataAPIDatabaseAdmin

Initialize a database admin from token and database id.

DataAPIDatabaseAdmin(String, String, DataAPIOptions) - Constructor for class com.datastax.astra.client.admin.DataAPIDatabaseAdmin

Initialize a database admin from token and database id.

DataApiException - Exception Class in com.datastax.astra.client.exception

Represents a runtime exception that occurs within the Data API client.

DataApiException(String, String) - Constructor for exception class com.datastax.astra.client.exception.DataApiException

Constructors providing all arguments and a parent exception.

DataApiException(String, String, Throwable) - Constructor for exception class com.datastax.astra.client.exception.DataApiException

Constructors providing all arguments and a parent exception.

DataApiExecutionInfoBuilder() - Constructor for class com.datastax.astra.internal.command.ExecutionInfos.DataApiExecutionInfoBuilder

Default constructor.

DataAPIFaultyResponseException - Exception Class in com.datastax.astra.client.exception

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.

DataAPIFaultyResponseException(Command, ApiResponse, String) - Constructor for exception class com.datastax.astra.client.exception.DataAPIFaultyResponseException

Constructs a new exception with the specified command that triggered the error, the API response received, and a custom error message.

DataAPIKeywords - Enum in com.datastax.astra.client.model

Constants in the JSON API.

DataAPIOptions - Class in com.datastax.astra.client

Options to set up the client for DataApiClient.

DataAPIOptions.DataAPIClientOptionsBuilder - Class in com.datastax.astra.client

Builder for the DataAPIClientOptions.

DataAPIOptions.DataAPIDestination - Enum in com.datastax.astra.client

Represent the destination of the data API.

DataAPIOptions.HttpProxy - Class in com.datastax.astra.client

Subclass to represent an http proxy.

DataApiResponseException - Exception Class in com.datastax.astra.client.exception

Extends DataApiException to specifically address errors encountered during the processing of responses from the Data API.

DataApiResponseException(List<ExecutionInfos>) - Constructor for exception class com.datastax.astra.client.exception.DataApiResponseException

Constructor with list of constructors.

Database - Class in com.datastax.astra.client

A Data API database.

Database(String, String) - Constructor for class com.datastax.astra.client.Database

Initialization with endpoint and apikey.

Database(String, String, String) - Constructor for class com.datastax.astra.client.Database

Initialization with endpoint and apikey.

Database(String, String, String, DataAPIOptions) - Constructor for class com.datastax.astra.client.Database

Initialization with endpoint and apikey.

DatabaseAdmin - Interface in com.datastax.astra.client.admin

Defines the core client interface for interacting with the Data API, focusing on CRUD (Create, Read, Update, Delete) operations for namespaces.

databaseExists(String) - Method in class com.datastax.astra.client.admin.AstraDBAdmin

Return true if the database exists.

databaseExists(UUID) - Method in class com.datastax.astra.client.admin.AstraDBAdmin

Return true if the database exists.

DatabaseInfo - Class in com.datastax.astra.client.model

Bean representing the database information.

DatabaseInfo(Database) - Constructor for class com.datastax.astra.client.model.DatabaseInfo

Initializing a database information representation by leveraging devops internal API and omitting technical internal information.

DATE - Enum constant in enum com.datastax.astra.client.model.DataAPIKeywords

ALL.

db - Variable in class com.datastax.astra.client.admin.AstraDBDatabaseAdmin

Database if initialized from the DB.

db - Variable in class com.datastax.astra.client.admin.DataAPIDatabaseAdmin

Database if initialized from the DB.

DEFAULT_CALLER_NAME - Static variable in class com.datastax.astra.client.DataAPIOptions

Default user agent.

DEFAULT_CALLER_VERSION - Static variable in class com.datastax.astra.client.DataAPIOptions

Default user agent.

DEFAULT_CONNECT_TIMEOUT_MILLIS_SECONDS - Static variable in class com.datastax.astra.client.DataAPIOptions

Default timeout for initiating connection.

DEFAULT_CONNECT_TIMEOUT_SECONDS - Static variable in class com.datastax.astra.client.model.HttpClientOptions

Default timeout for initiating connection.

DEFAULT_CREDENTIALS - Static variable in class com.datastax.astra.client.auth.UsernamePasswordTokenProvider

Default password for Cassandra.

DEFAULT_ENDPOINT_LOCAL - Static variable in class com.datastax.astra.client.DataAPIClients

Default Http endpoint for local deployment.

DEFAULT_ERROR_CODE - Static variable in exception class com.datastax.astra.client.exception.DataApiException

Default error code.

DEFAULT_ERROR_MESSAGE - Static variable in exception class com.datastax.astra.client.exception.DataApiException

Default error message.

DEFAULT_KEYSPACE - Static variable in class com.datastax.astra.client.admin.AstraDBAdmin

Default keyspace (same created by the ui).

DEFAULT_MAX_CHUNK_SIZE - Static variable in class com.datastax.astra.client.DataAPIOptions

Maximum number of documents when you insert.

DEFAULT_MAX_DOCUMENTS_COUNT - Static variable in class com.datastax.astra.client.DataAPIOptions

Number of documents for a count.

DEFAULT_MAX_PAGE_SIZE - Static variable in class com.datastax.astra.client.DataAPIOptions

Maximum number of documents in a page.

DEFAULT_NAMESPACE - Static variable in class com.datastax.astra.client.admin.AstraDBAdmin

Deprecated.

DEFAULT_REQUEST_TIMEOUT_MILLIS_SECONDS - Static variable in class com.datastax.astra.client.DataAPIOptions

Default timeout for initiating connection.

DEFAULT_REQUEST_TIMEOUT_MILLISECONDS - Static variable in class com.datastax.astra.client.model.HttpClientOptions

Default timeout for initiating connection.

DEFAULT_RETRY_COUNT - Static variable in class com.datastax.astra.client.DataAPIOptions

Default retry count.

DEFAULT_RETRY_COUNT - Static variable in class com.datastax.astra.client.model.HttpClientOptions

Default retry count.

DEFAULT_RETRY_DELAY_MILLIS - Static variable in class com.datastax.astra.client.DataAPIOptions

Default retry delay.

DEFAULT_RETRY_DELAY_MILLIS - Static variable in class com.datastax.astra.client.model.HttpClientOptions

Default retry delay.

DEFAULT_URL - Static variable in class com.datastax.astra.client.auth.UsernamePasswordTokenProvider

Default URL for local deployments.

DEFAULT_USER_AGENT - Static variable in class com.datastax.astra.client.model.HttpClientOptions

Default user agent.

DEFAULT_USERNAME - Static variable in class com.datastax.astra.client.auth.UsernamePasswordTokenProvider

Default username for Cassandra.

DEFAULT_VERSION - Static variable in class com.datastax.astra.client.DataAPIOptions

path for json api.

DefaultIdOptions() - Constructor for class com.datastax.astra.client.model.CollectionOptions.DefaultIdOptions

Default constructor.

DefaultIdOptions(String) - Constructor for class com.datastax.astra.client.model.CollectionOptions.DefaultIdOptions

Default constructor.

defaultIdType(CollectionIdTypes) - Method in class com.datastax.astra.client.model.CollectionOptions.CollectionOptionsBuilder

Builder Pattern with the Identifiers.

deleteAll() - Method in class com.datastax.astra.client.Collection

Removes all documents from the collection that match the given query filter.

deleteListener(String) - Method in class com.datastax.astra.client.Collection

Register a listener to execute commands on the collection.

deleteListener(String) - Method in class com.datastax.astra.client.Database

Register a listener to execute commands on the collection.

deleteMany(Filter) - Method in class com.datastax.astra.client.Collection

Removes all documents from the collection that match the given query filter.

deleteMany(Filter, DeleteManyOptions) - Method in class com.datastax.astra.client.Collection

Removes all documents from the collection that match the given query filter.

DeleteManyOptions - Class in com.datastax.astra.client.model

Options to delete many documents.

DeleteManyOptions() - Constructor for class com.datastax.astra.client.model.DeleteManyOptions

Default constructor.

deleteOne(Filter) - Method in class com.datastax.astra.client.Collection

Removes at most one document from the collection that matches the given filter.

deleteOne(Filter, DeleteOneOptions) - Method in class com.datastax.astra.client.Collection

Removes at most one document from the collection that matches the given filter.

DeleteOneOptions - Class in com.datastax.astra.client.model

Options to delete One document.

DeleteOneOptions() - Constructor for class com.datastax.astra.client.model.DeleteOneOptions

Default constructor.

DeleteOneOptions.Builder - Class in com.datastax.astra.client.model

Deprecated.

DeleteResult - Class in com.datastax.astra.client.model

Hold the result of delete commands (deleteOne, deleteMany).

DeleteResult(int) - Constructor for class com.datastax.astra.client.model.DeleteResult

Default constructor.

descending(String) - Static method in class com.datastax.astra.client.model.Sorts

Build a sort clause DESCENDING.

DESCENDING - Enum constant in enum com.datastax.astra.client.model.SortOrder

Value for descending order.

deserialize(JsonParser, DeserializationContext) - Method in class com.datastax.astra.internal.utils.CustomEJsonCalendarDeserializer

deserialize(JsonParser, DeserializationContext) - Method in class com.datastax.astra.internal.utils.CustomEJsonDateDeserializer

deserialize(JsonParser, DeserializationContext) - Method in class com.datastax.astra.internal.utils.CustomEJsonInstantDeserializer

deserialize(JsonParser, DeserializationContext) - Method in class com.datastax.astra.internal.utils.CustomObjectIdDeserializer

deserialize(JsonParser, DeserializationContext) - Method in class com.datastax.astra.internal.utils.CustomUuidDeserializer

distinct(String, Filter, Class<F>) - Method in class com.datastax.astra.client.Collection

Gets the distinct values of the specified field name.

distinct(String, Class<F>) - Method in class com.datastax.astra.client.Collection

Gets the distinct values of the specified field name.

DistinctIterable<T,F> - Class in com.datastax.astra.client.model

Iterator to get all distinct value for a particular field.

DistinctIterable(Collection<T>, String, Filter, Class<F>) - Constructor for class com.datastax.astra.client.model.DistinctIterable

Constructs an iterable that provides distinct elements from a specified collection, optionally filtered by a given criterion.

DistinctIterator<T,F> - Class in com.datastax.astra.client.model

Iterator to retrieve distinct values of a field in a document.

DistinctIterator(PageableIterable<T>, String, Class<F>) - Constructor for class com.datastax.astra.client.model.DistinctIterator

Starting the cursor on an iterable to fetch more pages.

Document - Class in com.datastax.astra.client.model

Represents a document without schema constraints as a Map<String, Object>.

Document() - Constructor for class com.datastax.astra.client.model.Document

Default Constructor.

Document(Object) - Constructor for class com.datastax.astra.client.model.Document

Default Constructor.

Document(Map<String, ?>) - Constructor for class com.datastax.astra.client.model.Document

Creates a Document instance initialized with the given map.

documentClass - Variable in class com.datastax.astra.client.Collection

Working class representing documents of the collection.

documentMap - Variable in class com.datastax.astra.client.model.Document

Data to be used in the document.

DOT_PRODUCT - Enum constant in enum com.datastax.astra.client.model.SimilarityMetric

Distance with dot+product (L1).

drop() - Method in class com.datastax.astra.client.Collection

Delete the current collection and all documents that its contains.

drop() - Method in class com.datastax.astra.client.Database

Drops this namespace

dropCollection(String) - Method in class com.datastax.astra.client.Database

Delete a collection.

dropDatabase(String) - Method in class com.datastax.astra.client.admin.AstraDBAdmin

Delete a Database if exists from its name.

dropDatabase(UUID) - Method in class com.datastax.astra.client.admin.AstraDBAdmin

Delete a Database if exists from its identifier.

dropKeyspace(String) - Method in class com.datastax.astra.client.admin.AstraDBDatabaseAdmin

dropKeyspace(String) - Method in class com.datastax.astra.client.admin.DataAPIDatabaseAdmin

dropKeyspace(String) - Method in interface com.datastax.astra.client.admin.DatabaseAdmin

Drops (deletes) the specified keyspace from the database.

dropKeyspaceAsync(String) - Method in interface com.datastax.astra.client.admin.DatabaseAdmin

Asynchronously drops (deletes) the specified keyspace from the database.

dropNamespace(String) - Method in class com.datastax.astra.client.admin.AstraDBDatabaseAdmin

Drops (deletes) the specified namespace from the database.

dropNamespace(String) - Method in class com.datastax.astra.client.admin.DataAPIDatabaseAdmin

Deprecated.

dropNamespace(String) - Method in interface com.datastax.astra.client.admin.DatabaseAdmin

Deprecated.

Use DatabaseAdmin.dropKeyspace(String) instead.

dropNamespaceAsync(String) - Method in interface com.datastax.astra.client.admin.DatabaseAdmin

Deprecated.

Use DatabaseAdmin.dropKeyspaceAsync(String) instead.

DSE - Enum constant in enum com.datastax.astra.client.DataAPIOptions.DataAPIDestination

Local installation of Datastax Enterprise

E

embeddingAPIKey(String) - Method in class com.datastax.astra.client.model.CommandOptions

Deprecated.

has been replace by CommandOptions.embeddingAuthProvider(EmbeddingHeadersProvider)

EmbeddingAPIKeyHeaderProvider - Class in com.datastax.astra.client.auth

Default header when working with an embedding service provider.

EmbeddingAPIKeyHeaderProvider(String) - Constructor for class com.datastax.astra.client.auth.EmbeddingAPIKeyHeaderProvider

Constructor.

embeddingAuthProvider - Variable in class com.datastax.astra.client.model.CommandOptions

Embedding auth provider

embeddingAuthProvider(EmbeddingHeadersProvider) - Method in class com.datastax.astra.client.model.CommandOptions

Provide the embedding service API key.

EmbeddingHeadersProvider - Interface in com.datastax.astra.client.auth

To use the interface embeddings API the user needs to be authenticated against the embedding provider

EmbeddingProvider - Class in com.datastax.astra.client.model

Class representing the Embedding Provider returned by findEmbeddingProviders command.

EmbeddingProvider() - Constructor for class com.datastax.astra.client.model.EmbeddingProvider

Default constructor.

EmbeddingProvider.AuthenticationMethod - Class in com.datastax.astra.client.model

Authentication method.

EmbeddingProvider.Model - Class in com.datastax.astra.client.model

Model for the service.

EmbeddingProvider.Parameter - Class in com.datastax.astra.client.model

Parameters for the service.

EmbeddingProvider.Token - Class in com.datastax.astra.client.model

Token method.

EmbeddingProvider.Validation - Class in com.datastax.astra.client.model

Validation Component for the parameter.

entrySet() - Method in class com.datastax.astra.client.model.Document

eq(Object) - Static method in class com.datastax.astra.client.model.Filters

Creates a filter that matches all documents where the value of _id field equals the specified value.

eq(String, Object) - Static method in class com.datastax.astra.client.model.Filters

Help Building the filters.

equals(Object) - Method in class com.datastax.astra.client.model.Document

equals(Object) - Method in class com.datastax.astra.client.model.ObjectId

EQUALS_TO - Enum constant in enum com.datastax.astra.client.model.FilterOperator

Equal To.

ERROR_CODE_HTTP - Static variable in exception class com.datastax.astra.client.exception.DataApiException

Default error code.

ERROR_CODE_INTERRUPTED - Static variable in exception class com.datastax.astra.client.exception.DataApiException

Default error code.

ERROR_CODE_RANDOM - Static variable in exception class com.datastax.astra.client.exception.DataApiException

Default error code.

ERROR_CODE_SERIALIZATION - Static variable in exception class com.datastax.astra.client.exception.DataApiException

Default error code.

ERROR_CODE_TIMEOUT - Static variable in exception class com.datastax.astra.client.exception.DataApiException

Default error code.

EstimatedCountDocumentsOptions - Class in com.datastax.astra.client.model

List Options for a FindOne command.

EstimatedCountDocumentsOptions() - Constructor for class com.datastax.astra.client.model.EstimatedCountDocumentsOptions

Default constructor.

estimatedDocumentCount() - Method in class com.datastax.astra.client.Collection

Calling an estimatedDocumentCount with default options.

estimatedDocumentCount(EstimatedCountDocumentsOptions) - Method in class com.datastax.astra.client.Collection

Executes the "estimatedDocumentCount" command to estimate the number of documents in a collection.

EUCLIDEAN - Enum constant in enum com.datastax.astra.client.model.SimilarityMetric

Distance with Euclidean (L2).

exclude(String...) - Static method in class com.datastax.astra.client.model.Projections

Exclude a field in the result.

executeHttp(String, String, String, String, String) - Method in class com.datastax.astra.internal.http.RetryHttpClient

Main Method executing HTTP Request.

executeHttpRequest(HttpRequest) - Method in class com.datastax.astra.internal.http.RetryHttpClient

Implementing retries.

ExecutionInfos - Class in com.datastax.astra.internal.command

Encapsulates detailed information about the execution of a command, including the original request, the raw response, HTTP response details, and timing information.

ExecutionInfos.DataApiExecutionInfoBuilder - Class in com.datastax.astra.internal.command

Builder class for execution information

exhausted - Variable in class com.datastax.astra.client.model.PageableIterable

the Iterator is exhausted

exists() - Method in class com.datastax.astra.client.Collection

Checks if the specified collection exists within the current namespace.

exists() - Method in class com.datastax.astra.client.model.FilterBuilder

Add condition exists.

exists(String) - Static method in class com.datastax.astra.client.model.Filters

Build a filter with the `$exists` operator.

EXISTS - Enum constant in enum com.datastax.astra.client.model.DataAPIKeywords

EXISTS.

EXISTS - Enum constant in enum com.datastax.astra.client.model.FilterOperator

Exist.

F

fetchNextPage() - Method in class com.datastax.astra.client.model.PageableIterable

Fetch the next page if the result.

filter - Variable in class com.datastax.astra.client.model.PageableIterable

Original command, we will edit it to iterate on pages.

Filter - Class in com.datastax.astra.client.model

Filter Builder.

Filter() - Constructor for class com.datastax.astra.client.model.Filter

Default constructor.

Filter(String, FilterOperator, Object) - Constructor for class com.datastax.astra.client.model.Filter

Create a filter from a where clause.

FilterBuilder - Class in com.datastax.astra.client.model

Helper to build a where clause in natural language (fluent API).

FilterBuilder(Filter, String) - Constructor for class com.datastax.astra.client.model.FilterBuilder

Only constructor allowed

FilterOperator - Enum in com.datastax.astra.client.model

Ease process of creating a where clause.

Filters - Class in com.datastax.astra.client.model

Helper to create Filter

find() - Method in class com.datastax.astra.client.Collection

Retrieves all documents in the collection.

find(float[], int) - Method in class com.datastax.astra.client.Collection

Finds documents in the collection that match the specified filter and sorts them based on their similarity to a provided vector, limiting the number of results returned.

find(Filter) - Method in class com.datastax.astra.client.Collection

Retrieves documents in the collection that match the specified filter.

find(Filter, float[], int) - Method in class com.datastax.astra.client.Collection

Finds documents in the collection that match the specified filter and sorts them based on their similarity to a provided vector, limiting the number of results returned.

find(Filter, FindOptions) - Method in class com.datastax.astra.client.Collection

Finds all documents in the collection.

find(Filter, String, int) - Method in class com.datastax.astra.client.Collection

Finds documents in the collection that match the specified filter and sorts them based on their similarity to a provided vector, limiting the number of results returned.

find(FindOptions) - Method in class com.datastax.astra.client.Collection

Finds all documents in the collection, applying the specified find options.

findById(Object) - Method in class com.datastax.astra.client.Collection

Retrieves a document by its identifier from the collection.

findById(String) - Static method in class com.datastax.astra.client.model.Filter

Build a filter for find by id.

findEmbeddingProviders() - Method in class com.datastax.astra.client.admin.AstraDBDatabaseAdmin

Retrieve the list of embedding providers available in the current database.

findEmbeddingProviders() - Method in class com.datastax.astra.client.admin.DataAPIDatabaseAdmin

Retrieve the list of embedding providers available in the current database.

findEmbeddingProviders() - Method in interface com.datastax.astra.client.admin.DatabaseAdmin

Retrieve the list of embedding providers available in the current database.

FindEmbeddingProvidersResult - Class in com.datastax.astra.client.model

Wrapper to get information about the findEmbeddingProviders.

FindEmbeddingProvidersResult() - Constructor for class com.datastax.astra.client.model.FindEmbeddingProvidersResult

findFirst() - Method in class com.datastax.astra.client.model.Page

Expected from a stream of result.

FindIterable<T> - Class in com.datastax.astra.client.model

Represents the result of a 'find' command executed on a collection, providing an iterable interface to navigate through the result set.

FindIterable(Collection<T>, Filter, FindOptions) - Constructor for class com.datastax.astra.client.model.FindIterable

Constructor for a cursor over the elements of the find.

FindIterator<T> - Class in com.datastax.astra.client.model

Implementing a custom iterator that will load next page if needed when hitting the last item of page.

FindIterator(PageableIterable<T>) - Constructor for class com.datastax.astra.client.model.FindIterator

Starting the cursor on an iterable to fetch more pages.

findOne(Filter) - Method in class com.datastax.astra.client.Collection

Attempts to find a single document within the collection that matches the given filter criteria.

findOne(Filter, FindOneOptions) - Method in class com.datastax.astra.client.Collection

Attempts to find a single document within the collection that matches the given filter criteria.

findOne(FindOneOptions) - Method in class com.datastax.astra.client.Collection

Syntax sugar to provide a findOne command without a filter @see Collection.findOne(Filter, FindOneOptions).

findOneAndDelete(Filter) - Method in class com.datastax.astra.client.Collection

Atomically find a document and remove it.

findOneAndDelete(Filter, FindOneAndDeleteOptions) - Method in class com.datastax.astra.client.Collection

Atomically find a document and remove it.

findOneAndDeleteAsync(Filter) - Method in class com.datastax.astra.client.Collection

Delete and return a document asynchronous.

FindOneAndDeleteOptions - Class in com.datastax.astra.client.model

Options to find one and delete.

FindOneAndDeleteOptions() - Constructor for class com.datastax.astra.client.model.FindOneAndDeleteOptions

Default constructor.

findOneAndReplace(Filter, T) - Method in class com.datastax.astra.client.Collection

Atomically find a document and replace it.

findOneAndReplace(Filter, T, FindOneAndReplaceOptions) - Method in class com.datastax.astra.client.Collection

Atomically find a document and replace it.

FindOneAndReplaceOptions - Class in com.datastax.astra.client.model

Options used in the `findAndReplace` command.

FindOneAndReplaceOptions() - Constructor for class com.datastax.astra.client.model.FindOneAndReplaceOptions

Default constructor.

FindOneAndReplaceResult<T> - Class in com.datastax.astra.client.model

Store the result of a findOneAndReplace operation.

FindOneAndReplaceResult() - Constructor for class com.datastax.astra.client.model.FindOneAndReplaceResult

Default constructor.

findOneAndUpdate(Filter, Update) - Method in class com.datastax.astra.client.Collection

Atomically find a document and update it.

findOneAndUpdate(Filter, Update, FindOneAndUpdateOptions) - Method in class com.datastax.astra.client.Collection

Atomically find a document and update it.

FindOneAndUpdateOptions - Class in com.datastax.astra.client.model

List options for a findOneAndUpdate command.

FindOneAndUpdateOptions() - Constructor for class com.datastax.astra.client.model.FindOneAndUpdateOptions

Default constructor.

FindOneAndUpdateOptions.Builder - Class in com.datastax.astra.client.model

Deprecated.

findOneASync(Filter) - Method in class com.datastax.astra.client.Collection

Initiates an asynchronous search to find a single document that matches the given filter criteria.

findOneASync(Filter, FindOneOptions) - Method in class com.datastax.astra.client.Collection

Asynchronously attempts to find a single document within the collection that matches the given filter criteria, utilizing the specified FindOneOptions for the query.

FindOneOptions - Class in com.datastax.astra.client.model

List Options for a FindOne command.

FindOneOptions() - Constructor for class com.datastax.astra.client.model.FindOneOptions

Default constructor.

FindOptions - Class in com.datastax.astra.client.model

List Options for a FindOne command.

FindOptions() - Constructor for class com.datastax.astra.client.model.FindOptions

Default constructor.

findPage(Filter, FindOptions) - Method in class com.datastax.astra.client.Collection

Executes a paginated 'find' query on the collection using the specified filter and find options.

findPageASync(Filter, FindOptions) - Method in class com.datastax.astra.client.Collection

Executes a paginated 'find' query on the collection using the specified filter and find options asynchronously.

FREE_TIER_CLOUD - Static variable in class com.datastax.astra.client.admin.AstraDBAdmin

Default cloud provider.

FREE_TIER_CLOUD_REGION - Static variable in class com.datastax.astra.client.admin.AstraDBAdmin

Default region.

fromString(String) - Static method in class com.datastax.astra.client.model.UUIDv6

Generate from a string.

fromString(String) - Static method in class com.datastax.astra.client.model.UUIDv7

Generate from a string.

fromValue(String) - Static method in enum com.datastax.astra.client.model.CollectionIdTypes

Creates a CollectionIdTypes from its string value.

fromValue(String) - Static method in enum com.datastax.astra.client.model.SimilarityMetric

Build from the key.

G

get() - Method in interface com.datastax.astra.client.auth.TokenProvider

get(String, Class<T>) - Method in class com.datastax.astra.client.model.Document

Gets the value of the given key, casting it to the given Class<T>.

get(Object) - Method in class com.datastax.astra.client.model.Document

getAdmin() - Method in class com.datastax.astra.client.DataAPIClient

Retrieves an administration client specific to Astra deployments.

getAdmin(String) - Method in class com.datastax.astra.client.DataAPIClient

Retrieves an administration client capable of performing CRUD operations on databases, requiring a token with advanced privileges.

getApiEndpoint() - Method in class com.datastax.astra.client.admin.DataAPIDatabaseAdmin

The subclass should provide the endpoint, url to post request.

getApiEndpoint() - Method in class com.datastax.astra.client.Collection

The subclass should provide the endpoint, url to post request.

getApiEndpoint() - Method in class com.datastax.astra.client.Database

The subclass should provide the endpoint, url to post request.

getApiEndpoint() - Method in class com.datastax.astra.internal.command.AbstractCommandRunner

The subclass should provide the endpoint, url to post request.

getApiEndPoint() - Method in class com.datastax.astra.internal.api.AstraApiEndpoint

Return the endpoint URL based on the chunks.

getApiErrors() - Method in exception class com.datastax.astra.client.exception.DataApiResponseException

Flattening errors as a list.

getArray(String, Class<K>) - Method in class com.datastax.astra.client.model.Document

Return an Array of items.

getBoolean(String) - Method in class com.datastax.astra.client.model.Document

Gets the value of the given key as a Boolean.

getByte(String) - Method in class com.datastax.astra.client.model.Document

Access element from the map

getCalendar(String) - Method in class com.datastax.astra.client.model.Document

Access element from the map

getCharacter(String) - Method in class com.datastax.astra.client.model.Document

Access element from the map

getCollection(String) - Method in class com.datastax.astra.client.Database

Gets a collection.

getCollection(String, CommandOptions<?>, Class<T>) - Method in class com.datastax.astra.client.Database

Gets a collection, with a specific default document class.

getCollection(String, Class<T>) - Method in class com.datastax.astra.client.Database

Gets a collection, with a specific default document class.

getDataApiObjectMapper() - Static method in class com.datastax.astra.internal.utils.JsonUtils

Building the data api specific object mapper.

getDatabase() - Method in class com.datastax.astra.client.admin.AstraDBDatabaseAdmin

Access the Database associated with this admin class.

getDatabase() - Method in class com.datastax.astra.client.admin.DataAPIDatabaseAdmin

Access the Database associated with this admin class.

getDatabase() - Method in interface com.datastax.astra.client.admin.DatabaseAdmin

Access the Database associated with this admin class.

getDatabase(String) - Method in class com.datastax.astra.client.admin.AstraDBDatabaseAdmin

Access teh database with the default token.

getDatabase(String) - Method in class com.datastax.astra.client.admin.DataAPIDatabaseAdmin

Retrieves a Database instance that represents a specific database (or namespace) based on the provided namespace name.

getDatabase(String) - Method in interface com.datastax.astra.client.admin.DatabaseAdmin

Retrieves a Database instance that represents a specific database (or namespace) based on the provided namespace name.

getDatabase(String) - Method in class com.datastax.astra.client.DataAPIClient

Retrieves a database client configured to interact with the Data API at the specified API endpoint.

getDatabase(String, String) - Method in class com.datastax.astra.client.admin.AstraDBDatabaseAdmin

Access teh database with the specialized token.

getDatabase(String, String) - Method in class com.datastax.astra.client.admin.DataAPIDatabaseAdmin

Access the Database associated with this admin class.

getDatabase(String, String) - Method in interface com.datastax.astra.client.admin.DatabaseAdmin

Access the Database associated with this admin class.

getDatabase(String, String) - Method in class com.datastax.astra.client.DataAPIClient

Creates and returns a database client configured to interact with the Data API at the specified API endpoint and within the given namespace.

getDatabase(UUID) - Method in class com.datastax.astra.client.admin.AstraDBAdmin

Access the database functions.

getDatabase(UUID) - Method in class com.datastax.astra.client.DataAPIClient

Retrieves a client for interacting with a specified database using its unique identifier.

getDatabase(UUID, String) - Method in class com.datastax.astra.client.admin.AstraDBAdmin

Access the database functions.

getDatabase(UUID, String) - Method in class com.datastax.astra.client.DataAPIClient

Retrieves a client for a specific database, enabling interactions with the Data API.

getDatabase(UUID, String, String) - Method in class com.datastax.astra.client.DataAPIClient

Retrieves a client for a specific database, enabling interactions with the Data API.

getDatabaseAdmin() - Method in class com.datastax.astra.client.Database

Access a database Admin client from the database

getDatabaseAdmin(String) - Method in class com.datastax.astra.client.DataAPIClient

Retrieves a client for interacting with a specified database using its unique identifier.

getDatabaseAdmin(String) - Method in class com.datastax.astra.client.Database

Gets the name of the database.

getDatabaseAdmin(UUID) - Method in class com.datastax.astra.client.admin.AstraDBAdmin

Access the database functions.

getDatabaseAdmin(UUID) - Method in class com.datastax.astra.client.DataAPIClient

Retrieves a client for interacting with a specified database using its unique identifier.

getDatabaseInfo(UUID) - Method in class com.datastax.astra.client.admin.AstraDBAdmin

Find database information from its id.

getDatabaseInformations() - Method in class com.datastax.astra.client.admin.AstraDBDatabaseAdmin

Find a database from its id.

getDate() - Method in class com.datastax.astra.client.model.ObjectId

Gets the timestamp as a Date instance.

getDate(Object) - Method in class com.datastax.astra.client.model.Document

Gets the value of the given key as a Date.

getDate(String) - Method in class com.datastax.astra.client.model.Document

Access element from the map

getDefinition() - Method in class com.datastax.astra.client.Collection

Retrieves the full definition of the collection, encompassing both its name and its configuration options.

getDouble(String) - Method in class com.datastax.astra.client.model.Document

Gets the value of the given key as a Double.

getEmbeddingAuthProvider() - Method in class com.datastax.astra.client.model.CommandOptions

Return the @EmbeddingAuthProvider if present in the configuration.

getErrorCode(List<ExecutionInfos>) - Static method in exception class com.datastax.astra.client.exception.DataApiResponseException

Parse the command list to get first error of first command.

getErrorMessage() - Method in class com.datastax.astra.internal.api.ApiError

Constructs a comprehensive error message by combining the exception class name, error code, and the detailed message.

getErrorMessage(List<ExecutionInfos>) - Static method in exception class com.datastax.astra.client.exception.DataApiResponseException

Parse the command list to get first error of first command.

getFloat(String) - Method in class com.datastax.astra.client.model.Document

Access element from the map

getHeaderAuthentication() - Method in class com.datastax.astra.client.model.EmbeddingProvider

Accessor for the Share Secret Authentication.

getHeaders() - Method in class com.datastax.astra.client.auth.AWSEmbeddingHeadersProvider

Build the Header for this provider.

getHeaders() - Method in class com.datastax.astra.client.auth.EmbeddingAPIKeyHeaderProvider

Build the Header for this provider.

getHeaders() - Method in interface com.datastax.astra.client.auth.EmbeddingHeadersProvider

Build the Header to authenticate against embeddings provider.

getHttpClientOptions() - Method in class com.datastax.astra.client.model.CommandOptions

Gets httpClientOptions

getId(Class<T>) - Method in class com.datastax.astra.client.model.Document

Access the document identifier

getInstant(String) - Method in class com.datastax.astra.client.model.Document

Access element from the map

getInteger(String) - Method in class com.datastax.astra.client.model.Document

Gets the value of the given key as an Integer.

getKeyspaceName() - Method in class com.datastax.astra.client.Collection

Retrieves the name of the parent keyspace associated with this collection.

getList(String, Class<T>) - Method in class com.datastax.astra.client.model.Document

Gets the list value of the given key, casting the list elements to the given Class<T>.

getList(String, Class<T>, List<T>) - Method in class com.datastax.astra.client.model.Document

Gets the list value of the given key, casting the list elements to Class<T> or returning the default list value if null.

getLong(String) - Method in class com.datastax.astra.client.model.Document

Gets the value of the given key as a Long.

getName() - Method in class com.datastax.astra.client.Collection

Retrieves the name of the collection.

getNamespaceName() - Method in class com.datastax.astra.client.Collection

Deprecated.

use Collection.getKeyspaceName() instead

getObjectId(String) - Method in class com.datastax.astra.client.model.Document

Access element from the map

getOptions() - Method in class com.datastax.astra.client.Collection

Retrieves the configuration options for the collection, including vector and indexing settings.

getOriginalEndPoint() - Method in class com.datastax.astra.internal.api.AstraApiEndpoint

Return the endpoint URL based on the chunks.

getPageState() - Method in class com.datastax.astra.client.model.Page

Getter accessor for attribute 'pageState'.

getResponseTimeoutInSeconds() - Method in class com.datastax.astra.internal.http.RetryHttpClient

Return value for default response time.

getSharedSecretAuthentication() - Method in class com.datastax.astra.client.model.EmbeddingProvider

Accessor for the Share Secret Authentication.

getShort(String) - Method in class com.datastax.astra.client.model.Document

Access element from the map

getSimilarity() - Method in class com.datastax.astra.client.model.Document

Get value for similarity.

getSimilarityMetric() - Method in class com.datastax.astra.client.model.CollectionOptions.VectorOptions

Get metric as an enum.

getSortVector() - Method in class com.datastax.astra.client.model.Page

If the sort Vector has been retrieved in the status, it will be available here.

getSortVector() - Method in class com.datastax.astra.client.model.PageableIterable

Get current page sort Vector When available.

getStatusKeyAsList(String, Class<T>) - Method in class com.datastax.astra.internal.api.ApiResponse

Retrieves a list of objects from the 'status' map based on the provided key, casting them to the specified class.

getStatusKeyAsMap(String, Class<T>) - Method in class com.datastax.astra.internal.api.ApiResponse

Retrieves a list of objects from the 'status' map based on the provided key, casting them to the specified class.

getStatusKeyAsStringStream(String) - Method in class com.datastax.astra.internal.api.ApiResponse

Retrieves a stream of String values from the 'status' map based on the provided key.

getString(String) - Method in class com.datastax.astra.client.model.Document

Gets the value of the given key as a String.

getToken() - Method in class com.datastax.astra.client.auth.StaticTokenProvider

Building the token.

getToken() - Method in interface com.datastax.astra.client.auth.TokenProvider

Building the token.

getToken() - Method in class com.datastax.astra.client.auth.UsernamePasswordTokenProvider

Generate or renew authentication token.

getToken() - Method in class com.datastax.astra.client.model.CommandOptions

Gets token

getTokenAsString() - Method in interface com.datastax.astra.client.auth.TokenProvider

Building the token.

getUserAgentHeader() - Method in class com.datastax.astra.internal.http.RetryHttpClient

Give access to the user agent header.

getUUID(String) - Method in class com.datastax.astra.client.model.Document

Access element from the map

getVector() - Method in class com.datastax.astra.client.model.Document

Get value for vector.

getVectorize() - Method in class com.datastax.astra.client.model.Document

Access attribute with vectorize name if any.

GREATER_THAN - Enum constant in enum com.datastax.astra.client.model.FilterOperator

Greater Than.

GREATER_THAN_OR_EQUALS_TO - Enum constant in enum com.datastax.astra.client.model.FilterOperator

Greater Than Or Equal To.

green(String) - Static method in class com.datastax.astra.internal.utils.AnsiUtils

write green.

gt(String, Number) - Static method in class com.datastax.astra.client.model.Filters

Creates a filter that matches all documents where the value of the given field is greater than the specified value.

gt(String, Instant) - Static method in class com.datastax.astra.client.model.Filters

Creates a filter that matches all documents where the value of the given field is greater than the specified value.

gt(String, Calendar) - Static method in class com.datastax.astra.client.model.Filters

Creates a filter that matches all documents where the value of the given field is greater than the specified value.

gt(String, Date) - Static method in class com.datastax.astra.client.model.Filters

Creates a filter that matches all documents where the value of the given field is greater than the specified value.

gte(String, Number) - Static method in class com.datastax.astra.client.model.Filters

Creates a filter that matches all documents where the value of the given field is greater than or equal to the specified value.

gte(String, Instant) - Static method in class com.datastax.astra.client.model.Filters

Creates a filter that matches all documents where the value of the given field is greater than or equal to the specified value.

gte(String, Calendar) - Static method in class com.datastax.astra.client.model.Filters

Creates a filter that matches all documents where the value of the given field is greater than or equal to the specified value.

gte(String, Date) - Static method in class com.datastax.astra.client.model.Filters

Creates a filter that matches all documents where the value of the given field is greater than or equal to the specified value.

H

hashCode() - Method in class com.datastax.astra.client.model.Document

hashCode() - Method in class com.datastax.astra.client.model.ObjectId

hasLength(String, String) - Static method in class com.datastax.astra.internal.utils.Assert

Input string should not be empty.

hasNext() - Method in class com.datastax.astra.client.model.DistinctIterator

hasNext() - Method in class com.datastax.astra.client.model.FindIterator

hasSize(int) - Method in class com.datastax.astra.client.model.FilterBuilder

Condition to evaluate size

hasSize(String, int) - Static method in class com.datastax.astra.client.model.Filters

Build a filter with the `$hasSize` operator.

hasSubFieldsEqualsTo(Map<String, Object>) - Method in class com.datastax.astra.client.model.FilterBuilder

$eq: [ ... ]

HCD - Enum constant in enum com.datastax.astra.client.DataAPIOptions.DataAPIDestination

Hyper Converged Database

HEADER_ACCEPT - Static variable in class com.datastax.astra.internal.http.RetryHttpClient

Header param.

HEADER_AUTHORIZATION - Static variable in class com.datastax.astra.internal.http.RetryHttpClient

Headers param to insert the token for devops API.

HEADER_AWS_ASSET_ID - Static variable in class com.datastax.astra.client.auth.AWSEmbeddingHeadersProvider

Headers param with the embedding ApiKey when dealing with a embedding service provider.

HEADER_AWS_SECRET_ID - Static variable in class com.datastax.astra.client.auth.AWSEmbeddingHeadersProvider

Headers param with the embedding ApiKey when dealing with a embedding service provider.

HEADER_CASSANDRA - Static variable in class com.datastax.astra.internal.http.RetryHttpClient

Headers param to insert the token.

HEADER_CONTENT_TYPE - Static variable in class com.datastax.astra.internal.http.RetryHttpClient

Headers param to insert the conte type.

HEADER_EMBEDDING_API_KEY - Static variable in class com.datastax.astra.client.auth.EmbeddingAPIKeyHeaderProvider

Headers param with the embedding ApiKey when dealing with a embedding service provider.

HEADER_REQUEST_ID - Static variable in class com.datastax.astra.internal.http.RetryHttpClient

Headers param to insert the unique identifier for the request.

HEADER_REQUESTED_WITH - Static variable in class com.datastax.astra.internal.http.RetryHttpClient

Headers param to insert the user agent identifying the client.

HEADER_USER_AGENT - Static variable in class com.datastax.astra.internal.http.RetryHttpClient

Headers name to insert the user agent identifying the client.

HTTP_CLIENT - Static variable in class com.datastax.astra.client.auth.UsernamePasswordTokenProvider

Simple Client.

httpClient - Variable in class com.datastax.astra.internal.command.AbstractCommandRunner

Http client reused when properties not override.

httpClient - Variable in class com.datastax.astra.internal.http.RetryHttpClient

JDK11 Http client.

httpClientOptions - Variable in class com.datastax.astra.client.model.CommandOptions

Will be used to create a client

httpClientOptions - Variable in class com.datastax.astra.internal.http.RetryHttpClient

Http Options.

httpClientOptions(HttpClientOptions) - Method in class com.datastax.astra.client.model.CommandOptions

Provide the token.

HttpClientOptions - Class in com.datastax.astra.client.model

Options to set up http Client.

HttpClientOptions() - Constructor for class com.datastax.astra.client.model.HttpClientOptions

Default constructor.

HttpProxy(String, int) - Constructor for class com.datastax.astra.client.DataAPIOptions.HttpProxy

Default constructor.

I

id(T) - Method in class com.datastax.astra.client.model.Document

Set value for the identifier.

ID - Enum constant in enum com.datastax.astra.client.model.DataAPIKeywords

ID.

in(String, V...) - Static method in class com.datastax.astra.client.model.Filters

Creates a filter that matches all documents where the value of a field equals any value in the list of specified values.

IN - Enum constant in enum com.datastax.astra.client.model.FilterOperator

in.

inc(String, Double) - Method in class com.datastax.astra.client.model.Update

Builder pattern

inc(String, Double) - Static method in class com.datastax.astra.client.model.Updates

Initialize an with the key and value.

include(String...) - Static method in class com.datastax.astra.client.model.Projections

Include a field in the result.

includeSimilarity() - Method in class com.datastax.astra.client.model.FindOneOptions

Fluent api.

includeSimilarity() - Method in class com.datastax.astra.client.model.FindOptions

Fluent api.

includeSortVector() - Method in class com.datastax.astra.client.model.FindOneOptions

Fluent api.

includeSortVector() - Method in class com.datastax.astra.client.model.FindOptions

Fluent api.

indexingAllow(String...) - Method in class com.datastax.astra.client.model.CollectionOptions.CollectionOptionsBuilder

Builder pattern.

indexingDeny(String...) - Method in class com.datastax.astra.client.model.CollectionOptions.CollectionOptionsBuilder

Builder pattern.

IndexingOptions() - Constructor for class com.datastax.astra.client.model.CollectionOptions.IndexingOptions

Default constructor.

INPUT_INCLUDE_SIMILARITY - Static variable in class com.datastax.astra.client.Collection

json inputs

INPUT_INCLUDE_SORT_VECTOR - Static variable in class com.datastax.astra.client.Collection

json inputs

insertMany(List<? extends T>) - Method in class com.datastax.astra.client.Collection

Inserts a batch of documents into the collection using default insertion options.

insertMany(List<? extends T>, InsertManyOptions) - Method in class com.datastax.astra.client.Collection

Inserts a batch of documents into the collection concurrently, optimizing the insertion process for large datasets.

insertMany(T...) - Method in class com.datastax.astra.client.Collection

Inserts a batch of documents into the collection using default insertion options.

insertManyAsync(List<? extends T>) - Method in class com.datastax.astra.client.Collection

Asynchronously inserts a batch of documents into the collection using default insertion options.

insertManyAsync(List<? extends T>, InsertManyOptions) - Method in class com.datastax.astra.client.Collection

Asynchronously inserts a batch of documents into the collection with customizable insertion options.

InsertManyOptions - Class in com.datastax.astra.client.model

Options for InsertMany

InsertManyOptions() - Constructor for class com.datastax.astra.client.model.InsertManyOptions

Populate insertMany options

InsertManyOptions.Builder - Class in com.datastax.astra.client.model

Deprecated.

InsertManyResult - Class in com.datastax.astra.client.model

Represents the result returned by command 'insertMany()', mainly the insertedIds.

InsertManyResult() - Constructor for class com.datastax.astra.client.model.InsertManyResult

Default constructor.

insertOne(T) - Method in class com.datastax.astra.client.Collection

Inserts a single document into the collection as an atomic operation, ensuring that the document is added in a single, indivisible step.

insertOne(T, float[]) - Method in class com.datastax.astra.client.Collection

Inserts a single document into the collection in an atomic operation, similar to the Collection.insertOne(Object) method, but with the additional capability to include vector embeddings.

insertOne(T, float[], InsertOneOptions) - Method in class com.datastax.astra.client.Collection

Inserts a single document into the collection in an atomic operation, similar to the Collection.insertOne(Object) method, but with the additional capability to include vector embeddings.

insertOne(T, InsertOneOptions) - Method in class com.datastax.astra.client.Collection

Inserts a single document into the collection as an atomic operation, ensuring that the document is added in a single, indivisible step.

insertOne(T, String) - Method in class com.datastax.astra.client.Collection

Inserts a single document into the collection in an atomic operation, extending the base functionality of the Collection.insertOne(Object) method by adding the capability to compute and include a vector of embeddings directly within the document.

insertOne(T, String, InsertOneOptions) - Method in class com.datastax.astra.client.Collection

Inserts a single document into the collection in an atomic operation, extending the base functionality of the Collection.insertOne(Object) method by adding the capability to compute and include a vector of embeddings directly within the document.

insertOneAsync(T) - Method in class com.datastax.astra.client.Collection

Asynchronously inserts a single document into the collection.

insertOneAsync(T, float[]) - Method in class com.datastax.astra.client.Collection

Asynchronously inserts a single document into the collection with vector embeddings.

insertOneAsync(T, InsertOneOptions) - Method in class com.datastax.astra.client.Collection

Asynchronous implementation of Collection.insertOne(Object, InsertOneOptions).

insertOneAsync(T, String) - Method in class com.datastax.astra.client.Collection

Asynchronously inserts a single document into the collection with a vectorization expression.

InsertOneOptions - Class in com.datastax.astra.client.model

Options for InsertOne

InsertOneOptions() - Constructor for class com.datastax.astra.client.model.InsertOneOptions

Default constructor.

InsertOneResult - Class in com.datastax.astra.client.model

Represents the result returned by command 'insertOne()', mainly the insertedI

InsertOneResult() - Constructor for class com.datastax.astra.client.model.InsertOneResult

Default constructor.

Installation - Search tag in Overview

Section

isAnArrayContaining(V...) - Method in class com.datastax.astra.client.model.FilterBuilder

$eq: [ ... ]

isAnArrayExactlyEqualsTo(Object[]) - Method in class com.datastax.astra.client.model.FilterBuilder

$all: [ ... ]

isEmpty() - Method in class com.datastax.astra.client.model.Document

isEmpty() - Method in class com.datastax.astra.client.model.Page

Express if results is empty.

isEqualsTo(Object) - Method in class com.datastax.astra.client.model.FilterBuilder

"fieldName": "value" ($eq is omitted)

isGreaterOrEqualsThan(Object) - Method in class com.datastax.astra.client.model.FilterBuilder

Add condition is greater than.

isGreaterThan(Object) - Method in class com.datastax.astra.client.model.FilterBuilder

Add condition is less than.

isInArray(V[]) - Method in class com.datastax.astra.client.model.FilterBuilder

$in: [ ... ]

isLessOrEqualsThan(Object) - Method in class com.datastax.astra.client.model.FilterBuilder

Add condition is less than.

isLessThan(Object) - Method in class com.datastax.astra.client.model.FilterBuilder

Add condition is less than.

isNotEqualsTo(Object) - Method in class com.datastax.astra.client.model.FilterBuilder

Add condition is not equals to.

isNotInArray(V[]) - Method in class com.datastax.astra.client.model.FilterBuilder

$in: [ ... ]

isTrue(boolean, String) - Static method in class com.datastax.astra.internal.utils.Assert

Check condition at start.

iterator() - Method in class com.datastax.astra.client.model.DistinctIterable

iterator() - Method in class com.datastax.astra.client.model.FindIterable

J

JsonUtils - Class in com.datastax.astra.internal.utils

Custom implementation of serialization : faster + no jackson dependency

K

keySet() - Method in class com.datastax.astra.client.model.Document

keyspaceExists(String) - Method in interface com.datastax.astra.client.admin.DatabaseAdmin

Evaluate if a keyspace exists.

KeyspaceInformation - Class in com.datastax.astra.client.model

Represents the keyspace definition with its name and metadata.

KeyspaceInformation() - Constructor for class com.datastax.astra.client.model.KeyspaceInformation

The options of the namespace.

KeyspaceInformation(String) - Constructor for class com.datastax.astra.client.model.KeyspaceInformation

Default Constructor.

KeyspaceInformation.ReplicationStrategy - Enum in com.datastax.astra.client.model

Replication strategies

KeyspaceOptions - Class in com.datastax.astra.client.model

Options to create a Namespace.

L

LESS_THAN - Enum constant in enum com.datastax.astra.client.model.FilterOperator

Less Than.

LESS_THAN_OR_EQUALS_TO - Enum constant in enum com.datastax.astra.client.model.FilterOperator

Less Than Or Equal To.

limit(int) - Method in class com.datastax.astra.client.model.FindOptions

Add a limit clause in the find block

listCollectionNames() - Method in class com.datastax.astra.client.Database

Gets the names of all the collections in this database.

listCollections() - Method in class com.datastax.astra.client.Database

Finds all the collections in this database.

listDatabaseNames() - Method in class com.datastax.astra.client.admin.AstraDBAdmin

List available database names.

listDatabases() - Method in class com.datastax.astra.client.admin.AstraDBAdmin

List active databases with vector enabled in current organization.

listKeyspaceNames() - Method in class com.datastax.astra.client.admin.AstraDBDatabaseAdmin

listKeyspaceNames() - Method in class com.datastax.astra.client.admin.DataAPIDatabaseAdmin

Retrieves a stream of keyspaces names available in the current database.

listKeyspaceNames() - Method in interface com.datastax.astra.client.admin.DatabaseAdmin

Retrieves a stream of keyspaces names available in the current database.

listKeyspacesNamesAsync() - Method in interface com.datastax.astra.client.admin.DatabaseAdmin

Asynchronously retrieves a stream of keyspaces names available in the current database.

listNamespaceNames() - Method in class com.datastax.astra.client.admin.AstraDBDatabaseAdmin

Retrieves a stream of namespace names available in the current database.

listNamespaceNames() - Method in class com.datastax.astra.client.admin.DataAPIDatabaseAdmin

Deprecated.

listNamespaceNames() - Method in interface com.datastax.astra.client.admin.DatabaseAdmin

Deprecated.

Use DatabaseAdmin.listKeyspaceNames() instead.

listNamespaceNamesAsync() - Method in interface com.datastax.astra.client.admin.DatabaseAdmin

Deprecated.

Use DatabaseAdmin.listKeyspacesNamesAsync() instead.

log(String, Object...) - Method in class com.datastax.astra.internal.command.LoggingCommandObserver

Convenient method to adjust dynamically the log level.

LoggingCommandObserver - Class in com.datastax.astra.internal.command

Implements a CommandObserver that logs command execution details.

LoggingCommandObserver(Class<?>) - Constructor for class com.datastax.astra.internal.command.LoggingCommandObserver

Initializes a new LoggingCommandObserver instance with a default logging level of DEBUG.

LoggingCommandObserver(Level, Class<?>) - Constructor for class com.datastax.astra.internal.command.LoggingCommandObserver

Initializes a new LoggingCommandObserver instance with a specified logging level and source class.

logRequests() - Method in class com.datastax.astra.client.DataAPIOptions.DataAPIClientOptionsBuilder

Help to enable loggin requests.

lt(String, Number) - Static method in class com.datastax.astra.client.model.Filters

Creates a filter that matches all documents where the value of the given field is less than the specified value.

lt(String, Instant) - Static method in class com.datastax.astra.client.model.Filters

Creates a filter that matches all documents where the value of the given field is less than the specified value.

lt(String, Calendar) - Static method in class com.datastax.astra.client.model.Filters

Creates a filter that matches all documents where the value of the given field is less than the specified value.

lt(String, Date) - Static method in class com.datastax.astra.client.model.Filters

Creates a filter that matches all documents where the value of the given field is less than the specified value.

lte(String, Number) - Static method in class com.datastax.astra.client.model.Filters

Creates a filter that matches all documents where the value of the given field is less than or equal to the specified value.

lte(String, Instant) - Static method in class com.datastax.astra.client.model.Filters

Creates a filter that matches all documents where the value of the given field is less than or equal to the specified value.

lte(String, Calendar) - Static method in class com.datastax.astra.client.model.Filters

Creates a filter that matches all documents where the value of the given field is less than or equal to the specified value.

lte(String, Date) - Static method in class com.datastax.astra.client.model.Filters

Creates a filter that matches all documents where the value of the given field is less than or equal to the specified value.

M

magenta(String) - Static method in class com.datastax.astra.internal.utils.AnsiUtils

write magenta.

map(Class<T>) - Method in class com.datastax.astra.client.model.Document

Marshall as a document if needed.

mapAsDocument(ApiResponse, Class<T>) - Method in class com.datastax.astra.internal.command.AbstractCommandRunner

Document Mapping.

marshall(Object) - Static method in class com.datastax.astra.internal.utils.JsonUtils

Transform object as a String.

min(String, Double) - Static method in class com.datastax.astra.client.model.Updates

Initialize an with the key and value.

min(String, Object) - Method in class com.datastax.astra.client.model.Update

Builder pattern

Model() - Constructor for class com.datastax.astra.client.model.EmbeddingProvider.Model

Default constructor.

N

name - Variable in class com.datastax.astra.client.model.Command

Command Name.

namespaceExists(String) - Method in interface com.datastax.astra.client.admin.DatabaseAdmin

Deprecated.

Use DatabaseAdmin.keyspaceExists(String) instead.

NamespaceInformation - Class in com.datastax.astra.client.model

Deprecated.

use KeyspaceInformation instead

NamespaceInformation() - Constructor for class com.datastax.astra.client.model.NamespaceInformation

Deprecated.

Default Constructor.

NamespaceInformation(String) - Constructor for class com.datastax.astra.client.model.NamespaceInformation

Deprecated.

Default Constructor.

NamespaceInformation.ReplicationStrategy - Enum in com.datastax.astra.client.model

Deprecated.

Replication strategies

NamespaceOptions - Class in com.datastax.astra.client.model

Deprecated.

use KeyspaceOptions instead

ne(String, Object) - Static method in class com.datastax.astra.client.model.Filters

Creates a filter that matches all documents where the value of the field name does not equal the specified value.

NETWORK_TOPOLOGY_STRATEGY - Enum constant in enum com.datastax.astra.client.model.KeyspaceInformation.ReplicationStrategy

The network topology strategy, for production environments.

NETWORK_TOPOLOGY_STRATEGY - Enum constant in enum com.datastax.astra.client.model.NamespaceInformation.ReplicationStrategy

Deprecated.

The network topology strategy, for production environments.

networkTopologyStrategy(Map<String, Integer>) - Static method in class com.datastax.astra.client.model.KeyspaceOptions

Enforce the creation of a namespace with NetworkTopology strategy.

networkTopologyStrategy(Map<String, Integer>) - Static method in class com.datastax.astra.client.model.NamespaceOptions

Deprecated.

Enforce the creation of a namespace with NetworkTopology strategy.

next() - Method in class com.datastax.astra.client.model.DistinctIterator

Implementing a logic of iterator combining current page and paging.

next() - Method in class com.datastax.astra.client.model.FindIterator

Implementing a logic of iterator combining current page and paging.

nin(String, V...) - Static method in class com.datastax.astra.client.model.Filters

Creates a filter that matches all documents where the value of a field equals any value in the list of specified values.

not(Filter) - Static method in class com.datastax.astra.client.model.Filters

Creates a filter that performs a logical NOT of the provided filter

NOT_EQUALS_TO - Enum constant in enum com.datastax.astra.client.model.FilterOperator

Not Equal To.

NOT_IN - Enum constant in enum com.datastax.astra.client.model.FilterOperator

in.

notNull(Object, String) - Static method in class com.datastax.astra.internal.utils.Assert

Input object should not be null

O

OBJECT_ID - Enum constant in enum com.datastax.astra.client.model.CollectionIdTypes

Represent a BSON ObjectId.

OBJECT_ID - Enum constant in enum com.datastax.astra.client.model.DataAPIKeywords

OBJECT_ID.

ObjectId - Class in com.datastax.astra.client.model

A globally unique identifier for objects.

ObjectId() - Constructor for class com.datastax.astra.client.model.ObjectId

Create a new object id.

ObjectId(byte[]) - Constructor for class com.datastax.astra.client.model.ObjectId

Constructs a new instance from the given byte array

ObjectId(String) - Constructor for class com.datastax.astra.client.model.ObjectId

Constructs a new instance from a 24-byte hexadecimal string representation.

ObjectId(ByteBuffer) - Constructor for class com.datastax.astra.client.model.ObjectId

Constructs a new instance from the given ByteBuffer

ObjectId(Date) - Constructor for class com.datastax.astra.client.model.ObjectId

Constructs a new instance using the given date.

observers - Variable in class com.datastax.astra.client.model.CommandOptions

List of observers to notify.

onCommand(ExecutionInfos) - Method in interface com.datastax.astra.internal.command.CommandObserver

Invoked when a command is executed, providing an opportunity for registered observers to perform synchronous post-execution treatments based on the command's execution information.

onCommand(ExecutionInfos) - Method in class com.datastax.astra.internal.command.LoggingCommandObserver

Invoked when a command is executed, providing an opportunity for registered observers to perform synchronous post-execution treatments based on the command's execution information.

one() - Method in class com.datastax.astra.client.model.Page

When the result is a singleton.

options - Variable in class com.datastax.astra.client.model.PageableIterable

Original command, we will edit it to iterate on pages.

OptionsUtils - Class in com.datastax.astra.internal.utils

Reuse of treatments for options

or(Filter...) - Static method in class com.datastax.astra.client.model.Filters

Creates a filter that performs a logical OR of the provided list of filters.

or(Iterable<Filter>) - Static method in class com.datastax.astra.client.model.Filters

Creates a filter that performs a logical OR of the provided list of filters.

ordered(boolean) - Static method in class com.datastax.astra.client.model.BulkWriteOptions.Builder

Initializes the building process with ordered options.

ordered(boolean) - Method in class com.datastax.astra.client.model.BulkWriteOptions

Setter for ordered.

ordered(boolean) - Static method in class com.datastax.astra.client.model.InsertManyOptions.Builder

Deprecated.

Initializes the building process with ordered options.

ordered(boolean) - Method in class com.datastax.astra.client.model.InsertManyOptions

Setter for ordered.

OTHERS - Enum constant in enum com.datastax.astra.client.DataAPIOptions.DataAPIDestination

Extra local installation .

Overview - Search tag in Overview

Section

P

Page<R> - Class in com.datastax.astra.client.model

Hold results for paging

Page(String, List<R>, float[]) - Constructor for class com.datastax.astra.client.model.Page

Default constructor.

PageableIterable<T> - Class in com.datastax.astra.client.model

Helping Iteration on Pages and Documents for DataApi.

PageableIterable() - Constructor for class com.datastax.astra.client.model.PageableIterable

Default constructor.

pageState(String) - Method in class com.datastax.astra.client.model.FindOptions

Update page state

Parameter() - Constructor for class com.datastax.astra.client.model.EmbeddingProvider.Parameter

Default constructor.

Parameters() - Constructor for class com.datastax.astra.client.model.CollectionOptions.Parameters

Default constructor.

parse(String) - Static method in class com.datastax.astra.client.model.Document

Parses a string in MongoDB Extended JSON format to a Document

parse(String) - Static method in class com.datastax.astra.internal.api.AstraApiEndpoint

Parse an endpoint URL to know information on the DB.

parseHttpResponse(HttpResponse<String>) - Method in class com.datastax.astra.internal.http.RetryHttpClient

Parse HTTP response as a ApiResponseHttp.

payload - Variable in class com.datastax.astra.client.model.Command

Command payload.

pop(String, Object) - Method in class com.datastax.astra.client.model.Update

Builder pattern

pop(String, Object) - Static method in class com.datastax.astra.client.model.Updates

Initialize an with the key and value.

post(String, String, String) - Method in class com.datastax.astra.internal.http.RetryHttpClient

Helper to build the HTTP request.

projection(Projection...) - Method in class com.datastax.astra.client.model.FindOneAndDeleteOptions

Syntax sugar as delete option is only a sort

projection(Projection...) - Method in class com.datastax.astra.client.model.FindOneAndReplaceOptions

Syntax sugar as delete option is only a sort

projection(Projection...) - Static method in class com.datastax.astra.client.model.FindOneAndUpdateOptions.Builder

Deprecated.

Initializes the building process with projection options.

projection(Projection...) - Method in class com.datastax.astra.client.model.FindOneAndUpdateOptions

Syntax sugar as delete option is only a sort

projection(Projection...) - Method in class com.datastax.astra.client.model.FindOneOptions

Syntax sugar as delete option is only a sort

projection(Projection...) - Method in class com.datastax.astra.client.model.FindOptions

Syntax sugar as delete option is only a sort

projection(Projection...) - Static method in class com.datastax.astra.internal.utils.OptionsUtils

Fluent api.

Projection - Class in com.datastax.astra.client.model

Encode the presence of a field in the result.

Projection(String, boolean) - Constructor for class com.datastax.astra.client.model.Projection

Default constructor.

Projection(String, Boolean, Integer, Integer) - Constructor for class com.datastax.astra.client.model.Projection

Default constructor.

Projections - Class in com.datastax.astra.client.model

Encode the presence of a field in the result.

push(String, Object) - Method in class com.datastax.astra.client.model.Update

Builder pattern

push(String, Object) - Static method in class com.datastax.astra.client.model.Updates

Initialize an with the key and value.

pushEach(String, List<Object>, Integer) - Method in class com.datastax.astra.client.model.Update

Builder pattern.

pushEach(String, List<Object>, Integer) - Static method in class com.datastax.astra.client.model.Updates

Initialize an with the key and value.

put(String, Object) - Method in class com.datastax.astra.client.model.Document

putAll(Map<? extends String, ?>) - Method in class com.datastax.astra.client.model.Document

putToByteBuffer(ByteBuffer) - Method in class com.datastax.astra.client.model.ObjectId

Convert to bytes and put those bytes to the provided ByteBuffer.

Q

QuickStart - Search tag in Overview

Section

R

registerListener(String, CommandObserver) - Method in class com.datastax.astra.client.admin.DataAPIDatabaseAdmin

Register a listener to execute commands on the collection.

registerListener(String, CommandObserver) - Method in class com.datastax.astra.client.Collection

Register a listener to execute commands on the collection.

registerListener(String, CommandObserver) - Method in class com.datastax.astra.client.Database

Register a listener to execute commands on the collection.

registerObserver(CommandObserver) - Method in class com.datastax.astra.client.model.CommandOptions

Register an observer with its className.

registerObserver(String, CommandObserver) - Method in class com.datastax.astra.client.model.CommandOptions

Allow to register a listener for the command.

remove(Object) - Method in class com.datastax.astra.client.model.Document

rename(String, Object) - Method in class com.datastax.astra.client.model.Update

Builder pattern

rename(String, String) - Static method in class com.datastax.astra.client.model.Updates

Initialize an with the key and value.

replaceOne(Filter, T) - Method in class com.datastax.astra.client.Collection

Replace a single document on the collection with a new one, optionally inserting a new document if no match is found.

replaceOne(Filter, T, ReplaceOneOptions) - Method in class com.datastax.astra.client.Collection

Replace a document in the collection according to the specified arguments.

ReplaceOneOptions - Class in com.datastax.astra.client.model

Options for the replaceOne operation.

ReplaceOneOptions() - Constructor for class com.datastax.astra.client.model.ReplaceOneOptions

Default constructor.

ReplaceOneOptions.Builder - Class in com.datastax.astra.client.model

Deprecated.

REQUEST_WITH - Static variable in class com.datastax.astra.internal.http.RetryHttpClient

Value for the requested with.

RESULT_COUNT - Static variable in class com.datastax.astra.client.Collection

parsing output json

RESULT_DELETED_COUNT - Static variable in class com.datastax.astra.client.Collection

parsing output json

RESULT_MATCHED_COUNT - Static variable in class com.datastax.astra.client.Collection

parsing output json

RESULT_MODIFIED_COUNT - Static variable in class com.datastax.astra.client.Collection

parsing output json

RESULT_MORE_DATA - Static variable in class com.datastax.astra.client.Collection

parsing output json

RESULT_UPSERTED_ID - Static variable in class com.datastax.astra.client.Collection

parsing output json

retryConfig - Variable in class com.datastax.astra.internal.http.RetryHttpClient

Default retry configuration.

RetryHttpClient - Class in com.datastax.astra.internal.http

Http Client using JDK11 client with a retry mechanism.

RetryHttpClient() - Constructor for class com.datastax.astra.internal.http.RetryHttpClient

Default initialization of http client.

RetryHttpClient(HttpClientOptions) - Constructor for class com.datastax.astra.internal.http.RetryHttpClient

Initialize the instance with all items

ReturnDocument - Enum in com.datastax.astra.client.model

Enum to define the return document option.

returnDocumentAfter() - Method in class com.datastax.astra.client.model.FindOneAndReplaceOptions

Builder Pattern, update the returnDocument flag

returnDocumentAfter() - Static method in class com.datastax.astra.client.model.FindOneAndUpdateOptions.Builder

Deprecated.

Initializes the building process with returnDocument options.

returnDocumentAfter() - Method in class com.datastax.astra.client.model.FindOneAndUpdateOptions

Builder Pattern, update the returnDocument flag

returnDocumentBefore() - Method in class com.datastax.astra.client.model.FindOneAndReplaceOptions

Builder Pattern, update the returnDocument flag

returnDocumentBefore() - Static method in class com.datastax.astra.client.model.FindOneAndUpdateOptions.Builder

Deprecated.

Initializes the building process with returnDocument options.

returnDocumentBefore() - Method in class com.datastax.astra.client.model.FindOneAndUpdateOptions

Builder Pattern, update the returnDocument flag

runCommand(Command) - Method in interface com.datastax.astra.client.model.CommandRunner

Command to return the payload as a Map.

runCommand(Command, CommandOptions<?>) - Method in interface com.datastax.astra.client.model.CommandRunner

Command to return the payload as a Map.

runCommand(Command, CommandOptions<?>) - Method in class com.datastax.astra.internal.command.AbstractCommandRunner

Command to return the payload as a Map.

runCommand(Command, CommandOptions<?>, Class<T>) - Method in interface com.datastax.astra.client.model.CommandRunner

Extension point to run any command with typing constraints.

runCommand(Command, CommandOptions<?>, Class<T>) - Method in class com.datastax.astra.internal.command.AbstractCommandRunner

Extension point to run any command with typing constraints.

runCommand(Command, Class<T>) - Method in interface com.datastax.astra.client.model.CommandRunner

Extension point to run any command with typing constraints.

S

serialize(Command, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.client.model.Command.CommandSerializer

serialize(ObjectId, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.utils.CustomObjectIdSerializer

serialize(UUIDv6, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.utils.CustomUuidv6Serializer

serialize(UUIDv7, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.utils.CustomUuidv7Serializer

serialize(Instant, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.utils.CustomEJsonInstantSerializer

serialize(Calendar, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.utils.CustomEJsonCalendarSerializer

serialize(Date, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.utils.CustomEJsonDateSerializer

serialize(UUID, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.utils.CustomUuidSerializer

Service() - Constructor for class com.datastax.astra.client.model.CollectionOptions.Service

Default constructor.

set(Document) - Method in class com.datastax.astra.client.model.Update

Builder pattern

set(String, Object) - Method in class com.datastax.astra.client.model.Update

Builder pattern

set(String, Object) - Static method in class com.datastax.astra.client.model.Updates

Initialize an with the key and value.

SIMILARITY - Enum constant in enum com.datastax.astra.client.model.DataAPIKeywords

SIMILARITY.

SimilarityMetric - Enum in com.datastax.astra.client.model

Similarity metric.

SIMPLE_STRATEGY - Enum constant in enum com.datastax.astra.client.model.KeyspaceInformation.ReplicationStrategy

The simple strategy, for development environments.

SIMPLE_STRATEGY - Enum constant in enum com.datastax.astra.client.model.NamespaceInformation.ReplicationStrategy

Deprecated.

The simple strategy, for development environments.

simpleStrategy(int) - Static method in class com.datastax.astra.client.model.KeyspaceOptions

Enforce the creation of a namespace with SimpleStrategy.

simpleStrategy(int) - Static method in class com.datastax.astra.client.model.NamespaceOptions

Deprecated.

Enforce the creation of a namespace with SimpleStrategy.

size() - Method in class com.datastax.astra.client.model.Document

SIZE - Enum constant in enum com.datastax.astra.client.model.DataAPIKeywords

SIZE.

skip(int) - Method in class com.datastax.astra.client.model.FindOptions

Add a skip clause in the find block

slice(String, Integer, Integer) - Static method in class com.datastax.astra.client.model.Projections

Specifies the number of elements in an array to return in the query result.

SLICE - Enum constant in enum com.datastax.astra.client.model.DataAPIKeywords

SIMILARITY.

sort(float[], Sort...) - Method in class com.datastax.astra.client.model.DeleteOneOptions

Add a criteria with $vector in the sort clause

sort(float[], Sort...) - Method in class com.datastax.astra.client.model.FindOneAndDeleteOptions

Add a criteria with $vector in the sort clause

sort(float[], Sort...) - Method in class com.datastax.astra.client.model.FindOneAndReplaceOptions

Add a criteria with $vector in the sort clause

sort(float[], Sort...) - Static method in class com.datastax.astra.client.model.FindOneAndUpdateOptions.Builder

Deprecated.

Initializes the building process with vector options.

sort(float[], Sort...) - Method in class com.datastax.astra.client.model.FindOneAndUpdateOptions

Add a criteria with $vector in the sort clause

sort(float[], Sort...) - Method in class com.datastax.astra.client.model.FindOneOptions

Add a criteria with $vector in the sort clause

sort(float[], Sort...) - Method in class com.datastax.astra.client.model.FindOptions

Add a criteria with $vector in the sort clause

sort(Document) - Method in class com.datastax.astra.client.model.FindOneAndDeleteOptions

Syntax sugar as delete option is only a sort Could be like Map.of("$vectorize", "command, "field1", 1, "field2", -1);

sort(Document) - Method in class com.datastax.astra.client.model.FindOneAndReplaceOptions

Syntax sugar as delete option is only a sort Could be like Map.of("$vectorize", "command, "field1", 1, "field2", -1);

sort(Document) - Method in class com.datastax.astra.client.model.FindOneAndUpdateOptions

Syntax sugar as delete option is only a sort Could be like Map.of("$vectorize", "command, "field1", 1, "field2", -1);

sort(Document) - Method in class com.datastax.astra.client.model.FindOneOptions

Syntax sugar as delete option is only a sort Could be like Map.of("$vectorize", "command, "field1", 1, "field2", -1);

sort(Document) - Method in class com.datastax.astra.client.model.FindOptions

Syntax sugar as delete option is only a sort Could be like Map.of("$vectorize", "command, "field1", 1, "field2", -1);

sort(Sort...) - Static method in class com.datastax.astra.client.model.DeleteOneOptions.Builder

Deprecated.

Initializes the building process with sorting options.

sort(Sort...) - Method in class com.datastax.astra.client.model.DeleteOneOptions

Syntax sugar as delete option is only a sort

sort(Sort...) - Method in class com.datastax.astra.client.model.FindOneAndDeleteOptions

Syntax sugar as delete option is only a sort

sort(Sort...) - Method in class com.datastax.astra.client.model.FindOneAndReplaceOptions

Syntax sugar as delete option is only a sort

sort(Sort...) - Static method in class com.datastax.astra.client.model.FindOneAndUpdateOptions.Builder

Deprecated.

Initializes the building process with sorting options.

sort(Sort...) - Method in class com.datastax.astra.client.model.FindOneAndUpdateOptions

Syntax sugar as delete option is only a sort

sort(Sort...) - Method in class com.datastax.astra.client.model.FindOneOptions

Syntax sugar as delete option is only a sort

sort(Sort...) - Method in class com.datastax.astra.client.model.FindOptions

Syntax sugar as delete option is only a sort

sort(Sort...) - Static method in class com.datastax.astra.client.model.UpdateOneOptions.Builder

Deprecated.

Initializes the building process with sorting options.

sort(Sort...) - Method in class com.datastax.astra.client.model.UpdateOneOptions

Syntax sugar as delete option is only a sort

sort(Sort...) - Static method in class com.datastax.astra.internal.utils.OptionsUtils

Fluent api.

sort(String, Sort...) - Method in class com.datastax.astra.client.model.DeleteOneOptions

Add a criteria with $vectorize in the sort clause

sort(String, Sort...) - Method in class com.datastax.astra.client.model.FindOneAndDeleteOptions

Add a criteria with $vectorize in the sort clause.

sort(String, Sort...) - Method in class com.datastax.astra.client.model.FindOneAndReplaceOptions

Add a criteria with $vectorize in the sort clause.

sort(String, Sort...) - Static method in class com.datastax.astra.client.model.FindOneAndUpdateOptions.Builder

Deprecated.

Initializes the building process with vectorize options.

sort(String, Sort...) - Method in class com.datastax.astra.client.model.FindOneAndUpdateOptions

Add a criteria with $vectorize in the sort clause.

sort(String, Sort...) - Method in class com.datastax.astra.client.model.FindOneOptions

Add a criteria with $vectorize in the sort clause.

sort(String, Sort...) - Method in class com.datastax.astra.client.model.FindOptions

Add a criteria with $vectorize in the sort clause.

sort(Map<String, Object>) - Method in class com.datastax.astra.client.model.FindOneAndDeleteOptions

Syntax sugar as delete option is only a sort Could be like Map.of("$vectorize", "command, "field1", 1, "field2", -1);

sort(Map<String, Object>) - Method in class com.datastax.astra.client.model.FindOneAndReplaceOptions

Syntax sugar as delete option is only a sort Could be like Map.of("$vectorize", "command, "field1", 1, "field2", -1);

sort(Map<String, Object>) - Method in class com.datastax.astra.client.model.FindOneAndUpdateOptions

Syntax sugar as delete option is only a sort Could be like Map.of("$vectorize", "command, "field1", 1, "field2", -1);

sort(Map<String, Object>) - Method in class com.datastax.astra.client.model.FindOneOptions

Syntax sugar as delete option is only a sort Could be like Map.of("$vectorize", "command, "field1", 1, "field2", -1);

sort(Map<String, Object>) - Method in class com.datastax.astra.client.model.FindOptions

Syntax sugar as delete option is only a sort Could be like Map.of("$vectorize", "command, "field1", 1, "field2", -1);

Sort - Class in com.datastax.astra.client.model

Class to help building a projection.

Sort(String, SortOrder) - Constructor for class com.datastax.astra.client.model.Sort

Default Constructor.

SORT_VECTOR - Enum constant in enum com.datastax.astra.client.model.DataAPIKeywords

SORT VECTOR.

SortOrder - Enum in com.datastax.astra.client.model

Encode the sort order in results.

Sorts - Class in com.datastax.astra.client.model

Utility class to hold the sort options for a query.

sortVector - Variable in class com.datastax.astra.client.model.Page

Sort vector retrieved in the status.

StaticTokenProvider - Class in com.datastax.astra.client.auth

Static token, never expires..

StaticTokenProvider(String) - Constructor for class com.datastax.astra.client.auth.StaticTokenProvider

Constructor with all parameters.

T

timeout(int) - Static method in class com.datastax.astra.client.model.InsertManyOptions.Builder

Deprecated.

Initializes the building process with timeout options.

timeout(int) - Method in class com.datastax.astra.client.model.InsertManyOptions

Setter for timeout.

toByteArray() - Method in class com.datastax.astra.client.model.ObjectId

Convert to a byte array.

toHexString() - Method in class com.datastax.astra.client.model.ObjectId

Converts this instance into a 24-byte hexadecimal string representation.

toJson() - Method in class com.datastax.astra.client.model.Document

Serialization with Jackson.

toJson() - Method in class com.datastax.astra.client.model.Filter

Express the json filter as a string.

token - Variable in class com.datastax.astra.client.model.CommandOptions

Token to use for authentication.

token(String) - Method in class com.datastax.astra.client.model.CommandOptions

Provide the token.

Token() - Constructor for class com.datastax.astra.client.model.EmbeddingProvider.Token

Default constructor.

TOKEN_HEADER_PARAM - Static variable in class com.datastax.astra.client.admin.AstraDBAdmin

Header name used to hold the Astra Token.

TokenProvider - Interface in com.datastax.astra.client.auth

To work the APi needs a token.

TooManyDocumentsToCountException - Exception Class in com.datastax.astra.client.exception

Error when too many documents in the collection

TooManyDocumentsToCountException() - Constructor for exception class com.datastax.astra.client.exception.TooManyDocumentsToCountException

Default constructor.

TooManyDocumentsToCountException(int) - Constructor for exception class com.datastax.astra.client.exception.TooManyDocumentsToCountException

Default constructor.

toString() - Method in class com.datastax.astra.client.model.CollectionInfo

toString() - Method in class com.datastax.astra.client.model.Document

Serialization with Jackson.

toString() - Method in class com.datastax.astra.client.model.Filter

Serialization with Jackson.

toString() - Method in class com.datastax.astra.client.model.KeyspaceInformation

toString() - Method in class com.datastax.astra.client.model.NamespaceInformation

Deprecated.

toString() - Method in class com.datastax.astra.client.model.ObjectId

toString() - Method in class com.datastax.astra.client.model.UUIDv6

toString() - Method in class com.datastax.astra.client.model.UUIDv7

totalItemProcessed - Variable in class com.datastax.astra.client.model.PageableIterable

Check host many has been processed (skip and limit support)

toUUID() - Method in class com.datastax.astra.client.model.UUIDv6

Return the Java Utils UUID.

toUUID() - Method in class com.datastax.astra.client.model.UUIDv7

Return the Java Utils UUID.

U

unMarshallBean(String, Class<T>) - Static method in class com.datastax.astra.internal.utils.JsonUtils

Load body as expected object.

unregisterObserver(Class<CommandObserver>) - Method in class com.datastax.astra.client.model.CommandOptions

Remove an observer by its class.

unregisterObserver(String) - Method in class com.datastax.astra.client.model.CommandOptions

Remove a listener from the command.

unset(String) - Method in class com.datastax.astra.client.model.Update

Builder pattern

unset(String) - Static method in class com.datastax.astra.client.model.Updates

Initialize an with the key and value.

Update - Class in com.datastax.astra.client.model

Encore the update document

Update() - Constructor for class com.datastax.astra.client.model.Update

Default constructor.

Update(String) - Constructor for class com.datastax.astra.client.model.Update

Default constructor.

Update(Map<String, Object>) - Constructor for class com.datastax.astra.client.model.Update

Default constructor.

updateCurrentDate(String...) - Method in class com.datastax.astra.client.model.Update

Builder pattern

updateCurrentDate(String...) - Static method in class com.datastax.astra.client.model.Updates

Initialize an with the key and value.

updateMany(Filter, Update) - Method in class com.datastax.astra.client.Collection

Update all documents in the collection according to the specified arguments.

updateMany(Filter, Update, UpdateManyOptions) - Method in class com.datastax.astra.client.Collection

Update all documents in the collection according to the specified arguments.

UpdateManyOptions - Class in com.datastax.astra.client.model

Options for the updateOne operation

UpdateManyOptions() - Constructor for class com.datastax.astra.client.model.UpdateManyOptions

Default constructor.

UpdateManyOptions.Builder - Class in com.datastax.astra.client.model

Deprecated.

updateMul(Map<String, Double>) - Method in class com.datastax.astra.client.model.Update

Builder pattern

updateOne(Filter, Update) - Method in class com.datastax.astra.client.Collection

Update a single document in the collection according to the specified arguments.

updateOne(Filter, Update, UpdateOneOptions) - Method in class com.datastax.astra.client.Collection

Update a single document in the collection according to the specified arguments.

UpdateOneOptions - Class in com.datastax.astra.client.model

Options for the updateOne operation

UpdateOneOptions() - Constructor for class com.datastax.astra.client.model.UpdateOneOptions

Default constructor.

UpdateOneOptions.Builder - Class in com.datastax.astra.client.model

Deprecated.

UpdateResult - Class in com.datastax.astra.client.model

Return update result.

UpdateResult() - Constructor for class com.datastax.astra.client.model.UpdateResult

Default constructor.

Updates - Class in com.datastax.astra.client.model

Helper for Syntax with updates.

updateSetOnInsert(Map<String, Double>) - Method in class com.datastax.astra.client.model.Update

Builder pattern

updateSetOnInsert(Map<String, Double>) - Static method in class com.datastax.astra.client.model.Updates

Initialize an with the key and value.

upsert(boolean) - Static method in class com.datastax.astra.client.model.ReplaceOneOptions.Builder

Deprecated.

Create a new instance of ReplaceOneOptions.

upsert(boolean) - Static method in class com.datastax.astra.client.model.UpdateManyOptions.Builder

Deprecated.

Create a new instance of UpdateManyOptions.

upsert(boolean) - Static method in class com.datastax.astra.client.model.UpdateOneOptions.Builder

Deprecated.

Create a new instance of UpdateOneOptions.

upsert(Boolean) - Method in class com.datastax.astra.client.model.FindOneAndReplaceOptions

Builder Pattern, update the upsert flag.

upsert(Boolean) - Static method in class com.datastax.astra.client.model.FindOneAndUpdateOptions.Builder

Deprecated.

Initializes the building process with upsert options.

upsert(Boolean) - Method in class com.datastax.astra.client.model.FindOneAndUpdateOptions

Builder Pattern, update the upsert flag.

upsert(Boolean) - Method in class com.datastax.astra.client.model.ReplaceOneOptions

Upsert flag.

upsert(Boolean) - Method in class com.datastax.astra.client.model.UpdateManyOptions

Upsert flag.

upsert(Boolean) - Method in class com.datastax.astra.client.model.UpdateOneOptions

Upsert flag.

useKeyspace(String) - Method in class com.datastax.astra.client.Database

Deprecated.

useNamespace(String) - Method in class com.datastax.astra.client.Database

Deprecated.

use Database.useKeyspace(String)

userAgents - Variable in class com.datastax.astra.internal.http.RetryHttpClient

Default settings in Request and Retry

UsernamePasswordTokenProvider - Class in com.datastax.astra.client.auth

Creating a token with base64 encoded credentials.

UsernamePasswordTokenProvider() - Constructor for class com.datastax.astra.client.auth.UsernamePasswordTokenProvider

Using defaults settings.

UsernamePasswordTokenProvider(String, String) - Constructor for class com.datastax.astra.client.auth.UsernamePasswordTokenProvider

Full-fledged constructor.

UUID - Enum constant in enum com.datastax.astra.client.model.CollectionIdTypes

UUID v4, the default random UUID.

UUID - Enum constant in enum com.datastax.astra.client.model.DataAPIKeywords

UUID

UUIDv6 - Class in com.datastax.astra.client.model

Materializing the UUIDv6 as a specialization class to drive serialization and deserialization.

UUIDv6() - Constructor for class com.datastax.astra.client.model.UUIDv6

Default constructor.

UUIDv6(UUID) - Constructor for class com.datastax.astra.client.model.UUIDv6

Constructor.

UUIDV6 - Enum constant in enum com.datastax.astra.client.model.CollectionIdTypes

UUID in version v6 allowing natural ordering.

UUIDv7 - Class in com.datastax.astra.client.model

Materializing the UUIDv6 as a specialization class to drive serialization and deserialization.

UUIDv7() - Constructor for class com.datastax.astra.client.model.UUIDv7

Default constructor.

UUIDv7(UUID) - Constructor for class com.datastax.astra.client.model.UUIDv7

Constructor.

UUIDV7 - Enum constant in enum com.datastax.astra.client.model.CollectionIdTypes

UUID in version v7, random and time-based.

V

Validation() - Constructor for class com.datastax.astra.client.model.EmbeddingProvider.Validation

Default constructor.

valueOf(String) - Static method in enum com.datastax.astra.client.DataAPIOptions.DataAPIDestination

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.datastax.astra.client.model.CollectionIdTypes

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.datastax.astra.client.model.DataAPIKeywords

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.datastax.astra.client.model.FilterOperator

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.datastax.astra.client.model.KeyspaceInformation.ReplicationStrategy

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.datastax.astra.client.model.NamespaceInformation.ReplicationStrategy

Deprecated.

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.datastax.astra.client.model.ReturnDocument

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.datastax.astra.client.model.SimilarityMetric

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.datastax.astra.client.model.SortOrder

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.datastax.astra.client.DataAPIOptions.DataAPIDestination

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.datastax.astra.client.model.CollectionIdTypes

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.datastax.astra.client.model.DataAPIKeywords

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Method in class com.datastax.astra.client.model.Document

values() - Static method in enum com.datastax.astra.client.model.FilterOperator

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.datastax.astra.client.model.KeyspaceInformation.ReplicationStrategy

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.datastax.astra.client.model.NamespaceInformation.ReplicationStrategy

Deprecated.

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.datastax.astra.client.model.ReturnDocument

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.datastax.astra.client.model.SimilarityMetric

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.datastax.astra.client.model.SortOrder

Returns an array containing the constants of this enum type, in the order they are declared.

vector(float[]) - Method in class com.datastax.astra.client.model.Document

Set the vector value.

vector(float[]) - Static method in class com.datastax.astra.client.model.Sorts

Build a sort clause with a vector.

vector(float[], Sort...) - Static method in class com.datastax.astra.client.model.DeleteOneOptions.Builder

Deprecated.

Initializes the building process with vector options.

vector(float[], Sort...) - Static method in class com.datastax.astra.client.model.UpdateOneOptions.Builder

Deprecated.

Initializes the building process with sorting options.

vector(float[], Sort...) - Method in class com.datastax.astra.client.model.UpdateOneOptions

Add a criteria with $vector in the sort clause

vector(int, SimilarityMetric) - Method in class com.datastax.astra.client.model.CollectionOptions.CollectionOptionsBuilder

Builder pattern.

VECTOR - Enum constant in enum com.datastax.astra.client.model.DataAPIKeywords

VECTOR.

vectorDimension(int) - Method in class com.datastax.astra.client.model.CollectionOptions.CollectionOptionsBuilder

Builder pattern.

vectorize(String) - Method in class com.datastax.astra.client.model.Document

Add a vectorize attribute to the document.

vectorize(String) - Static method in class com.datastax.astra.client.model.Sorts

Build a sort clause with vectorize.

vectorize(String, Sort...) - Static method in class com.datastax.astra.client.model.DeleteOneOptions.Builder

Deprecated.

Initializes the building process with vectorize options.

vectorize(String, Sort...) - Static method in class com.datastax.astra.client.model.UpdateOneOptions.Builder

Deprecated.

Initializes the building process with sorting options.

vectorize(String, Sort...) - Method in class com.datastax.astra.client.model.UpdateOneOptions

Add a criteria with $vectorize in the sort clause

vectorize(String, String) - Method in class com.datastax.astra.client.model.CollectionOptions.CollectionOptionsBuilder

Enable Vectorization within the collection.

vectorize(String, String, String) - Method in class com.datastax.astra.client.model.CollectionOptions.CollectionOptionsBuilder

Enable Vectorization within the collection.

vectorize(String, String, String, Map<String, Object>) - Method in class com.datastax.astra.client.model.CollectionOptions.CollectionOptionsBuilder

Enable Vectorization within the collection.

VECTORIZE - Enum constant in enum com.datastax.astra.client.model.DataAPIKeywords

VECTORIZE.

VectorOptions() - Constructor for class com.datastax.astra.client.model.CollectionOptions.VectorOptions

Default constructor.

vectorSimilarity(SimilarityMetric) - Method in class com.datastax.astra.client.model.CollectionOptions.CollectionOptionsBuilder

Builder pattern.

W

WAIT_IN_SECONDS - Static variable in class com.datastax.astra.client.admin.AstraDBAdmin

Default timeout in seconds.

where(String) - Method in class com.datastax.astra.client.model.Filter

Work with arguments.

where(String, FilterOperator, Object) - Method in class com.datastax.astra.client.model.Filter

Build where clause with operator

withApiResponse(ApiResponse) - Method in class com.datastax.astra.internal.command.ExecutionInfos.DataApiExecutionInfoBuilder

Populate after http call.

withApiVersion(String) - Method in class com.datastax.astra.client.DataAPIOptions.DataAPIClientOptionsBuilder

Builder pattern, update api version.

withCaller(String, String) - Method in class com.datastax.astra.client.DataAPIOptions.DataAPIClientOptionsBuilder

Builder pattern, update caller information. o

withCommand(Command) - Method in class com.datastax.astra.internal.command.ExecutionInfos.DataApiExecutionInfoBuilder

Populate after http call.

withDestination(DataAPIOptions.DataAPIDestination) - Method in class com.datastax.astra.client.DataAPIOptions.DataAPIClientOptionsBuilder

Builder pattern, update http connection Timeout

withDocument(Object) - Method in class com.datastax.astra.client.model.Command

Builder pattern, update document.

withDocuments(List<T>) - Method in class com.datastax.astra.client.model.Command

Builder pattern, update documents.

withEmbeddingAPIKey(String) - Method in class com.datastax.astra.client.DataAPIOptions.DataAPIClientOptionsBuilder

Builder pattern, update http connection Timeout

withEmbeddingAuthProvider(EmbeddingHeadersProvider) - Method in class com.datastax.astra.client.DataAPIOptions.DataAPIClientOptionsBuilder

Builder pattern, update authentication provider for vectorize.

withFilter(Filter) - Method in class com.datastax.astra.client.model.Command

Builder pattern, update filter.

withHtpVersion(HttpClient.Version) - Method in class com.datastax.astra.client.DataAPIOptions.DataAPIClientOptionsBuilder

Builder pattern, update http version

withHttpConnectTimeout(int) - Method in class com.datastax.astra.client.DataAPIOptions.DataAPIClientOptionsBuilder

Builder pattern, update http connection Timeout

withHttpProxy(DataAPIOptions.HttpProxy) - Method in class com.datastax.astra.client.DataAPIOptions.DataAPIClientOptionsBuilder

Builder pattern, update http httpProxy

withHttpRedirect(HttpClient.Redirect) - Method in class com.datastax.astra.client.DataAPIOptions.DataAPIClientOptionsBuilder

Builder pattern, update http redirect

withHttpResponse(ApiResponseHttp) - Method in class com.datastax.astra.internal.command.ExecutionInfos.DataApiExecutionInfoBuilder

Populate after http call.

withHttpRetryCount(int) - Method in class com.datastax.astra.client.DataAPIOptions.DataAPIClientOptionsBuilder

Builder pattern, update http retry count

withHttpRetryDelayMillis(int) - Method in class com.datastax.astra.client.DataAPIOptions.DataAPIClientOptionsBuilder

Sets the delay between retry attempts when the number of retries is greater than 1.

withMaxDocumentCount(int) - Method in class com.datastax.astra.client.DataAPIOptions.DataAPIClientOptionsBuilder

Sets the maximum number of documents that can be returned by the count function.

withMaxDocumentsInInsert(int) - Method in class com.datastax.astra.client.DataAPIOptions.DataAPIClientOptionsBuilder

Sets the maximum number of documents that can be inserted in a single operation.

withMaxPageSize(int) - Method in class com.datastax.astra.client.DataAPIOptions.DataAPIClientOptionsBuilder

Sets the maximum number of documents that can be returned in a single page.

withMaxTimeMS(long) - Method in class com.datastax.astra.client.DataAPIOptions.DataAPIClientOptionsBuilder

Builder pattern, update http request Timeout in millis

withObserver(CommandObserver) - Method in class com.datastax.astra.client.DataAPIOptions.DataAPIClientOptionsBuilder

Register an observer with its className.

withObserver(String, CommandObserver) - Method in class com.datastax.astra.client.DataAPIOptions.DataAPIClientOptionsBuilder

Allow to register a listener for the command.

withOptions(Object) - Method in class com.datastax.astra.client.model.Command

Builder pattern, update options.

withProjection(Map<String, Object>) - Method in class com.datastax.astra.client.model.Command

Builder pattern, update projection.

withReplacement(Object) - Method in class com.datastax.astra.client.model.Command

Builder pattern, update replacement document.

withRequestHeaders(Map<String, List<String>>) - Method in class com.datastax.astra.internal.command.ExecutionInfos.DataApiExecutionInfoBuilder

Populate after http call.

withRequestUrl(String) - Method in class com.datastax.astra.internal.command.ExecutionInfos.DataApiExecutionInfoBuilder

Populate after http call.

withSort(Document) - Method in class com.datastax.astra.client.model.Command

Builder pattern, update sort.

withUpdate(Update) - Method in class com.datastax.astra.client.model.Command

Builder pattern, Update.

Y

yellow(String) - Static method in class com.datastax.astra.internal.utils.AnsiUtils

write yellow.

A B C D E F G H I J K L M N O P Q R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form