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

Class TableRegularIndexDescriptor

java.lang.Object

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

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

public class TableRegularIndexDescriptor
extends TableIndexDescriptor<TableRegularIndexDefinition>

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
	TableRegularIndexDescriptor()	The default name for the index.
protected	TableRegularIndexDescriptor(TableRegularIndexDefinition definition)	Constructor that accepts a set of index options.

Method Summary

Modifier and Type	Method	Description
TableRegularIndexDescriptor	definition(TableRegularIndexDefinition def)	Sets the index definition for the table.
TableRegularIndexDescriptor	name(String name)	Sets the name of the table.

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

TableRegularIndexDescriptor

public TableRegularIndexDescriptor()

The default name for the index.

TableRegularIndexDescriptor

protected TableRegularIndexDescriptor(TableRegularIndexDefinition definition)

Constructor that accepts a set of index options.

Parameters:

definition - the index options to use.

Method Details

name

public TableRegularIndexDescriptor name(String name)

Description copied from class: TableIndexDescriptor

Sets the name of the table.

Overrides:

name in class TableIndexDescriptor<TableRegularIndexDefinition>

Parameters:

name - the name of the table.

Returns:

a new instance with the updated table name.

definition

public TableRegularIndexDescriptor definition(TableRegularIndexDefinition def)

Description copied from class: TableIndexDescriptor

Sets the index definition for the table.

Overrides:

definition in class TableIndexDescriptor<TableRegularIndexDefinition>

Parameters:

def - the TableIndexDefinition defining the index options for the table.

Returns:

a new instance with the updated definition.