Package com.redis.vl.schema

Class GeoField.GeoFieldBuilder

java.lang.Object

com.redis.vl.schema.GeoField.GeoFieldBuilder

Enclosing class:

GeoField

public static class GeoField.GeoFieldBuilder
extends Object

Fluent builder for GeoField

Method Summary

Modifier and Type	Method	Description
GeoField.GeoFieldBuilder	alias(String alias)	Set the field alias.
GeoField	build()	Build the GeoField.
GeoField.GeoFieldBuilder	indexed(boolean indexed)	Set whether the field is indexed.
GeoField.GeoFieldBuilder	name(String name)	Set the field name.
GeoField.GeoFieldBuilder	sortable()	Make the field sortable.
GeoField.GeoFieldBuilder	sortable(boolean sortable)	Set whether the field is sortable.
GeoField.GeoFieldBuilder	withAlias(String alias)	Set the field alias (alternative method name).

Methods inherited from class java.lang.Object

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

Method Details

name

public GeoField.GeoFieldBuilder name(String name)

Set the field name.

Parameters:

name - The name for this field

Returns:

This builder for chaining

alias

public GeoField.GeoFieldBuilder alias(String alias)

Set the field alias.

Parameters:

alias - The alias for this field

Returns:

This builder for chaining

withAlias

public GeoField.GeoFieldBuilder withAlias(String alias)

Set the field alias (alternative method name).

Parameters:

alias - The alias for this field

Returns:

This builder for chaining

indexed

public GeoField.GeoFieldBuilder indexed(boolean indexed)

Set whether the field is indexed.

Parameters:

indexed - True if the field should be indexed

Returns:

This builder for chaining

sortable

public GeoField.GeoFieldBuilder sortable(boolean sortable)

Set whether the field is sortable.

Parameters:

sortable - True if the field should be sortable

Returns:

This builder for chaining

sortable

public GeoField.GeoFieldBuilder sortable()

Make the field sortable.

Returns:

This builder for chaining

build

public GeoField build()

Build the GeoField.

Returns:

A new GeoField instance

Throws:

IllegalArgumentException - if the field name is null or empty