io.lettuce.core.search.arguments

Class GeoFieldArgs

java.lang.Object

io.lettuce.core.search.arguments.FieldArgs

io.lettuce.core.search.arguments.GeoFieldArgs

public class GeoFieldArgs
extends FieldArgs

Field arguments for GEO fields in a RediSearch index.

Geo fields are used to store geographical coordinates such as longitude and latitude. They enable geospatial radius queries, which allow you to implement location-based search functionality in your applications such as finding nearby restaurants, stores, or any other points of interest.

Since:

6.8

Author:

Tihomir Mateev

See Also:

Geo Fields

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeoFieldArgs.Builder Builder for GeoFieldArgs.

Field Summary

Fields inherited from class io.lettuce.core.search.arguments.FieldArgs

as, indexEmpty, indexMissing, name, noIndex, sortable, unNormalizedForm

Constructor Summary

Constructors

Constructor and Description
GeoFieldArgs()

Method Summary

Modifier and Type	Method and Description
static GeoFieldArgs.Builder	builder() Create a new GeoFieldArgs using the builder pattern.
protected void	buildTypeSpecificArgs(CommandArgs<?,?> args) Add type-specific arguments to the command.
String	getFieldType() Returns the field type.

Methods inherited from class io.lettuce.core.search.arguments.FieldArgs

build, getAs, getName, isIndexEmpty, isIndexMissing, isNoIndex, isSortable, isUnNormalizedForm

Methods inherited from class java.lang.Object

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

Constructor Detail

GeoFieldArgs

public GeoFieldArgs()

Method Detail

builder

public static GeoFieldArgs.Builder builder()

Create a new GeoFieldArgs using the builder pattern.

Returns:

a new GeoFieldArgs.Builder

getFieldType

public String getFieldType()

Description copied from class: FieldArgs

Returns the field type. Subclasses must implement this method.

Specified by:

getFieldType in class FieldArgs

Returns:

the field type

buildTypeSpecificArgs

protected void buildTypeSpecificArgs(CommandArgs<?,?> args)

Description copied from class: FieldArgs

Add type-specific arguments to the command. Subclasses should override this method to add their specific arguments.

Specified by:

buildTypeSpecificArgs in class FieldArgs

Parameters:

args - the command arguments to modify