Package org.redisson.api.search.index

Class GeoIndexParams

java.lang.Object

org.redisson.api.search.index.GeoIndexParams

All Implemented Interfaces:

FieldIndex, GeoIndex

public final class GeoIndexParams
extends Object
implements GeoIndex

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method	Description
GeoIndexParams	as(String as)	Defines the attribute associated to the field name
String	getAs()
String	getFieldName()
SortMode	getSortMode()
GeoIndexParams	indexMissing()	Defines to index documents that don't contain this attribute
boolean	isIndexMissing()
boolean	isNoIndex()
GeoIndexParams	noIndex()	Defines to not index this attribute
GeoIndexParams	sortMode(SortMode sortMode)	Defines sort mode applied to the value of this attribute

Methods inherited from class java.lang.Object

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

Method Details

as

public GeoIndexParams as(String as)

Description copied from interface: GeoIndex

Defines the attribute associated to the field name

Specified by:

as in interface GeoIndex

Parameters:

as - the associated attribute

Returns:

options object

sortMode

public GeoIndexParams sortMode(SortMode sortMode)

Description copied from interface: GeoIndex

Defines sort mode applied to the value of this attribute

Specified by:

sortMode in interface GeoIndex

Parameters:

sortMode - sort mode

Returns:

options object

noIndex

public GeoIndexParams noIndex()

Description copied from interface: GeoIndex

Defines to not index this attribute

Specified by:

noIndex in interface GeoIndex

Returns:

options object

indexMissing

public GeoIndexParams indexMissing()

Description copied from interface: GeoIndex

Defines to index documents that don't contain this attribute

Specified by:

indexMissing in interface GeoIndex

Returns:

options object

getSortMode

public SortMode getSortMode()

isNoIndex

public boolean isNoIndex()

getFieldName

public String getFieldName()

getAs

public String getAs()

isIndexMissing

public boolean isIndexMissing()