io.lettuce.core.search.arguments

Class CreateArgs<K,V>

java.lang.Object

io.lettuce.core.search.arguments.CreateArgs<K,V>

Type Parameters:

K - Key type.

V - Value type.

public class CreateArgs<K,V>
extends Object

Argument list builder for FT.CREATE.

Since:

6.8

Author:

Tihomir Mateev

See Also:

FT.CREATE

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateArgs.Builder<K,V> Builder for CreateArgs.
static class	CreateArgs.TargetType Possible target types for the index.

Constructor Summary

Constructors

Constructor and Description
CreateArgs()

Method Summary

Modifier and Type	Method and Description
void	build(CommandArgs<K,V> args) Build a CommandArgs object that contains all the arguments.
static <K,V> CreateArgs.Builder<K,V>	builder() Used to build a new instance of the CreateArgs.
Optional<DocumentLanguage>	getDefaultLanguage() Get the default language for the documents in the index.
OptionalDouble	getDefaultScore() Get the default score for the documents in the index.
Optional<V>	getFilter() Get the filter for the index.
Optional<K>	getLanguageField() Get the field that contains the language setting for the documents in the index.
Optional<CreateArgs.TargetType>	getOn() Get the target type for the index.
Optional<K>	getPayloadField() Get the field that contains the payload setting for the documents in the index.
List<K>	getPrefixes() Get the prefixes for the index.
Optional<K>	getScoreField() Get the field that contains the score setting for the documents in the index.
Optional<List<V>>	getStopWords() Get the stop words for the index.
OptionalLong	getTemporary() Get the temporary index expiration time in seconds.
boolean	isMaxTextFields() Get the maximum number of text fields in the index.
boolean	isNoFields() Get the no fields flag.
boolean	isNoFrequency() Get the no frequency flag.
boolean	isNoHighlight() Get the no highlighting flag.
boolean	isNoOffsets() Get the no offsets flag.
boolean	isSkipInitialScan() Get the skip initial scan flag.

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateArgs

public CreateArgs()

Method Detail

builder

public static <K,V> CreateArgs.Builder<K,V> builder()

Used to build a new instance of the CreateArgs.

Type Parameters:

K - the key type

V - the value type

Returns:

a CreateArgs.Builder that provides the option to build up a new instance of the CreateArgs

getOn

public Optional<CreateArgs.TargetType> getOn()

Get the target type for the index.

Returns:

the target type

See Also:

CreateArgs.TargetType, Builder#on(TargetType)

getPrefixes

public List<K> getPrefixes()

Get the prefixes for the index.

Returns:

the prefixes

See Also:

CreateArgs.Builder.withPrefix(Object), CreateArgs.Builder.withPrefixes(List)

getFilter

public Optional<V> getFilter()

Get the filter for the index.

Returns:

the filter

See Also:

CreateArgs.Builder.filter(Object)

getDefaultLanguage

public Optional<DocumentLanguage> getDefaultLanguage()

Get the default language for the documents in the index.

Returns:

the default language

See Also:

CreateArgs.Builder.defaultLanguage(DocumentLanguage)

getLanguageField

public Optional<K> getLanguageField()

Get the field that contains the language setting for the documents in the index.

Returns:

the language field

See Also:

CreateArgs.Builder.languageField(Object)

getDefaultScore

public OptionalDouble getDefaultScore()

Get the default score for the documents in the index.

Returns:

the default score

See Also:

CreateArgs.Builder.defaultScore(double)

getScoreField

public Optional<K> getScoreField()

Get the field that contains the score setting for the documents in the index.

Returns:

the score field

See Also:

CreateArgs.Builder.scoreField(Object)

getPayloadField

public Optional<K> getPayloadField()

Get the field that contains the payload setting for the documents in the index.

Returns:

the payload field

See Also:

CreateArgs.Builder.payloadField(Object)

isMaxTextFields

public boolean isMaxTextFields()

Get the maximum number of text fields in the index.

Returns:

the maximum number of text fields

See Also:

CreateArgs.Builder.maxTextFields()

getTemporary

public OptionalLong getTemporary()

Get the temporary index expiration time in seconds.

Returns:

the temporary index expiration time in seconds

See Also:

CreateArgs.Builder.temporary(long)

isNoOffsets

public boolean isNoOffsets()

Get the no offsets flag.

Returns:

the no offsets flag

See Also:

CreateArgs.Builder.noOffsets()

isNoHighlight

public boolean isNoHighlight()

Get the no highlighting flag.

Returns:

the no highlighting flag

See Also:

CreateArgs.Builder.noHighlighting()

isNoFields

public boolean isNoFields()

Get the no fields flag.

Returns:

the no fields flag

See Also:

CreateArgs.Builder.noFields()

isNoFrequency

public boolean isNoFrequency()

Get the no frequency flag.

Returns:

the no frequency flag

See Also:

CreateArgs.Builder.noFrequency()

isSkipInitialScan

public boolean isSkipInitialScan()

Get the skip initial scan flag.

Returns:

the skip initial scan flag

See Also:

CreateArgs.Builder.skipInitialScan()

getStopWords

public Optional<List<V>> getStopWords()

Get the stop words for the index.

Returns:

the stop words

See Also:

CreateArgs.Builder.stopWords(List)

build

public void build(CommandArgs<K,V> args)

Build a CommandArgs object that contains all the arguments.

Parameters:

args - the CommandArgs object