Package com.algolia.search

Interface AsyncSearchForFacet<T>

All Superinterfaces:

AbstractIndex<T>, AsyncBaseIndex<T>, Serializable

All Known Implementing Classes:

AsyncIndex

public interface AsyncSearchForFacet<T>
extends AsyncBaseIndex<T>

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<SearchFacetResult>	searchFacet(String facetName, String facetQuery)	Deprecated.
default CompletableFuture<SearchFacetResult>	searchFacet(String facetName, String facetQuery, Query query)	Deprecated.
default CompletableFuture<SearchFacetResult>	searchForFacetValues(String facetName, String facetQuery)	Search in a facet
default CompletableFuture<SearchFacetResult>	searchForFacetValues(String facetName, String facetQuery, Query query)	Search in a facet
default CompletableFuture<SearchFacetResult>	searchForFacetValues(String facetName, String facetQuery, Query query, RequestOptions requestOptions)	Search in a facet
default CompletableFuture<SearchFacetResult>	searchForFacetValues(String facetName, String facetQuery, RequestOptions requestOptions)	Search in a facet
default CompletableFuture<SearchFacetResult>	searchInFacetValues(String facetName, String facetQuery)	Deprecated.
default CompletableFuture<SearchFacetResult>	searchInFacetValues(String facetName, String facetQuery, Query query)	Deprecated.

Methods inherited from interface com.algolia.search.AbstractIndex

getKlass, getName

Methods inherited from interface com.algolia.search.AsyncBaseIndex

getApiClient

Method Detail

searchForFacetValues

default CompletableFuture<SearchFacetResult> searchForFacetValues(@Nonnull
                                                                  String facetName,
                                                                  @Nonnull
                                                                  String facetQuery,
                                                                  Query query)

Search in a facet

Parameters:

facetName - The name of the facet to search in

facetQuery - The search query for this facet

query - the query (not required)

Returns:

the result of the search

searchForFacetValues

default CompletableFuture<SearchFacetResult> searchForFacetValues(@Nonnull
                                                                  String facetName,
                                                                  @Nonnull
                                                                  String facetQuery,
                                                                  Query query,
                                                                  @Nonnull
                                                                  RequestOptions requestOptions)

Search in a facet

Parameters:

facetName - The name of the facet to search in

facetQuery - The search query for this facet

query - the query (not required)

requestOptions - Options to pass to this request

Returns:

the result of the search

searchForFacetValues

default CompletableFuture<SearchFacetResult> searchForFacetValues(@Nonnull
                                                                  String facetName,
                                                                  @Nonnull
                                                                  String facetQuery)

Search in a facet

Parameters:

facetName - The name of the facet to search in

facetQuery - The search query for this facet

Returns:

the result of the search

searchForFacetValues

default CompletableFuture<SearchFacetResult> searchForFacetValues(@Nonnull
                                                                  String facetName,
                                                                  @Nonnull
                                                                  String facetQuery,
                                                                  @Nonnull
                                                                  RequestOptions requestOptions)

Search in a facet

Parameters:

facetName - The name of the facet to search in

facetQuery - The search query for this facet

requestOptions - Options to pass to this request

Returns:

the result of the search

searchInFacetValues

@Deprecated
default CompletableFuture<SearchFacetResult> searchInFacetValues(@Nonnull
                                                                 String facetName,
                                                                 @Nonnull
                                                                 String facetQuery,
                                                                 Query query)

Deprecated.

Deprecated: use searchForFacetValues(String, String, Query)

searchInFacetValues

@Deprecated
default CompletableFuture<SearchFacetResult> searchInFacetValues(@Nonnull
                                                                 String facetName,
                                                                 @Nonnull
                                                                 String facetQuery)

Deprecated.

Deprecated: use searchForFacetValues(String, String)

searchFacet

@Deprecated
default CompletableFuture<SearchFacetResult> searchFacet(@Nonnull
                                                         String facetName,
                                                         @Nonnull
                                                         String facetQuery,
                                                         Query query)

Deprecated.

Deprecated: use searchForFacetValues(String, String, Query)

searchFacet

@Deprecated
default CompletableFuture<SearchFacetResult> searchFacet(@Nonnull
                                                         String facetName,
                                                         @Nonnull
                                                         String facetQuery)

Deprecated.

Deprecated: use searchForFacetValues(String, String)