Index

A B C D E F G H I 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<OPTIONS> - Class in com.datastax.astra.internal.command
Abstract base class for executing commands and handling their results.
AbstractCommandRunner() - Constructor for class com.datastax.astra.internal.command.AbstractCommandRunner
Default constructor.
AbstractCommandRunner(String, OPTIONS) - Constructor for class com.datastax.astra.internal.command.AbstractCommandRunner
Constructor with the API endpoint and default options.
AbstractCursor<T,R> - Class in com.datastax.astra.internal.command
Implementation of a cursor across the find items
AbstractCursor(Class<R>) - Constructor for class com.datastax.astra.internal.command.AbstractCursor
Cursor to iterate on the result of a query.
add(String, Object) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Put the given key/value pair into this Document and return this.
addAdminAdditionalHeader(String, String) - Method in class com.datastax.astra.client.core.options.DataAPIClientOptions
Add a header to the admin calls.
addArg(String, String) - Method in class com.datastax.astra.client.core.lexical.Analyzer.LexicalFilter
Adds an argument to the filter.
addAscii(String, String) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds an ASCII-encoded text value to the row.
addAuthentication(String, Object) - Method in class com.datastax.astra.client.core.rerank.RerankServiceOptions
Adds a single authentication key-value pair to the authentication map.
addAuthentication(String, Object) - Method in class com.datastax.astra.client.core.vectorize.VectorServiceOptions
Adds a single authentication key-value pair to the authentication map.
addBigInt(String, Long) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds a BigInt value to the row.
addBlob(String, byte[]) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds a Blob (byte array) to the row.
addBoolean(String, Boolean) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds a Boolean value to the row.
addCaller(Caller) - Method in class com.datastax.astra.client.core.http.HttpClientOptions
Add a caller.
addCaller(String, String) - Method in class com.datastax.astra.client.core.options.DataAPIClientOptions
Builder pattern, update caller information.
addChartFilter(String) - Method in class com.datastax.astra.client.core.lexical.Analyzer
Adds a char filter to the analyzer.
addChartFilter(String, Map<String, String>) - Method in class com.datastax.astra.client.core.lexical.Analyzer
Adds a char filter to the analyzer.
addColumn(String, RerankServiceOptions) - Method in class com.datastax.astra.client.tables.commands.AlterTableAddReranking
Adds a new column with the specified name and reranking options.
addColumn(String, VectorServiceOptions) - Method in class com.datastax.astra.client.tables.commands.AlterTableAddVectorize
Adds a new column with the specified name and vectorization options.
addColumn(String, ColumnDefinition) - Method in class com.datastax.astra.client.tables.definition.TableDefinition
Adds a column to the table definition.
addColumn(String, ColumnTypes) - Method in class com.datastax.astra.client.tables.commands.AlterTableAddColumns
Adds a column with the specified name and type to the table.
addColumn(String, ColumnTypes) - Method in class com.datastax.astra.client.tables.definition.TableDefinition
Adds a column to the table with a specific type.
addColumnAscii(String) - Method in class com.datastax.astra.client.tables.definition.TableDefinition
Adds an ascii column to the table.
addColumnBigInt(String) - Method in class com.datastax.astra.client.tables.definition.TableDefinition
Adds a boolean column to the table.
addColumnBlob(String) - Method in class com.datastax.astra.client.tables.definition.TableDefinition
Adds a blob column to the table.
addColumnBoolean(String) - Method in class com.datastax.astra.client.tables.commands.AlterTableAddColumns
Adds a column with the BOOLEAN type.
addColumnBoolean(String) - Method in class com.datastax.astra.client.tables.definition.TableDefinition
Adds a boolean column to the table.
addColumnInt(String) - Method in class com.datastax.astra.client.tables.commands.AlterTableAddColumns
Adds a column with the INT type.
addColumnInt(String) - Method in class com.datastax.astra.client.tables.definition.TableDefinition
Adds an integer column to the table.
addColumnList(String, ColumnTypes) - Method in class com.datastax.astra.client.tables.commands.AlterTableAddColumns
Adds a column with the LIST type, where the list items are of the specified value type.
addColumnList(String, ColumnTypes) - Method in class com.datastax.astra.client.tables.definition.TableDefinition
Adds a list column to the table.
addColumnMap(String, ColumnTypes, ColumnTypes) - Method in class com.datastax.astra.client.tables.commands.AlterTableAddColumns
Adds a column with the MAP type, where the keys and values are of the specified types.
addColumnMap(String, ColumnTypes, ColumnTypes) - Method in class com.datastax.astra.client.tables.definition.TableDefinition
Adds a map column to the table.
addColumnSet(String, ColumnTypes) - Method in class com.datastax.astra.client.tables.commands.AlterTableAddColumns
Adds a column with the SET type, where the set items are of the specified value type.
addColumnSet(String, ColumnTypes) - Method in class com.datastax.astra.client.tables.definition.TableDefinition
Adds a set column to the table.
addColumnText(String) - Method in class com.datastax.astra.client.tables.commands.AlterTableAddColumns
Adds a column with the TEXT type.
addColumnText(String) - Method in class com.datastax.astra.client.tables.definition.TableDefinition
Adds a text column to the table.
addColumnTimestamp(String) - Method in class com.datastax.astra.client.tables.definition.TableDefinition
Adds a timestamp column to the table.
addColumnVector(String, ColumnDefinitionVector) - Method in class com.datastax.astra.client.tables.commands.AlterTableAddColumns
Adds a column defined by a ColumnDefinitionVector.
addColumnVector(String, ColumnDefinitionVector) - Method in class com.datastax.astra.client.tables.definition.TableDefinition
Adds a vector column to the table.
addDatabaseAdditionalHeader(String, String) - Method in class com.datastax.astra.client.core.options.DataAPIClientOptions
Add a header to the db calls.
addDate(String, Date) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds a Date value to the row.
addDecimal(String, BigDecimal) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds a Decimal (BigDecimal) value to the row.
addDouble(String, Double) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds a Double value to the row.
addDuration(String, Duration) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds a Duration value to the row.
addDuration(String, Period) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds a duration value composed of only a Period to the row.
addDuration(String, Period, Duration) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds a Duration value to the row.
addFilter(String) - Method in class com.datastax.astra.client.core.lexical.Analyzer
Adds a filter to the analyzer.
addFilter(String, Map<String, String>) - Method in class com.datastax.astra.client.core.lexical.Analyzer
Adds a filter to the analyzer.
addFloat(String, Float) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds a Float value to the row.
addHybrid(Hybrid) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Add a vectorize attribute to the document.
addInet(String, InetAddress) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds an InetAddress value to the row.
addInt(String, Integer) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds an Integer value to the row.
addList(String, List<T>) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds a list to the row.
addLocalDate(String, LocalDate) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds a LocalDate value to the row, converting it to a Date.
addMap(String, Map<K, V>) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds a map to the row.
addObserver(CommandObserver) - Method in class com.datastax.astra.client.core.options.DataAPIClientOptions
Register an observer with its className.
addObserver(String, CommandObserver) - Method in class com.datastax.astra.client.core.options.DataAPIClientOptions
Register an observer with its className.
addPartitionBy(String) - Method in class com.datastax.astra.client.tables.definition.TableDefinition
Adds a partition key to the table's primary key.
addPartitionSort(Sort) - Method in class com.datastax.astra.client.tables.definition.TableDefinition
Adds a sort column to the table's primary key.
addSet(String, Set<T>) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds a set to the row.
addSmallInt(String, Short) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds a SmallInt value to the row.
addTableDuration(String, TableDuration) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds a TableDuration value to the row.
addText(String, String) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds a text value to the row.
addTime(String, LocalTime) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds a LocalTime value to the row.
addTimeStamp(String, Instant) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds a timestamp (Instant) value to the row.
addTinyInt(String, Byte) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds a TinyInt value to the row.
addTo(Temporal) - Method in class com.datastax.astra.client.tables.definition.TableDuration
addToSet(String, Object) - Method in class com.datastax.astra.client.collections.commands.Update
Builder pattern
addToSet(String, Object) - Static method in class com.datastax.astra.client.collections.commands.Updates
addUUID(String, UUID) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds a UUID value to the row.
addVarInt(String, BigInteger) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds a variable-length integer (VarInt) value to the row.
addVector(String, float[]) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds a vector (float array) to the row, wrapping it in a DataAPIVector.
addVector(String, DataAPIVector) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds a DataAPIVector value to the row.
addVectorize(String, String) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Adds a vectorized value to the row.
adminAdditionalHeaders(Map<String, String>) - Method in class com.datastax.astra.client.core.options.BaseOptions
Provide the token.
AdminOptions - Class in com.datastax.astra.client.admin
Represents the configuration options for administrative operations in the database API.
AdminOptions() - Constructor for class com.datastax.astra.client.admin.AdminOptions
Serializer for the collections.
AdminOptions(String, DataAPIClientOptions) - Constructor for class com.datastax.astra.client.admin.AdminOptions
Constructs an AdminOptions instance with the specified token and options.
AFTER - Enum constant in enum class com.datastax.astra.client.collections.commands.ReturnDocument
if set to after, the command will return the document after the update
all(String, Object...) - Static method in class com.datastax.astra.client.core.query.Filters
Build a filter with the `$all` operator.
ALL - Enum constant in enum class com.datastax.astra.client.core.DataAPIKeywords
ALL.
allDone(List<CompletionStage<T>>) - Static method in class com.datastax.astra.internal.utils.CompletableFutures
Merge multiple CompletionStage in a single one
alter(AlterTableOperation) - Method in class com.datastax.astra.client.tables.Table
Performs an alteration operation on the table with default options.
alter(AlterTableOperation, AlterTableOptions) - Method in class com.datastax.astra.client.tables.Table
Performs an alteration operation on the table with the specified options.
alter(AlterTableOperation, AlterTableOptions, Class<R>) - Method in class com.datastax.astra.client.tables.Table
Performs an alteration operation on the table with the specified options and row class.
AlterTableAddColumns - Class in com.datastax.astra.client.tables.commands
Represents an operation to add columns to an existing table in a database schema.
AlterTableAddColumns() - Constructor for class com.datastax.astra.client.tables.commands.AlterTableAddColumns
Constructs a new AlterTableAddColumns instance.
AlterTableAddReranking - Class in com.datastax.astra.client.tables.commands
Represents an operation to add vectorized columns to a table in a database schema alteration.
AlterTableAddReranking() - Constructor for class com.datastax.astra.client.tables.commands.AlterTableAddReranking
Default constructor.
AlterTableAddVectorize - Class in com.datastax.astra.client.tables.commands
Represents an operation to add vectorized columns to a table in a database schema alteration.
AlterTableAddVectorize() - Constructor for class com.datastax.astra.client.tables.commands.AlterTableAddVectorize
Default constructor.
AlterTableDropColumns - Class in com.datastax.astra.client.tables.commands
Represents an operation to drop columns from a table in a database schema alteration.
AlterTableDropColumns(String...) - Constructor for class com.datastax.astra.client.tables.commands.AlterTableDropColumns
Constructs a new AlterTableDropColumns instance with the specified column names.
AlterTableDropColumns(Set<String>) - Constructor for class com.datastax.astra.client.tables.commands.AlterTableDropColumns
Constructs a new AlterTableDropColumns instance with the specified set of column names.
AlterTableDropVectorize - Class in com.datastax.astra.client.tables.commands
Represents an operation to drop vectorized columns from a table in a database schema alteration.
AlterTableDropVectorize() - Constructor for class com.datastax.astra.client.tables.commands.AlterTableDropVectorize
Default constructor.
AlterTableDropVectorize(String...) - Constructor for class com.datastax.astra.client.tables.commands.AlterTableDropVectorize
Constructs a new AlterTableDropVectorize instance with the specified column names.
AlterTableDropVectorize(Set<String>) - Constructor for class com.datastax.astra.client.tables.commands.AlterTableDropVectorize
Constructs a new AlterTableDropVectorize instance with the specified set of column names.
AlterTableOperation - Interface in com.datastax.astra.client.tables.commands
Represents a generic operation to alter a database table schema.
AlterTableOptions - Class in com.datastax.astra.client.tables.commands.options
Represents options for altering a table in a database schema.
AlterTableOptions() - Constructor for class com.datastax.astra.client.tables.commands.options.AlterTableOptions
Constructs a new AlterTableOptions instance with default settings.
AlterTableRenameColumns - Class in com.datastax.astra.client.tables.commands
Represents an operation to rename columns in a database table.
AlterTableRenameColumns() - Constructor for class com.datastax.astra.client.tables.commands.AlterTableRenameColumns
Default constructor.
analyzer(Analyzer) - Method in class com.datastax.astra.client.tables.definition.indexes.TableTextIndexDefinition
Setter for the analyzer
analyzer(Analyzer) - Method in class com.datastax.astra.client.tables.definition.indexes.TableTextIndexDefinitionOptions
Constructor that accepts an analyzer.
analyzer(AnalyzerTypes) - Method in class com.datastax.astra.client.tables.definition.indexes.TableTextIndexDefinition
Setter for the analyzer with a type
analyzer(AnalyzerTypes) - Method in class com.datastax.astra.client.tables.definition.indexes.TableTextIndexDefinitionOptions
Constructor that accepts an analyzer type.
Analyzer - Class in com.datastax.astra.client.core.lexical
Analyzer used for indexing and searching 'lexical' data.
Analyzer() - Constructor for class com.datastax.astra.client.core.lexical.Analyzer
Default constructor.
Analyzer(AnalyzerTypes) - Constructor for class com.datastax.astra.client.core.lexical.Analyzer
Constructor with analyzer type.
Analyzer(String) - Constructor for class com.datastax.astra.client.core.lexical.Analyzer
Constructor with analyzer definition.
Analyzer.LexicalFilter - Class in com.datastax.astra.client.core.lexical
Definition of filters and tokenizers
AnalyzerSerializer - Class in com.datastax.astra.internal.serdes.core
Serializer for TableIndexColumnDefinition.
AnalyzerSerializer() - Constructor for class com.datastax.astra.internal.serdes.core.AnalyzerSerializer
Default constructor
AnalyzerTypes - Enum Class in com.datastax.astra.client.core.lexical
Enum representing different types of analyzers.
and(Filter...) - Static method in class com.datastax.astra.client.core.query.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.core.query.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.
apiEndpoint - Variable in class com.datastax.astra.internal.command.AbstractCommandRunner
Api Endpoint for the API.
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.
apiSupport - Variable in class com.datastax.astra.client.tables.definition.indexes.TableIndexDefinition
The API support configuration for the table index.
append(String[], Object) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Put the given key/value pair into this Document and return this.
append(String, Object) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Put the given key/value pair into this Document and return this.
append(String, Object) - Method in class com.datastax.astra.client.core.commands.Command
Builder pattern, update documents.
appendIfNotNull(String, Object) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Put the given key/value pair into this Document and return this only if the value is not null.
ARG_CLAZZ - Static variable in class com.datastax.astra.internal.command.AbstractCommandRunner
parameters names.
ARG_DATABASE - Static variable in class com.datastax.astra.internal.command.AbstractCommandRunner
parameters names.
ARG_OPTIONS - Static variable in class com.datastax.astra.client.collections.Collection
parameters names.
ARG_OPTIONS - Static variable in class com.datastax.astra.internal.command.AbstractCommandRunner
parameters names.
ARG_UPDATE - Static variable in class com.datastax.astra.client.collections.Collection
parameters names.
ARG_UPDATE - Static variable in class com.datastax.astra.internal.command.AbstractCommandRunner
parameters names.
args(Map<String, String>) - Method in class com.datastax.astra.client.core.lexical.Analyzer.LexicalFilter
Sets the arguments for the filter.
ascending(String) - Static method in class com.datastax.astra.client.core.query.Sort
Build a sort clause ascending.
ascending(String[]) - Static method in class com.datastax.astra.client.core.query.Sort
Build a sort clause ascending.
ASCENDING - Enum constant in enum class com.datastax.astra.client.core.query.SortOrder
Value for ascending order.
ascii(boolean) - Method in class com.datastax.astra.client.tables.definition.indexes.TableIndexDefinitionOptions
Sets the ASCII flag for the index.
ascii(boolean) - Method in class com.datastax.astra.client.tables.definition.indexes.TableRegularIndexDefinition
Enables or disables ASCII encoding for the index.
ASCII - Enum constant in enum class com.datastax.astra.client.tables.definition.columns.ColumnTypes
ASCII string type.
Assert - Class in com.datastax.astra.internal.utils
Syntaxic sugar for common validations.
assertIsAstra() - Method in class com.datastax.astra.internal.command.AbstractCommandRunner
Validates that the current options are configured for Astra.
astra(String) - Static method in class com.datastax.astra.client.DataAPIClients
Creates a DataAPIClient configured for interacting with Astra in a production environment.
ASTRA - Enum constant in enum class com.datastax.astra.client.DataAPIDestination
Astra Production environment
ASTRA_DEV - Enum constant in enum class com.datastax.astra.client.DataAPIDestination
Astra Development environment
ASTRA_RESTRICTED_OPERATION - Enum constant in enum class com.datastax.astra.client.exceptions.ErrorCodesClient
Indicates that the operation is restricted to Astra environments.
ASTRA_TEST - Enum constant in enum class com.datastax.astra.client.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(AdminOptions) - 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, AdminOptions) - Constructor for class com.datastax.astra.client.admin.AstraDBDatabaseAdmin
Initialize a database admin from token and database id.
AstraDBDatabaseAdmin(String, UUID, DataAPIClientOptions) - Constructor for class com.datastax.astra.client.admin.AstraDBDatabaseAdmin
Initialize a database admin from token and database id.
astraDev(String) - Static method in class com.datastax.astra.client.DataAPIClients
Creates a DataAPIClient configured for interacting with Astra in a development environment.
astraTest(String) - Static method in class com.datastax.astra.client.DataAPIClients
Creates a DataAPIClient specifically configured for interacting with Astra in a test environment.
authentication() - Element in annotation interface com.datastax.astra.client.tables.mapping.ColumnVector
List some authentication information for the column.
authentication(Map<String, Object>) - Method in class com.datastax.astra.client.core.rerank.RerankServiceOptions
Sets the authentication map.
authentication(Map<String, Object>) - Method in class com.datastax.astra.client.core.vectorize.VectorServiceOptions
Sets the authentication map.
AUTHENTICATION_METHOD_HEADER - Static variable in class com.datastax.astra.client.core.rerank.RerankProvider
Keys for the supported authentication methods
AUTHENTICATION_METHOD_HEADER - Static variable in class com.datastax.astra.client.core.vectorize.EmbeddingProvider
Keys for the supported authentication methods
AUTHENTICATION_METHOD_NONE - Static variable in class com.datastax.astra.client.core.rerank.RerankProvider
Keys for the supported authentication methods
AUTHENTICATION_METHOD_NONE - Static variable in class com.datastax.astra.client.core.vectorize.EmbeddingProvider
Keys for the supported authentication methods
AUTHENTICATION_METHOD_SHARED_SECRET - Static variable in class com.datastax.astra.client.core.rerank.RerankProvider
Keys for the supported authentication methods
AUTHENTICATION_METHOD_SHARED_SECRET - Static variable in class com.datastax.astra.client.core.vectorize.EmbeddingProvider
Keys for the supported authentication methods
AuthenticationMethod() - Constructor for class com.datastax.astra.client.core.rerank.RerankProvider.AuthenticationMethod
Default constructor.
AuthenticationMethod() - Constructor for class com.datastax.astra.client.core.vectorize.EmbeddingProvider.AuthenticationMethod
Default constructor.
AWSEmbeddingHeadersProvider - Class in com.datastax.astra.client.core.headers
Implementation of the Embedding Auth Provider for AWS.
AWSEmbeddingHeadersProvider(String, String) - Constructor for class com.datastax.astra.client.core.headers.AWSEmbeddingHeadersProvider
Constructor.

B

BaseOptions<T> - Class in com.datastax.astra.client.core.options
Options that will be provided to all commands for this collection.
BaseOptions(String, CommandType, DataAPIClientOptions) - Constructor for class com.datastax.astra.client.core.options.BaseOptions
Return the HTTP Request Timeout based on the command type.
BaseOptions(String, CommandType, DataAPISerializer, DataAPIClientOptions) - Constructor for class com.datastax.astra.client.core.options.BaseOptions
Return the HTTP Request Timeout based on the command type.
BEFORE - Enum constant in enum class com.datastax.astra.client.collections.commands.ReturnDocument
if set to before, the command will return the document before the update
BetaPreview - Annotation Interface in com.datastax.astra.internal.utils
Deprecated.
BIGINT - Enum constant in enum class com.datastax.astra.client.tables.definition.columns.ColumnTypes
64-bit signed integer.
BLOB - Enum constant in enum class com.datastax.astra.client.tables.definition.columns.ColumnTypes
Binary large object (BLOB) type.
BM25 - Enum constant in enum class com.datastax.astra.client.core.rerank.RerankProviderTypes
bm25 reranker
BOOLEAN - Enum constant in enum class com.datastax.astra.client.tables.definition.columns.ColumnTypes
Boolean type, representing true or false values.
buffer - Variable in class com.datastax.astra.internal.command.AbstractCursor
Records to process
build() - Method in class com.datastax.astra.internal.command.ExecutionInfos.DataApiExecutionInfoBuilder
Invoke constructor with the builder.
builder() - Static method in class com.datastax.astra.internal.command.ExecutionInfos
Initialize our custom builder.
ByteArrayDeserializer - Class in com.datastax.astra.internal.serdes.tables
A custom deserializer for byte arrays that expects the input JSON to be a Base64-encoded string wrapped in a JSON object with a specific field name.
ByteArrayDeserializer() - Constructor for class com.datastax.astra.internal.serdes.tables.ByteArrayDeserializer
Default constructor that specifies the byte[] type for deserialization.
ByteArraySerializer - Class in com.datastax.astra.internal.serdes.tables
A custom serializer for byte arrays that encodes the array as a Base64 string and wraps it in a JSON object with a specific field name.
ByteArraySerializer() - Constructor for class com.datastax.astra.internal.serdes.tables.ByteArraySerializer
Default constructor that specifies the byte[] type for serialization.

C

Caller - Class in com.datastax.astra.client.core.http
Caller information.
Caller() - Constructor for class com.datastax.astra.client.core.http.Caller
Default constructor.
caseSensitive(boolean) - Method in class com.datastax.astra.client.tables.definition.indexes.TableIndexDefinitionOptions
Sets the case sensitivity flag for the index.
caseSensitive(boolean) - Method in class com.datastax.astra.client.tables.definition.indexes.TableRegularIndexDefinition
Sets whether the index should be case-sensitive.
CASSANDRA - Enum constant in enum class com.datastax.astra.client.DataAPIDestination
Local installation of Apache Cassandra
checkIdleState() - Method in class com.datastax.astra.internal.command.AbstractCursor
Validate that the cursor is in the IDLE state.
clear() - Method in class com.datastax.astra.client.collections.definition.documents.Document
Removes all mappings from this document.
clientCassandra() - Static method in class com.datastax.astra.client.DataAPIClients
Creates and configures a DataAPIClient for interaction with a local instance of DataAPI, a data gateway that facilitates working with Apache Cassandra®.
clientCassandra(String, String) - Static method in class com.datastax.astra.client.DataAPIClients
Creates and configures a DataAPIClient for interaction with a local instance of DataAPI, a data gateway that facilitates working with Apache Cassandra®.
clientHCD() - Static method in class com.datastax.astra.client.DataAPIClients
Creates and configures a DataAPIClient specifically designed for interaction with a local instance of the Data API and Cassandra.
clientHCD(String, String) - Static method in class com.datastax.astra.client.DataAPIClients
Creates and configures a DataAPIClient specifically designed for interaction with a local instance of the Data API and Cassandra.
clone() - Method in class com.datastax.astra.client.collections.commands.cursor.CollectionFindAndRerankCursor
clone() - Method in class com.datastax.astra.client.collections.commands.cursor.CollectionFindCursor
clone() - Method in class com.datastax.astra.client.core.headers.AWSEmbeddingHeadersProvider
 
clone() - Method in class com.datastax.astra.client.core.headers.EmbeddingAPIKeyHeaderProvider
 
clone() - Method in class com.datastax.astra.client.core.headers.RerankingAPIKeyHeaderProvider
 
clone() - Method in class com.datastax.astra.client.core.http.HttpClientOptions
clone() - Method in class com.datastax.astra.client.core.http.HttpProxy
clone() - Method in class com.datastax.astra.client.core.options.BaseOptions
clone() - Method in class com.datastax.astra.client.core.options.DataAPIClientOptions
clone() - Method in class com.datastax.astra.client.core.options.SerdesOptions
clone() - Method in class com.datastax.astra.client.core.options.TimeoutOptions
clone() - Method in class com.datastax.astra.client.databases.DatabaseOptions
clone() - Method in class com.datastax.astra.client.tables.cursor.TableFindCursor
close() - Method in class com.datastax.astra.internal.command.AbstractCursor
Change the state of the cursor to close.
CLOSED - Enum constant in enum class com.datastax.astra.client.core.paging.CursorState
Indicates that the cursor has been closed and is no longer usable.
clusteringColumns(Sort...) - Method in class com.datastax.astra.client.tables.definition.TableDefinition
Sets the clustering columns for the table.
COHERE - Enum constant in enum class com.datastax.astra.client.core.rerank.RerankProviderTypes
Cohere reranker
Collection<T> - Class in com.datastax.astra.client.collections
A Data API collection, the main object to interact with the Data API, especially for DDL operations.
Collection(Database, String, CollectionOptions, Class<T>) - Constructor for class com.datastax.astra.client.collections.Collection
Constructs an instance of a collection within the specified database.
COLLECTION_ADMIN - Enum constant in enum class com.datastax.astra.client.core.commands.CommandType
Collection Schema operation (create*, drop*)
collectionAdminTimeout(Duration) - Method in class com.datastax.astra.client.core.options.TimeoutOptions
Sets the timeout for collection administration operations.
CollectionDefaultIdTypeDeserializer - Class in com.datastax.astra.internal.serdes.collections
Custom deserializer for EJson Date type.
CollectionDefaultIdTypeDeserializer() - Constructor for class com.datastax.astra.internal.serdes.collections.CollectionDefaultIdTypeDeserializer
Default constructor.
CollectionDefaultIdTypes - Enum Class in com.datastax.astra.client.collections.definition
List of possible types for the collection 'defaultId'.
CollectionDefaultIdTypeSerializer - Class in com.datastax.astra.internal.serdes.collections
A custom serializer for CollectionDefaultIdTypes values, extending StdSerializer.
CollectionDefaultIdTypeSerializer() - Constructor for class com.datastax.astra.internal.serdes.collections.CollectionDefaultIdTypeSerializer
Default constructor.
CollectionDefaultIdTypeSerializer(Class<CollectionDefaultIdTypes>) - Constructor for class com.datastax.astra.internal.serdes.collections.CollectionDefaultIdTypeSerializer
Constructor with type
CollectionDefinition - Class in com.datastax.astra.client.collections.definition
Set of options to define and initialize a collection.
CollectionDefinition() - Constructor for class com.datastax.astra.client.collections.definition.CollectionDefinition
Default constructor.
CollectionDefinition.DefaultIdOptions - Class in com.datastax.astra.client.collections.definition
Subclass representing the indexing options.
CollectionDefinition.IndexingOptions - Class in com.datastax.astra.client.collections.definition
Subclass representing the indexing options.
CollectionDeleteManyOptions - Class in com.datastax.astra.client.collections.commands.options
Options to delete many documents.
CollectionDeleteManyOptions() - Constructor for class com.datastax.astra.client.collections.commands.options.CollectionDeleteManyOptions
Default constructor.
CollectionDeleteOneOptions - Class in com.datastax.astra.client.collections.commands.options
Options to delete One document.
CollectionDeleteOneOptions() - Constructor for class com.datastax.astra.client.collections.commands.options.CollectionDeleteOneOptions
Default constructor.
CollectionDeleteResult - Class in com.datastax.astra.client.collections.commands.results
Hold the result of delete commands (deleteOne, deleteMany).
CollectionDeleteResult(int) - Constructor for class com.datastax.astra.client.collections.commands.results.CollectionDeleteResult
Default constructor.
CollectionDescriptor - Class in com.datastax.astra.client.collections.definition
Represents the Collection definition with its name and metadata.
CollectionDescriptor() - Constructor for class com.datastax.astra.client.collections.definition.CollectionDescriptor
Default constructor.
collectionExists(String) - Method in class com.datastax.astra.client.databases.Database
Checks if a specified collection exists in this database.
CollectionFindAndRerankCursor<T,R> - Class in com.datastax.astra.client.collections.commands.cursor
Implementation of a cursor across the find items
CollectionFindAndRerankCursor(Collection<T>, Filter, CollectionFindAndRerankOptions, Class<R>) - Constructor for class com.datastax.astra.client.collections.commands.cursor.CollectionFindAndRerankCursor
Cursor to iterate on the result of a query.
CollectionFindAndRerankOptions - Class in com.datastax.astra.client.collections.commands.options
List Options for a FindOne command.
CollectionFindAndRerankOptions() - Constructor for class com.datastax.astra.client.collections.commands.options.CollectionFindAndRerankOptions
Default constructor.
CollectionFindCursor<T,R> - Class in com.datastax.astra.client.collections.commands.cursor
Implementation of a cursor across the find items
CollectionFindCursor(Collection<T>, Filter, CollectionFindOptions, Class<R>) - Constructor for class com.datastax.astra.client.collections.commands.cursor.CollectionFindCursor
Cursor to iterate on the result of a query.
CollectionFindOneAndDeleteOptions - Class in com.datastax.astra.client.collections.commands.options
Options to find one and delete.
CollectionFindOneAndDeleteOptions() - Constructor for class com.datastax.astra.client.collections.commands.options.CollectionFindOneAndDeleteOptions
Default constructor.
CollectionFindOneAndReplaceOptions - Class in com.datastax.astra.client.collections.commands.options
Options used in the `findAndReplace` command.
CollectionFindOneAndReplaceOptions() - Constructor for class com.datastax.astra.client.collections.commands.options.CollectionFindOneAndReplaceOptions
Default constructor.
CollectionFindOneAndUpdateOptions - Class in com.datastax.astra.client.collections.commands.options
List options for a findOneAndUpdate command.
CollectionFindOneAndUpdateOptions() - Constructor for class com.datastax.astra.client.collections.commands.options.CollectionFindOneAndUpdateOptions
Default constructor.
CollectionFindOneOptions - Class in com.datastax.astra.client.collections.commands.options
List Options for a FindOne command.
CollectionFindOneOptions() - Constructor for class com.datastax.astra.client.collections.commands.options.CollectionFindOneOptions
Default constructor.
CollectionFindOptions - Class in com.datastax.astra.client.collections.commands.options
List Options for a FindOne command.
CollectionFindOptions() - Constructor for class com.datastax.astra.client.collections.commands.options.CollectionFindOptions
Default constructor.
CollectionInsertManyOptions - Class in com.datastax.astra.client.collections.commands.options
Options for InsertMany
CollectionInsertManyOptions() - Constructor for class com.datastax.astra.client.collections.commands.options.CollectionInsertManyOptions
Default constructor.
CollectionInsertManyResult - Class in com.datastax.astra.client.collections.commands.results
Represents the result returned by command 'insertMany()', mainly the insertedIds.
CollectionInsertManyResult() - Constructor for class com.datastax.astra.client.collections.commands.results.CollectionInsertManyResult
Default constructor.
CollectionInsertOneOptions - Class in com.datastax.astra.client.collections.commands.options
Options for InsertOne
CollectionInsertOneOptions() - Constructor for class com.datastax.astra.client.collections.commands.options.CollectionInsertOneOptions
Default constructor.
CollectionInsertOneResult - Class in com.datastax.astra.client.collections.commands.results
Represents the result returned by command 'insertOne()', mainly the insertedI
CollectionInsertOneResult() - Constructor for class com.datastax.astra.client.collections.commands.results.CollectionInsertOneResult
Default constructor.
CollectionOptions - Class in com.datastax.astra.client.collections
The options to use for the data API client.
CollectionOptions() - Constructor for class com.datastax.astra.client.collections.CollectionOptions
Default constructor nor overriding token nor options but stilling setting the default timeouts and serializer for collection.
CollectionOptions(String, DataAPIClientOptions) - Constructor for class com.datastax.astra.client.collections.CollectionOptions
Constructor with options and not token override.
CollectionReplaceOneOptions - Class in com.datastax.astra.client.collections.commands.options
Options for the replaceOne operation.
CollectionReplaceOneOptions() - Constructor for class com.datastax.astra.client.collections.commands.options.CollectionReplaceOneOptions
Default constructor.
CollectionRerankOptions - Class in com.datastax.astra.client.core.rerank
Subclass representing the vector options.
CollectionRerankOptions() - Constructor for class com.datastax.astra.client.core.rerank.CollectionRerankOptions
Default constructor.
CollectionUpdateManyOptions - Class in com.datastax.astra.client.collections.commands.options
Options for the updateOne operation
CollectionUpdateManyOptions() - Constructor for class com.datastax.astra.client.collections.commands.options.CollectionUpdateManyOptions
Default constructor.
CollectionUpdateOneOptions - Class in com.datastax.astra.client.collections.commands.options
Options for the updateOne operation
CollectionUpdateOneOptions() - Constructor for class com.datastax.astra.client.collections.commands.options.CollectionUpdateOneOptions
Default constructor.
CollectionUpdateResult - Class in com.datastax.astra.client.collections.commands.results
Return update result.
CollectionUpdateResult() - Constructor for class com.datastax.astra.client.collections.commands.results.CollectionUpdateResult
Default constructor.
column - Variable in class com.datastax.astra.client.tables.definition.indexes.TableIndexDefinition
The name of the column that the index is associated with.
column(String) - Method in class com.datastax.astra.client.tables.definition.indexes.TableIndexDefinition
Sets the name of the column for the index.
column(String) - Method in class com.datastax.astra.client.tables.definition.indexes.TableRegularIndexDefinition
 
column(String) - Method in class com.datastax.astra.client.tables.definition.indexes.TableTextIndexDefinition
Setter for the column name
column(String) - Method in class com.datastax.astra.client.tables.definition.indexes.TableVectorIndexDefinition
 
column(String, TableIndexMapTypes) - Method in class com.datastax.astra.client.tables.definition.indexes.TableIndexDefinition
Sets the name of the column for the index.
column(String, TableIndexMapTypes) - Method in class com.datastax.astra.client.tables.definition.indexes.TableRegularIndexDefinition
 
column(String, TableIndexMapTypes) - Method in class com.datastax.astra.client.tables.definition.indexes.TableTextIndexDefinition
Setter for the column name
column(String, TableIndexMapTypes) - Method in class com.datastax.astra.client.tables.definition.indexes.TableVectorIndexDefinition
 
Column - Annotation Interface in com.datastax.astra.client.tables.mapping
Annotation to define properties for a database column.
ColumnDefinition - Class in com.datastax.astra.client.tables.definition.columns
Represents a column definition in a database schema.
ColumnDefinition() - Constructor for class com.datastax.astra.client.tables.definition.columns.ColumnDefinition
Default constructor.
ColumnDefinition(ColumnTypes) - Constructor for class com.datastax.astra.client.tables.definition.columns.ColumnDefinition
Constructor with type.
ColumnDefinitionApiSupport - Class in com.datastax.astra.client.tables.definition.columns
Represents the API support configuration for a column definition.
ColumnDefinitionApiSupport() - Constructor for class com.datastax.astra.client.tables.definition.columns.ColumnDefinitionApiSupport
Default constructor.
ColumnDefinitionList - Class in com.datastax.astra.client.tables.definition.columns
Represents a column definition for a list type in a database schema.
ColumnDefinitionList() - Constructor for class com.datastax.astra.client.tables.definition.columns.ColumnDefinitionList
Constructs a new ColumnDefinitionList instance with the column type set to ColumnTypes.LIST.
ColumnDefinitionList(ColumnTypes) - Constructor for class com.datastax.astra.client.tables.definition.columns.ColumnDefinitionList
Constructs a new ColumnDefinitionList instance with the specified value type.
ColumnDefinitionMap - Class in com.datastax.astra.client.tables.definition.columns
Represents a column definition for a map type in a database schema.
ColumnDefinitionMap() - Constructor for class com.datastax.astra.client.tables.definition.columns.ColumnDefinitionMap
Constructs a new ColumnDefinitionMap instance with the column type set to ColumnTypes.MAP.
ColumnDefinitionMap(ColumnTypes, ColumnTypes) - Constructor for class com.datastax.astra.client.tables.definition.columns.ColumnDefinitionMap
Constructs a new ColumnDefinitionMap instance with the specified key and value types.
ColumnDefinitionSet - Class in com.datastax.astra.client.tables.definition.columns
Represents a column definition for a set type in a database schema.
ColumnDefinitionSet() - Constructor for class com.datastax.astra.client.tables.definition.columns.ColumnDefinitionSet
Constructs a new ColumnDefinitionSet instance with the column type set to ColumnTypes.SET.
ColumnDefinitionSet(ColumnTypes) - Constructor for class com.datastax.astra.client.tables.definition.columns.ColumnDefinitionSet
Constructs a new ColumnDefinitionSet instance with the specified value type.
ColumnDefinitionVector - Class in com.datastax.astra.client.tables.definition.columns
Represents a column definition for vector-based data.
ColumnDefinitionVector() - Constructor for class com.datastax.astra.client.tables.definition.columns.ColumnDefinitionVector
Constructs a new ColumnDefinitionVector instance with the column type set to ColumnTypes.VECTOR.
columnMap - Variable in class com.datastax.astra.client.tables.definition.rows.Row
Data to be used in the document.
columns(String...) - Method in class com.datastax.astra.client.tables.commands.AlterTableDropColumns
Adds additional column names to the list of columns to drop.
columns(String...) - Method in class com.datastax.astra.client.tables.commands.AlterTableDropVectorize
Adds additional column names to the list of columns to drop.
columns(Map<String, RerankServiceOptions>) - Method in class com.datastax.astra.client.tables.commands.AlterTableAddReranking
Replaces the current column definitions with the specified map of column names and vectorization options.
columns(Map<String, VectorServiceOptions>) - Method in class com.datastax.astra.client.tables.commands.AlterTableAddVectorize
Replaces the current column definitions with the specified map of column names and vectorization options.
ColumnTypeDeserializer - Class in com.datastax.astra.internal.serdes.tables
Custom deserializer for EJson Date type.
ColumnTypeDeserializer() - Constructor for class com.datastax.astra.internal.serdes.tables.ColumnTypeDeserializer
Default constructor.
ColumnTypeMapper - Class in com.datastax.astra.client.tables.definition.columns
Maps Java types to corresponding Cassandra column types.
ColumnTypes - Enum Class in com.datastax.astra.client.tables.definition.columns
Represents the various column types supported in a database schema.
ColumnTypeSerializer - Class in com.datastax.astra.internal.serdes.tables
Object Id Could be objectId|uuid|uuidv6|uuidv7
ColumnTypeSerializer() - Constructor for class com.datastax.astra.internal.serdes.tables.ColumnTypeSerializer
Default constructor.
ColumnTypeSerializer(Class<ColumnTypes>) - Constructor for class com.datastax.astra.internal.serdes.tables.ColumnTypeSerializer
Constructor with type
ColumnVector - Annotation Interface in com.datastax.astra.client.tables.mapping
Annotation to define properties for a database column.
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.collections - package com.datastax.astra.client.collections
Top package to interact with Collections
com.datastax.astra.client.collections.commands - package com.datastax.astra.client.collections.commands
Command Definitions for operating on Collections.
com.datastax.astra.client.collections.commands.cursor - package com.datastax.astra.client.collections.commands.cursor
Objects representing cursors working with find collection commands.
com.datastax.astra.client.collections.commands.options - package com.datastax.astra.client.collections.commands.options
Options and Inputs for Collections commands.
com.datastax.astra.client.collections.commands.results - package com.datastax.astra.client.collections.commands.results
Outputs and DTO for Collections Commands.
com.datastax.astra.client.collections.definition - package com.datastax.astra.client.collections.definition
Objects describing the structure of a collection.
com.datastax.astra.client.collections.definition.documents - package com.datastax.astra.client.collections.definition.documents
Objects describing the structure of a Document.
com.datastax.astra.client.collections.definition.documents.types - package com.datastax.astra.client.collections.definition.documents.types
Object representing the type Id for collections.
com.datastax.astra.client.collections.exceptions - package com.datastax.astra.client.collections.exceptions
Specializations of the exceptions to work with Collections.
com.datastax.astra.client.core - package com.datastax.astra.client.core
Core classes to interact both with Tables and Collections.
com.datastax.astra.client.core.auth - package com.datastax.astra.client.core.auth
Internal technical classes to authenticate against API endpoint.
com.datastax.astra.client.core.commands - package com.datastax.astra.client.core.commands
Utility classes for commands and operations.
com.datastax.astra.client.core.headers - package com.datastax.astra.client.core.headers
 
com.datastax.astra.client.core.http - package com.datastax.astra.client.core.http
Classes to specialize the HTTP Client.
com.datastax.astra.client.core.hybrid - package com.datastax.astra.client.core.hybrid
 
com.datastax.astra.client.core.lexical - package com.datastax.astra.client.core.lexical
 
com.datastax.astra.client.core.options - package com.datastax.astra.client.core.options
Classes for options of the core commands.
com.datastax.astra.client.core.paging - package com.datastax.astra.client.core.paging
Informations for cursor-based paging.
com.datastax.astra.client.core.query - package com.datastax.astra.client.core.query
Classes uses to build queries with Sort and Projection.
com.datastax.astra.client.core.rerank - package com.datastax.astra.client.core.rerank
 
com.datastax.astra.client.core.vector - package com.datastax.astra.client.core.vector
Objects representing Vector options (vector)
com.datastax.astra.client.core.vectorize - package com.datastax.astra.client.core.vectorize
Objects representing Vector Services options (vectorize)
com.datastax.astra.client.databases - package com.datastax.astra.client.databases
Top package to interact with Databases and Keyspaces.
com.datastax.astra.client.databases.commands - package com.datastax.astra.client.databases.commands
Objects representing commands against databases and keyspaces.
com.datastax.astra.client.databases.commands.options - package com.datastax.astra.client.databases.commands.options
 
com.datastax.astra.client.databases.commands.results - package com.datastax.astra.client.databases.commands.results
Object representing keyspace level returns objects.
com.datastax.astra.client.databases.definition - package com.datastax.astra.client.databases.definition
Objects the informations of databases
com.datastax.astra.client.databases.definition.keyspaces - package com.datastax.astra.client.databases.definition.keyspaces
Object representing the keyspaces.
com.datastax.astra.client.exceptions - package com.datastax.astra.client.exceptions
Exceptions specialized checked and unchecked thrown by the client.
com.datastax.astra.client.tables - package com.datastax.astra.client.tables
Top package to interact with Tables.
com.datastax.astra.client.tables.commands - package com.datastax.astra.client.tables.commands
Command Definitions for operating on Tables.
com.datastax.astra.client.tables.commands.options - package com.datastax.astra.client.tables.commands.options
Options and Inputs for Tables commands.
com.datastax.astra.client.tables.commands.results - package com.datastax.astra.client.tables.commands.results
Outputs and DTO for Tables Commands.
com.datastax.astra.client.tables.cursor - package com.datastax.astra.client.tables.cursor
Objects representing cursors working with find tables commands.
com.datastax.astra.client.tables.definition - package com.datastax.astra.client.tables.definition
Objects describing the structure of a Table.
com.datastax.astra.client.tables.definition.columns - package com.datastax.astra.client.tables.definition.columns
Objects representing Table Columns
com.datastax.astra.client.tables.definition.indexes - package com.datastax.astra.client.tables.definition.indexes
Objects representing Table Indexes.
com.datastax.astra.client.tables.definition.rows - package com.datastax.astra.client.tables.definition.rows
Objects representing Table Rows, like primary key.
com.datastax.astra.client.tables.exceptions - package com.datastax.astra.client.tables.exceptions
Specializations of the exceptions to work with Tables.
com.datastax.astra.client.tables.mapping - package com.datastax.astra.client.tables.mapping
Annotations Set to map objects as Row Entities.
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.reflection - package com.datastax.astra.internal.reflection
Utilities for reflection at runtime
com.datastax.astra.internal.serdes - package com.datastax.astra.internal.serdes
Utilities classes for Serialization and Deserialization
com.datastax.astra.internal.serdes.collections - package com.datastax.astra.internal.serdes.collections
Custom Serializers to work with Collections.
com.datastax.astra.internal.serdes.core - package com.datastax.astra.internal.serdes.core
 
com.datastax.astra.internal.serdes.shared - package com.datastax.astra.internal.serdes.shared
Custom Serializers applied for both tables and collections.
com.datastax.astra.internal.serdes.tables - package com.datastax.astra.internal.serdes.tables
Custom Serializers to work with Tables
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.core.commands
Represent a command to be executed against the Data API.
Command() - Constructor for class com.datastax.astra.client.core.commands.Command
Default constructor.
Command(String) - Constructor for class com.datastax.astra.client.core.commands.Command
Constructor with a name.
Command(String, Document) - Constructor for class com.datastax.astra.client.core.commands.Command
Specialization of the command.
Command.CommandSerializer - Class in com.datastax.astra.client.core.commands
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.
CommandRunner - Interface in com.datastax.astra.client.core.commands
Use to initialize the HTTPClient.
CommandSerializer() - Constructor for class com.datastax.astra.client.core.commands.Command.CommandSerializer
Default constructor.
CommandSerializer(Class<Command>) - Constructor for class com.datastax.astra.client.core.commands.Command.CommandSerializer
Constructor with the class in used.
commandType - Variable in class com.datastax.astra.client.core.options.BaseOptions
The command type will drive the timeout in used.
commandType(CommandType) - Method in class com.datastax.astra.client.core.options.BaseOptions
Provide the command type.
CommandType - Enum Class in com.datastax.astra.client.core.commands
Type of Commands.
compareTo(ObjectId) - Method in class com.datastax.astra.client.collections.definition.documents.types.ObjectId
 
CompletableFutures - Class in com.datastax.astra.internal.utils
Utilities to work with Async functions.
connectTimeout(Duration) - Method in class com.datastax.astra.client.core.options.TimeoutOptions
Sets the connection timeout.
constructor - Variable in class com.datastax.astra.client.tables.definition.indexes.TableIndexDefinition
Constructor function to create new instances in subclasses.
constructor - Variable in class com.datastax.astra.client.tables.definition.indexes.TableIndexDescriptor
Function to create a new instance of the subclass.
consumeBuffer(int) - Method in class com.datastax.astra.internal.command.AbstractCursor
Consume the buffer and return the list of items.
consumed - Variable in class com.datastax.astra.internal.command.AbstractCursor
How many consumed in the current buffer.
CONTAIN_ENTRY - Enum constant in enum class com.datastax.astra.client.core.query.FilterOperator
Contains Entry.
CONTAIN_KEY - Enum constant in enum class com.datastax.astra.client.core.query.FilterOperator
Contains Key.
CONTAINS - Enum constant in enum class com.datastax.astra.client.core.query.FilterOperator
Contains.
containsKey(Object) - Method in class com.datastax.astra.internal.api.DataAPIStatus
Check if the payload contains a key.
containsKey(String) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Check if the given dot-delimited path exists as a key (final segment).
containsKey(String) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Gets the value of the given key.
CONTENT_TYPE_JSON - Static variable in class com.datastax.astra.internal.http.RetryHttpClient
Headers, Api is usig JSON
convertValue(Object, Class<T>) - Method in interface com.datastax.astra.internal.serdes.DataAPISerializer
Jackson deserialization.
copy() - Method in class com.datastax.astra.client.core.headers.AWSEmbeddingHeadersProvider
 
copy() - Method in class com.datastax.astra.client.core.headers.EmbeddingAPIKeyHeaderProvider
 
copy() - Method in interface com.datastax.astra.client.core.headers.EmbeddingHeadersProvider
Clone the EmbeddingHeadersProvider.
copy() - Method in class com.datastax.astra.client.core.headers.RerankingAPIKeyHeaderProvider
 
copy() - Method in interface com.datastax.astra.client.core.headers.RerankingHeadersProvider
Clone the EmbeddingHeadersProvider.
Core Features: - Search tag in class com.datastax.astra.client.DataAPIClient
Section
COSINE - Enum constant in enum class com.datastax.astra.client.core.vector.SimilarityMetric
Distance with cosine.
countDocuments(int) - Method in class com.datastax.astra.client.collections.Collection
Counts the number of documents in the collection.
countDocuments(Filter, int) - Method in class com.datastax.astra.client.collections.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.collections.Collection
Counts the number of documents in the collection with a filter.
CountDocumentsOptions - Class in com.datastax.astra.client.collections.commands.options
List Options for a FindOne command.
CountDocumentsOptions() - Constructor for class com.datastax.astra.client.collections.commands.options.CountDocumentsOptions
Default constructor.
countRows(int) - Method in class com.datastax.astra.client.tables.Table
Counts the number of rows in the table.
countRows(Filter, int) - Method in class com.datastax.astra.client.tables.Table
Implementation of the @see Table.countRows(Filter, int, CountRowsOptions) method with default options.
countRows(Filter, int, CountRowsOptions) - Method in class com.datastax.astra.client.tables.Table
Counts the number of rows in the table with a filter.
CountRowsOptions - Class in com.datastax.astra.client.tables.commands.options
List Options for a FindOne command.
CountRowsOptions() - Constructor for class com.datastax.astra.client.tables.commands.options.CountRowsOptions
Default constructor.
create() - Static method in class com.datastax.astra.client.collections.commands.Update
Allow to creat a new instance.
create() - Static method in class com.datastax.astra.client.collections.definition.documents.Document
Create a document with no attributes.
create() - Static method in class com.datastax.astra.client.tables.definition.rows.Row
Create a row with no attributes.
create(Object) - Static method in class com.datastax.astra.client.collections.definition.documents.Document
Create a document with an id.
create(String) - Static method in class com.datastax.astra.client.core.commands.Command
Create an empty command from its name.
createCollection(String) - Method in class com.datastax.astra.client.databases.Database
Creates a new collection with the default document type Document.
createCollection(String, CollectionDefinition) - Method in class com.datastax.astra.client.databases.Database
Creates a new collection with a specified definition and the default document type Document.
createCollection(String, CollectionDefinition, CreateCollectionOptions) - Method in class com.datastax.astra.client.databases.Database
Creates a new collection with a specified definition, options, and the default document type Document.
createCollection(String, CollectionDefinition, Class<T>) - Method in class com.datastax.astra.client.databases.Database
Creates a new collection with a specified definition and the specified document class.
createCollection(String, CollectionDefinition, Class<T>, CreateCollectionOptions) - Method in class com.datastax.astra.client.databases.Database
Creates a new collection in the database.
createCollection(String, Class<T>) - Method in class com.datastax.astra.client.databases.Database
Creates a new collection with the specified document class.
CreateCollectionOptions - Class in com.datastax.astra.client.collections.commands.options
Options for the createCollection operation.
CreateCollectionOptions() - Constructor for class com.datastax.astra.client.collections.commands.options.CreateCollectionOptions
Default constructor.
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.
createIndex(String, TableRegularIndexDefinition, CreateIndexOptions) - Method in class com.datastax.astra.client.tables.Table
Create a new index with the given description.
createIndex(String, String) - Method in class com.datastax.astra.client.tables.Table
Create a simple index on the given column with no special options
createIndex(String, String, CreateIndexOptions) - Method in class com.datastax.astra.client.tables.Table
Create a simple index on the given column with no special options
CreateIndexOptions - Class in com.datastax.astra.client.tables.commands.options
Set of options used when creating a table
CreateIndexOptions() - Constructor for class com.datastax.astra.client.tables.commands.options.CreateIndexOptions
Default constructor
createKeyspace(KeyspaceDefinition) - Method in interface com.datastax.astra.client.admin.DatabaseAdmin
Syntax Sugar, retro compatible.
createKeyspace(KeyspaceDefinition, CreateKeyspaceOptions) - Method in class com.datastax.astra.client.admin.AstraDBDatabaseAdmin
 
createKeyspace(KeyspaceDefinition, CreateKeyspaceOptions) - Method in class com.datastax.astra.client.admin.DataAPIDatabaseAdmin
 
createKeyspace(KeyspaceDefinition, CreateKeyspaceOptions) - Method in interface com.datastax.astra.client.admin.DatabaseAdmin
Create a Keyspace providing a name.
createKeyspace(String) - Method in class com.datastax.astra.client.admin.AstraDBDatabaseAdmin
Syntax Sugar, retro compatible.
createKeyspace(String) - Method in interface com.datastax.astra.client.admin.DatabaseAdmin
Syntax Sugar, retro compatible.
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.
CreateKeyspaceOptions - Class in com.datastax.astra.client.databases.commands.options
Set of options used when creating a table
CreateKeyspaceOptions() - Constructor for class com.datastax.astra.client.databases.commands.options.CreateKeyspaceOptions
Default constructor
createTable(Class<T>) - Method in class com.datastax.astra.client.databases.Database
Creates a table using default options and the inferred table name from the row class.
createTable(Class<T>, CreateTableOptions) - Method in class com.datastax.astra.client.databases.Database
Creates a table using default options and the inferred table name from the row class.
createTable(String, TableDefinition) - Method in class com.datastax.astra.client.databases.Database
Creates a table with a default row type of Row.
createTable(String, TableDefinition, CreateTableOptions) - Method in class com.datastax.astra.client.databases.Database
Creates a table using default options and runtime configurations.
createTable(String, TableDefinition, Class<T>) - Method in class com.datastax.astra.client.databases.Database
Creates a table using default options and runtime configurations.
createTable(String, TableDefinition, Class<T>, CreateTableOptions) - Method in class com.datastax.astra.client.databases.Database
Creates a table in the system with the specified parameters.
createTable(String, Class<T>, CreateTableOptions) - Method in class com.datastax.astra.client.databases.Database
Creates a table using default options and runtime configurations.
createTableCommand(String, Class<?>) - Static method in class com.datastax.astra.internal.reflection.EntityBeanDefinition
Create a table command based on the annotated fields.
CreateTableOptions - Class in com.datastax.astra.client.tables.commands.options
Set of options used when creating a table
CreateTableOptions() - Constructor for class com.datastax.astra.client.tables.commands.options.CreateTableOptions
Default constructor
createTextIndex(String, TableTextIndexDefinition) - Method in class com.datastax.astra.client.tables.Table
Create a new index with the given description.
createTextIndex(String, TableTextIndexDefinition, CreateTextIndexOptions) - Method in class com.datastax.astra.client.tables.Table
Create a new index with the given description.
createTextIndex(String, String) - Method in class com.datastax.astra.client.tables.Table
Create a new index with the given description.
CreateTextIndexOptions - Class in com.datastax.astra.client.tables.commands.options
Set of options used when creating a table
CreateTextIndexOptions() - Constructor for class com.datastax.astra.client.tables.commands.options.CreateTextIndexOptions
Default constructor
createVectorIndex(String, TableVectorIndexDefinition) - Method in class com.datastax.astra.client.tables.Table
Create a new index with the given description.
createVectorIndex(String, TableVectorIndexDefinition, CreateVectorIndexOptions) - Method in class com.datastax.astra.client.tables.Table
Create a new index with the given description.
createVectorIndex(String, String) - Method in class com.datastax.astra.client.tables.Table
Create a new index with the given description.
CreateVectorIndexOptions - Class in com.datastax.astra.client.tables.commands.options
Set of options used when creating a table
CreateVectorIndexOptions() - Constructor for class com.datastax.astra.client.tables.commands.options.CreateVectorIndexOptions
Default constructor
currentPage - Variable in class com.datastax.astra.internal.command.AbstractCursor
Current page
cursor - Variable in exception class com.datastax.astra.internal.command.CursorError
The default error code for cursor errors.
CursorError - Exception Class in com.datastax.astra.internal.command
Exception thrown when an error occurs while using a cursor.
CursorError(String, AbstractCursor<?, ?>) - Constructor for exception class com.datastax.astra.internal.command.CursorError
Constructor.
CursorException - Exception Class in com.datastax.astra.client.exceptions
Represents an exception that occurs when there is an error related to a database cursor.
CursorException(String, String) - Constructor for exception class com.datastax.astra.client.exceptions.CursorException
Constructs a new CursorException with the specified error message and cursor state.
CursorState - Enum Class in com.datastax.astra.client.core.paging
Represents the possible states of a database cursor.
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, providing an intuitive and streamlined interface for interacting with the Data API.
DataAPIClient(DataAPIClientOptions) - Constructor for class com.datastax.astra.client.DataAPIClient
Constructs a new instance of the DataAPIClient without a default token.
DataAPIClient(String) - Constructor for class com.datastax.astra.client.DataAPIClient
Constructs a DataAPIClient instance using the specified authentication token.
DataAPIClient(String, DataAPIClientOptions) - Constructor for class com.datastax.astra.client.DataAPIClient
Constructs a DataAPIClient with specified authentication token and HTTP client configuration options.
DataAPIClientException - Exception Class in com.datastax.astra.client.exceptions
Exception thrown when there is an error in the client side.
DataAPIClientException(ErrorCodesClient, Object...) - Constructor for exception class com.datastax.astra.client.exceptions.DataAPIClientException
Constructors providing all arguments and a parent exception.
DataAPIClientException(ErrorCodesClient, String) - Constructor for exception class com.datastax.astra.client.exceptions.DataAPIClientException
Constructors providing all arguments and a parent exception.
dataAPIClientOptions - Variable in class com.datastax.astra.client.core.options.BaseOptions
Token used
dataAPIClientOptions(DataAPIClientOptions) - Method in class com.datastax.astra.client.core.options.BaseOptions
Provide a fluent setter for the data API Client.
DataAPIClientOptions - Class in com.datastax.astra.client.core.options
Options to set up the client for DataApiClient.
DataAPIClientOptions() - Constructor for class com.datastax.astra.client.core.options.DataAPIClientOptions
A default Client Options
DataAPIClientOptions(DataAPIClientOptions) - Constructor for class com.datastax.astra.client.core.options.DataAPIClientOptions
Copy constructor.
DataAPIClients - Class in com.datastax.astra.client
Provides utility methods for initializing and configuring clients to interact with the Data API.
DataAPIData - 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.
DataAPIData() - Constructor for class com.datastax.astra.internal.api.DataAPIData
Default constructor for DataAPIData.
DataAPIDatabaseAdmin - Class in com.datastax.astra.client.admin
Implementation of Client.
DataAPIDatabaseAdmin(Database, AdminOptions) - Constructor for class com.datastax.astra.client.admin.DataAPIDatabaseAdmin
Initialize a database admin from token and database id.
DataAPIDestination - Enum Class in com.datastax.astra.client
Represent the destination of the data API.
DataAPIErrorDescriptor - Exception Class in com.datastax.astra.client.exceptions
Encapsulates error details from a JSON API response.
DataAPIErrorDescriptor() - Constructor for exception class com.datastax.astra.client.exceptions.DataAPIErrorDescriptor
Default constructor for DataAPIErrorDescriptor.
DataAPIException - Exception Class in com.datastax.astra.client.exceptions
Represents a runtime exception that occurs within the Data API client.
DataAPIException(String, String) - Constructor for exception class com.datastax.astra.client.exceptions.DataAPIException
Constructors providing all arguments and a parent exception.
DataAPIException(String, String, Throwable) - Constructor for exception class com.datastax.astra.client.exceptions.DataAPIException
Constructors providing all arguments and a parent exception.
DataApiExecutionInfoBuilder() - Constructor for class com.datastax.astra.internal.command.ExecutionInfos.DataApiExecutionInfoBuilder
Default constructor.
DataAPIHttpException - Exception Class in com.datastax.astra.client.exceptions
A request to the Data API resulted in an HTTP 4xx or 5xx response.
DataAPIHttpException(String) - Constructor for exception class com.datastax.astra.client.exceptions.DataAPIHttpException
Constructors providing all arguments and a parent exception.
DataAPIHttpException(String, String) - Constructor for exception class com.datastax.astra.client.exceptions.DataAPIHttpException
Constructors providing all arguments and a parent exception.
DataAPIKeywords - Enum Class in com.datastax.astra.client.core
Constants in the JSON API.
DataAPIResponse - Class in com.datastax.astra.internal.api
Represents the generic response structure for API calls.
DataAPIResponse() - Constructor for class com.datastax.astra.internal.api.DataAPIResponse
Default constructor for DataAPIResponse.
DataAPIResponseException - Exception Class in com.datastax.astra.client.exceptions
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.exceptions.DataAPIResponseException
Constructor with list of constructors.
DataAPISerializer - Interface in com.datastax.astra.internal.serdes
Definition of a serializer for the Data API
DataAPIStatus - Class in com.datastax.astra.internal.api
Status of the Data API.
DataAPIStatus() - Constructor for class com.datastax.astra.internal.api.DataAPIStatus
Default constructor.
DataAPITimeoutException - Exception Class in com.datastax.astra.client.exceptions
A request to the Data API resulted in an HTTP 4xx or 5xx response.
DataAPITimeoutException(String) - Constructor for exception class com.datastax.astra.client.exceptions.DataAPITimeoutException
Constructors providing all arguments and a parent exception.
DataAPIVector - Class in com.datastax.astra.client.core.vector
DataAPIVector is a vector of embeddings.
DataAPIVector(float[]) - Constructor for class com.datastax.astra.client.core.vector.DataAPIVector
Load the vector from a float array.
DataAPIVectorDeserializer - Class in com.datastax.astra.internal.serdes.shared
Deserializer for DataAPIVector.
DataAPIVectorDeserializer() - Constructor for class com.datastax.astra.internal.serdes.shared.DataAPIVectorDeserializer
Default constructor.
DataAPIVectorSerializer - Class in com.datastax.astra.internal.serdes.shared
Serializer for DataAPIVector
DataAPIVectorSerializer() - Constructor for class com.datastax.astra.internal.serdes.shared.DataAPIVectorSerializer
Default constructor.
Database - Class in com.datastax.astra.client.databases
Represents a Data API database, providing the primary entry point for database-level operations and interactions.
Database(String, DatabaseOptions) - Constructor for class com.datastax.astra.client.databases.Database
Initializes a Database instance with the specified API endpoint and connection options.
DATABASE_ADMIN - Enum constant in enum class com.datastax.astra.client.core.commands.CommandType
Database admin operation (create, delete, list)
databaseAdditionalHeaders(Map<String, String>) - Method in class com.datastax.astra.client.core.options.BaseOptions
Provide the token.
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.
databaseAdminTimeout(Duration) - Method in class com.datastax.astra.client.core.options.TimeoutOptions
Sets the timeout for database administration operations.
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.databases.definition
Bean representing the database information.
DatabaseInfo(Database) - Constructor for class com.datastax.astra.client.databases.definition.DatabaseInfo
Initializing a database information representation by leveraging devops internal API and omitting technical internal information.
DatabaseOptions - Class in com.datastax.astra.client.databases
Represents the configuration options required to connect to a database.
DatabaseOptions() - Constructor for class com.datastax.astra.client.databases.DatabaseOptions
Default constructor.
DatabaseOptions(String, DataAPIClientOptions) - Constructor for class com.datastax.astra.client.databases.DatabaseOptions
Constructor with options and not token override.
DatabaseSerializer - Class in com.datastax.astra.internal.serdes
Custom implementation of serialization : faster + no jackson dependency
DatabaseSerializer() - Constructor for class com.datastax.astra.internal.serdes.DatabaseSerializer
Default constructor
DATE - Enum constant in enum class com.datastax.astra.client.core.DataAPIKeywords
ALL.
DATE - Enum constant in enum class com.datastax.astra.client.tables.definition.columns.ColumnTypes
Date type, storing only the date part without a time zone.
db - Variable in class com.datastax.astra.client.admin.DataAPIDatabaseAdmin
Database if initialized from the DB.
DECIMAL - Enum constant in enum class com.datastax.astra.client.tables.definition.columns.ColumnTypes
Arbitrary precision decimal number.
DEFAULT_CALLER - Static variable in class com.datastax.astra.client.core.http.HttpClientOptions
Default caller name.
DEFAULT_COLLECTION_ADMIN_TIMEOUT_MILLIS - Static variable in class com.datastax.astra.client.core.options.TimeoutOptions
Default timeout values
DEFAULT_COLLECTION_SERIALIZER - Static variable in class com.datastax.astra.client.collections.Collection
Default collection serializer.
DEFAULT_CONNECT_TIMEOUT_MILLIS - Static variable in class com.datastax.astra.client.core.options.TimeoutOptions
Default timeout values
DEFAULT_CREDENTIALS - Static variable in class com.datastax.astra.client.core.auth.UsernamePasswordTokenProvider
Default password for Cassandra.
DEFAULT_DATABASE_ADMIN_TIMEOUT_MILLIS - Static variable in class com.datastax.astra.client.core.options.TimeoutOptions
Default timeout values
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.exceptions.DataAPIException
Default error code.
DEFAULT_ERROR_MESSAGE - Static variable in exception class com.datastax.astra.client.exceptions.DataAPIException
Default error message.
DEFAULT_GENERAL_METHOD_TIMEOUT_MILLIS - Static variable in class com.datastax.astra.client.core.options.TimeoutOptions
Default timeout values
DEFAULT_KEYSPACE - Static variable in class com.datastax.astra.client.core.options.DataAPIClientOptions
The default keyspace to use for working with your databases.
DEFAULT_KEYSPACE_ADMIN_TIMEOUT_MILLIS - Static variable in class com.datastax.astra.client.core.options.TimeoutOptions
Default timeout values
DEFAULT_REQUEST_TIMEOUT_MILLIS - Static variable in class com.datastax.astra.client.core.options.TimeoutOptions
Default timeout values
DEFAULT_RETRY_COUNT - Static variable in class com.datastax.astra.client.core.http.HttpClientOptions
Default retry count.
DEFAULT_RETRY_DELAY_MILLIS - Static variable in class com.datastax.astra.client.core.http.HttpClientOptions
Default retry delay.
DEFAULT_SERIALIZER - Static variable in class com.datastax.astra.client.admin.AdminOptions
Serializer for the collections.
DEFAULT_TABLE_ADMIN_TIMEOUT_MILLIS - Static variable in class com.datastax.astra.client.core.options.TimeoutOptions
Default timeout values
DEFAULT_TABLE_SERIALIZER - Static variable in class com.datastax.astra.client.tables.Table
Avoid duplicating for each operation if not override.
DEFAULT_URL - Static variable in class com.datastax.astra.client.core.auth.UsernamePasswordTokenProvider
Default URL for local deployments.
DEFAULT_USERNAME - Static variable in class com.datastax.astra.client.core.auth.UsernamePasswordTokenProvider
Default username for Cassandra.
DEFAULT_VERSION - Static variable in class com.datastax.astra.client.core.options.DataAPIClientOptions
API version and path in the URL in the format '/api/${version}'.
defaultId(CollectionDefaultIdTypes) - Method in class com.datastax.astra.client.collections.definition.CollectionDefinition
Builder pattern.
DefaultIdOptions() - Constructor for class com.datastax.astra.client.collections.definition.CollectionDefinition.DefaultIdOptions
Default constructor.
DefaultIdOptions(CollectionDefaultIdTypes) - Constructor for class com.datastax.astra.client.collections.definition.CollectionDefinition.DefaultIdOptions
Default constructor.
defaultValue(Object) - Method in class com.datastax.astra.client.core.rerank.RerankServiceOptions.Parameters
Sets the default value for this parameter.
defaultValue(Object) - Method in class com.datastax.astra.client.core.vectorize.VectorServiceOptions.Parameters
Sets the default value for this parameter.
definition - Variable in class com.datastax.astra.client.tables.definition.indexes.TableIndexDescriptor
The options defining the table's index characteristics.
definition(TableRegularIndexDefinition) - Method in class com.datastax.astra.client.tables.definition.indexes.TableRegularIndexDescriptor
 
definition(TableTextIndexDefinition) - Method in class com.datastax.astra.client.tables.definition.indexes.TableTextIndexDescriptor
Adds a definitions to the index.
definition(TableVectorIndexDefinition) - Method in class com.datastax.astra.client.tables.definition.indexes.TableVectorIndexDescriptor
 
definition(TableDefinition) - Method in class com.datastax.astra.client.tables.definition.TableDescriptor
Set the definition of the table.
definition(DEF) - Method in class com.datastax.astra.client.tables.definition.indexes.TableIndexDescriptor
Sets the index definition for the table.
deleteAll() - Method in class com.datastax.astra.client.collections.Collection
Removes all documents from the collection that match the given query filter.
deleteAll() - Method in class com.datastax.astra.client.tables.Table
Removes all rows from the table that match the given query filter.
deleteMany(Filter) - Method in class com.datastax.astra.client.collections.Collection
Removes all documents from the collection that match the given query filter.
deleteMany(Filter) - Method in class com.datastax.astra.client.tables.Table
Removes all rows from the table that match the given query filter.
deleteMany(Filter, CollectionDeleteManyOptions) - Method in class com.datastax.astra.client.collections.Collection
Removes all documents from the collection that match the given query filter.
deleteMany(Filter, TableDeleteManyOptions) - Method in class com.datastax.astra.client.tables.Table
Removes all rows from the tables that match the given query filter.
deleteOne(Filter) - Method in class com.datastax.astra.client.collections.Collection
Removes at most one document from the collection that matches the given filter.
deleteOne(Filter) - Method in class com.datastax.astra.client.tables.Table
Removes at most one rows from the table that matches the given filter.
deleteOne(Filter, CollectionDeleteOneOptions) - Method in class com.datastax.astra.client.collections.Collection
Removes at most one document from the collection that matches the given filter.
deleteOne(Filter, TableDeleteOneOptions) - Method in class com.datastax.astra.client.tables.Table
Removes at most one row from the table that matches the given filter.
descending(String) - Static method in class com.datastax.astra.client.core.query.Sort
Build a sort clause DESCENDING.
descending(String[]) - Static method in class com.datastax.astra.client.core.query.Sort
Build a sort clause DESCENDING.
DESCENDING - Enum constant in enum class com.datastax.astra.client.core.query.SortOrder
Value for descending order.
DESERIALIZATION_ERROR - Enum constant in enum class com.datastax.astra.client.exceptions.ErrorCodesClient
Indicates an error in client-side serialization.
DESERIALIZATION_ERROR - Enum constant in enum class com.datastax.astra.client.exceptions.ErrorCodesServer
Indicates an error in client-side serialization.
deserialize(JsonParser, DeserializationContext) - Method in class com.datastax.astra.internal.serdes.collections.CollectionDefaultIdTypeDeserializer
deserialize(JsonParser, DeserializationContext) - Method in class com.datastax.astra.internal.serdes.collections.EJsonCalendarDeserializer
deserialize(JsonParser, DeserializationContext) - Method in class com.datastax.astra.internal.serdes.collections.EJsonDateDeserializer
deserialize(JsonParser, DeserializationContext) - Method in class com.datastax.astra.internal.serdes.collections.EJsonInstantDeserializer
deserialize(JsonParser, DeserializationContext) - Method in class com.datastax.astra.internal.serdes.collections.ObjectIdDeserializer
deserialize(JsonParser, DeserializationContext) - Method in class com.datastax.astra.internal.serdes.collections.UUIDDeserializer
deserialize(JsonParser, DeserializationContext) - Method in class com.datastax.astra.internal.serdes.shared.DataAPIVectorDeserializer
deserialize(JsonParser, DeserializationContext) - Method in class com.datastax.astra.internal.serdes.shared.SimilarityMetricDeserializer
deserialize(JsonParser, DeserializationContext) - Method in class com.datastax.astra.internal.serdes.tables.ByteArrayDeserializer
Deserializes a JSON object containing a Base64-encoded string into a byte array.
deserialize(JsonParser, DeserializationContext) - Method in class com.datastax.astra.internal.serdes.tables.ColumnTypeDeserializer
deserialize(JsonParser, DeserializationContext) - Method in class com.datastax.astra.internal.serdes.tables.DoubleDeserializer
Deserializes a JSON string into a Double object.
deserialize(JsonParser, DeserializationContext) - Method in class com.datastax.astra.internal.serdes.tables.DurationDeserializer
Deserializes a JSON string into a Duration object.
deserialize(JsonParser, DeserializationContext) - Method in class com.datastax.astra.internal.serdes.tables.FloatDeserializer
Deserializes a JSON string into a Float object.
deserialize(JsonParser, DeserializationContext) - Method in class com.datastax.astra.internal.serdes.tables.TableDurationDeserializer
Deserializes a JSON string into a TableDuration object.
deserialize(JsonParser, DeserializationContext) - Method in class com.datastax.astra.internal.serdes.tables.TableIndexColumnDefinitionDeserializer
Deserializes a JSON string into a TableDuration object.
dimension() - Method in class com.datastax.astra.client.core.vector.DataAPIVector
Access dimension of the Vector.
dimension() - Element in annotation interface com.datastax.astra.client.tables.mapping.ColumnVector
Specifies the dimension of the column, usually relevant for multidimensional data.
dimension(int) - Method in class com.datastax.astra.client.tables.definition.columns.ColumnDefinitionVector
Sets the dimension of the vector and returns the updated instance.
disableEncodeDataApiVectorsAsBase64() - Method in class com.datastax.astra.client.core.options.SerdesOptions
Disable the encoding of Data API vectors as Base64.
disableEncodeDurationAsISO8601() - Method in class com.datastax.astra.client.core.options.SerdesOptions
Disable the encoding of Duration as ISO8601.
disableFeatureFlagTables() - Method in class com.datastax.astra.client.core.options.DataAPIClientOptions
Disable the feature flag tables.
disableLexical() - Method in class com.datastax.astra.client.collections.definition.CollectionDefinition
Builder pattern, disabled lexical
disableRerank() - Method in class com.datastax.astra.client.collections.definition.CollectionDefinition
Builder pattern, disable reranking
distinct(String[], Filter, Class<R>) - Method in class com.datastax.astra.client.collections.Collection
Return a list of distinct values for the given field name.
distinct(String[], Class<R>) - Method in class com.datastax.astra.client.collections.Collection
Return a list of distinct values for the given field name.
distinct(String, Filter, Class<R>) - Method in class com.datastax.astra.client.collections.Collection
Return a list of distinct values for the given field name.
distinct(String, Filter, Class<R>) - Method in class com.datastax.astra.client.tables.Table
Return a list of distinct values for the given field name.
distinct(String, Filter, Class<R>, TableDistinctOptions) - Method in class com.datastax.astra.client.collections.Collection
Return a list of distinct values for the given field name.
distinct(String, Filter, Class<R>, TableDistinctOptions) - Method in class com.datastax.astra.client.tables.Table
Return a list of distinct values for the given field name.
distinct(String, Class<R>) - Method in class com.datastax.astra.client.collections.Collection
Return a list of distinct values for the given field name.
Document - Class in com.datastax.astra.client.collections.definition.documents
Represents a document without schema constraints as a Map<String, Object>.
Document() - Constructor for class com.datastax.astra.client.collections.definition.documents.Document
Default Constructor.
Document(Object) - Constructor for class com.datastax.astra.client.collections.definition.documents.Document
Default Constructor.
Document(Map<String, ?>) - Constructor for class com.datastax.astra.client.collections.definition.documents.Document
Creates a Document instance initialized with the given map.
DOCUMENT - Static variable in class com.datastax.astra.client.collections.Collection
parameters names.
documentMap - Variable in class com.datastax.astra.client.collections.definition.documents.Document
Data to be used in the document.
DocumentSerializer - Class in com.datastax.astra.internal.serdes.collections
Custom implementation of serialization : faster + no jackson dependency
DocumentSerializer() - Constructor for class com.datastax.astra.internal.serdes.collections.DocumentSerializer
Default constructor
DOT_PRODUCT - Enum constant in enum class com.datastax.astra.client.core.vector.SimilarityMetric
Distance with dot+product (L1).
DOUBLE - Enum constant in enum class com.datastax.astra.client.tables.definition.columns.ColumnTypes
Double-precision floating-point number.
DoubleDeserializer - Class in com.datastax.astra.internal.serdes.tables
A custom deserializer for Double values, extending StdDeserializer.
DoubleDeserializer() - Constructor for class com.datastax.astra.internal.serdes.tables.DoubleDeserializer
Default constructor.
DoubleSerializer - Class in com.datastax.astra.internal.serdes.tables
A custom serializer for Double values, extending StdSerializer.
DoubleSerializer() - Constructor for class com.datastax.astra.internal.serdes.tables.DoubleSerializer
Default constructor.
drop() - Method in class com.datastax.astra.client.collections.Collection
Delete the current collection and all documents that its contains.
drop() - Method in class com.datastax.astra.client.tables.Table
Delete the current table
dropCollection(String) - Method in class com.datastax.astra.client.databases.Database
Deletes a collection from the database with default options.
dropCollection(String, DropCollectionOptions) - Method in class com.datastax.astra.client.databases.Database
Deletes a collection from the database.
DropCollectionOptions - Class in com.datastax.astra.client.collections.commands.options
Options for the dropCollection operation.
DropCollectionOptions() - Constructor for class com.datastax.astra.client.collections.commands.options.DropCollectionOptions
Default constructor.
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
Drops (deletes) the specified keyspace from the database.
dropKeyspace(String) - Method in interface com.datastax.astra.client.admin.DatabaseAdmin
Drops (deletes) the specified keyspace from the database.
dropKeyspace(String, DropKeyspaceOptions) - Method in class com.datastax.astra.client.admin.AstraDBDatabaseAdmin
Drops (deletes) the specified keyspace from the database.
dropKeyspace(String, DropKeyspaceOptions) - Method in class com.datastax.astra.client.admin.DataAPIDatabaseAdmin
 
dropKeyspace(String, DropKeyspaceOptions) - 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.
dropKeyspaceAsync(String, DropKeyspaceOptions) - Method in interface com.datastax.astra.client.admin.DatabaseAdmin
Asynchronously drops (deletes) the specified keyspace from the database.
DropKeyspaceOptions - Class in com.datastax.astra.client.databases.commands.options
Set of options used when creating a table
DropKeyspaceOptions() - Constructor for class com.datastax.astra.client.databases.commands.options.DropKeyspaceOptions
Default constructor
dropTable(String) - Method in class com.datastax.astra.client.databases.Database
Deletes a collection (table) from the database.
dropTable(String, DropTableOptions) - Method in class com.datastax.astra.client.databases.Database
Deletes a collection (table) from the database with specific options.
dropTableIndex(String) - Method in class com.datastax.astra.client.databases.Database
Delete an index by name.
dropTableIndex(String, DropTableIndexOptions) - Method in class com.datastax.astra.client.databases.Database
Delete an index by name.
DropTableIndexOptions - Class in com.datastax.astra.client.tables.commands.options
Options for dropping an index on a table.
DropTableIndexOptions() - Constructor for class com.datastax.astra.client.tables.commands.options.DropTableIndexOptions
Default constructor
DropTableOptions - Class in com.datastax.astra.client.tables.commands.options
Options for dropping a table.
DropTableOptions() - Constructor for class com.datastax.astra.client.tables.commands.options.DropTableOptions
Default constructor
DSE - Enum constant in enum class com.datastax.astra.client.DataAPIDestination
Local installation of Datastax Enterprise
DURATION - Enum constant in enum class com.datastax.astra.client.tables.definition.columns.ColumnTypes
Time duration type.
DurationDeserializer - Class in com.datastax.astra.internal.serdes.tables
A custom deserializer for Duration objects, extending JsonDeserializer.
DurationDeserializer() - Constructor for class com.datastax.astra.internal.serdes.tables.DurationDeserializer
Default constructor.
DurationSerializer - Class in com.datastax.astra.internal.serdes.tables
A custom serializer for Duration objects, extending StdSerializer.
DurationSerializer() - Constructor for class com.datastax.astra.internal.serdes.tables.DurationSerializer
Default constructor.

E

EDGE_N_GRAM - Enum constant in enum class com.datastax.astra.client.core.lexical.AnalyzerTypes
Filters StandardTokenizer output that divides text into terms on word boundaries and then uses the LowerCaseFilter.
EJsonCalendarDeserializer - Class in com.datastax.astra.internal.serdes.collections
Custom deserializer for EJson Date type.
EJsonCalendarDeserializer() - Constructor for class com.datastax.astra.internal.serdes.collections.EJsonCalendarDeserializer
Default constructor.
EJsonCalendarSerializer - Class in com.datastax.astra.internal.serdes.collections
Custom Serializer for EJson Date type.
EJsonCalendarSerializer() - Constructor for class com.datastax.astra.internal.serdes.collections.EJsonCalendarSerializer
Default constructor.
EJsonCalendarSerializer(Class<Calendar>) - Constructor for class com.datastax.astra.internal.serdes.collections.EJsonCalendarSerializer
Constructor with type
EJsonDateDeserializer - Class in com.datastax.astra.internal.serdes.collections
Custom deserializer for EJson Date type.
EJsonDateDeserializer() - Constructor for class com.datastax.astra.internal.serdes.collections.EJsonDateDeserializer
Default constructor.
EJsonDateSerializer - Class in com.datastax.astra.internal.serdes.collections
Custom Serializer for EJson Date type.
EJsonDateSerializer() - Constructor for class com.datastax.astra.internal.serdes.collections.EJsonDateSerializer
Default constructor.
EJsonDateSerializer(Class<Date>) - Constructor for class com.datastax.astra.internal.serdes.collections.EJsonDateSerializer
Constructor with type
EJsonInstantDeserializer - Class in com.datastax.astra.internal.serdes.collections
Custom deserializer for EJson Date type.
EJsonInstantDeserializer() - Constructor for class com.datastax.astra.internal.serdes.collections.EJsonInstantDeserializer
Default constructor.
EJsonInstantSerializer - Class in com.datastax.astra.internal.serdes.collections
Custom Serializer for EJson Date type.
EJsonInstantSerializer() - Constructor for class com.datastax.astra.internal.serdes.collections.EJsonInstantSerializer
Default constructor.
EJsonInstantSerializer(Class<Instant>) - Constructor for class com.datastax.astra.internal.serdes.collections.EJsonInstantSerializer
Constructor with type
embeddingApiKey(String) - Method in class com.datastax.astra.client.core.options.BaseOptions
Provide the embedding service API key.
embeddingAPIKey(String) - Method in class com.datastax.astra.client.core.options.DataAPIClientOptions
Builder pattern, update http connection Timeout
EmbeddingAPIKeyHeaderProvider - Class in com.datastax.astra.client.core.headers
Default header when working with an embedding service provider.
EmbeddingAPIKeyHeaderProvider(String) - Constructor for class com.datastax.astra.client.core.headers.EmbeddingAPIKeyHeaderProvider
Constructor.
embeddingAuthProvider(EmbeddingHeadersProvider) - Method in class com.datastax.astra.client.core.options.BaseOptions
Provide the embedding service API key.
EmbeddingHeadersProvider - Interface in com.datastax.astra.client.core.headers
To use the interface embeddings API the user needs to be authenticated against the embedding provider
EmbeddingProvider - Class in com.datastax.astra.client.core.vectorize
Class representing the Embedding Provider returned by findEmbeddingProviders command.
EmbeddingProvider() - Constructor for class com.datastax.astra.client.core.vectorize.EmbeddingProvider
Default constructor.
EmbeddingProvider.AuthenticationMethod - Class in com.datastax.astra.client.core.vectorize
Authentication method.
EmbeddingProvider.Model - Class in com.datastax.astra.client.core.vectorize
Model for the service.
EmbeddingProvider.Parameter - Class in com.datastax.astra.client.core.vectorize
Parameters for the service.
EmbeddingProvider.Token - Class in com.datastax.astra.client.core.vectorize
Token method.
EmbeddingProvider.Validation - Class in com.datastax.astra.client.core.vectorize
Validation Component for the parameter.
enableFeatureFlagTables() - Method in class com.datastax.astra.client.core.options.DataAPIClientOptions
Enable the feature flag tables.
EntityBeanDefinition<T> - Class in com.datastax.astra.internal.reflection
Provides introspection and metadata for a JavaBean entity.
EntityBeanDefinition(Class<T>) - Constructor for class com.datastax.astra.internal.reflection.EntityBeanDefinition
Constructor for the beam.
EntityFieldDefinition - Class in com.datastax.astra.internal.reflection
Definition of a field in an entity.
EntityFieldDefinition() - Constructor for class com.datastax.astra.internal.reflection.EntityFieldDefinition
Default constructor.
EntityTable - Annotation Interface in com.datastax.astra.client.tables.mapping
EntityTable annotation to define the table name
ENTRIES - Enum constant in enum class com.datastax.astra.client.tables.definition.indexes.TableIndexMapTypes
Index on map values
eq(Iterable<Filter>) - Static method in class com.datastax.astra.client.core.query.Filters
Creates a filter that performs a logical AND of the provided list of filters.
eq(Object) - Static method in class com.datastax.astra.client.core.query.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.core.query.Filters
Help Building the filters.
equals(Object) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Compares this document to another object for equality.
equals(Object) - Method in class com.datastax.astra.client.collections.definition.documents.types.ObjectId
 
equals(Object) - Method in class com.datastax.astra.client.tables.definition.rows.Row
EQUALS_TO - Enum constant in enum class com.datastax.astra.client.core.query.FilterOperator
Equal To.
ERROR_CODE_HTTP - Static variable in exception class com.datastax.astra.client.exceptions.DataAPIException
Default error code.
ERROR_CODE_INTERRUPTED - Static variable in exception class com.datastax.astra.client.exceptions.DataAPIException
Default error code.
ERROR_CODE_RANDOM - Static variable in exception class com.datastax.astra.client.exceptions.DataAPIException
Default error code.
ERROR_CODE_SERIALIZATION - Static variable in exception class com.datastax.astra.client.exceptions.DataAPIException
Default error code.
ERROR_CODE_TIMEOUT - Static variable in exception class com.datastax.astra.client.exceptions.DataAPIException
Default error code.
ErrorCodesClient - Enum Class in com.datastax.astra.client.exceptions
Represents client error codes used to standardize error reporting in the application.
ErrorCodesServer - Enum Class in com.datastax.astra.client.exceptions
Error codes for server-side errors.
escapeFieldNames(String...) - Static method in class com.datastax.astra.internal.utils.EscapeUtils
Escape a field path.
escapeSingleExpression(String) - Static method in class com.datastax.astra.internal.utils.EscapeUtils
Escape a single expression.
EscapeUtils - Class in com.datastax.astra.internal.utils
Escaper for special characters like dot and and.
EstimatedCountDocumentsOptions - Class in com.datastax.astra.client.collections.commands.options
List Options for a FindOne command.
EstimatedCountDocumentsOptions() - Constructor for class com.datastax.astra.client.collections.commands.options.EstimatedCountDocumentsOptions
Default constructor.
EstimatedCountRowsOptions - Class in com.datastax.astra.client.tables.commands.options
List Options for a FindOne command.
EstimatedCountRowsOptions() - Constructor for class com.datastax.astra.client.tables.commands.options.EstimatedCountRowsOptions
Default constructor.
estimatedDocumentCount() - Method in class com.datastax.astra.client.collections.Collection
Calling an estimatedDocumentCount with default options.
estimatedDocumentCount(EstimatedCountDocumentsOptions) - Method in class com.datastax.astra.client.collections.Collection
Executes the "estimatedDocumentCount" command to estimate the number of documents in a collection.
estimatedRowCount() - Method in class com.datastax.astra.client.tables.Table
Calling an estimatedRowCount with default options.
estimatedRowCount(EstimatedCountRowsOptions) - Method in class com.datastax.astra.client.tables.Table
Executes the "estimatedRowCount" command to estimate the number of rowse in a table.
EUCLIDEAN - Enum constant in enum class com.datastax.astra.client.core.vector.SimilarityMetric
Distance with Euclidean (L2).
Example usage: - Search tag in class com.datastax.astra.client.databases.DatabaseOptions
Section
Example Usage: - Search tag in class com.datastax.astra.client.DataAPIClient
Section
exclude(String...) - Static method in class com.datastax.astra.client.core.query.Projection
Exclude a field in the result.
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
exists() - Method in class com.datastax.astra.client.collections.Collection
Checks if the specified collection exists within the current namespace.
exists() - Method in class com.datastax.astra.client.core.query.FilterBuilder
Add condition exists.
exists(String) - Static method in class com.datastax.astra.client.core.query.Filters
Build a filter with the `$exists` operator.
EXISTS - Enum constant in enum class com.datastax.astra.client.core.DataAPIKeywords
EXISTS.
EXISTS - Enum constant in enum class com.datastax.astra.client.core.query.FilterOperator
Exist.

F

fetchNextBatch() - Method in class com.datastax.astra.client.collections.commands.cursor.CollectionFindAndRerankCursor
{PageState is always null, all is returned here }
fetchNextBatch() - Method in class com.datastax.astra.client.collections.commands.cursor.CollectionFindCursor
Fetches the next batch of documents into the buffer.
fetchNextBatch() - Method in class com.datastax.astra.client.tables.cursor.TableFindCursor
Fetches the next batch of documents into the buffer.
fetchNextBatch() - Method in class com.datastax.astra.internal.command.AbstractCursor
Fetches the next batch of documents into the buffer.
filter(Filter) - Method in class com.datastax.astra.client.collections.commands.cursor.CollectionFindAndRerankCursor
Immutable methods that return a new Cursor instance.
filter(Filter) - Method in class com.datastax.astra.client.collections.commands.cursor.CollectionFindCursor
Immutable methods that return a new Cursor instance.
filter(Filter) - Method in class com.datastax.astra.client.tables.cursor.TableFindCursor
Immutable methods that return a new Cursor instance.
Filter - Class in com.datastax.astra.client.core.query
Filter Builder.
Filter() - Constructor for class com.datastax.astra.client.core.query.Filter
Default constructor.
Filter(String, FilterOperator, Object) - Constructor for class com.datastax.astra.client.core.query.Filter
Create a filter from a where clause.
Filter(Map<String, Object>) - Constructor for class com.datastax.astra.client.core.query.Filter
Create a filter from a map.
FilterBuilder - Class in com.datastax.astra.client.core.query
Helper to build a where clause in natural language (fluent API).
FilterBuilder(Filter, String) - Constructor for class com.datastax.astra.client.core.query.FilterBuilder
Only constructor allowed
FilterOperator - Enum Class in com.datastax.astra.client.core.query
Ease process of creating a where clause.
Filters - Class in com.datastax.astra.client.core.query
Helper to create Filter
find(CollectionFindOptions) - Method in class com.datastax.astra.client.collections.Collection
Finds all documents in the collection.
find(Filter) - Method in class com.datastax.astra.client.collections.Collection
Finds all documents in the collection.
find(Filter) - Method in class com.datastax.astra.client.tables.Table
Finds all rows in the table.
find(Filter, CollectionFindOptions) - Method in class com.datastax.astra.client.collections.Collection
Finds all documents in the collection.
find(Filter, CollectionFindOptions, Class<R>) - Method in class com.datastax.astra.client.collections.Collection
Finds all documents in the collection.
find(Filter, TableFindOptions) - Method in class com.datastax.astra.client.tables.Table
Finds all rows in the table.
find(Filter, TableFindOptions, Class<R>) - Method in class com.datastax.astra.client.tables.Table
Finds all rows in the table.
find(TableFindOptions) - Method in class com.datastax.astra.client.tables.Table
Finds all rows in the table.
findAll() - Method in class com.datastax.astra.client.collections.Collection
Retrieves all documents in the collection.
findAll() - Method in class com.datastax.astra.client.tables.Table
Retrieves all rows in the table.
findAndRerank(CollectionFindAndRerankOptions) - Method in class com.datastax.astra.client.collections.Collection
Finds and reranks all documents in the collection using the specified options.
findAndRerank(Filter, CollectionFindAndRerankOptions) - Method in class com.datastax.astra.client.collections.Collection
Finds and reranks documents in the collection that match the given filter using the specified options.
findAndRerank(Filter, CollectionFindAndRerankOptions, Class<R>) - Method in class com.datastax.astra.client.collections.Collection
Finds and reranks documents in the collection that match the given filter using the specified options, mapping the resulting documents to the specified target type.
findAndRerankPage(Filter, CollectionFindAndRerankOptions, Class<R>) - Method in class com.datastax.astra.client.collections.Collection
Finds and reranks documents in the collection using the given filter and options, and returns a paginated result containing reranked items mapped to the specified result type.
findById(Object) - Method in class com.datastax.astra.client.collections.Collection
Retrieves a document by its identifier from the collection.
findById(String) - Static method in class com.datastax.astra.client.core.query.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.databases.commands.results
Wrapper to get information about the findEmbeddingProviders.
FindEmbeddingProvidersResult() - Constructor for class com.datastax.astra.client.databases.commands.results.FindEmbeddingProvidersResult
Default constructor.
findFirst() - Method in class com.datastax.astra.client.core.paging.Page
Expected from a stream of result.
findOne(CollectionFindOneOptions) - Method in class com.datastax.astra.client.collections.Collection
Syntax sugar to provide a findOne command without a filter @see Collection.findOne(Filter, CollectionFindOneOptions).
findOne(Filter) - Method in class com.datastax.astra.client.collections.Collection
Attempts to find a single document within the collection that matches the given filter criteria.
findOne(Filter) - Method in class com.datastax.astra.client.tables.Table
Retrieves a single row from the table that matches the specified filter criteria.
findOne(Filter, CollectionFindOneOptions) - Method in class com.datastax.astra.client.collections.Collection
Attempts to find a single document within the collection that matches the given filter criteria.
findOne(Filter, TableFindOneOptions) - Method in class com.datastax.astra.client.tables.Table
Retrieves a single row from the table that matches the specified filter criteria.
findOne(Filter, TableFindOneOptions, Class<R>) - Method in class com.datastax.astra.client.tables.Table
Retrieves a single row from the table that matches the specified filter criteria.
findOne(Filter, Class<R>) - Method in class com.datastax.astra.client.tables.Table
Retrieves a single row from the table that matches the specified filter criteria.
findOne(TableFindOneOptions) - Method in class com.datastax.astra.client.tables.Table
Retrieves a single row from the table that matches the specified filter criteria.
findOneAndDelete(Filter) - Method in class com.datastax.astra.client.collections.Collection
Atomically find a document and remove it.
findOneAndDelete(Filter, CollectionFindOneAndDeleteOptions) - Method in class com.datastax.astra.client.collections.Collection
Atomically find a document and remove it.
findOneAndDeleteAsync(Filter) - Method in class com.datastax.astra.client.collections.Collection
Delete and return a document asynchronous.
findOneAndReplace(Filter, T) - Method in class com.datastax.astra.client.collections.Collection
Atomically find a document and replace it.
findOneAndReplace(Filter, T, CollectionFindOneAndReplaceOptions) - Method in class com.datastax.astra.client.collections.Collection
Atomically find a document and replace it.
FindOneAndReplaceResult<T> - Class in com.datastax.astra.client.collections.commands.results
Store the result of a findOneAndReplace operation.
FindOneAndReplaceResult() - Constructor for class com.datastax.astra.client.collections.commands.results.FindOneAndReplaceResult
Default constructor.
findOneAndUpdate(Filter, Update) - Method in class com.datastax.astra.client.collections.Collection
Atomically find a document and update it.
findOneAndUpdate(Filter, Update, CollectionFindOneAndUpdateOptions) - Method in class com.datastax.astra.client.collections.Collection
Atomically find a document and update it.
findOneASync(Filter) - Method in class com.datastax.astra.client.collections.Collection
Initiates an asynchronous search to find a single document that matches the given filter criteria.
findOneASync(Filter, CollectionFindOneOptions) - Method in class com.datastax.astra.client.collections.Collection
Asynchronously attempts to find a single document within the collection that matches the given filter criteria, utilizing the specified CollectionFindOneOptions for the query.
findPage(Filter, CollectionFindOptions) - Method in class com.datastax.astra.client.collections.Collection
Fine document with pagination with no projection.
findPage(Filter, CollectionFindOptions, Class<R>) - Method in class com.datastax.astra.client.collections.Collection
Executes a paginated 'find' query on the collection using the specified filter and find options.
findPage(Filter, TableFindOptions) - Method in class com.datastax.astra.client.tables.Table
Search for a Page with no projection.
findPage(Filter, TableFindOptions, Class<R>) - Method in class com.datastax.astra.client.tables.Table
Executes a paginated 'find' query on the table using the specified filter and find options.
findPageASync(Filter, CollectionFindOptions) - Method in class com.datastax.astra.client.collections.Collection
Executes a paginated 'find' query on the collection using the specified filter and find options asynchronously.
findRerankingProviders() - Method in class com.datastax.astra.client.admin.AstraDBDatabaseAdmin
Retrieve the list of reranking providers available in the current database.
findRerankingProviders() - Method in class com.datastax.astra.client.admin.DataAPIDatabaseAdmin
 
findRerankingProviders() - Method in interface com.datastax.astra.client.admin.DatabaseAdmin
Retrieve the list of reranking providers available in the current database.
FindRerankingProvidersResult - Class in com.datastax.astra.client.databases.commands.results
Wrapper to get information about the findEmbeddingProviders.
FindRerankingProvidersResult() - Constructor for class com.datastax.astra.client.databases.commands.results.FindRerankingProvidersResult
Default constructor.
FLOAT - Enum constant in enum class com.datastax.astra.client.tables.definition.columns.ColumnTypes
Single-precision floating-point number.
FloatDeserializer - Class in com.datastax.astra.internal.serdes.tables
A custom deserializer for Float values, extending StdDeserializer.
FloatDeserializer() - Constructor for class com.datastax.astra.internal.serdes.tables.FloatDeserializer
Default constructor.
FloatSerializer - Class in com.datastax.astra.internal.serdes.tables
A custom serializer for Float values, extending StdSerializer.
FloatSerializer() - Constructor for class com.datastax.astra.internal.serdes.tables.FloatSerializer
Default constructor.
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.collections.definition.documents.types.UUIDv6
Generate from a string.
fromString(String) - Static method in class com.datastax.astra.client.collections.definition.documents.types.UUIDv7
Generate from a string.
fromValue(String) - Static method in enum class com.datastax.astra.client.collections.definition.CollectionDefaultIdTypes
Creates a CollectionIdTypes from its string value.
fromValue(String) - Static method in enum class com.datastax.astra.client.core.lexical.AnalyzerTypes
Build from the key.
fromValue(String) - Static method in enum class com.datastax.astra.client.core.rerank.RerankProviderTypes
Build from the key.
fromValue(String) - Static method in enum class com.datastax.astra.client.core.vector.SimilarityMetric
Build from the key.

G

ge(String) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Access element from the map
GENERAL_METHOD - Enum constant in enum class com.datastax.astra.client.core.commands.CommandType
Data operation (find*, insert*, update*, delete*)
generalMethodTimeout(Duration) - Method in class com.datastax.astra.client.core.options.TimeoutOptions
Sets the general method timeout.
get() - Method in interface com.datastax.astra.client.core.auth.TokenProvider
get(String, Class<T>) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Gets the value of the given key, casting it to the given Class<T>.
get(String, Class<T>) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Gets the value of the given key, casting it to the given Class<T>.
get(String, Class<T>) - Method in class com.datastax.astra.internal.api.DataAPIStatus
Gets the value of the given key, casting it to the given Class<T>.
get(Object) - Method in class com.datastax.astra.internal.api.DataAPIStatus
Gets the value of the given key.
get(String) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Retrieves the value associated with the specified key from the document.
get(String) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Access element from the map
get(String[]) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Check if the given dot-delimited path exists as a key (final segment).
get(TemporalUnit) - Method in class com.datastax.astra.client.tables.definition.TableDuration
getAdmin() - Method in class com.datastax.astra.client.DataAPIClient
Retrieves an administration client using the default authentication token provided during DataAPIClient initialization.
getAdmin() - Method in class com.datastax.astra.client.databases.Database
Retrieves an administration client specifically for Astra deployments using the default authentication token.
getAdmin(AdminOptions) - Method in class com.datastax.astra.client.DataAPIClient
Retrieves an administration client specifically designed for Astra deployments.
getAdmin(AdminOptions) - Method in class com.datastax.astra.client.databases.Database
Retrieves an administration client for Astra deployments using detailed administrative options.
getAdmin(String) - Method in class com.datastax.astra.client.DataAPIClient
Retrieves an administration client using the default authentication token provided during DataAPIClient initialization.
getAdmin(String) - Method in class com.datastax.astra.client.databases.Database
Retrieves an administration client specifically for Astra deployments using a provided super-user token.
getAdminAdditionalHeaders() - Method in class com.datastax.astra.client.core.options.DataAPIClientOptions
Gets adminAdditionalHeaders
getAllow() - Method in class com.datastax.astra.client.collections.definition.CollectionDefinition.IndexingOptions
Gets allow
getAnalyzer() - Method in class com.datastax.astra.client.core.lexical.LexicalOptions
Gets analyzer
getApiEndpoint() - Method in class com.datastax.astra.client.admin.AstraDBDatabaseAdmin
Get the API endpoint for the current database.
getApiEndpoint() - Method in class com.datastax.astra.client.databases.Database
Gets apiEndpoint
getApiEndpoint() - Method in class com.datastax.astra.internal.command.AbstractCommandRunner
Gets apiEndpoint
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.exceptions.DataAPIResponseException
Flattening errors as a list.
getApiVersion() - Method in class com.datastax.astra.client.core.options.DataAPIClientOptions
Gets apiVersion
getArray(String, Class<K>) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Return an Array of items.
getArray(String, Class<K>) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Return an Array of items.
getAscii(String) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Gets the value of the given key as a String.
getAstraEnvironment() - Method in class com.datastax.astra.client.core.options.DataAPIClientOptions
Find the Astra Environment from the destination provided in the initial Optional.
getAstraEnvironment(DataAPIDestination) - Static method in class com.datastax.astra.client.core.options.DataAPIClientOptions
Allow to map in between Astra Environment (devops) and the DataApiClient destinations
getAuthenticationNone() - Method in class com.datastax.astra.client.core.rerank.RerankProvider
Accessor for the Share Secret Authentication.
getBigInt(String) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Gets the value of the given key as a Long.
getBoolean(String) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Gets the value of the given key as a Boolean.
getBoolean(String) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Gets the value of the given key as a Boolean.
getBoolean(String) - Method in class com.datastax.astra.internal.api.DataAPIStatus
Gets the value of the given key as a Boolean.
getBufferedSize() - Method in class com.datastax.astra.internal.command.AbstractCursor
Access the size of the buffer.
getByte(String) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Access element from the map
getByte(String) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Access element from the map
getCalendar(String) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Access element from the map
getCalendar(String) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Access element from the map
getCallers() - Method in class com.datastax.astra.client.core.http.HttpClientOptions
Gets callers
getCharacter(String) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Access element from the map
getCharacter(String) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Access element from the map
getChunkSize() - Method in class com.datastax.astra.client.collections.commands.options.CollectionInsertManyOptions
Gets chunkSize
getCollection(String) - Method in class com.datastax.astra.client.databases.Database
Retrieves a Collection object for the specified collection name.
getCollection(String, CollectionOptions) - Method in class com.datastax.astra.client.databases.Database
Retrieves a Collection object for the specified collection name with the ability to specify custom options.
getCollection(String, Class<T>) - Method in class com.datastax.astra.client.databases.Database
Retrieves a Collection object for the specified collection name, with the ability to customize the collection behavior using the specified CollectionOptions.
getCollection(String, Class<T>, CollectionOptions) - Method in class com.datastax.astra.client.databases.Database
Retrieves a Collection object for the specified collection name with custom options and document type.
getCollectionAdminTimeoutMillis() - Method in class com.datastax.astra.client.core.options.TimeoutOptions
Gets collectionAdminTimeoutMillis
getColumnMap() - Method in class com.datastax.astra.client.tables.definition.rows.Row
Access internal property map.
getColumnType(Class<?>) - Static method in class com.datastax.astra.client.tables.definition.columns.ColumnTypeMapper
Retrieves the Cassandra column type corresponding to the given Java class.
getCommandType() - Method in class com.datastax.astra.client.core.options.BaseOptions
Gets commandType
getConcurrency() - Method in class com.datastax.astra.client.collections.commands.options.CollectionInsertManyOptions
Gets concurrency
getConnectTimeoutMillis() - Method in class com.datastax.astra.client.core.options.TimeoutOptions
Gets connectTimeoutMillis
getDataAPIClientOptions() - Method in class com.datastax.astra.client.core.options.BaseOptions
Gets dataAPIClientOptions
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 connect to the Data API using the specified API endpoint.
getDatabase(String, DatabaseOptions) - Method in class com.datastax.astra.client.DataAPIClient
Retrieves a database client configured to interact with the Data API.
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
Retrieves a database client configured to connect to the Data API using the specified API endpoint and keyspace.
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 database client configured to connect to the Data API using a database identifier.
getDatabase(UUID, DatabaseOptions) - Method in class com.datastax.astra.client.admin.AstraDBAdmin
Access the database functions.
getDatabase(UUID, DatabaseOptions) - Method in class com.datastax.astra.client.DataAPIClient
Retrieves a database client configured to connect to the Data API using a database identifier, with custom DatabaseOptions.
getDatabase(UUID, String) - Method in class com.datastax.astra.client.admin.AstraDBAdmin
Access the database functions.
getDatabase(UUID, String, DatabaseOptions) - Method in class com.datastax.astra.client.DataAPIClient
Retrieves a database client configured to connect to the Data API using a database identifier, a specified region, and custom DatabaseOptions.
getDatabaseAdditionalHeaders() - Method in class com.datastax.astra.client.core.options.DataAPIClientOptions
Gets databaseAdditionalHeaders
getDatabaseAdmin() - Method in class com.datastax.astra.client.databases.Database
Retrieves a database administration client using the default authentication token.
getDatabaseAdmin(AdminOptions) - Method in class com.datastax.astra.client.databases.Database
Retrieves a database administration client using detailed administrative options.
getDatabaseAdmin(String) - Method in class com.datastax.astra.client.databases.Database
Retrieves a database administration client using a provided super-user token.
getDatabaseAdmin(UUID) - Method in class com.datastax.astra.client.admin.AstraDBAdmin
Access the database functions.
getDatabaseAdminTimeoutMillis() - Method in class com.datastax.astra.client.core.options.TimeoutOptions
Gets databaseAdminTimeoutMillis
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.collections.definition.documents.types.ObjectId
Gets the timestamp as a Date instance.
getDate(String) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Access element from the map
getDate(String) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Access element from the map
getDefaultId() - Method in class com.datastax.astra.client.collections.definition.CollectionDefinition
Gets defaultId
getDefinition() - Method in class com.datastax.astra.client.collections.Collection
Retrieves the full definition of the collection, encompassing both its name and its configuration options.
getDefinition() - Method in class com.datastax.astra.client.tables.Table
Retrieves the full definition of the table, encompassing both its name and its configuration options.
getDeny() - Method in class com.datastax.astra.client.collections.definition.CollectionDefinition.IndexingOptions
Gets deny
getDestination() - Method in class com.datastax.astra.client.core.options.DataAPIClientOptions
Gets destination
getDimension() - Method in class com.datastax.astra.client.core.vector.VectorOptions
Gets dimension
getDocumentMap() - Method in class com.datastax.astra.client.collections.definition.documents.Document
Getter for the document map.
getDouble(String) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Gets the value of the given key as a Double.
getDouble(String) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Gets the value of the given key as a Double.
getEmbeddingHeadersProvider() - Method in class com.datastax.astra.client.core.options.DataAPIClientOptions
Gets embeddingAuthProvider
getErrorCode(List<ExecutionInfos>) - Static method in exception class com.datastax.astra.client.exceptions.DataAPIResponseException
Parse the command list to get first error of first command.
getErrorMessage() - Method in exception class com.datastax.astra.client.exceptions.DataAPIErrorDescriptor
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.exceptions.DataAPIResponseException
Parse the command list to get first error of first command.
getExecutionTime() - Method in class com.datastax.astra.internal.command.ExecutionInfos.DataApiExecutionInfoBuilder
Execute the command and populate the response.
getFloat(String) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Access element from the map
getFloat(String) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Access element from the map
getGeneralMethodTimeoutMillis() - Method in class com.datastax.astra.client.core.options.TimeoutOptions
Gets dataOperationTimeoutMillis
getHeaderAuthentication() - Method in class com.datastax.astra.client.core.rerank.RerankProvider
Accessor for the Share Secret Authentication.
getHeaderAuthentication() - Method in class com.datastax.astra.client.core.vectorize.EmbeddingProvider
Accessor for the Share Secret Authentication.
getHeaders() - Method in class com.datastax.astra.client.core.headers.AWSEmbeddingHeadersProvider
Build the Header for this provider.
getHeaders() - Method in class com.datastax.astra.client.core.headers.EmbeddingAPIKeyHeaderProvider
Build the Header for this provider.
getHeaders() - Method in interface com.datastax.astra.client.core.headers.HeadersProvider
Build the Header to authenticate against embeddings provider.
getHeaders() - Method in class com.datastax.astra.client.core.headers.RerankingAPIKeyHeaderProvider
Build the Header for this provider.
getHostname() - Method in class com.datastax.astra.client.core.http.HttpProxy
Gets hostname
getHttpClientOptions() - Method in class com.datastax.astra.client.core.options.DataAPIClientOptions
Gets httpClientOptions
getHttpProxy() - Method in class com.datastax.astra.client.core.http.HttpClientOptions
Gets proxy
getHttpRedirect() - Method in class com.datastax.astra.client.core.http.HttpClientOptions
Gets httpRedirect
getHttpVersion() - Method in class com.datastax.astra.client.core.http.HttpClientOptions
Gets httpVersion
getId() - Method in class com.datastax.astra.client.databases.Database
Retrieves the unique database identifier (UUID) of the database if it is deployed in Astra.
getId(Class<T>) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Access the document identifier
getIndexing() - Method in class com.datastax.astra.client.collections.definition.CollectionDefinition
Access the indexing options.
getInfo() - Method in class com.datastax.astra.client.databases.Database
Retrieves information about the current database, including metadata and configuration details.
getInsertedIdAsRow() - Method in class com.datastax.astra.client.tables.commands.results.TableInsertOneResult
Converts the inserted ID values into a structured Row.
getInsertedIds(Class<T>) - Method in class com.datastax.astra.internal.api.DataAPIStatus
Access the insertedIds mapping.
getInstant(String) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Access element from the map
getInstant(String) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Access element from the map
getInteger(String) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Gets the value of the given key as an Integer.
getInteger(String) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Gets the value of the given key as an Integer.
getInteger(String) - Method in class com.datastax.astra.internal.api.DataAPIStatus
Gets the value of the given key as an Integer.
getKeyspace() - Method in class com.datastax.astra.client.collections.CollectionOptions
Gets keyspace
getKeyspace() - Method in class com.datastax.astra.client.collections.commands.cursor.CollectionFindAndRerankCursor
Retrieve keyspace name.
getKeyspace() - Method in class com.datastax.astra.client.collections.commands.cursor.CollectionFindCursor
Retrieve keyspace name.
getKeyspace() - Method in class com.datastax.astra.client.collections.commands.options.CreateCollectionOptions
Gets keyspace
getKeyspace() - Method in class com.datastax.astra.client.databases.Database
Retrieves the name of the currently selected keyspace.
getKeyspace() - Method in class com.datastax.astra.client.databases.DatabaseOptions
Gets keyspace
getKeyspace() - Method in class com.datastax.astra.client.tables.commands.options.CreateTableOptions
Gets keyspace
getKeyspace() - Method in class com.datastax.astra.client.tables.commands.options.DropTableIndexOptions
Gets keyspace
getKeyspace() - Method in class com.datastax.astra.client.tables.commands.options.DropTableOptions
Gets keyspace
getKeyspace() - Method in class com.datastax.astra.client.tables.commands.options.ListTablesOptions
Gets keyspace
getKeyspace() - Method in class com.datastax.astra.client.tables.cursor.TableFindCursor
Retrieve keyspace name.
getKeyspace() - Method in class com.datastax.astra.client.tables.TableOptions
Gets keyspace
getKeyspaceAdminTimeoutMillis() - Method in class com.datastax.astra.client.core.options.TimeoutOptions
Gets keyspaceAdminTimeoutMillis
getKeyspaceName() - Method in class com.datastax.astra.client.collections.Collection
Retrieves the name of the parent keyspace associated with this collection.
getKeyspaceName() - Method in class com.datastax.astra.client.tables.Table
Retrieves the name of the parent keyspace associated with this table.
getLexical() - Method in class com.datastax.astra.client.collections.definition.CollectionDefinition
Gets lexical
getLexical() - Method in class com.datastax.astra.client.collections.definition.documents.Document
Access attribute with vectorize name if any.
getList(String, Class<T>) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Gets the list value of the given key, casting the list elements to the given Class<T>.
getList(String, Class<T>) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Gets the list value of the given key, casting the list elements to the given Class<T>.
getLocalizedMessage() - Method in exception class com.datastax.astra.client.exceptions.DataAPIErrorDescriptor
getLong(String) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Gets the value of the given key as a Long.
getMap(String, Class<K>, Class<V>) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Gets the list value of the given key, casting the list elements to the given Class<T>.
getMapper() - Method in class com.datastax.astra.internal.serdes.collections.DocumentSerializer
 
getMapper() - Method in interface com.datastax.astra.internal.serdes.DataAPISerializer
Access the Jackson Mapper
getMapper() - Method in class com.datastax.astra.internal.serdes.DatabaseSerializer
 
getMapper() - Method in class com.datastax.astra.internal.serdes.tables.RowSerializer
Definition of the Jackson object mapper to work with Tables.
getMetric() - Method in class com.datastax.astra.client.core.vector.VectorOptions
Gets metric
getName() - Method in class com.datastax.astra.client.core.http.Caller
Gets name
getName() - Method in class com.datastax.astra.client.databases.Database
Retrieves the name of the current database.
getName() - Method in class com.datastax.astra.client.tables.Table
Retrieves the name of the table.
getObjectId(String) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Access element from the map
getObservers() - Method in class com.datastax.astra.client.core.options.DataAPIClientOptions
Gets observers
getOperationName() - Method in class com.datastax.astra.client.tables.commands.AlterTableAddColumns
Returns the name of this operation.
getOperationName() - Method in class com.datastax.astra.client.tables.commands.AlterTableAddReranking
Returns the name of this operation, which is "addVectorize".
getOperationName() - Method in class com.datastax.astra.client.tables.commands.AlterTableAddVectorize
Returns the name of this operation, which is "addVectorize".
getOperationName() - Method in class com.datastax.astra.client.tables.commands.AlterTableDropColumns
Returns the name of this operation, which is "drop".
getOperationName() - Method in class com.datastax.astra.client.tables.commands.AlterTableDropVectorize
Returns the name of this operation, which is "dropVectorize".
getOperationName() - Method in interface com.datastax.astra.client.tables.commands.AlterTableOperation
Returns the name of the table alteration operation.
getOperationName() - Method in class com.datastax.astra.client.tables.commands.AlterTableRenameColumns
Returns the name of the operation, which is "rename".
getOptions() - Method in class com.datastax.astra.client.DataAPIClient
Gets options
getOptions() - Method in class com.datastax.astra.internal.command.AbstractCommandRunner
Gets commandOptions
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.core.paging.Page
Getter accessor for attribute 'pageState'.
getPartitionBy() - Method in class com.datastax.astra.internal.reflection.EntityBeanDefinition
Build the partition Key based on annotated fields with @PartitionBy with position.
getPartitionSort() - Method in class com.datastax.astra.internal.reflection.EntityBeanDefinition
Build the partition sort based on annotated fields @PartitionSort with position and order.
getPayload() - Method in class com.datastax.astra.internal.api.DataAPIStatus
Getter for the payload.
getPort() - Method in class com.datastax.astra.client.core.http.HttpProxy
Gets port
getProjectionArray() - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindAndRerankOptions
Adding this on top of sort(Sort[] s) to allow for a more fluent API.
getProjectionArray() - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindOneAndDeleteOptions
Adding this on top of sort(Sort[] s) to allow for a more fluent API.
getProjectionArray() - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindOneAndReplaceOptions
Adding this on top of sort(Sort[] s) to allow for a more fluent API.
getProjectionArray() - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindOneAndUpdateOptions
Adding this on top of sort(Sort[] s) to allow for a more fluent API.
getProjectionArray() - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindOneOptions
Adding this on top of sort(Sort[] s) to allow for a more fluent API.
getProjectionArray() - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindOptions
Adding this on top of sort(Sort[] s) to allow for a more fluent API.
getProjectionArray() - Method in class com.datastax.astra.client.tables.commands.options.TableFindOneOptions
Adding this on top of sort(Sort[] s) to allow for a more fluent API.
getProjectionArray() - Method in class com.datastax.astra.client.tables.commands.options.TableFindOptions
Adding this on top of sort(Sort[] s) to allow for a more fluent API.
getRegion() - Method in class com.datastax.astra.client.databases.Database
Retrieves the region of the database if it is deployed in Astra.
getRequestTimeout() - Method in class com.datastax.astra.client.core.options.BaseOptions
Return the HTTP Request Timeout based on the command type
getRequestTimeout(TimeoutOptions, CommandType) - Method in class com.datastax.astra.client.core.options.BaseOptions
Request timeout based on the command type.
getRequestTimeoutMillis() - Method in class com.datastax.astra.client.core.options.TimeoutOptions
Gets requestTimeoutMillis
getRerank() - Method in class com.datastax.astra.client.collections.definition.CollectionDefinition
Gets reranking
getRerankHeadersProvider() - Method in class com.datastax.astra.client.core.options.DataAPIClientOptions
Gets rerankHeadersProvider
getRerankingHeadersProvider() - Method in class com.datastax.astra.client.core.options.DataAPIClientOptions
Gets rerankingHeadersProvider
getRetryCount() - Method in class com.datastax.astra.client.core.http.HttpClientOptions
Gets retryCount
getRetryDelay() - Method in class com.datastax.astra.client.core.http.HttpClientOptions
Gets retryDelay
getSerdesOptions() - Static method in class com.datastax.astra.client.core.options.DataAPIClientOptions
Gets serdesOptions
getSerializer() - Method in class com.datastax.astra.client.core.options.BaseOptions
Gets serializer
getSerializer() - Method in class com.datastax.astra.internal.command.AbstractCommandRunner
Gets the serializer currently in place to parse inputs and outputs.
getService() - Method in class com.datastax.astra.client.core.rerank.CollectionRerankOptions
Gets service
getService() - Method in class com.datastax.astra.client.core.vector.VectorOptions
Gets service
getSharedSecretAuthentication() - Method in class com.datastax.astra.client.core.rerank.RerankProvider
Accessor for the Share Secret Authentication.
getSharedSecretAuthentication() - Method in class com.datastax.astra.client.core.vectorize.EmbeddingProvider
Accessor for the Share Secret Authentication.
getShort(String) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Access element from the map
getShort(String) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Access element from the map
getSimilarity() - Method in class com.datastax.astra.client.collections.definition.documents.Document
Get value for similarity.
getSimilarity() - Method in class com.datastax.astra.client.tables.definition.rows.Row
Access the similarity.
getSimilarityMetric() - Method in class com.datastax.astra.client.core.vector.VectorOptions
Get metric as an enum.
getSortArray() - Method in class com.datastax.astra.client.collections.commands.options.CollectionDeleteOneOptions
Get the sort options.
getSortArray() - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindAndRerankOptions
Return the sort clause as an arryr
getSortArray() - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindOneAndDeleteOptions
Get the sort options.
getSortArray() - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindOneAndReplaceOptions
Get the sort options.
getSortArray() - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindOneAndUpdateOptions
Get the sort options.
getSortArray() - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindOneOptions
Get the sort options.
getSortArray() - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindOptions
Get the sort options.
getSortArray() - Method in class com.datastax.astra.client.collections.commands.options.CollectionUpdateOneOptions
Get the sort options.
getSortArray() - Method in class com.datastax.astra.client.tables.commands.options.TableFindOneOptions
Get the sort options.
getSortArray() - Method in class com.datastax.astra.client.tables.commands.options.TableFindOptions
Get the sort options.
getSortVector() - Method in class com.datastax.astra.client.core.paging.Page
If the sort Vector has been retrieved in the status, it will be available here.
getSortVector() - Method in class com.datastax.astra.internal.command.AbstractCursor
Access to the Sort Vector.
getStatus(Class<T>) - Method in class com.datastax.astra.internal.api.DataAPIResponse
Retrieves a single object from the 'status' map based on the provided key, casting it to the specified class.
getStatusKeyAsList(String, Class<T>) - Method in class com.datastax.astra.internal.api.DataAPIResponse
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.DataAPIResponse
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.DataAPIResponse
Retrieves a stream of String values from the 'status' map based on the provided key.
getString(String) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Gets the value of the given key as a String.
getString(String) - Method in class com.datastax.astra.internal.api.DataAPIStatus
Gets the value of the given key as an Integer.
getTable(Class<T>) - Method in class com.datastax.astra.client.databases.Database
Retrieves a table representation for a row class annotated with EntityTable.
getTable(String) - Method in class com.datastax.astra.client.databases.Database
Retrieves a table representation for the specified table name with default TableOptions.
getTable(String, TableOptions) - Method in class com.datastax.astra.client.databases.Database
Retrieves a table representation for the specified table name and TableOptions, defaulting to Row type rows.
getTable(String, Class<T>) - Method in class com.datastax.astra.client.databases.Database
Retrieves a table representation for the specified table name and row class type with default TableOptions.
getTable(String, Class<T>, TableOptions) - Method in class com.datastax.astra.client.databases.Database
Retrieves a table representation for the specified table name, table options, and row class type.
getTableAdminTimeoutMillis() - Method in class com.datastax.astra.client.core.options.TimeoutOptions
Gets schemaOperationTimeoutMillis
getTableName(Class<T>) - Method in class com.datastax.astra.client.databases.Database
Creates a table using default options and runtime configurations.
getText(String) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Gets the value of the given key as a String.
getTimeout() - Method in class com.datastax.astra.client.core.options.BaseOptions
Return the HTTP Request Timeout based on the command type
getTimeout(TimeoutOptions, CommandType) - Method in class com.datastax.astra.client.core.options.BaseOptions
Request timeout based on the command type.
getTimeoutOptions() - Method in class com.datastax.astra.client.core.options.DataAPIClientOptions
Gets timeoutOptions
getToken() - Method in class com.datastax.astra.client.core.auth.StaticTokenProvider
Building the token.
getToken() - Method in interface com.datastax.astra.client.core.auth.TokenProvider
Building the token.
getToken() - Method in class com.datastax.astra.client.core.auth.UsernamePasswordTokenProvider
Generate or renew authentication token.
getToken() - Method in class com.datastax.astra.client.core.options.BaseOptions
Gets token
getToken() - Method in class com.datastax.astra.client.DataAPIClient
Gets token
getTokenAsString() - Method in interface com.datastax.astra.client.core.auth.TokenProvider
Building the token.
getType() - Method in class com.datastax.astra.client.collections.definition.CollectionDefinition.DefaultIdOptions
Gets type
getUnits() - Method in class com.datastax.astra.client.tables.definition.TableDuration
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.collections.definition.documents.Document
Access element from the map
getUUID(String) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Access element from the map
getValue() - Method in class com.datastax.astra.client.core.query.Sort
Get the value of the sort.
getVector() - Method in class com.datastax.astra.client.collections.definition.CollectionDefinition
Access the vector options.
getVector() - Method in class com.datastax.astra.client.collections.definition.documents.Document
Get value for vector.
getVector(String) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Gets the value of the given key as a DataAPIVector.
getVectorize() - Method in class com.datastax.astra.client.collections.definition.documents.Document
Access attribute with vectorize name if any.
getVersion() - Method in class com.datastax.astra.client.core.http.Caller
Gets version
GREATER_THAN - Enum constant in enum class com.datastax.astra.client.core.query.FilterOperator
Greater Than.
GREATER_THAN_OR_EQUALS_TO - Enum constant in enum class com.datastax.astra.client.core.query.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.core.query.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.core.query.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.core.query.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.core.query.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.core.query.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.core.query.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.core.query.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.core.query.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.collections.definition.documents.Document
Returns the hash code value for this document.
hashCode() - Method in class com.datastax.astra.client.collections.definition.documents.types.ObjectId
 
hashCode() - Method in class com.datastax.astra.client.tables.definition.rows.Row
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.internal.command.AbstractCursor
Checks if there are more elements in the cursor.
hasSize(int) - Method in class com.datastax.astra.client.core.query.FilterBuilder
Condition to evaluate size
hasSize(String, int) - Static method in class com.datastax.astra.client.core.query.Filters
Build a filter with the `$hasSize` operator.
hasSubFieldsEqualsTo(Map<String, Object>) - Method in class com.datastax.astra.client.core.query.FilterBuilder
$eq: [ ... ]
HCD - Enum constant in enum class com.datastax.astra.client.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.core.headers.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.core.headers.AWSEmbeddingHeadersProvider
Headers param with the embedding ApiKey when dealing with a embedding service provider.
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.core.headers.EmbeddingAPIKeyHeaderProvider
Headers param with the embedding ApiKey when dealing with a embedding service provider.
HEADER_FEATURE_FLAG_TABLES - Static variable in class com.datastax.astra.client.core.options.DataAPIClientOptions
Feature Flag Tables.
HEADER_REQUESTED_WITH - Static variable in class com.datastax.astra.internal.http.RetryHttpClient
Headers param to insert the user agent identifying the client.
HEADER_RERANK_API_KEY - Static variable in class com.datastax.astra.client.core.headers.RerankingAPIKeyHeaderProvider
Headers param with the embedding ApiKey when dealing with a rerank service provider.
HEADER_TOKEN - Static variable in class com.datastax.astra.internal.http.RetryHttpClient
Headers param to insert the token.
HEADER_USER_AGENT - Static variable in class com.datastax.astra.internal.http.RetryHttpClient
Headers name to insert the user agent identifying the client.
HeadersProvider - Interface in com.datastax.astra.client.core.headers
Super interface to provide headers for the client.
help(String) - Method in class com.datastax.astra.client.core.rerank.RerankServiceOptions.Parameters
Sets the description for this parameter.
help(String) - Method in class com.datastax.astra.client.core.vectorize.VectorServiceOptions.Parameters
Sets the description for this parameter.
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.internal.http.RetryHttpClient
Http Options.
httpClientOptions(HttpClientOptions) - Method in class com.datastax.astra.client.core.options.BaseOptions
Provide the token.
HttpClientOptions - Class in com.datastax.astra.client.core.http
Options to set up http Client.
HttpClientOptions() - Constructor for class com.datastax.astra.client.core.http.HttpClientOptions
Default constructor.
HttpProxy - Class in com.datastax.astra.client.core.http
Subclass to represent an http proxy.
HttpProxy() - Constructor for class com.datastax.astra.client.core.http.HttpProxy
Default constructor.
HttpProxy(String, int) - Constructor for class com.datastax.astra.client.core.http.HttpProxy
Constructor with hostname and port.
httpRetries(int, Duration) - Method in class com.datastax.astra.client.core.http.HttpClientOptions
Set the number of retries and the delay between each retry.
hybrid(Hybrid) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Add a hybrid attribute in the documentW
hybrid(Hybrid) - Static method in class com.datastax.astra.client.core.query.Sort
Build a sort clause with vectorize.
hybrid(String) - Static method in class com.datastax.astra.client.core.query.Sort
Build a sort clause with vectorize.
hybrid(String, String) - Static method in class com.datastax.astra.client.core.query.Sort
Build a sort clause with vectorize.
Hybrid - Class in com.datastax.astra.client.core.hybrid
Hybrid object that can be used to store both vector and lexical information.
Hybrid() - Constructor for class com.datastax.astra.client.core.hybrid.Hybrid
Default constructor.
Hybrid(Document) - Constructor for class com.datastax.astra.client.core.hybrid.Hybrid
Constructor with custom document.
Hybrid(String) - Constructor for class com.datastax.astra.client.core.hybrid.Hybrid
Constructor with text.
HYBRID - Enum constant in enum class com.datastax.astra.client.core.DataAPIKeywords
HYBRID.
hybridLimits(int) - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindAndRerankOptions
Add a hybridLimits clause in the find block
hybridLimits(Map<String, Integer>) - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindAndRerankOptions
Add a hybridLimits clause in the find block
HybridLimits - Class in com.datastax.astra.client.core.hybrid
Represents the limits for lexical and vector data.
HybridLimits(Integer) - Constructor for class com.datastax.astra.client.core.hybrid.HybridLimits
Constructor.
HybridLimits(Map<String, Integer>) - Constructor for class com.datastax.astra.client.core.hybrid.HybridLimits
Constructor.
HybridLimitsSerializer - Class in com.datastax.astra.internal.serdes.collections
Serializer for TableIndexColumnDefinition.
HybridLimitsSerializer() - Constructor for class com.datastax.astra.internal.serdes.collections.HybridLimitsSerializer
Default constructor
HybridSerializer - Class in com.datastax.astra.internal.serdes.core
Serializer for Vectorize
HybridSerializer() - Constructor for class com.datastax.astra.internal.serdes.core.HybridSerializer
Default constructor
hybridSort(Hybrid) - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindAndRerankOptions
Adding this on top of sort(Sort[] s) to allow for a more fluent API.

I

id(T) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Set value for the identifier.
ID - Enum constant in enum class com.datastax.astra.client.core.DataAPIKeywords
ID.
IDLE - Enum constant in enum class com.datastax.astra.client.core.paging.CursorState
Indicates that the cursor is created but not yet started.
IF_EXISTS - Static variable in class com.datastax.astra.client.databases.commands.options.DropKeyspaceOptions
Improve syntax.
IF_EXISTS - Static variable in class com.datastax.astra.client.tables.commands.options.AlterTableOptions
A predefined instance of AlterTableOptions with the "IF EXISTS" condition enabled.
IF_EXISTS - Static variable in class com.datastax.astra.client.tables.commands.options.DropTableIndexOptions
Improve syntax.
IF_EXISTS - Static variable in class com.datastax.astra.client.tables.commands.options.DropTableOptions
Improve syntax.
IF_NOT_EXISTS - Static variable in class com.datastax.astra.client.databases.commands.options.CreateKeyspaceOptions
Improve syntax.
IF_NOT_EXISTS - Static variable in class com.datastax.astra.client.tables.commands.options.CreateIndexOptions
Improve syntax.
IF_NOT_EXISTS - Static variable in class com.datastax.astra.client.tables.commands.options.CreateTableOptions
Improve syntax.
IF_NOT_EXISTS - Static variable in class com.datastax.astra.client.tables.commands.options.CreateTextIndexOptions
Improve syntax.
IF_NOT_EXISTS - Static variable in class com.datastax.astra.client.tables.commands.options.CreateVectorIndexOptions
Improve syntax.
in(String, V...) - Static method in class com.datastax.astra.client.core.query.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 class com.datastax.astra.client.core.query.FilterOperator
in.
inc(String, Double) - Method in class com.datastax.astra.client.collections.commands.Update
Builder pattern
inc(String, Double) - Static method in class com.datastax.astra.client.collections.commands.Updates
include(String...) - Static method in class com.datastax.astra.client.core.query.Projection
Include a field in the result.
includeSimilarity() - Method in class com.datastax.astra.client.collections.commands.cursor.CollectionFindAndRerankCursor
Creates a new CollectionFindAndRerankCursor that includes similarity scores in the results.
includeSimilarity() - Method in class com.datastax.astra.client.collections.commands.cursor.CollectionFindCursor
Creates a new CollectionFindCursor that includes similarity scores in the results.
includeSimilarity() - Method in class com.datastax.astra.client.tables.cursor.TableFindCursor
Creates a new TableFindCursor that includes similarity scores in the results.
includeSortVector() - Method in class com.datastax.astra.client.collections.commands.cursor.CollectionFindAndRerankCursor
Creates a new CollectionFindAndRerankCursor that includes sort vector metadata in the results.
includeSortVector() - Method in class com.datastax.astra.client.collections.commands.cursor.CollectionFindCursor
Creates a new CollectionFindCursor that includes sort vector metadata in the results.
includeSortVector() - Method in class com.datastax.astra.client.tables.cursor.TableFindCursor
Creates a new TableFindCursor that includes sort vector metadata in the results.
indexingAllow(String...) - Method in class com.datastax.astra.client.collections.definition.CollectionDefinition
Builder pattern.
indexingDeny(String...) - Method in class com.datastax.astra.client.collections.definition.CollectionDefinition
Builder pattern.
IndexingOptions() - Constructor for class com.datastax.astra.client.collections.definition.CollectionDefinition.IndexingOptions
Default constructor.
indexType - Variable in class com.datastax.astra.client.tables.definition.indexes.TableIndexDescriptor
The type of index (vector, regular)
INET - Enum constant in enum class com.datastax.astra.client.tables.definition.columns.ColumnTypes
IP address type.
insertMany(List<? extends T>) - Method in class com.datastax.astra.client.collections.Collection
Inserts a batch of documents into the collection using default insertion options.
insertMany(List<? extends T>) - Method in class com.datastax.astra.client.tables.Table
Inserts multiple rows into the table.
insertMany(List<? extends T>, CollectionInsertManyOptions) - Method in class com.datastax.astra.client.collections.Collection
Inserts a batch of documents into the collection concurrently, optimizing the insertion process for large datasets.
insertMany(List<? extends T>, TableInsertManyOptions) - Method in class com.datastax.astra.client.tables.Table
Inserts multiple rows into the table with the specified options.
insertMany(T...) - Method in class com.datastax.astra.client.collections.Collection
Inserts a batch of documents into the collection using default insertion options.
insertMany(T...) - Method in class com.datastax.astra.client.tables.Table
Inserts multiple rows into the table.
insertManyAsync(List<? extends T>) - Method in class com.datastax.astra.client.collections.Collection
Asynchronously inserts a batch of documents into the collection using default insertion options.
insertManyAsync(List<? extends T>, CollectionInsertManyOptions) - Method in class com.datastax.astra.client.collections.Collection
Asynchronously inserts a batch of documents into the collection with customizable insertion options.
insertOne(T) - Method in class com.datastax.astra.client.collections.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) - Method in class com.datastax.astra.client.tables.Table
Inserts a single row into the table.
insertOne(T, CollectionInsertOneOptions) - Method in class com.datastax.astra.client.collections.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, TableInsertOneOptions) - Method in class com.datastax.astra.client.tables.Table
Inserts a single row into the table with the specified options.
insertOneAsync(T) - Method in class com.datastax.astra.client.collections.Collection
Asynchronously inserts a single document into the collection.
insertOneAsync(T, CollectionInsertOneOptions) - Method in class com.datastax.astra.client.collections.Collection
Installation - Search tag in Overview
Section
INT - Enum constant in enum class com.datastax.astra.client.tables.definition.columns.ColumnTypes
32-bit signed integer.
INVALID_ANNOTATION - Enum constant in enum class com.datastax.astra.client.exceptions.ErrorCodesClient
Indicates that an annotation on a bean is invalid.
INVALID_EXPRESSION - Enum constant in enum class com.datastax.astra.client.exceptions.ErrorCodesClient
Indicates a field name was invalid and cannot be escaped Dynamic placeholders: '%s': The value for the field to escape
INVALID_VALUE - Enum constant in enum class com.datastax.astra.client.exceptions.ErrorCodesClient
Indicates that a field value is invalid.
InvalidConfigurationException - Exception Class in com.datastax.astra.client.exceptions
Exception thrown when the configuration is invalid.
InvalidConfigurationException(ErrorCodesClient, Object...) - Constructor for exception class com.datastax.astra.client.exceptions.InvalidConfigurationException
Constructor with code and message
InvalidEnvironmentException - Exception Class in com.datastax.astra.client.exceptions
Exception thrown when the environment is invalid.
InvalidEnvironmentException(ErrorCodesClient, String) - Constructor for exception class com.datastax.astra.client.exceptions.InvalidEnvironmentException
Constructor with code and message
InvalidFieldExpressionException - Exception Class in com.datastax.astra.client.exceptions
Error raised during escaping or unescaping a field path.
InvalidFieldExpressionException(ErrorCodesClient, String) - Constructor for exception class com.datastax.astra.client.exceptions.InvalidFieldExpressionException
Constructor with code and message
isAnArrayContaining(V...) - Method in class com.datastax.astra.client.core.query.FilterBuilder
$eq: [ ... ]
isAnArrayExactlyEqualsTo(Object[]) - Method in class com.datastax.astra.client.core.query.FilterBuilder
$all: [ ... ]
isAstra() - Method in class com.datastax.astra.client.core.options.DataAPIClientOptions
Check if the deploying is Astra
isEmpty() - Method in class com.datastax.astra.client.core.paging.Page
Express if results is empty.
isEnabled() - Method in class com.datastax.astra.client.core.lexical.LexicalOptions
Gets enabled
isEnabled() - Method in class com.datastax.astra.client.core.rerank.CollectionRerankOptions
Gets enabled
isEncodeDataApiVectorsAsBase64() - Method in class com.datastax.astra.client.core.options.SerdesOptions
Gets encodeDataApiVectorsAsBase64
isEncodeDurationAsISO8601() - Method in class com.datastax.astra.client.core.options.SerdesOptions
Gets encodeDurationAsISO8601
isEqualsTo(Object) - Method in class com.datastax.astra.client.core.query.FilterBuilder
"fieldName": "value" ($eq is omitted)
isEqualsToExplicit(Object) - Method in class com.datastax.astra.client.core.query.FilterBuilder
"fieldName": "value" ($eq is omitted)
isGreaterOrEqualsThan(Object) - Method in class com.datastax.astra.client.core.query.FilterBuilder
Add condition is greater than.
isGreaterThan(Object) - Method in class com.datastax.astra.client.core.query.FilterBuilder
Add condition is less than.
isIfExists() - Method in class com.datastax.astra.client.databases.commands.options.DropKeyspaceOptions
Accessor for serialization.
isIfExists() - Method in class com.datastax.astra.client.tables.commands.options.AlterTableOptions
Retrieves the value of the "IF EXISTS" condition.
isIfExists() - Method in class com.datastax.astra.client.tables.commands.options.DropTableIndexOptions
Accessor for serialization.
isIfExists() - Method in class com.datastax.astra.client.tables.commands.options.DropTableOptions
Accessor for serialization.
isIfNotExists() - Method in class com.datastax.astra.client.databases.commands.options.CreateKeyspaceOptions
Gets ifNotExists
isIfNotExists() - Method in class com.datastax.astra.client.tables.commands.options.CreateIndexOptions
Accessor for serialization.
isIfNotExists() - Method in class com.datastax.astra.client.tables.commands.options.CreateTableOptions
Accessor for serialization.
isIfNotExists() - Method in class com.datastax.astra.client.tables.commands.options.CreateTextIndexOptions
Accessor for serialization.
isIfNotExists() - Method in class com.datastax.astra.client.tables.commands.options.CreateVectorIndexOptions
Accessor for serialization.
isInArray(V[]) - Method in class com.datastax.astra.client.core.query.FilterBuilder
$in: [ ... ]
isLessOrEqualsThan(Object) - Method in class com.datastax.astra.client.core.query.FilterBuilder
Add condition is less than.
isLessThan(Object) - Method in class com.datastax.astra.client.core.query.FilterBuilder
Add condition is less than.
isNotEqualsTo(Object) - Method in class com.datastax.astra.client.core.query.FilterBuilder
Add condition is not equals to.
isNotInArray(V[]) - Method in class com.datastax.astra.client.core.query.FilterBuilder
$in: [ ... ]
isOrdered() - Method in class com.datastax.astra.client.collections.commands.options.CollectionInsertManyOptions
Gets ordered
isReturnDocumentResponses() - Method in class com.datastax.astra.client.collections.commands.options.CollectionInsertManyOptions
Gets returnDocumentResponses
isTrue(boolean, String) - Static method in class com.datastax.astra.internal.utils.Assert
Check condition at start.
isUpdateDBKeyspace() - Method in class com.datastax.astra.client.databases.commands.options.CreateKeyspaceOptions
Gets updateDBKeyspace
iterator() - Method in class com.datastax.astra.internal.command.AbstractCursor
Iterate over the cursor.

K

key() - Element in annotation interface com.datastax.astra.client.tables.mapping.KeyValue
Key.
Key Features: - Search tag in class com.datastax.astra.client.databases.DatabaseOptions
Section
KEYS - Enum constant in enum class com.datastax.astra.client.tables.definition.indexes.TableIndexMapTypes
Index on map Keys
KEYSPACE_ADMIN - Enum constant in enum class com.datastax.astra.client.core.commands.CommandType
Keyspace admin operation (create, delete, list)
keyspaceAdminTimeout(Duration) - Method in class com.datastax.astra.client.core.options.TimeoutOptions
Sets the timeout for keyspace administration operations.
KeyspaceDefinition - Class in com.datastax.astra.client.databases.definition.keyspaces
Keyspace definition.
KeyspaceDefinition() - Constructor for class com.datastax.astra.client.databases.definition.keyspaces.KeyspaceDefinition
Default constructor
keyspaceExists(String) - Method in interface com.datastax.astra.client.admin.DatabaseAdmin
Evaluate if a keyspace exists.
KeyspaceInformation - Class in com.datastax.astra.client.databases.definition.keyspaces
Represents the keyspace definition with its name and metadata.
KeyspaceInformation() - Constructor for class com.datastax.astra.client.databases.definition.keyspaces.KeyspaceInformation
The options of the namespace.
KeyspaceInformation(String) - Constructor for class com.datastax.astra.client.databases.definition.keyspaces.KeyspaceInformation
Default Constructor.
KeyspaceOptions - Class in com.datastax.astra.client.databases.definition.keyspaces
Options to create a Namespace.
KeyspaceOptions() - Constructor for class com.datastax.astra.client.databases.definition.keyspaces.KeyspaceOptions
Default Constructor.
KeyspaceReplicationStrategy - Enum Class in com.datastax.astra.client.databases.definition.keyspaces
Available Keyspace replication strategy.
keyType() - Element in annotation interface com.datastax.astra.client.tables.mapping.Column
Specifies the key type of the column, typically used for mapping keys in key-value pairs.
KeyValue - Annotation Interface in com.datastax.astra.client.tables.mapping
Key value annotation.
KEYWORD - Enum constant in enum class com.datastax.astra.client.core.lexical.AnalyzerTypes
Filters StandardTokenizer output that divides text into terms on word boundaries and then uses the LowerCaseFilter.

L

LESS_THAN - Enum constant in enum class com.datastax.astra.client.core.query.FilterOperator
Less Than.
LESS_THAN_OR_EQUALS_TO - Enum constant in enum class com.datastax.astra.client.core.query.FilterOperator
Less Than Or Equal To.
LETTER - Enum constant in enum class com.datastax.astra.client.core.lexical.AnalyzerTypes
Filters StandardTokenizer output that divides text into terms on word boundaries and then uses the LowerCaseFilter.
lexical(Analyzer) - Method in class com.datastax.astra.client.collections.definition.CollectionDefinition
Builder pattern.
lexical(AnalyzerTypes) - Method in class com.datastax.astra.client.collections.definition.CollectionDefinition
Builder pattern.
lexical(Lexical) - Method in class com.datastax.astra.client.core.hybrid.Hybrid
Add a lexical field.
lexical(LexicalOptions) - Method in class com.datastax.astra.client.collections.definition.CollectionDefinition
Builder pattern.
lexical(Integer) - Method in class com.datastax.astra.client.core.hybrid.HybridLimits
Add a limit for the lexical data.
lexical(String) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Add a vectorize attribute to the document.
lexical(String) - Method in class com.datastax.astra.client.core.hybrid.Hybrid
Add a lexical field.
Lexical - Class in com.datastax.astra.client.core.lexical
Lexical data.
Lexical(String) - Constructor for class com.datastax.astra.client.core.lexical.Lexical
Default constructor.
LEXICAL - Enum constant in enum class com.datastax.astra.client.core.DataAPIKeywords
LEXICAL.
LexicalFilter() - Constructor for class com.datastax.astra.client.core.lexical.Analyzer.LexicalFilter
Default constructor.
LexicalFilters - Enum Class in com.datastax.astra.client.core.lexical
Lexical filters used for indexing and searching 'lexical' data.
LexicalOptions - Class in com.datastax.astra.client.core.lexical
Subclass representing the vector options.
LexicalOptions() - Constructor for class com.datastax.astra.client.core.lexical.LexicalOptions
Default constructor.
LexicalSerializer - Class in com.datastax.astra.internal.serdes.core
Serializer for Vectorize
LexicalSerializer() - Constructor for class com.datastax.astra.internal.serdes.core.LexicalSerializer
Default constructor
limit(int) - Method in class com.datastax.astra.client.collections.commands.cursor.CollectionFindAndRerankCursor
Creates a new CollectionFindAndRerankCursor with a specified limit on the number of results.
limit(int) - Method in class com.datastax.astra.client.collections.commands.cursor.CollectionFindCursor
Creates a new CollectionFindCursor with a specified limit on the number of results.
limit(int) - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindAndRerankOptions
Add a limit clause in the find block
limit(int) - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindOptions
Add a limit clause in the find block
limit(int) - Method in class com.datastax.astra.client.tables.commands.options.TableFindOptions
Add a limit clause in the find block
limit(int) - Method in class com.datastax.astra.client.tables.cursor.TableFindCursor
Creates a new TableFindCursor with a specified limit on the number of results.
LIST - Enum constant in enum class com.datastax.astra.client.tables.definition.columns.ColumnTypes
List collection type.
listCollectionNames() - Method in class com.datastax.astra.client.databases.Database
Retrieves the names of all the collections present in this database.
listCollectionNames(ListCollectionOptions) - Method in class com.datastax.astra.client.databases.Database
Retrieves the names of all the collections present in this database, with the ability to customize the listing behavior using the specified ListCollectionOptions.
ListCollectionOptions - Class in com.datastax.astra.client.collections.commands.options
Options for the listCollection operation.
ListCollectionOptions() - Constructor for class com.datastax.astra.client.collections.commands.options.ListCollectionOptions
Default constructor.
listCollections() - Method in class com.datastax.astra.client.databases.Database
Retrieves all collections in this database along with their definitions.
listCollections(ListCollectionOptions) - Method in class com.datastax.astra.client.databases.Database
Retrieves all collections in this database along with their definitions, customized by the specified ListCollectionOptions.
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.
listIndexes() - Method in class com.datastax.astra.client.tables.Table
Finds all the indices in the selected keyspace.
listIndexes(ListIndexesOptions) - Method in class com.datastax.astra.client.tables.Table
Finds all the indices in the selected keyspace.
listIndexesNames() - Method in class com.datastax.astra.client.tables.Table
Retrieves the names of all indices in the keyspace with default options.
listIndexesNames(ListIndexesOptions) - Method in class com.datastax.astra.client.tables.Table
Retrieves the names of all indices in the keyspace with default options.
ListIndexesOptions - Class in com.datastax.astra.client.tables.commands.options
Options to list indexes.
ListIndexesOptions() - Constructor for class com.datastax.astra.client.tables.commands.options.ListIndexesOptions
Default constructor.
listKeyspaceNames() - Method in class com.datastax.astra.client.admin.AstraDBDatabaseAdmin
Retrieves a stream of keyspaces names available in the current database.
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.
listTableNames() - Method in class com.datastax.astra.client.databases.Database
Retrieves the names of all tables in the database with default options.
listTableNames(ListTablesOptions) - Method in class com.datastax.astra.client.databases.Database
Retrieves the names of all tables in the database.
listTables() - Method in class com.datastax.astra.client.databases.Database
Retrieves the details of all tables in the database with default options.
listTables(ListTablesOptions) - Method in class com.datastax.astra.client.databases.Database
Retrieves the details of all tables in the database.
ListTablesOptions - Class in com.datastax.astra.client.tables.commands.options
Options for listing tables.
ListTablesOptions() - Constructor for class com.datastax.astra.client.tables.commands.options.ListTablesOptions
Default constructor
listVectorIndexDefinitions(String, Class<?>) - Static method in class com.datastax.astra.internal.reflection.EntityBeanDefinition
List all vector index definitions for the given table name and class.
localDbWithDefaultKeyspace() - Static method in class com.datastax.astra.client.DataAPIClients
Creates and configures a Database client specifically designed for interaction with a local instance of the Data API and Cassandra.
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.core.options.DataAPIClientOptions
Help to enable loggin requests.
LOWERCASE - Enum constant in enum class com.datastax.astra.client.core.lexical.AnalyzerTypes
Filters StandardTokenizer output that divides text into terms on word boundaries and then uses the LowerCaseFilter.
LOWERCASE - Enum constant in enum class com.datastax.astra.client.core.lexical.LexicalFilters
Filters StandardTokenizer output that divides text into terms on word boundaries and then uses the LowerCaseFilter.
lt(String, Number) - Static method in class com.datastax.astra.client.core.query.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.core.query.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.core.query.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.core.query.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.core.query.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.core.query.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.core.query.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.core.query.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.collections.definition.documents.Document
Marshall as a document if needed.
map(Class<T>) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Marshall as a row if needed.
MAP - Enum constant in enum class com.datastax.astra.client.tables.definition.columns.ColumnTypes
Map collection type, storing key-value pairs.
mapAsRow(T) - Static method in class com.datastax.astra.internal.serdes.tables.RowMapper
Map any object as a Row
mapFromRow(Row, DataAPISerializer, Class<T>) - Static method in class com.datastax.astra.internal.serdes.tables.RowMapper
Mapping a row to a bean.
mapImpl(Consumer<TableIndexDefinition<OPTIONS>>) - Method in class com.datastax.astra.client.tables.definition.indexes.TableIndexDefinition
Maps the current instance to a new instance with updated properties.
mapImpl(Consumer<TableIndexDescriptor<DEF>>) - Method in class com.datastax.astra.client.tables.definition.indexes.TableIndexDescriptor
Generic method to create a new instance with modified properties.
marshall(Object) - Method in interface com.datastax.astra.internal.serdes.DataAPISerializer
Transform object as a String.
MAX_CHUNK_SIZE - Static variable in class com.datastax.astra.client.core.options.DataAPIClientOptions
The maximum number of documents to insert in a single batch operation.
MAX_COUNT - Static variable in class com.datastax.astra.client.core.options.DataAPIClientOptions
The maximum number of documents allowed for processing before throwing an exception.
metric() - Element in annotation interface com.datastax.astra.client.tables.mapping.ColumnVector
Specifies the similarity metric for the column.
metric(SimilarityMetric) - Method in class com.datastax.astra.client.tables.definition.columns.ColumnDefinitionVector
Sets the similarity metric for vector comparison and returns the updated instance.
metric(SimilarityMetric) - Method in class com.datastax.astra.client.tables.definition.indexes.TableVectorIndexDefinition
Configures the similarity metric to be used for the vector index.
metric(SimilarityMetric) - Method in class com.datastax.astra.client.tables.definition.indexes.TableVectorIndexDefinitionOptions
Sets the similarity metric for the vector index.
min(String, Double) - Static method in class com.datastax.astra.client.collections.commands.Updates
min(String, Object) - Method in class com.datastax.astra.client.collections.commands.Update
Builder pattern
minus(TableDuration) - Method in class com.datastax.astra.client.tables.definition.TableDuration
Subtracts the specified TableDuration from this instance.
MISSING_ANNOTATION - Enum constant in enum class com.datastax.astra.client.exceptions.ErrorCodesClient
Indicates that a required annotation is missing from a bean.
MISSING_CONFIGURATION - Enum constant in enum class com.datastax.astra.client.exceptions.ErrorCodesClient
Indicates that a required configuration parameter is missing.
Model() - Constructor for class com.datastax.astra.client.core.rerank.RerankProvider.Model
Default constructor.
Model() - Constructor for class com.datastax.astra.client.core.vectorize.EmbeddingProvider.Model
Default constructor.
modelName() - Element in annotation interface com.datastax.astra.client.tables.mapping.ColumnVector
Specifies the model name for the column.
modelName(String) - Method in class com.datastax.astra.client.core.rerank.RerankServiceOptions
Sets the LLM model name.
modelName(String) - Method in class com.datastax.astra.client.core.vectorize.VectorServiceOptions
Sets the LLM model name.
multipliedBy(int) - Method in class com.datastax.astra.client.tables.definition.TableDuration
Multiplies this duration by the specified scalar value.

N

N_GRAM - Enum constant in enum class com.datastax.astra.client.core.lexical.AnalyzerTypes
Filters StandardTokenizer output that divides text into terms on word boundaries and then uses the LowerCaseFilter.
name - Variable in class com.datastax.astra.client.core.commands.Command
Command Name.
name - Variable in class com.datastax.astra.client.tables.definition.indexes.TableIndexDescriptor
The name of the table.
name() - Element in annotation interface com.datastax.astra.client.tables.mapping.Column
Specifies the name of the column.
name() - Element in annotation interface com.datastax.astra.client.tables.mapping.ColumnVector
Specifies the name of the column.
name(String) - Method in class com.datastax.astra.client.core.lexical.Analyzer.LexicalFilter
Sets the name of the filter.
name(String) - Method in class com.datastax.astra.client.databases.definition.keyspaces.KeyspaceDefinition
Name for the keyspace.
name(String) - Method in class com.datastax.astra.client.tables.definition.indexes.TableIndexDescriptor
Sets the name of the table.
name(String) - Method in class com.datastax.astra.client.tables.definition.indexes.TableRegularIndexDescriptor
 
name(String) - Method in class com.datastax.astra.client.tables.definition.indexes.TableTextIndexDescriptor
Adds a name to the index.
name(String) - Method in class com.datastax.astra.client.tables.definition.indexes.TableVectorIndexDescriptor
 
name(String) - Method in class com.datastax.astra.client.tables.definition.TableDescriptor
Set the name of the table.
ne(String, Object) - Static method in class com.datastax.astra.client.core.query.Filters
Creates a filter that matches all documents where the value of the field name does not equal the specified value.
negated() - Method in class com.datastax.astra.client.tables.definition.TableDuration
Negates this duration.
NETWORK_TOPOLOGY_STRATEGY - Enum constant in enum class com.datastax.astra.client.databases.definition.keyspaces.KeyspaceReplicationStrategy
The network topology strategy, for production environments.
networkTopologyStrategy(Map<String, Integer>) - Method in class com.datastax.astra.client.databases.definition.keyspaces.KeyspaceDefinition
Enforce the creation of a namespace with NetworkTopology strategy.
networkTopologyStrategy(Map<String, Integer>) - Static method in class com.datastax.astra.client.databases.definition.keyspaces.KeyspaceOptions
Enforce the creation of a namespace with NetworkTopology strategy.
next() - Method in class com.datastax.astra.internal.command.AbstractCursor
Retrieves the next element from the cursor.
nin(String, V...) - Static method in class com.datastax.astra.client.core.query.Filters
Creates a filter that matches all documents where the value of a field equals any value in the list of specified values.
normalize(boolean) - Method in class com.datastax.astra.client.tables.definition.indexes.TableIndexDefinitionOptions
Sets the normalization flag for the index.
normalize(boolean) - Method in class com.datastax.astra.client.tables.definition.indexes.TableRegularIndexDefinition
Enables or disables normalization for the index.
not(Filter) - Static method in class com.datastax.astra.client.core.query.Filters
Creates a filter that performs a logical NOT of the provided filter
NOT_EQUALS_TO - Enum constant in enum class com.datastax.astra.client.core.query.FilterOperator
Not Equal To.
NOT_IN - Enum constant in enum class com.datastax.astra.client.core.query.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 class com.datastax.astra.client.collections.definition.CollectionDefaultIdTypes
Represent a BSON ObjectId.
OBJECT_ID - Enum constant in enum class com.datastax.astra.client.core.DataAPIKeywords
OBJECT_ID.
ObjectId - Class in com.datastax.astra.client.collections.definition.documents.types
A globally unique identifier for objects.
ObjectId() - Constructor for class com.datastax.astra.client.collections.definition.documents.types.ObjectId
Create a new object id.
ObjectId(byte[]) - Constructor for class com.datastax.astra.client.collections.definition.documents.types.ObjectId
Constructs a new instance from the given byte array
ObjectId(String) - Constructor for class com.datastax.astra.client.collections.definition.documents.types.ObjectId
Constructs a new instance from a 24-byte hexadecimal string representation.
ObjectId(ByteBuffer) - Constructor for class com.datastax.astra.client.collections.definition.documents.types.ObjectId
Constructs a new instance from the given ByteBuffer
ObjectId(Date) - Constructor for class com.datastax.astra.client.collections.definition.documents.types.ObjectId
Constructs a new instance using the given date.
ObjectIdDeserializer - Class in com.datastax.astra.internal.serdes.collections
Custom deserializer for EJson Date type.
ObjectIdDeserializer() - Constructor for class com.datastax.astra.internal.serdes.collections.ObjectIdDeserializer
Default constructor.
ObjectIdSerializer - Class in com.datastax.astra.internal.serdes.collections
Object Id Could be objectId|uuid|uuidv6|uuidv7
ObjectIdSerializer() - Constructor for class com.datastax.astra.internal.serdes.collections.ObjectIdSerializer
Default constructor.
ObjectIdSerializer(Class<ObjectId>) - Constructor for class com.datastax.astra.internal.serdes.collections.ObjectIdSerializer
Constructor with type
of(Period, Duration) - Static method in class com.datastax.astra.client.tables.definition.TableDuration
Factory method to create a new TableDuration instance.
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.core.paging.Page
When the result is a singleton.
options - Variable in class com.datastax.astra.client.tables.definition.indexes.TableIndexDefinition
The Options for this particular index.
options - Variable in class com.datastax.astra.internal.command.AbstractCommandRunner
Default command options when not override.
options(TableIndexDefinitionOptions) - Method in class com.datastax.astra.client.tables.definition.indexes.TableRegularIndexDefinition
 
options(TableTextIndexDefinitionOptions) - Method in class com.datastax.astra.client.tables.definition.indexes.TableTextIndexDefinition
Setter for the options
options(TableVectorIndexDefinitionOptions) - Method in class com.datastax.astra.client.tables.definition.indexes.TableVectorIndexDefinition
 
options(OPTIONS) - Method in class com.datastax.astra.client.tables.definition.indexes.TableIndexDefinition
Sets the options for configuring the table index.
OPTIONS_HYBRID_LIMITS - Static variable in class com.datastax.astra.internal.command.AbstractCommandRunner
json inputs
OPTIONS_INCLUDE_SCORES - Static variable in class com.datastax.astra.internal.command.AbstractCommandRunner
json inputs
OPTIONS_INCLUDE_SIMILARITY - Static variable in class com.datastax.astra.internal.command.AbstractCommandRunner
json inputs
OPTIONS_INCLUDE_SORT_VECTOR - Static variable in class com.datastax.astra.internal.command.AbstractCommandRunner
json inputs
OPTIONS_LIMIT - Static variable in class com.datastax.astra.internal.command.AbstractCommandRunner
json inputs
OPTIONS_ORDERED - Static variable in class com.datastax.astra.internal.command.AbstractCommandRunner
json inputs
OPTIONS_PAGE_STATE - Static variable in class com.datastax.astra.internal.command.AbstractCommandRunner
json inputs
OPTIONS_RERANK_ON - Static variable in class com.datastax.astra.internal.command.AbstractCommandRunner
json inputs
OPTIONS_RERANK_QUERY - Static variable in class com.datastax.astra.internal.command.AbstractCommandRunner
json inputs
OPTIONS_RETURN_DOCUMENT - Static variable in class com.datastax.astra.internal.command.AbstractCommandRunner
json inputs
OPTIONS_RETURN_DOCUMENT_RESPONSES - Static variable in class com.datastax.astra.internal.command.AbstractCommandRunner
json inputs
OPTIONS_UPSERT - Static variable in class com.datastax.astra.internal.command.AbstractCommandRunner
json inputs
OptionsUtils - Class in com.datastax.astra.internal.utils
Reuse of treatments for options
or(Filter...) - Static method in class com.datastax.astra.client.core.query.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.core.query.Filters
Creates a filter that performs a logical OR of the provided list of filters.
order() - Element in annotation interface com.datastax.astra.client.tables.mapping.PartitionSort
Specifies the sorting order (ascending or descending) for the annotated field or method.
OTHERS - Enum constant in enum class com.datastax.astra.client.DataAPIDestination
Extra local installation .
Overview - Search tag in Overview
Section

P

Page<R> - Class in com.datastax.astra.client.core.paging
Hold results for paging
Page(String, List<R>, DataAPIVector) - Constructor for class com.datastax.astra.client.core.paging.Page
Default constructor.
Parameter() - Constructor for class com.datastax.astra.client.core.rerank.RerankProvider.Parameter
Default constructor.
Parameter() - Constructor for class com.datastax.astra.client.core.vectorize.EmbeddingProvider.Parameter
Default constructor.
parameters() - Element in annotation interface com.datastax.astra.client.tables.mapping.ColumnVector
Specifies the parameters for authentication
parameters(Map<String, Object>) - Method in class com.datastax.astra.client.core.rerank.RerankServiceOptions
Sets the parameters map.
parameters(Map<String, Object>) - Method in class com.datastax.astra.client.core.vectorize.VectorServiceOptions
Sets the parameters map.
Parameters() - Constructor for class com.datastax.astra.client.core.rerank.RerankServiceOptions.Parameters
Default constructor for serialization purposes.
Parameters() - Constructor for class com.datastax.astra.client.core.vectorize.VectorServiceOptions.Parameters
Default constructor for serialization purposes.
parse(String) - Static method in class com.datastax.astra.client.collections.definition.documents.Document
Parses a string in MongoDB Extended JSON format to a Document
parse(String) - Static method in class com.datastax.astra.client.tables.definition.rows.Row
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.
PartitionBy - Annotation Interface in com.datastax.astra.client.tables.mapping
Specifies a partition key for fields or methods.
partitionKey(String...) - Method in class com.datastax.astra.client.tables.definition.TableDefinition
Sets the partition keys for the table.
PartitionSort - Annotation Interface in com.datastax.astra.client.tables.mapping
Defines sorting behavior for partitioned fields or methods.
PASSAGE - Enum constant in enum class com.datastax.astra.client.core.DataAPIKeywords
PASSAGE.
payload - Variable in class com.datastax.astra.client.core.commands.Command
Command payload.
payload - Variable in class com.datastax.astra.internal.api.DataAPIStatus
Default properties.
plus(TableDuration) - Method in class com.datastax.astra.client.tables.definition.TableDuration
Adds the specified TableDuration to this instance.
pop(String, Object) - Method in class com.datastax.astra.client.collections.commands.Update
Builder pattern
pop(String, Object) - Static method in class com.datastax.astra.client.collections.commands.Updates
position() - Element in annotation interface com.datastax.astra.client.tables.mapping.PartitionSort
Specifies the sorting position for the annotated field or method.
project(Projection...) - Method in class com.datastax.astra.client.collections.commands.cursor.CollectionFindAndRerankCursor
Creates a new CollectionFindAndRerankCursor with an updated projection.
project(Projection...) - Method in class com.datastax.astra.client.collections.commands.cursor.CollectionFindCursor
Creates a new CollectionFindCursor with an updated projection.
project(Projection...) - Method in class com.datastax.astra.client.tables.cursor.TableFindCursor
Creates a new TableFindCursor with an updated projection.
projection(Projection...) - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindAndRerankOptions
Adding this on top of projection(Projection[] p) to allow for a more fluent API.
projection(Projection...) - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindOneAndDeleteOptions
Adding this on top of projection(Projection[] p) to allow for a more fluent API.
projection(Projection...) - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindOneAndReplaceOptions
Adding this on top of projection(Projection[] p) to allow for a more fluent API.
projection(Projection...) - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindOneAndUpdateOptions
Adding this on top of projection(Projection[] p) to allow for a more fluent API.
projection(Projection...) - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindOneOptions
Adding this on top of projection(Projection[] p) to allow for a more fluent API.
projection(Projection...) - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindOptions
Adding this on top of projection(Projection[] p) to allow for a more fluent API.
projection(Projection...) - Method in class com.datastax.astra.client.tables.commands.options.TableFindOneOptions
Adding this on top of sort(Sort[] s) to allow for a more fluent API.
projection(Projection...) - Method in class com.datastax.astra.client.tables.commands.options.TableFindOptions
Adding this on top of sort(Sort[] s) to allow for a more fluent API.
projection(Projection...) - Static method in class com.datastax.astra.internal.utils.OptionsUtils
Fluent api.
Projection - Class in com.datastax.astra.client.core.query
Encode the presence of a field in the result.
Projection(String, boolean) - Constructor for class com.datastax.astra.client.core.query.Projection
Default constructor.
Projection(String, Boolean, Integer, Integer) - Constructor for class com.datastax.astra.client.core.query.Projection
Default constructor.
provider() - Element in annotation interface com.datastax.astra.client.tables.mapping.ColumnVector
Specifies the provider for the column.
provider(String) - Method in class com.datastax.astra.client.core.rerank.RerankServiceOptions
Sets the LLM provider.
provider(String) - Method in class com.datastax.astra.client.core.vectorize.VectorServiceOptions
Sets the LLM provider.
push(String, Object) - Method in class com.datastax.astra.client.collections.commands.Update
Builder pattern
push(String, Object) - Static method in class com.datastax.astra.client.collections.commands.Updates
pushEach(String, List<Object>, Integer) - Method in class com.datastax.astra.client.collections.commands.Update
Builder pattern.
pushEach(String, List<Object>, Integer) - Static method in class com.datastax.astra.client.collections.commands.Updates
put(String[], Object) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Associates the specified value with the specified key in the document.
put(String, Object) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Associates the specified value with the specified key in the document.
put(String, Object) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Add a key/value pair to the document.
putAll(Map<? extends String, ?>) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Copies all mappings from the specified map to this document.
putAll(Map<? extends String, ?>) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Add all information from the map.
putToByteBuffer(ByteBuffer) - Method in class com.datastax.astra.client.collections.definition.documents.types.ObjectId
Convert to bytes and put those bytes to the provided ByteBuffer.

Q

QuickStart - Search tag in Overview
Section

R

recordType - Variable in class com.datastax.astra.internal.command.AbstractCursor
Type of the row to return
registerListener(String, CommandObserver) - Method in class com.datastax.astra.client.tables.Table
Register a listener to execute commands on the table.
registerObserver(String, CommandObserver) - Method in class com.datastax.astra.client.core.options.BaseOptions
Allow to register a listener for the command.
remove(String) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Removes the mapping for a key from the document if it is present.
remove(String) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Removes the mapping for a key from the row if it is present.
rename(String, Object) - Method in class com.datastax.astra.client.collections.commands.Update
Builder pattern
rename(String, String) - Static method in class com.datastax.astra.client.collections.commands.Updates
replaceOne(Filter, T) - Method in class com.datastax.astra.client.collections.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, CollectionReplaceOneOptions) - Method in class com.datastax.astra.client.collections.Collection
Replace a document in the collection according to the specified arguments.
requestTimeout(long) - Method in class com.datastax.astra.client.collections.commands.options.CollectionInsertManyOptions
Specialization of the timeout options for this command.
requestTimeout(Duration) - Method in class com.datastax.astra.client.core.options.TimeoutOptions
Sets the request timeout.
required(boolean) - Method in class com.datastax.astra.client.core.rerank.RerankServiceOptions.Parameters
Sets whether this parameter is required.
required(boolean) - Method in class com.datastax.astra.client.core.vectorize.VectorServiceOptions.Parameters
Sets whether this parameter is required.
rerank(CollectionRerankOptions) - Method in class com.datastax.astra.client.collections.definition.CollectionDefinition
Builder pattern.
rerank(String, String) - Method in class com.datastax.astra.client.collections.definition.CollectionDefinition
Builder pattern.
RERANK - Enum constant in enum class com.datastax.astra.client.core.DataAPIKeywords
PASSAGE.
rerankAPIKey(String) - Method in class com.datastax.astra.client.core.options.DataAPIClientOptions
Builder pattern, update http connection Timeout
RerankedResult<DOC> - Class in com.datastax.astra.client.core.rerank
Wrapper for the rerank result.
RerankedResult(DOC, Map<String, Double>) - Constructor for class com.datastax.astra.client.core.rerank.RerankedResult
Constructor.
rerankingApiKey(String) - Method in class com.datastax.astra.client.core.options.BaseOptions
Provide the reranking service API key.
RerankingAPIKeyHeaderProvider - Class in com.datastax.astra.client.core.headers
Default header when working with an embedding service provider.
RerankingAPIKeyHeaderProvider(String) - Constructor for class com.datastax.astra.client.core.headers.RerankingAPIKeyHeaderProvider
Constructor.
rerankingAuthProvider(RerankingHeadersProvider) - Method in class com.datastax.astra.client.core.options.BaseOptions
Provide the reranking service API key.
RerankingHeadersProvider - Interface in com.datastax.astra.client.core.headers
To use the interface embeddings API the user needs to be authenticated against the embedding provider
rerankOn(String) - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindAndRerankOptions
Add a rerankOn clause in the find block
RerankProvider - Class in com.datastax.astra.client.core.rerank
Class representing the Embedding Provider returned by findEmbeddingProviders command.
RerankProvider() - Constructor for class com.datastax.astra.client.core.rerank.RerankProvider
Default constructor.
RerankProvider.AuthenticationMethod - Class in com.datastax.astra.client.core.rerank
Authentication method.
RerankProvider.Model - Class in com.datastax.astra.client.core.rerank
Model for the service.
RerankProvider.Parameter - Class in com.datastax.astra.client.core.rerank
Parameters for the service.
RerankProvider.Token - Class in com.datastax.astra.client.core.rerank
Token method.
RerankProvider.Validation - Class in com.datastax.astra.client.core.rerank
Validation Component for the parameter.
RerankProviderTypes - Enum Class in com.datastax.astra.client.core.rerank
Rerank provider types.
rerankQuery(String) - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindAndRerankOptions
Add a rerankQuery clause in the find block
RerankServiceOptions - Class in com.datastax.astra.client.core.rerank
Options for the Rerank service at collection/table creation.
RerankServiceOptions() - Constructor for class com.datastax.astra.client.core.rerank.RerankServiceOptions
Default constructor for serialization purposes.
RerankServiceOptions.Parameters - Class in com.datastax.astra.client.core.rerank
Represents a parameter definition for LLM services.
RESULT_COUNT - Static variable in class com.datastax.astra.internal.command.AbstractCommandRunner
parsing output json
RESULT_DELETED_COUNT - Static variable in class com.datastax.astra.internal.command.AbstractCommandRunner
parsing output json
RESULT_INSERTED_IDS - Static variable in class com.datastax.astra.internal.command.AbstractCommandRunner
parameters names.
RESULT_MATCHED_COUNT - Static variable in class com.datastax.astra.internal.command.AbstractCommandRunner
parsing output json
RESULT_MODIFIED_COUNT - Static variable in class com.datastax.astra.internal.command.AbstractCommandRunner
parsing output json
RESULT_MORE_DATA - Static variable in class com.datastax.astra.internal.command.AbstractCommandRunner
parsing output json
RESULT_UPSERTED_ID - Static variable in class com.datastax.astra.internal.command.AbstractCommandRunner
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(HttpClientOptions, TimeoutOptions) - Constructor for class com.datastax.astra.internal.http.RetryHttpClient
Initialize the instance with all items
returnDocument(ReturnDocument) - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindOneAndReplaceOptions
Adding this on top of projection(Projection[] p) to allow for a more fluent API.
returnDocument(ReturnDocument) - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindOneAndUpdateOptions
Adding this on top of projection(Projection[] p) to allow for a more fluent API.
ReturnDocument - Enum Class in com.datastax.astra.client.collections.commands
Enum to define the return document option.
rewind() - Method in class com.datastax.astra.internal.command.AbstractCursor
Rewind the cursor to the beginning.
Row - Class in com.datastax.astra.client.tables.definition.rows
Record present in a Cassandra Table.
Row() - Constructor for class com.datastax.astra.client.tables.definition.rows.Row
Default Constructor.
Row(Map<String, ?>) - Constructor for class com.datastax.astra.client.tables.definition.rows.Row
Creates a Document instance initialized with the given map.
rowClass - Variable in class com.datastax.astra.client.tables.Table
Working class representing rows of the table.
RowMapper - Class in com.datastax.astra.internal.serdes.tables
Pivot class to interact with Table is a Row.
RowSerializer - Class in com.datastax.astra.internal.serdes.tables
Custom implementation of serialization : faster + no jackson dependency
RowSerializer() - Constructor for class com.datastax.astra.internal.serdes.tables.RowSerializer
Default constructor
runCommand(Command) - Method in interface com.datastax.astra.client.core.commands.CommandRunner
Command to return the payload as a Map.
runCommand(Command, BaseOptions<?>) - Method in interface com.datastax.astra.client.core.commands.CommandRunner
Command to return the payload as a Map.
runCommand(Command, BaseOptions<?>) - Method in class com.datastax.astra.internal.command.AbstractCommandRunner
Command to return the payload as a Map.
runCommand(Command, BaseOptions<?>, Class<DOC>) - Method in class com.datastax.astra.internal.command.AbstractCommandRunner
Extension point to run any command with typing constraints.
runCommand(Command, BaseOptions<?>, Class<T>) - Method in interface com.datastax.astra.client.core.commands.CommandRunner
Extension point to run any command with typing constraints.
runCommand(Command, Class<T>) - Method in interface com.datastax.astra.client.core.commands.CommandRunner
Extension point to run any command with typing constraints.

S

SerdesOptions - Class in com.datastax.astra.client.core.options
Options for serialization and deserialization.
SerdesOptions() - Constructor for class com.datastax.astra.client.core.options.SerdesOptions
Default constructor.
SERIALIZATION_ERROR - Enum constant in enum class com.datastax.astra.client.exceptions.ErrorCodesClient
Indicates an error in client-side serialization.
serialize(byte[], JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.serdes.tables.ByteArraySerializer
Serializes a byte array as a Base64-encoded string wrapped in a JSON object.
serialize(CollectionDefaultIdTypes, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.serdes.collections.CollectionDefaultIdTypeSerializer
serialize(ObjectId, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.serdes.collections.ObjectIdSerializer
serialize(UUIDv6, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.serdes.collections.UUID6Serializer
serialize(UUIDv7, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.serdes.collections.UUID7Serializer
serialize(Command, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.client.core.commands.Command.CommandSerializer
serialize(HybridLimits, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.serdes.collections.HybridLimitsSerializer
serialize(Hybrid, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.serdes.core.HybridSerializer
 
serialize(Analyzer, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.serdes.core.AnalyzerSerializer
 
serialize(Lexical, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.serdes.core.LexicalSerializer
 
serialize(DataAPIVector, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.serdes.shared.DataAPIVectorSerializer
serialize(SimilarityMetric, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.serdes.shared.SimilarityMetricSerializer
serialize(Vectorize, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.serdes.core.VectorizeSerializer
 
serialize(ColumnTypes, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.serdes.tables.ColumnTypeSerializer
serialize(TableIndexColumnDefinition, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.serdes.tables.TableIndexColumnDefinitionSerializer
serialize(TableDuration, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.serdes.tables.TableDurationSerializer
serialize(Double, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.serdes.tables.DoubleSerializer
Serializes a Double value into JSON.
serialize(Float, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.serdes.tables.FloatSerializer
Serializes a Float value into JSON.
serialize(Duration, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.serdes.tables.DurationSerializer
Serializes a Duration object into JSON.
serialize(Instant, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.serdes.collections.EJsonInstantSerializer
serialize(Calendar, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.serdes.collections.EJsonCalendarSerializer
serialize(Date, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.serdes.collections.EJsonDateSerializer
serialize(UUID, JsonGenerator, SerializerProvider) - Method in class com.datastax.astra.internal.serdes.collections.UUIDSerializer
serializer - Variable in class com.datastax.astra.client.core.options.BaseOptions
Serializer for the command.
serializer(DataAPISerializer) - Method in class com.datastax.astra.client.core.options.BaseOptions
Provide the token.
SERIALIZER - Static variable in class com.datastax.astra.client.admin.DataAPIDatabaseAdmin
Serializer.
SERIALIZER - Static variable in class com.datastax.astra.client.collections.definition.documents.Document
Serializer
SERIALIZER - Static variable in class com.datastax.astra.client.tables.definition.rows.Row
Serializer for the Rows.
service(VectorServiceOptions) - Method in class com.datastax.astra.client.tables.definition.columns.ColumnDefinitionVector
Sets the vectorization service options and returns the updated instance.
set(Document) - Method in class com.datastax.astra.client.collections.commands.Update
Builder pattern
set(Row) - Method in class com.datastax.astra.client.tables.commands.TableUpdateOperation
Set all elements of a row
set(String, Object) - Method in class com.datastax.astra.client.collections.commands.Update
Builder pattern
set(String, Object) - Static method in class com.datastax.astra.client.collections.commands.Updates
set(String, Object) - Method in class com.datastax.astra.client.tables.commands.TableUpdateOperation
Builder pattern, set a field value
SET - Enum constant in enum class com.datastax.astra.client.tables.definition.columns.ColumnTypes
Set collection type, storing unique elements.
SET_PASSAGE - Enum constant in enum class com.datastax.astra.client.core.DataAPIKeywords
SET_PASSAGE.
setProperty(String, Object) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Setter for a property in the document map
setProperty(String, Object) - Method in class com.datastax.astra.client.tables.definition.rows.Row
Set a property in the row.
setProperty(String, Object) - Method in class com.datastax.astra.internal.api.DataAPIStatus
Add a property to the payload.
SIMILARITY - Enum constant in enum class com.datastax.astra.client.core.DataAPIKeywords
SIMILARITY.
SimilarityMetric - Enum Class in com.datastax.astra.client.core.vector
Similarity metric.
SimilarityMetricDeserializer - Class in com.datastax.astra.internal.serdes.shared
Custom deserializer for EJson Date type.
SimilarityMetricDeserializer() - Constructor for class com.datastax.astra.internal.serdes.shared.SimilarityMetricDeserializer
Default constructor.
SimilarityMetricSerializer - Class in com.datastax.astra.internal.serdes.shared
Object Id Could be objectId|uuid|uuidv6|uuidv7
SimilarityMetricSerializer() - Constructor for class com.datastax.astra.internal.serdes.shared.SimilarityMetricSerializer
Default constructor.
SimilarityMetricSerializer(Class<SimilarityMetric>) - Constructor for class com.datastax.astra.internal.serdes.shared.SimilarityMetricSerializer
Constructor with type
SIMPLE_STRATEGY - Enum constant in enum class com.datastax.astra.client.databases.definition.keyspaces.KeyspaceReplicationStrategy
The simple strategy, for development environments.
simpleStrategy(int) - Method in class com.datastax.astra.client.databases.definition.keyspaces.KeyspaceDefinition
Enforce the creation of a namespace with SimpleStrategy.
simpleStrategy(int) - Static method in class com.datastax.astra.client.databases.definition.keyspaces.KeyspaceOptions
Enforce the creation of a namespace with SimpleStrategy.
SIZE - Enum constant in enum class com.datastax.astra.client.core.DataAPIKeywords
SIZE.
skip(int) - Method in class com.datastax.astra.client.collections.commands.cursor.CollectionFindCursor
Creates a new CollectionFindCursor that skips a specified number of results.
skip(int) - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindOptions
Add a skip clause in the find block
skip(int) - Method in class com.datastax.astra.client.tables.commands.options.TableFindOptions
Add a skip clause in the find block
skip(int) - Method in class com.datastax.astra.client.tables.cursor.TableFindCursor
Creates a new TableFindCursor that skips a specified number of results.
slice(String, Integer, Integer) - Static method in class com.datastax.astra.client.core.query.Projection
Specifies the number of elements in an array to return in the query result.
SLICE - Enum constant in enum class com.datastax.astra.client.core.DataAPIKeywords
SIMILARITY.
SMALLINT - Enum constant in enum class com.datastax.astra.client.tables.definition.columns.ColumnTypes
16-bit signed integer.
sort(Sort...) - Method in class com.datastax.astra.client.collections.commands.cursor.CollectionFindAndRerankCursor
Creates a new CollectionFindAndRerankCursor with a specified sort order.
sort(Sort...) - Method in class com.datastax.astra.client.collections.commands.cursor.CollectionFindCursor
Creates a new CollectionFindCursor with a specified sort order.
sort(Sort...) - Method in class com.datastax.astra.client.collections.commands.options.CollectionDeleteOneOptions
Adding this on top of sort(Sort[] s) to allow for a more fluent API.
sort(Sort...) - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindAndRerankOptions
Adding this on top of sort(Sort[] s) to allow for a more fluent API.
sort(Sort...) - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindOneAndDeleteOptions
Adding this on top of sort(Sort[] s) to allow for a more fluent API.
sort(Sort...) - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindOneAndReplaceOptions
Adding this on top of sort(Sort[] s) to allow for a more fluent API.
sort(Sort...) - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindOneAndUpdateOptions
Adding this on top of sort(Sort[] s) to allow for a more fluent API.
sort(Sort...) - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindOneOptions
Adding this on top of sort(Sort[] s) to allow for a more fluent API.
sort(Sort...) - Method in class com.datastax.astra.client.collections.commands.options.CollectionFindOptions
Adding this on top of sort(Sort[] s) to allow for a more fluent API.
sort(Sort...) - Method in class com.datastax.astra.client.collections.commands.options.CollectionUpdateOneOptions
Adding this on top of sort(Sort[] s) to allow for a more fluent API.
sort(Sort...) - Method in class com.datastax.astra.client.tables.commands.options.TableFindOneOptions
Adding this on top of sort(Sort[] s) to allow for a more fluent API.
sort(Sort...) - Method in class com.datastax.astra.client.tables.commands.options.TableFindOptions
Adding this on top of sort(Sort[] s) to allow for a more fluent API.
sort(Sort...) - Method in class com.datastax.astra.client.tables.cursor.TableFindCursor
Creates a new TableFindCursor with a specified sort order.
sort(Sort...) - Static method in class com.datastax.astra.internal.utils.OptionsUtils
Fluent api.
Sort - Class in com.datastax.astra.client.core.query
Class to help building a projection.
SORT_VECTOR - Enum constant in enum class com.datastax.astra.client.core.DataAPIKeywords
SORT VECTOR.
SortOrder - Enum Class in com.datastax.astra.client.core.query
Encode the sort order in results.
sortVector - Variable in class com.datastax.astra.client.core.paging.Page
Sort vector retrieved in the status.
SOURCE_MODEL_ADA002 - Static variable in class com.datastax.astra.client.tables.definition.indexes.TableVectorIndexDefinition
Initial source model.
SOURCE_MODEL_BERT - Static variable in class com.datastax.astra.client.tables.definition.indexes.TableVectorIndexDefinition
Initial source model.
SOURCE_MODEL_COHERE_V3 - Static variable in class com.datastax.astra.client.tables.definition.indexes.TableVectorIndexDefinition
Initial source model.
SOURCE_MODEL_GECKO - Static variable in class com.datastax.astra.client.tables.definition.indexes.TableVectorIndexDefinition
Initial source model.
SOURCE_MODEL_NV_QA_4 - Static variable in class com.datastax.astra.client.tables.definition.indexes.TableVectorIndexDefinition
Initial source model.
SOURCE_MODEL_OPENAI_V3_LARGE - Static variable in class com.datastax.astra.client.tables.definition.indexes.TableVectorIndexDefinition
Initial source model.
SOURCE_MODEL_OPENAI_V3_SMALL - Static variable in class com.datastax.astra.client.tables.definition.indexes.TableVectorIndexDefinition
Initial source model.
sourceModel() - Element in annotation interface com.datastax.astra.client.tables.mapping.ColumnVector
Specifies source model for the column.
sourceModel(String) - Method in class com.datastax.astra.client.tables.definition.indexes.TableVectorIndexDefinition
Sets the source model for the vector index.
sourceModel(String) - Method in class com.datastax.astra.client.tables.definition.indexes.TableVectorIndexDefinitionOptions
Sets the source model for the vector index.
STANDARD - Enum constant in enum class com.datastax.astra.client.core.lexical.AnalyzerTypes
Filters StandardTokenizer output that divides text into terms on word boundaries and then uses the LowerCaseFilter.
STARTED - Enum constant in enum class com.datastax.astra.client.core.paging.CursorState
Indicates that the cursor has been started and is active.
state - Variable in class com.datastax.astra.internal.command.AbstractCursor
Cursor state.
state - Variable in exception class com.datastax.astra.internal.command.CursorError
The state of the cursor when the error occurred.
StaticTokenProvider - Class in com.datastax.astra.client.core.auth
Static token, never expires..
StaticTokenProvider(String) - Constructor for class com.datastax.astra.client.core.auth.StaticTokenProvider
Constructor with all parameters.
STOP - Enum constant in enum class com.datastax.astra.client.core.lexical.LexicalFilters
Filter with stop words
stream() - Method in class com.datastax.astra.internal.command.AbstractCursor
Convert the current cursor as a stream
subtractFrom(Temporal) - Method in class com.datastax.astra.client.tables.definition.TableDuration
SYNONYM - Enum constant in enum class com.datastax.astra.client.core.lexical.LexicalFilters
Filter with synonyms
SYNONYM_GRAPH - Enum constant in enum class com.datastax.astra.client.core.lexical.LexicalFilters
Filter with synonyms and graph

T

Table<T> - Class in com.datastax.astra.client.tables
Executes commands and operations on tables.
Table(Database, String, TableOptions, Class<T>) - Constructor for class com.datastax.astra.client.tables.Table
Constructs an instance of a table within the specified database.
TABLE_ADMIN - Enum constant in enum class com.datastax.astra.client.core.commands.CommandType
Table schema operation (create*, drop*)
tableAdminTimeout(Duration) - Method in class com.datastax.astra.client.core.options.TimeoutOptions
Sets the timeout for table administration operations.
TableDefinition - Class in com.datastax.astra.client.tables.definition
Definition of a table.
TableDefinition() - Constructor for class com.datastax.astra.client.tables.definition.TableDefinition
Default constructor.
TableDeleteManyOptions - Class in com.datastax.astra.client.tables.commands.options
Options to delete many documents.
TableDeleteManyOptions() - Constructor for class com.datastax.astra.client.tables.commands.options.TableDeleteManyOptions
Default constructor.
TableDeleteOneOptions - Class in com.datastax.astra.client.tables.commands.options
Options to delete One document.
TableDeleteOneOptions() - Constructor for class com.datastax.astra.client.tables.commands.options.TableDeleteOneOptions
Default constructor.
TableDescriptor - Class in com.datastax.astra.client.tables.definition
Represents the Table definition with its name and metadata.
TableDescriptor() - Constructor for class com.datastax.astra.client.tables.definition.TableDescriptor
Default constructor.
TableDescriptor(String) - Constructor for class com.datastax.astra.client.tables.definition.TableDescriptor
Default constructor.
TableDistinctOptions - Class in com.datastax.astra.client.tables.commands.options
Options to delete many documents.
TableDistinctOptions() - Constructor for class com.datastax.astra.client.tables.commands.options.TableDistinctOptions
Default constructor.
TableDuration - Class in com.datastax.astra.client.tables.definition
Represents a combination of a Period and a Duration.
TableDuration(Period, Duration) - Constructor for class com.datastax.astra.client.tables.definition.TableDuration
Constructs a TableDuration from the specified period and duration.
TableDurationDeserializer - Class in com.datastax.astra.internal.serdes.tables
A custom deserializer for converting JSON strings into TableDuration objects.
TableDurationDeserializer() - Constructor for class com.datastax.astra.internal.serdes.tables.TableDurationDeserializer
Default constructor.
TableDurationSerializer - Class in com.datastax.astra.internal.serdes.tables
Serializer for TableDuration.
TableDurationSerializer() - Constructor for class com.datastax.astra.internal.serdes.tables.TableDurationSerializer
Default constructor.
tableExists(String) - Method in class com.datastax.astra.client.databases.Database
Checks if a table exists in the database by its name.
TableFindCursor<T,R> - Class in com.datastax.astra.client.tables.cursor
Implementation of a cursor across the find items
TableFindCursor(Table<T>, Filter, TableFindOptions, Class<R>) - Constructor for class com.datastax.astra.client.tables.cursor.TableFindCursor
Cursor to iterate on the result of a query.
TableFindOneOptions - Class in com.datastax.astra.client.tables.commands.options
List Options for a FindOne command.
TableFindOneOptions() - Constructor for class com.datastax.astra.client.tables.commands.options.TableFindOneOptions
Default constructor.
TableFindOptions - Class in com.datastax.astra.client.tables.commands.options
List Options for a FindOne command.
TableFindOptions() - Constructor for class com.datastax.astra.client.tables.commands.options.TableFindOptions
Default constructor.
TableIndexColumnDefinition - Class in com.datastax.astra.client.tables.definition.indexes
Represents a column definition for a table index, including the column's name and type.
TableIndexColumnDefinition(String) - Constructor for class com.datastax.astra.client.tables.definition.indexes.TableIndexColumnDefinition
Constructor that accepts a column name.
TableIndexColumnDefinitionDeserializer - Class in com.datastax.astra.internal.serdes.tables
A custom deserializer for converting JSON strings into TableDuration objects.
TableIndexColumnDefinitionDeserializer() - Constructor for class com.datastax.astra.internal.serdes.tables.TableIndexColumnDefinitionDeserializer
Default constructor.
TableIndexColumnDefinitionSerializer - Class in com.datastax.astra.internal.serdes.tables
Serializer for TableIndexColumnDefinition.
TableIndexColumnDefinitionSerializer() - Constructor for class com.datastax.astra.internal.serdes.tables.TableIndexColumnDefinitionSerializer
Default constructor
TableIndexDefinition<OPTIONS> - Class in com.datastax.astra.client.tables.definition.indexes
Represents the base class for table index definitions, encapsulating common properties and behaviors for index definitions, including the column being indexed and API support for index-related operations.
TableIndexDefinition(Function<OPTIONS, ? extends TableIndexDefinition<OPTIONS>>) - Constructor for class com.datastax.astra.client.tables.definition.indexes.TableIndexDefinition
Constructs a new instance of TableIndexDefinition with the specified constructor function.
TableIndexDefinitionApiSupport - Class in com.datastax.astra.client.tables.definition.indexes
Represents the API support for table index definitions, providing flags for various operations such as table creation, insertion, and reading, along with a CQL (Cassandra Query Language) definition.
TableIndexDefinitionApiSupport() - Constructor for class com.datastax.astra.client.tables.definition.indexes.TableIndexDefinitionApiSupport
Default constructor.
TableIndexDefinitionOptions - Class in com.datastax.astra.client.tables.definition.indexes
Represents the options for table index definitions, allowing configuration of index characteristics.
TableIndexDefinitionOptions() - Constructor for class com.datastax.astra.client.tables.definition.indexes.TableIndexDefinitionOptions
Default constructor.
TableIndexDescriptor<DEF> - Class in com.datastax.astra.client.tables.definition.indexes
Represents a descriptor for a table index, including the table's name and associated index options.
TableIndexDescriptor(Function<DEF, ? extends TableIndexDescriptor<DEF>>) - Constructor for class com.datastax.astra.client.tables.definition.indexes.TableIndexDescriptor
Constructor that accepts a function for instance creation.
TableIndexMapTypes - Enum Class in com.datastax.astra.client.tables.definition.indexes
Enum representing the types of map indexes in a table.
TableInsertManyOptions - Class in com.datastax.astra.client.tables.commands.options
Options for InsertMany
TableInsertManyOptions() - Constructor for class com.datastax.astra.client.tables.commands.options.TableInsertManyOptions
Default constructor.
TableInsertManyResult - Class in com.datastax.astra.client.tables.commands.results
Represents the result returned by command 'insertMany()', mainly the insertedIds.
TableInsertManyResult() - Constructor for class com.datastax.astra.client.tables.commands.results.TableInsertManyResult
Default constructor.
TableInsertOneOptions - Class in com.datastax.astra.client.tables.commands.options
Options for InsertOne
TableInsertOneOptions() - Constructor for class com.datastax.astra.client.tables.commands.options.TableInsertOneOptions
Default constructor.
TableInsertOneResult - Class in com.datastax.astra.client.tables.commands.results
Represents the result of a single row insertion into a table, containing the inserted primary key values and the schema of the primary key.
TableInsertOneResult() - Constructor for class com.datastax.astra.client.tables.commands.results.TableInsertOneResult
No-argument constructor that initializes insertedId to an empty ArrayList and primaryKeySchema to an empty LinkedHashMap.
TableOptions - Class in com.datastax.astra.client.tables
The options to use for the data API client.
TableOptions() - Constructor for class com.datastax.astra.client.tables.TableOptions
Default constructor nor overriding token nor options
TableOptions(String, DataAPIClientOptions) - Constructor for class com.datastax.astra.client.tables.TableOptions
Constructor with options and not token override.
TablePrimaryKey - Class in com.datastax.astra.client.tables.definition
The primary key definition for a table.
TablePrimaryKey() - Constructor for class com.datastax.astra.client.tables.definition.TablePrimaryKey
Default constructor.
TableRegularIndexDefinition - Class in com.datastax.astra.client.tables.definition.indexes
Represents a definition for table indices, allowing customization of various indexing options.
TableRegularIndexDefinition() - Constructor for class com.datastax.astra.client.tables.definition.indexes.TableRegularIndexDefinition
Default constructor.
TableRegularIndexDefinition(TableIndexDefinitionOptions) - Constructor for class com.datastax.astra.client.tables.definition.indexes.TableRegularIndexDefinition
Constructor that accepts a set of index options.
TableRegularIndexDescriptor - Class in com.datastax.astra.client.tables.definition.indexes
Represents a descriptor for a table index, including the table's name and associated index options.
TableRegularIndexDescriptor() - Constructor for class com.datastax.astra.client.tables.definition.indexes.TableRegularIndexDescriptor
The default name for the index.
TableRegularIndexDescriptor(TableRegularIndexDefinition) - Constructor for class com.datastax.astra.client.tables.definition.indexes.TableRegularIndexDescriptor
Constructor that accepts a set of index options.
TableTextIndexDefinition - Class in com.datastax.astra.client.tables.definition.indexes
Represents a definition for table vector indices, allowing configuration of vector-specific options such as similarity metrics and source models.
TableTextIndexDefinition() - Constructor for class com.datastax.astra.client.tables.definition.indexes.TableTextIndexDefinition
Constructs a new TableVectorIndexDefinition instance.
TableTextIndexDefinition(TableTextIndexDefinitionOptions) - Constructor for class com.datastax.astra.client.tables.definition.indexes.TableTextIndexDefinition
Constructs a new TableVectorIndexDefinition instance with the specified options.
TableTextIndexDefinitionOptions - Class in com.datastax.astra.client.tables.definition.indexes
Represents the options for a text index definition in a table.
TableTextIndexDefinitionOptions() - Constructor for class com.datastax.astra.client.tables.definition.indexes.TableTextIndexDefinitionOptions
Default constructor.
TableTextIndexDescriptor - Class in com.datastax.astra.client.tables.definition.indexes
Represents a descriptor for a table index, including the table's name and associated index options.
TableTextIndexDescriptor() - Constructor for class com.datastax.astra.client.tables.definition.indexes.TableTextIndexDescriptor
The default name for the index.
TableTextIndexDescriptor(TableTextIndexDefinition) - Constructor for class com.datastax.astra.client.tables.definition.indexes.TableTextIndexDescriptor
Constructor that accepts a set of index options.
TableUpdateOneOptions - Class in com.datastax.astra.client.tables.commands.options
Options for the updateOne operation
TableUpdateOneOptions() - Constructor for class com.datastax.astra.client.tables.commands.options.TableUpdateOneOptions
Default constructor.
TableUpdateOperation - Class in com.datastax.astra.client.tables.commands
Encore the update document
TableUpdateOperation() - Constructor for class com.datastax.astra.client.tables.commands.TableUpdateOperation
Default constructor.
TableUpdateOperation(String) - Constructor for class com.datastax.astra.client.tables.commands.TableUpdateOperation
Default constructor.
TableUpdateOperation(Map<String, Object>) - Constructor for class com.datastax.astra.client.tables.commands.TableUpdateOperation
Default constructor.
TableUpdateResult - Class in com.datastax.astra.client.tables.commands.results
Return update result.
TableUpdateResult() - Constructor for class com.datastax.astra.client.tables.commands.results.TableUpdateResult
Default constructor.
TableVectorIndexDefinition - Class in com.datastax.astra.client.tables.definition.indexes
Represents a definition for table vector indices, allowing configuration of vector-specific options such as similarity metrics and source models.
TableVectorIndexDefinition() - Constructor for class com.datastax.astra.client.tables.definition.indexes.TableVectorIndexDefinition
Constructs a new TableVectorIndexDefinition instance.
TableVectorIndexDefinition(TableVectorIndexDefinitionOptions) - Constructor for class com.datastax.astra.client.tables.definition.indexes.TableVectorIndexDefinition
Constructs a new TableVectorIndexDefinition instance with the specified options.
TableVectorIndexDefinitionOptions - Class in com.datastax.astra.client.tables.definition.indexes
Options for defining vector-based index configurations for tables.
TableVectorIndexDefinitionOptions() - Constructor for class com.datastax.astra.client.tables.definition.indexes.TableVectorIndexDefinitionOptions
Default constructor.
TableVectorIndexDescriptor - Class in com.datastax.astra.client.tables.definition.indexes
Descriptor for a table vector index.
TableVectorIndexDescriptor() - Constructor for class com.datastax.astra.client.tables.definition.indexes.TableVectorIndexDescriptor
The default name for the index.
TableVectorIndexDescriptor(TableVectorIndexDefinition) - Constructor for class com.datastax.astra.client.tables.definition.indexes.TableVectorIndexDescriptor
Constructor that accepts a set of index options.
TEXT - Enum constant in enum class com.datastax.astra.client.tables.definition.columns.ColumnTypes
Text or string type.
throwErrorMissingAnnotation(String, String, String) - Static method in exception class com.datastax.astra.client.exceptions.InvalidConfigurationException
Format error message.
throwErrorMissingConfiguration(String, String) - Static method in exception class com.datastax.astra.client.exceptions.InvalidConfigurationException
Format error message.
throwErrorRestrictedAstra(String, DataAPIDestination) - Static method in exception class com.datastax.astra.client.exceptions.InvalidEnvironmentException
Format error message.
throwInvalidField(String, String) - Static method in exception class com.datastax.astra.client.exceptions.InvalidFieldExpressionException
Format error message.
TIME - Enum constant in enum class com.datastax.astra.client.tables.definition.columns.ColumnTypes
Time type, storing only the time part.
timeout(long) - Method in class com.datastax.astra.client.core.options.BaseOptions
Provide the command type.
timeout(long, CommandType) - Method in class com.datastax.astra.client.core.options.BaseOptions
Provide the command type.
timeout(Duration) - Method in class com.datastax.astra.client.core.options.BaseOptions
Provide the command type.
timeoutOptions - Variable in class com.datastax.astra.internal.http.RetryHttpClient
Http Options.
timeoutOptions(TimeoutOptions) - Method in class com.datastax.astra.client.core.options.BaseOptions
Provide the embedding service API key.
TimeoutOptions - Class in com.datastax.astra.client.core.options
This class is used to define the timeout options for the client.
TimeoutOptions() - Constructor for class com.datastax.astra.client.core.options.TimeoutOptions
Default constructor
TIMESTAMP - Enum constant in enum class com.datastax.astra.client.tables.definition.columns.ColumnTypes
Timestamp type, representing a specific date and time.
TINYINT - Enum constant in enum class com.datastax.astra.client.tables.definition.columns.ColumnTypes
8-bit signed integer.
toByteArray() - Method in class com.datastax.astra.client.collections.definition.documents.types.ObjectId
Convert to a byte array.
toCompactString() - Method in class com.datastax.astra.client.tables.definition.TableDuration
Returns a compact string representation of this duration.
toHexString() - Method in class com.datastax.astra.client.collections.definition.documents.types.ObjectId
Converts this instance into a 24-byte hexadecimal string representation.
toISO8601() - Method in class com.datastax.astra.client.tables.definition.TableDuration
Converts this TableDuration to an ISO8601 string representation.
toJson() - Method in class com.datastax.astra.client.collections.definition.documents.Document
Serialization with Jackson.
toJson() - Method in class com.datastax.astra.client.core.query.Filter
Express the json filter as a string.
token - Variable in class com.datastax.astra.client.core.options.BaseOptions
Token to use for authentication.
token(String) - Method in class com.datastax.astra.client.core.options.BaseOptions
Provide the token.
Token() - Constructor for class com.datastax.astra.client.core.rerank.RerankProvider.Token
Default constructor.
Token() - Constructor for class com.datastax.astra.client.core.vectorize.EmbeddingProvider.Token
Default constructor.
tokenizer(String) - Method in class com.datastax.astra.client.core.lexical.Analyzer
Define a tokenizer by its name.
tokenizer(String, Map<String, String>) - Method in class com.datastax.astra.client.core.lexical.Analyzer
Define a tokenizer by its name and arguments.
TokenProvider - Interface in com.datastax.astra.client.core.auth
To work the APi needs a token.
toList() - Method in class com.datastax.astra.internal.command.AbstractCursor
Collects all remaining elements in the cursor into a list.
toMap(KeyValue[]) - Static method in class com.datastax.astra.internal.reflection.EntityFieldDefinition
Constructor with field name.
TooManyDocumentsToCountException - Exception Class in com.datastax.astra.client.collections.exceptions
Error when too many documents in the collection
TooManyDocumentsToCountException() - Constructor for exception class com.datastax.astra.client.collections.exceptions.TooManyDocumentsToCountException
Default constructor.
TooManyDocumentsToCountException(int) - Constructor for exception class com.datastax.astra.client.collections.exceptions.TooManyDocumentsToCountException
Default constructor.
TooManyRowsToCountException - Exception Class in com.datastax.astra.client.tables.exceptions
Error when too many documents in the collection
TooManyRowsToCountException() - Constructor for exception class com.datastax.astra.client.tables.exceptions.TooManyRowsToCountException
Default constructor.
TooManyRowsToCountException(int) - Constructor for exception class com.datastax.astra.client.tables.exceptions.TooManyRowsToCountException
Default constructor.
toString() - Method in class com.datastax.astra.client.collections.definition.CollectionDescriptor
toString() - Method in class com.datastax.astra.client.collections.definition.documents.Document
Serialization with Jackson.
toString() - Method in class com.datastax.astra.client.collections.definition.documents.types.ObjectId
 
toString() - Method in class com.datastax.astra.client.collections.definition.documents.types.UUIDv6
toString() - Method in class com.datastax.astra.client.collections.definition.documents.types.UUIDv7
toString() - Method in class com.datastax.astra.client.core.options.BaseOptions
toString() - Method in class com.datastax.astra.client.core.options.DataAPIClientOptions
toString() - Method in class com.datastax.astra.client.core.query.Filter
Serialization with Jackson.
toString() - Method in class com.datastax.astra.client.databases.definition.keyspaces.KeyspaceInformation
toString() - Method in class com.datastax.astra.client.tables.definition.columns.ColumnDefinition
toString() - Method in class com.datastax.astra.client.tables.definition.columns.ColumnDefinitionApiSupport
toString() - Method in class com.datastax.astra.client.tables.definition.indexes.TableIndexDescriptor
Converts the object to a string using the RowSerializer.
toString() - Method in class com.datastax.astra.client.tables.definition.rows.Row
Serialization with Jackson.
toString() - Method in class com.datastax.astra.client.tables.definition.TableDefinition
toString() - Method in class com.datastax.astra.client.tables.definition.TableDescriptor
toUUID() - Method in class com.datastax.astra.client.collections.definition.documents.types.UUIDv6
Return the Java Utils UUID.
toUUID() - Method in class com.datastax.astra.client.collections.definition.documents.types.UUIDv7
Return the Java Utils UUID.
type() - Element in annotation interface com.datastax.astra.client.tables.mapping.Column
Specifies the type of the column.
type(String) - Method in class com.datastax.astra.client.core.rerank.RerankServiceOptions.Parameters
Sets the type of this parameter.
type(String) - Method in class com.datastax.astra.client.core.vectorize.VectorServiceOptions.Parameters
Sets the type of this parameter.

U

UNDEFINED - Enum constant in enum class com.datastax.astra.client.tables.definition.columns.ColumnTypes
Represents an undefined column type.
unEscapeFieldPath(String) - Static method in class com.datastax.astra.internal.utils.EscapeUtils
Escape a field path.
UnexpectedDataAPIResponseException - Exception Class in com.datastax.astra.client.exceptions
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.
UnexpectedDataAPIResponseException(Command, DataAPIResponse, String) - Constructor for exception class com.datastax.astra.client.exceptions.UnexpectedDataAPIResponseException
Constructs a new exception with the specified command that triggered the error, the API response received, and a custom error message.
UnexpectedDataAPIResponseException(String) - Constructor for exception class com.datastax.astra.client.exceptions.UnexpectedDataAPIResponseException
Constructs a new exception with the specified command that triggered the error, the API response received, and a custom error message.
unmarshall(DataAPIResponse, Class<DOC>) - Method in class com.datastax.astra.internal.command.AbstractCommandRunner
Document Mapping.
unMarshallBean(String, Class<T>) - Method in interface com.datastax.astra.internal.serdes.DataAPISerializer
Load body as expected object.
unregisterObserver(String) - Method in class com.datastax.astra.client.core.options.BaseOptions
Remove a listener from the command.
unset(String) - Method in class com.datastax.astra.client.collections.commands.Update
Builder pattern
unset(String) - Static method in class com.datastax.astra.client.collections.commands.Updates
unset(String...) - Method in class com.datastax.astra.client.tables.commands.TableUpdateOperation
Builder pattern
unset(String, Object) - Method in class com.datastax.astra.client.tables.commands.TableUpdateOperation
Builder pattern, unset a field
UNSUPPORTED - Enum constant in enum class com.datastax.astra.client.tables.definition.columns.ColumnTypes
Represents unsupported column types.
Update - Class in com.datastax.astra.client.collections.commands
Encore the update document
Update() - Constructor for class com.datastax.astra.client.collections.commands.Update
Default constructor.
Update(String) - Constructor for class com.datastax.astra.client.collections.commands.Update
Default constructor.
Update(Map<String, Object>) - Constructor for class com.datastax.astra.client.collections.commands.Update
Default constructor.
updateCurrentDate(String...) - Method in class com.datastax.astra.client.collections.commands.Update
Builder pattern
updateCurrentDate(String...) - Static method in class com.datastax.astra.client.collections.commands.Updates
updateMany(Filter, Update) - Method in class com.datastax.astra.client.collections.Collection
Update all documents in the collection according to the specified arguments.
updateMany(Filter, Update, CollectionUpdateManyOptions) - Method in class com.datastax.astra.client.collections.Collection
Update all documents in the collection according to the specified arguments.
updateMul(Map<String, Double>) - Method in class com.datastax.astra.client.collections.commands.Update
Builder pattern
updateOne(Filter, Update) - Method in class com.datastax.astra.client.collections.Collection
Update a single document in the collection according to the specified arguments.
updateOne(Filter, Update, CollectionUpdateOneOptions) - Method in class com.datastax.astra.client.collections.Collection
Update a single document in the collection according to the specified arguments.
updateOne(Filter, TableUpdateOperation) - Method in class com.datastax.astra.client.tables.Table
Update a single row in the table according to the specified arguments.
updateOne(Filter, TableUpdateOperation, TableUpdateOneOptions) - Method in class com.datastax.astra.client.tables.Table
Update a single document in the collection according to the specified arguments.
Updates - Class in com.datastax.astra.client.collections.commands
Helper for Syntax with updates.
updateSetOnInsert(Map<String, Object>) - Method in class com.datastax.astra.client.collections.commands.Update
Builder pattern
updateSetOnInsert(Map<String, Object>) - Static method in class com.datastax.astra.client.collections.commands.Updates
useKeyspace(String) - Method in class com.datastax.astra.client.databases.Database
Sets the active keyspace for the database.
UsernamePasswordTokenProvider - Class in com.datastax.astra.client.core.auth
Creating a token with base64 encoded credentials.
UsernamePasswordTokenProvider() - Constructor for class com.datastax.astra.client.core.auth.UsernamePasswordTokenProvider
Using defaults settings.
UsernamePasswordTokenProvider(String, String) - Constructor for class com.datastax.astra.client.core.auth.UsernamePasswordTokenProvider
Full-fledged constructor.
UUID - Enum constant in enum class com.datastax.astra.client.collections.definition.CollectionDefaultIdTypes
UUID v4, the default random UUID.
UUID - Enum constant in enum class com.datastax.astra.client.core.DataAPIKeywords
UUID
UUID - Enum constant in enum class com.datastax.astra.client.tables.definition.columns.ColumnTypes
Universally Unique Identifier (UUID) type.
UUID6Serializer - Class in com.datastax.astra.internal.serdes.collections
Object Id Could be objectId|uuid|uuidv6|uuidv7
UUID6Serializer() - Constructor for class com.datastax.astra.internal.serdes.collections.UUID6Serializer
Default constructor.
UUID6Serializer(Class<UUIDv6>) - Constructor for class com.datastax.astra.internal.serdes.collections.UUID6Serializer
Constructor with type
UUID7Serializer - Class in com.datastax.astra.internal.serdes.collections
Object Id Could be objectId|uuid|uuidv6|uuidv7
UUID7Serializer() - Constructor for class com.datastax.astra.internal.serdes.collections.UUID7Serializer
Default constructor.
UUID7Serializer(Class<UUIDv7>) - Constructor for class com.datastax.astra.internal.serdes.collections.UUID7Serializer
Constructor with type
UUIDDeserializer - Class in com.datastax.astra.internal.serdes.collections
Custom deserializer for EJson Date type.
UUIDDeserializer() - Constructor for class com.datastax.astra.internal.serdes.collections.UUIDDeserializer
Default constructor.
UUIDSerializer - Class in com.datastax.astra.internal.serdes.collections
Object Id Could be objectId|uuid|uuidv6|uuidv7
UUIDSerializer() - Constructor for class com.datastax.astra.internal.serdes.collections.UUIDSerializer
Default constructor.
UUIDSerializer(Class<UUID>) - Constructor for class com.datastax.astra.internal.serdes.collections.UUIDSerializer
Constructor with type
UUIDv6 - Class in com.datastax.astra.client.collections.definition.documents.types
Materializing the UUIDv6 as a specialization class to drive serialization and deserialization.
UUIDv6() - Constructor for class com.datastax.astra.client.collections.definition.documents.types.UUIDv6
Default constructor.
UUIDv6(UUID) - Constructor for class com.datastax.astra.client.collections.definition.documents.types.UUIDv6
Constructor.
UUIDV6 - Enum constant in enum class com.datastax.astra.client.collections.definition.CollectionDefaultIdTypes
UUID in version v6 allowing natural ordering.
UUIDv7 - Class in com.datastax.astra.client.collections.definition.documents.types
Materializing the UUIDv6 as a specialization class to drive serialization and deserialization.
UUIDv7() - Constructor for class com.datastax.astra.client.collections.definition.documents.types.UUIDv7
Default constructor.
UUIDv7(UUID) - Constructor for class com.datastax.astra.client.collections.definition.documents.types.UUIDv7
Constructor.
UUIDV7 - Enum constant in enum class com.datastax.astra.client.collections.definition.CollectionDefaultIdTypes
UUID in version v7, random and time-based.

V

Validation() - Constructor for class com.datastax.astra.client.core.rerank.RerankProvider.Validation
Default constructor.
Validation() - Constructor for class com.datastax.astra.client.core.vectorize.EmbeddingProvider.Validation
Default constructor.
value() - Element in annotation interface com.datastax.astra.client.tables.mapping.EntityTable
Table Name, if not provided the class name will be used
value() - Element in annotation interface com.datastax.astra.client.tables.mapping.KeyValue
Value.
value() - Element in annotation interface com.datastax.astra.client.tables.mapping.PartitionBy
The partition key value for the annotated field or method.
value() - Element in annotation interface com.datastax.astra.internal.utils.BetaPreview
Deprecated.
Message to be displayed when the feature is used.
valueOf(String) - Static method in enum class com.datastax.astra.client.collections.commands.ReturnDocument
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.datastax.astra.client.collections.definition.CollectionDefaultIdTypes
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.datastax.astra.client.core.commands.CommandType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.datastax.astra.client.core.DataAPIKeywords
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.datastax.astra.client.core.lexical.AnalyzerTypes
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.datastax.astra.client.core.lexical.LexicalFilters
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.datastax.astra.client.core.paging.CursorState
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.datastax.astra.client.core.query.FilterOperator
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.datastax.astra.client.core.query.SortOrder
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.datastax.astra.client.core.rerank.RerankProviderTypes
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.datastax.astra.client.core.vector.SimilarityMetric
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.datastax.astra.client.DataAPIDestination
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.datastax.astra.client.databases.definition.keyspaces.KeyspaceReplicationStrategy
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.datastax.astra.client.exceptions.ErrorCodesClient
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.datastax.astra.client.exceptions.ErrorCodesServer
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.datastax.astra.client.tables.definition.columns.ColumnTypes
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.datastax.astra.client.tables.definition.indexes.TableIndexMapTypes
Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.datastax.astra.client.collections.commands.ReturnDocument
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.datastax.astra.client.collections.definition.CollectionDefaultIdTypes
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.datastax.astra.client.core.commands.CommandType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.datastax.astra.client.core.DataAPIKeywords
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.datastax.astra.client.core.lexical.AnalyzerTypes
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.datastax.astra.client.core.lexical.LexicalFilters
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.datastax.astra.client.core.paging.CursorState
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.datastax.astra.client.core.query.FilterOperator
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.datastax.astra.client.core.query.SortOrder
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.datastax.astra.client.core.rerank.RerankProviderTypes
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.datastax.astra.client.core.vector.SimilarityMetric
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.datastax.astra.client.DataAPIDestination
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.datastax.astra.client.databases.definition.keyspaces.KeyspaceReplicationStrategy
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.datastax.astra.client.exceptions.ErrorCodesClient
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.datastax.astra.client.exceptions.ErrorCodesServer
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.datastax.astra.client.tables.definition.columns.ColumnTypes
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.datastax.astra.client.tables.definition.indexes.TableIndexMapTypes
Returns an array containing the constants of this enum class, in the order they are declared.
VALUES - Enum constant in enum class com.datastax.astra.client.tables.definition.indexes.TableIndexMapTypes
Index on map values
valueType() - Element in annotation interface com.datastax.astra.client.tables.mapping.Column
Specifies the value type of the column, typically used for complex data structures.
VARINT - Enum constant in enum class com.datastax.astra.client.tables.definition.columns.ColumnTypes
Arbitrary precision integer type.
vector(float[]) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Set the vector value.
vector(float[]) - Method in class com.datastax.astra.client.core.hybrid.Hybrid
Add a vector that will be serialized as a float array.
vector(float[]) - Static method in class com.datastax.astra.client.core.query.Sort
Build a sort clause with a vector.
vector(int, SimilarityMetric) - Method in class com.datastax.astra.client.collections.definition.CollectionDefinition
Builder pattern.
vector(DataAPIVector) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Set the vector value.
vector(DataAPIVector) - Method in class com.datastax.astra.client.core.hybrid.Hybrid
Add a vector that will be serialized as a base64 encoded string..
vector(VectorOptions) - Method in class com.datastax.astra.client.collections.definition.CollectionDefinition
Builder pattern.
vector(Integer) - Method in class com.datastax.astra.client.core.hybrid.HybridLimits
Add a limit for the vector data.
vector(String, float[]) - Static method in class com.datastax.astra.client.core.query.Sort
Build a sort clause with a vector on a table
vector(String, DataAPIVector) - Static method in class com.datastax.astra.client.core.query.Sort
Build a sort clause with a vector on a table
VECTOR - Enum constant in enum class com.datastax.astra.client.core.DataAPIKeywords
VECTOR.
VECTOR - Enum constant in enum class com.datastax.astra.client.tables.definition.columns.ColumnTypes
Vector data type, typically used for machine learning or specialized computations.
vectorDimension(int) - Method in class com.datastax.astra.client.collections.definition.CollectionDefinition
Builder pattern.
vectorize(Vectorize) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Add a vectorize attribute to the document.
vectorize(Vectorize) - Method in class com.datastax.astra.client.core.hybrid.Hybrid
Add a vectorize field.
vectorize(String) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Add a vectorize attribute to the document.
vectorize(String) - Method in class com.datastax.astra.client.core.hybrid.Hybrid
Add a vectorize field.
vectorize(String) - Static method in class com.datastax.astra.client.core.query.Sort
Build a sort clause with vectorize.
vectorize(String, String) - Method in class com.datastax.astra.client.collections.definition.CollectionDefinition
Enable Vectorization within the collection.
vectorize(String, String) - Method in class com.datastax.astra.client.collections.definition.documents.Document
Add a vectorize attribute to the document.
vectorize(String, String) - Static method in class com.datastax.astra.client.core.query.Sort
Build a sort clause with vectorize.
vectorize(String, String, String) - Method in class com.datastax.astra.client.collections.definition.CollectionDefinition
Enable Vectorization within the collection.
vectorize(String, String, String, Map<String, Object>) - Method in class com.datastax.astra.client.collections.definition.CollectionDefinition
Enable Vectorization within the collection.
Vectorize - Class in com.datastax.astra.client.core.vectorize
Serialization of vectorize
Vectorize(String, String) - Constructor for class com.datastax.astra.client.core.vectorize.Vectorize
Constructor with passage and setPassage
Vectorize(String) - Constructor for class com.datastax.astra.client.core.vectorize.Vectorize
Default constructor.
VECTORIZE - Enum constant in enum class com.datastax.astra.client.core.DataAPIKeywords
VECTORIZE.
VectorizeSerializer - Class in com.datastax.astra.internal.serdes.core
Serializer for Vectorize
VectorizeSerializer() - Constructor for class com.datastax.astra.internal.serdes.core.VectorizeSerializer
Default constructor
VectorOptions - Class in com.datastax.astra.client.core.vector
Subclass representing the vector options.
VectorOptions() - Constructor for class com.datastax.astra.client.core.vector.VectorOptions
Default constructor.
VectorServiceOptions - Class in com.datastax.astra.client.core.vectorize
Configuration options for the Vector Service.
VectorServiceOptions() - Constructor for class com.datastax.astra.client.core.vectorize.VectorServiceOptions
Default constructor for serialization purposes.
VectorServiceOptions.Parameters - Class in com.datastax.astra.client.core.vectorize
Represents a parameter definition for LLM services.
vectorSimilarity(SimilarityMetric) - Method in class com.datastax.astra.client.collections.definition.CollectionDefinition
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.core.query.Filter
Work with arguments.
where(String, FilterOperator, Object) - Method in class com.datastax.astra.client.core.query.Filter
Build where clause with operator
WHITESPACE - Enum constant in enum class com.datastax.astra.client.core.lexical.AnalyzerTypes
Filters StandardTokenizer output that divides text into terms on word boundaries and then uses the LowerCaseFilter.
withApiResponse(DataAPIResponse) - Method in class com.datastax.astra.internal.command.ExecutionInfos.DataApiExecutionInfoBuilder
Populate after http call.
withCommand(Command) - Method in class com.datastax.astra.internal.command.ExecutionInfos.DataApiExecutionInfoBuilder
Populate after http call.
withCommandOptions(BaseOptions<?>) - Method in class com.datastax.astra.internal.command.ExecutionInfos.DataApiExecutionInfoBuilder
Populate after http call.
withDocument(Object) - Method in class com.datastax.astra.client.core.commands.Command
Builder pattern, update document.
withDocuments(List<T>) - Method in class com.datastax.astra.client.core.commands.Command
Builder pattern, update documents.
withFilter(Filter) - Method in class com.datastax.astra.client.core.commands.Command
Builder pattern, update filter.
withHttpResponse(ApiResponseHttp) - Method in class com.datastax.astra.internal.command.ExecutionInfos.DataApiExecutionInfoBuilder
Populate after http call.
withOptions(Object) - Method in class com.datastax.astra.client.core.commands.Command
Builder pattern, update options.
withOverrideCommandOptions(BaseOptions<?>) - Method in class com.datastax.astra.internal.command.ExecutionInfos.DataApiExecutionInfoBuilder
Populate after http call.
withProjection(Projection...) - Method in class com.datastax.astra.client.core.commands.Command
Return projections.
withProjection(Map<String, Boolean>) - Method in class com.datastax.astra.client.core.commands.Command
Builder pattern, update projection.
withReplacement(Object) - Method in class com.datastax.astra.client.core.commands.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.
withSerializer(DataAPISerializer) - Method in class com.datastax.astra.internal.command.ExecutionInfos.DataApiExecutionInfoBuilder
Populate after http call.
withSort(Sort...) - Method in class com.datastax.astra.client.core.commands.Command
Builder pattern, update sort.
withUpdate(Update) - Method in class com.datastax.astra.client.core.commands.Command
Builder pattern, Update.
withUpdate(TableUpdateOperation) - Method in class com.datastax.astra.client.core.commands.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 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