Package glide.api.models.commands.FT

Class FTProfileOptions

java.lang.Object

glide.api.models.commands.FT.FTProfileOptions

public class FTProfileOptions
extends java.lang.Object

Mandatory parameters for FT.profile(glide.api.BaseClient, java.lang.String, glide.api.models.commands.FT.FTProfileOptions) command.

Constructor Summary

Constructors

Constructor	Description
FTProfileOptions(@NonNull GlideString query, @NonNull FTAggregateOptions options)	Profile an aggregation query with given parameters.
FTProfileOptions(@NonNull GlideString query, @NonNull FTAggregateOptions options, boolean limited)	Profile a search query with given parameters.
FTProfileOptions(@NonNull GlideString query, @NonNull FTSearchOptions options)	Profile a search query with given parameters.
FTProfileOptions(@NonNull GlideString query, @NonNull FTSearchOptions options, boolean limited)	Profile a search query with given parameters.
FTProfileOptions(@NonNull java.lang.String query, @NonNull FTAggregateOptions options)	Profile an aggregation query with given parameters.
FTProfileOptions(@NonNull java.lang.String query, @NonNull FTAggregateOptions options, boolean limited)	Profile an aggregation query with given parameters.
FTProfileOptions(@NonNull java.lang.String query, @NonNull FTSearchOptions options)	Profile a search query with given parameters.
FTProfileOptions(@NonNull java.lang.String query, @NonNull FTSearchOptions options, boolean limited)	Profile an aggregation query with given parameters.

Method Summary

Modifier and Type	Method	Description
GlideString[]	toArgs()	Convert to module API.

Methods inherited from class java.lang.Object

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

Constructor Detail

FTProfileOptions

public FTProfileOptions(@NonNull
                        @NonNull java.lang.String query,
                        @NonNull
                        @NonNull FTAggregateOptions options)

Profile an aggregation query with given parameters.

Parameters:

query - The query itself.

options - FT.aggregate(glide.api.BaseClient, java.lang.String, java.lang.String) options.

FTProfileOptions

public FTProfileOptions(@NonNull
                        @NonNull GlideString query,
                        @NonNull
                        @NonNull FTAggregateOptions options)

Profile an aggregation query with given parameters.

Parameters:

query - The query itself.

options - FT.aggregate(glide.api.BaseClient, java.lang.String, java.lang.String) options.

FTProfileOptions

public FTProfileOptions(@NonNull
                        @NonNull java.lang.String query,
                        @NonNull
                        @NonNull FTSearchOptions options)

Profile a search query with given parameters.

Parameters:

query - The query itself.

options - FT.search(glide.api.BaseClient, java.lang.String, java.lang.String, glide.api.models.commands.FT.FTSearchOptions) options.

FTProfileOptions

public FTProfileOptions(@NonNull
                        @NonNull GlideString query,
                        @NonNull
                        @NonNull FTSearchOptions options)

Profile a search query with given parameters.

Parameters:

query - The query itself.

options - FT.search(glide.api.BaseClient, java.lang.String, java.lang.String, glide.api.models.commands.FT.FTSearchOptions) options.

FTProfileOptions

public FTProfileOptions(@NonNull
                        @NonNull java.lang.String query,
                        @NonNull
                        @NonNull FTAggregateOptions options,
                        boolean limited)

Profile an aggregation query with given parameters.

Parameters:

query - The query itself.

options - FT.aggregate(glide.api.BaseClient, java.lang.String, java.lang.String) options.

limited - Either provide a full verbose output or some brief version (limited).

FTProfileOptions

public FTProfileOptions(@NonNull
                        @NonNull GlideString query,
                        @NonNull
                        @NonNull FTAggregateOptions options,
                        boolean limited)

Profile a search query with given parameters.

Parameters:

query - The query itself.

options - FT.search(glide.api.BaseClient, java.lang.String, java.lang.String, glide.api.models.commands.FT.FTSearchOptions) options.

limited - Either provide a full verbose output or some brief version (limited).

FTProfileOptions

public FTProfileOptions(@NonNull
                        @NonNull java.lang.String query,
                        @NonNull
                        @NonNull FTSearchOptions options,
                        boolean limited)

Profile an aggregation query with given parameters.

Parameters:

query - The query itself.

options - FT.aggregate(glide.api.BaseClient, java.lang.String, java.lang.String) options.

limited - Either provide a full verbose output or some brief version (limited).

FTProfileOptions

public FTProfileOptions(@NonNull
                        @NonNull GlideString query,
                        @NonNull
                        @NonNull FTSearchOptions options,
                        boolean limited)

Profile a search query with given parameters.

Parameters:

query - The query itself.

options - FT.search(glide.api.BaseClient, java.lang.String, java.lang.String, glide.api.models.commands.FT.FTSearchOptions) options.

limited - Either provide a full verbose output or some brief version (limited).

Method Detail

toArgs

public GlideString[] toArgs()

Convert to module API.