Package com.datastax.astra.client.tables.definition.indexes

Class TableTextIndexDescriptor

java.lang.Object

com.datastax.astra.client.tables.definition.indexes.TableIndexDescriptor<TableTextIndexDefinition>

com.datastax.astra.client.tables.definition.indexes.TableTextIndexDescriptor

public class TableTextIndexDescriptor
extends TableIndexDescriptor<TableTextIndexDefinition>

Represents a descriptor for a table index, including the table's name and associated index options. This class is designed for use in scenarios such as serialization/deserialization with libraries like Jackson and for method chaining in fluent-style APIs.

Field Summary

Fields inherited from class com.datastax.astra.client.tables.definition.indexes.TableIndexDescriptor

constructor, definition, indexType, name

Constructor Summary

Constructors

Modifier	Constructor	Description
	TableTextIndexDescriptor()	The default name for the index.
protected	TableTextIndexDescriptor(TableTextIndexDefinition definition)	Constructor that accepts a set of index options.

Method Summary

Modifier and Type	Method	Description
TableTextIndexDescriptor	definition(TableTextIndexDefinition def)	Adds a definitions to the index.
TableTextIndexDescriptor	name(String name)	Adds a name to the index.

Methods inherited from class com.datastax.astra.client.tables.definition.indexes.TableIndexDescriptor

mapImpl, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

TableTextIndexDescriptor

public TableTextIndexDescriptor()

The default name for the index.

TableTextIndexDescriptor

protected TableTextIndexDescriptor(TableTextIndexDefinition definition)

Constructor that accepts a set of index options.

Parameters:

definition - the index options to use.

Method Details

name

public TableTextIndexDescriptor name(String name)

Adds a name to the index.

Overrides:

name in class TableIndexDescriptor<TableTextIndexDefinition>

Parameters:

name - the name of the table.

Returns:

the current instance of TableTextIndexDescriptor.

definition

public TableTextIndexDescriptor definition(TableTextIndexDefinition def)

Adds a definitions to the index.

Overrides:

definition in class TableIndexDescriptor<TableTextIndexDefinition>

Parameters:

def - the definition of the index.

Returns:

the current instance of TableTextIndexDescriptor.