Package redis.clients.jedis.search

Class IndexDefinition

java.lang.Object

redis.clients.jedis.search.IndexDefinition

All Implemented Interfaces:

IParams

public class IndexDefinition
extends Object
implements IParams

IndexDefinition encapsulates configuration for index definition creation and should be given to the client on index creation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	IndexDefinition.Type

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	async
private String	filter
private String	language
private String	languageField
private String	payloadField
private String[]	prefixes
private double	score
private String	scoreFiled
private final IndexDefinition.Type	type

Constructor Summary

Constructors

Constructor	Description
IndexDefinition()
IndexDefinition(IndexDefinition.Type type)

Method Summary

Modifier and Type	Method	Description
void	addParams(CommandArguments args)
String	getFilter()
String	getLanguage()
String	getLanguageField()
String	getPayloadField()	Deprecated.
String[]	getPrefixes()
double	getScore()
String	getScoreFiled()
IndexDefinition.Type	getType()
boolean	isAsync()
IndexDefinition	setAsync(boolean async)
IndexDefinition	setFilter(String filter)
IndexDefinition	setLanguage(String language)
IndexDefinition	setLanguageField(String languageField)
IndexDefinition	setPayloadField(String payloadField)	Deprecated. Since RediSearch 2.0.0, PAYLOAD_FIELD option is deprecated.
IndexDefinition	setPrefixes(String... prefixes)
IndexDefinition	setScore(double score)
IndexDefinition	setScoreFiled(String scoreFiled)

Methods inherited from class java.lang.Object

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

Field Details

type

private final IndexDefinition.Type type

async

private boolean async

prefixes

private String[] prefixes

filter

private String filter

languageField

private String languageField

language

private String language

scoreFiled

private String scoreFiled

score

private double score

payloadField

private String payloadField

Constructor Details

IndexDefinition

public IndexDefinition()

IndexDefinition

public IndexDefinition(IndexDefinition.Type type)

Method Details

getType

public IndexDefinition.Type getType()

isAsync

public boolean isAsync()

setAsync

public IndexDefinition setAsync(boolean async)

getPrefixes

public String[] getPrefixes()

setPrefixes

public IndexDefinition setPrefixes(String... prefixes)

getFilter

public String getFilter()

setFilter

public IndexDefinition setFilter(String filter)

getLanguageField

public String getLanguageField()

setLanguageField

public IndexDefinition setLanguageField(String languageField)

getLanguage

public String getLanguage()

setLanguage

public IndexDefinition setLanguage(String language)

getScoreFiled

public String getScoreFiled()

setScoreFiled

public IndexDefinition setScoreFiled(String scoreFiled)

getScore

public double getScore()

setScore

public IndexDefinition setScore(double score)

getPayloadField

@Deprecated
public String getPayloadField()

Deprecated.

setPayloadField

@Deprecated
public IndexDefinition setPayloadField(String payloadField)

Deprecated.

Since RediSearch 2.0.0, PAYLOAD_FIELD option is deprecated.

addParams

public void addParams(CommandArguments args)

Specified by:

addParams in interface IParams