Package com.redis.vl.schema

Class IndexSchema.Builder

java.lang.Object

com.redis.vl.schema.IndexSchema.Builder

Enclosing class:

IndexSchema

public static class IndexSchema.Builder
extends Object

Builder for IndexSchema

Method Summary

Modifier and Type	Method	Description
IndexSchema.Builder	addNumericField(String name, Consumer<NumericField.NumericFieldBuilder> customizer)	Add a numeric field with customization
IndexSchema.Builder	addTagField(String name, Consumer<TagField.TagFieldBuilder> customizer)	Add a tag field with customization
IndexSchema.Builder	addTextField(String name, Consumer<TextField.TextFieldBuilder> customizer)	Add a text field with customization
IndexSchema.Builder	addVectorField(String name, int dimensions, Consumer<VectorField.VectorFieldBuilder> customizer)	Add a vector field with customization
IndexSchema	build()	Build the IndexSchema
IndexSchema.Builder	field(BaseField field)	Add a field to the schema
IndexSchema.Builder	index(IndexSchema.Index index)	Set the builder from an Index configuration
IndexSchema.Builder	name(String name)	Set the index name
IndexSchema.Builder	prefix(String prefix)	Set the key prefix
IndexSchema.Builder	storageType(IndexSchema.StorageType storageType)	Set the storage type
IndexSchema.Builder	withPrefix(String prefix)	Set the key prefix (alias for prefix)
IndexSchema.Builder	withStorageType(IndexSchema.StorageType storageType)	Set the storage type (alias for storageType)

Methods inherited from class java.lang.Object

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

Method Details

name

public IndexSchema.Builder name(String name)

Set the index name

Parameters:

name - the index name

Returns:

this builder

prefix

public IndexSchema.Builder prefix(String prefix)

Set the key prefix

Parameters:

prefix - the key prefix

Returns:

this builder

withPrefix

public IndexSchema.Builder withPrefix(String prefix)

Set the key prefix (alias for prefix)

Parameters:

prefix - the key prefix

Returns:

this builder

storageType

public IndexSchema.Builder storageType(IndexSchema.StorageType storageType)

Set the storage type

Parameters:

storageType - the storage type

Returns:

this builder

withStorageType

public IndexSchema.Builder withStorageType(IndexSchema.StorageType storageType)

Set the storage type (alias for storageType)

Parameters:

storageType - the storage type

Returns:

this builder

field

public IndexSchema.Builder field(BaseField field)

Add a field to the schema

Parameters:

field - the field to add

Returns:

this builder

addTextField

public IndexSchema.Builder addTextField(String name,
 Consumer<TextField.TextFieldBuilder> customizer)

Add a text field with customization

Parameters:

name - the field name

customizer - consumer to customize the field builder

Returns:

this builder

addTagField

public IndexSchema.Builder addTagField(String name,
 Consumer<TagField.TagFieldBuilder> customizer)

Add a tag field with customization

Parameters:

name - the field name

customizer - consumer to customize the field builder

Returns:

this builder

addNumericField

public IndexSchema.Builder addNumericField(String name,
 Consumer<NumericField.NumericFieldBuilder> customizer)

Add a numeric field with customization

Parameters:

name - the field name

customizer - consumer to customize the field builder

Returns:

this builder

addVectorField

public IndexSchema.Builder addVectorField(String name,
 int dimensions,
 Consumer<VectorField.VectorFieldBuilder> customizer)

Add a vector field with customization

Parameters:

name - the field name

dimensions - the vector dimensions

customizer - consumer to customize the field builder

Returns:

this builder

build

public IndexSchema build()

Build the IndexSchema

Returns:

the constructed IndexSchema

index

public IndexSchema.Builder index(IndexSchema.Index index)

Set the builder from an Index configuration

Parameters:

index - the Index configuration to use

Returns:

this builder