io.lettuce.core.search.arguments.hybrid

Class PostProcessingArgs.Builder

java.lang.Object

io.lettuce.core.search.arguments.hybrid.PostProcessingArgs.Builder

Enclosing class:

PostProcessingArgs

public static class PostProcessingArgs.Builder
extends Object

Builder for PostProcessingArgs.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
PostProcessingArgs.Builder	apply(Apply apply) Add an APPLY operation to the pipeline.
PostProcessingArgs	build() Build the PostProcessingArgs.
PostProcessingArgs.Builder	filter(Filter filter) Add a FILTER operation to the pipeline.
PostProcessingArgs.Builder	groupBy(GroupBy groupBy) Add a GROUPBY operation to the pipeline.
PostProcessingArgs.Builder	limit(Limit limit) Add a LIMIT operation to the pipeline.
PostProcessingArgs.Builder	load(String... fields) Request loading of document attributes.
PostProcessingArgs.Builder	loadAll() Load all document attributes.
PostProcessingArgs.Builder	sortBy(SortBy sortBy) Add a SORTBY operation to the pipeline.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

load

@SafeVarargs
public final PostProcessingArgs.Builder load(String... fields)

Request loading of document attributes.

Note: To load all attributes, use loadAll() instead of passing "*" as a field. Passing "*" as a field name will result in an IllegalArgumentException.

Parameters:

fields - the field identifiers (must not include "*")

Returns:

this builder

Throws:

IllegalArgumentException - if "*" is passed as a field name

loadAll

public PostProcessingArgs.Builder loadAll()

Load all document attributes.

Equivalent to using LOAD * in the Redis command. This loads all attributes from the source documents. Use with caution as this can significantly impact performance when dealing with large documents or many results.

Note: This feature requires Redis OSS 8.6 or later.

Returns:

this builder

Since:

Redis OSS 8.6

groupBy

public PostProcessingArgs.Builder groupBy(GroupBy groupBy)

Add a GROUPBY operation to the pipeline.

Groups results by one or more properties with optional reducer functions. Only one GROUPBY operation is allowed per pipeline.

Parameters:

groupBy - the GROUPBY operation

Returns:

this builder

Throws:

IllegalStateException - if a GROUPBY operation has already been added

sortBy

public PostProcessingArgs.Builder sortBy(SortBy sortBy)

Add a SORTBY operation to the pipeline.

Sorts results by one or more properties. Only one SORTBY operation is allowed per pipeline.

Parameters:

sortBy - the SORTBY operation

Returns:

this builder

Throws:

IllegalStateException - if a SORTBY operation has already been added

limit

public PostProcessingArgs.Builder limit(Limit limit)

Add a LIMIT operation to the pipeline.

Limits the number of results returned. Only one LIMIT operation is allowed per pipeline.

Parameters:

limit - the LIMIT operation

Returns:

this builder

Throws:

IllegalStateException - if a LIMIT operation has already been added

apply

public PostProcessingArgs.Builder apply(Apply apply)

Add an APPLY operation to the pipeline.

Applies an expression to create a computed field. Multiple APPLY operations can be added.

Parameters:

apply - the APPLY operation

Returns:

this builder

filter

public PostProcessingArgs.Builder filter(Filter filter)

Add a FILTER operation to the pipeline.

Filters results based on an expression. Only one FILTER operation is allowed per pipeline.

Parameters:

filter - the FILTER operation

Returns:

this builder

Throws:

IllegalStateException - if a FILTER operation has already been added

build

public PostProcessingArgs build()

Build the PostProcessingArgs.

Returns:

the built PostProcessingArgs