Package glide.api.models.commands.FT

Class FTAggregateOptions.FTAggregateOptionsBuilder

java.lang.Object

glide.api.models.commands.FT.FTAggregateOptions.FTAggregateOptionsBuilder

Enclosing class:

FTAggregateOptions

public static class FTAggregateOptions.FTAggregateOptionsBuilder
extends java.lang.Object

Method Summary

Modifier and Type	Method	Description
FTAggregateOptions.FTAggregateOptionsBuilder	addClause(@NonNull FTAggregateOptions.FTAggregateClause clause)	Add FTAggregateOptions.Filter, FTAggregateOptions.Limit, FTAggregateOptions.GroupBy, FTAggregateOptions.SortBy or FTAggregateOptions.Apply clause to the pipeline, that can be repeated multiple times in any order and be freely intermixed.
FTAggregateOptions	build()
FTAggregateOptions.FTAggregateOptionsBuilder	clauses(java.util.List<FTAggregateOptions.FTAggregateClause> clauses)
FTAggregateOptions.FTAggregateOptionsBuilder	dialect(int dialect)	Set the query dialect version.
FTAggregateOptions.FTAggregateOptionsBuilder	inorder()	If set, proximity matching of terms must be in order.
FTAggregateOptions.FTAggregateOptionsBuilder	loadAll()	Load all fields declared in the index.
FTAggregateOptions.FTAggregateOptionsBuilder	loadFields(@NonNull GlideString[] fields)	Load specified fields from the index.
FTAggregateOptions.FTAggregateOptionsBuilder	loadFields(@NonNull java.lang.String[] fields)	Load specified fields from the index.
FTAggregateOptions.FTAggregateOptionsBuilder	params(java.util.Map<java.lang.String,GlideString> params)	Query parameters, which could be referenced in the query by $ sign, followed by the parameter name.
FTAggregateOptions.FTAggregateOptionsBuilder	slop(int slop)	Set the slop value for proximity matching of terms.
FTAggregateOptions.FTAggregateOptionsBuilder	timeout(java.lang.Integer timeout)	Query timeout in milliseconds.
java.lang.String	toString()
FTAggregateOptions.FTAggregateOptionsBuilder	verbatim()	If set, stemming is not applied to term searches.

Methods inherited from class java.lang.Object

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

Method Detail

loadAll

public FTAggregateOptions.FTAggregateOptionsBuilder loadAll()

Load all fields declared in the index.

loadFields

public FTAggregateOptions.FTAggregateOptionsBuilder loadFields(@NonNull
                                                               @NonNull java.lang.String[] fields)

Load specified fields from the index.

loadFields

public FTAggregateOptions.FTAggregateOptionsBuilder loadFields(@NonNull
                                                               @NonNull GlideString[] fields)

Load specified fields from the index.

addClause

public FTAggregateOptions.FTAggregateOptionsBuilder addClause(@NonNull
                                                              @NonNull FTAggregateOptions.FTAggregateClause clause)

Add FTAggregateOptions.Filter, FTAggregateOptions.Limit, FTAggregateOptions.GroupBy, FTAggregateOptions.SortBy or FTAggregateOptions.Apply clause to the pipeline, that can be repeated multiple times in any order and be freely intermixed. They are applied in the order specified, with the output of one clause feeding the input of the next clause.

verbatim

public FTAggregateOptions.FTAggregateOptionsBuilder verbatim()

If set, stemming is not applied to term searches.

inorder

public FTAggregateOptions.FTAggregateOptionsBuilder inorder()

If set, proximity matching of terms must be in order.

slop

public FTAggregateOptions.FTAggregateOptionsBuilder slop(int slop)

Set the slop value for proximity matching of terms.

Parameters:

slop - The maximum number of intervening terms allowed between query terms.

dialect

public FTAggregateOptions.FTAggregateOptionsBuilder dialect(int dialect)

Set the query dialect version.

Parameters:

dialect - The dialect version.

timeout

public FTAggregateOptions.FTAggregateOptionsBuilder timeout(java.lang.Integer timeout)

Query timeout in milliseconds.

Returns:

this.

clauses

public FTAggregateOptions.FTAggregateOptionsBuilder clauses(java.util.List<FTAggregateOptions.FTAggregateClause> clauses)

Returns:

this.

params

public FTAggregateOptions.FTAggregateOptionsBuilder params(java.util.Map<java.lang.String,GlideString> params)

Query parameters, which could be referenced in the query by $ sign, followed by the parameter name.

Returns:

this.

build

public FTAggregateOptions build()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object