com.algolia.search

Interface SyncSearchForFacet<T>

All Superinterfaces:

AbstractIndex<T>, Serializable, SyncBaseIndex<T>

All Known Implementing Classes:

Index

public interface SyncSearchForFacet<T>
extends SyncBaseIndex<T>

Method Summary

Modifier and Type	Method and Description
default SearchFacetResult	searchFacet(String facetName, String facetQuery) Deprecated.
default SearchFacetResult	searchFacet(String facetName, String facetQuery, Query query) Deprecated.
default SearchFacetResult	searchForFacetValues(String facetName, String facetQuery) Search in a facet throws a AlgoliaIndexNotFoundException if the index does not exists
default SearchFacetResult	searchForFacetValues(String facetName, String facetQuery, Query query) Search in a facet throws a AlgoliaIndexNotFoundException if the index does not exists
default SearchFacetResult	searchForFacetValues(String facetName, String facetQuery, Query query, RequestOptions requestOptions) Search in a facet throws a AlgoliaIndexNotFoundException if the index does not exists
default SearchFacetResult	searchForFacetValues(String facetName, String facetQuery, RequestOptions requestOptions) Search in a facet throws a AlgoliaIndexNotFoundException if the index does not exists
default SearchFacetResult	searchInFacetValues(String facetName, String facetQuery) Deprecated.
default SearchFacetResult	searchInFacetValues(String facetName, String facetQuery, Query query) Deprecated.

Methods inherited from interface com.algolia.search.SyncBaseIndex

getApiClient

Methods inherited from interface com.algolia.search.AbstractIndex

getKlass, getName

Method Detail

searchForFacetValues

default SearchFacetResult searchForFacetValues(@Nonnull
                                               String facetName,
                                               @Nonnull
                                               String facetQuery,
                                               Query query)
                                        throws AlgoliaException

Search in a facet throws a AlgoliaIndexNotFoundException if the index does not exists

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

Throws:

AlgoliaException

searchForFacetValues

default SearchFacetResult searchForFacetValues(@Nonnull
                                               String facetName,
                                               @Nonnull
                                               String facetQuery,
                                               Query query,
                                               @Nonnull
                                               RequestOptions requestOptions)
                                        throws AlgoliaException

Search in a facet throws a AlgoliaIndexNotFoundException if the index does not exists

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

Throws:

AlgoliaException

searchForFacetValues

default SearchFacetResult searchForFacetValues(@Nonnull
                                               String facetName,
                                               @Nonnull
                                               String facetQuery)
                                        throws AlgoliaException

Search in a facet throws a AlgoliaIndexNotFoundException if the index does not exists

Parameters:

facetName - The name of the facet to search in

facetQuery - The search query for this facet

Returns:

the result of the search

Throws:

AlgoliaException

searchForFacetValues

default SearchFacetResult searchForFacetValues(@Nonnull
                                               String facetName,
                                               @Nonnull
                                               String facetQuery,
                                               @Nonnull
                                               RequestOptions requestOptions)
                                        throws AlgoliaException

Search in a facet throws a AlgoliaIndexNotFoundException if the index does not exists

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

Throws:

AlgoliaException

searchInFacetValues

@Deprecated
default SearchFacetResult searchInFacetValues(@Nonnull
                                                          String facetName,
                                                          @Nonnull
                                                          String facetQuery,
                                                          Query query)
                                                   throws AlgoliaException

Deprecated.

Deprecated: use searchForFacetValues(String, String, Query)

Throws:

AlgoliaException

searchInFacetValues

@Deprecated
default SearchFacetResult searchInFacetValues(@Nonnull
                                                          String facetName,
                                                          @Nonnull
                                                          String facetQuery)
                                                   throws AlgoliaException

Deprecated.

Deprecated: use searchForFacetValues(String, String)

Throws:

AlgoliaException

searchFacet

@Deprecated
default SearchFacetResult searchFacet(@Nonnull
                                                  String facetName,
                                                  @Nonnull
                                                  String facetQuery,
                                                  Query query)
                                           throws AlgoliaException

Deprecated.

Deprecated: use searchForFacetValues(String, String, Query)

Throws:

AlgoliaException

searchFacet

@Deprecated
default SearchFacetResult searchFacet(@Nonnull
                                                  String facetName,
                                                  @Nonnull
                                                  String facetQuery)
                                           throws AlgoliaException

Deprecated.

Deprecated: use searchForFacetValues(String, String)

Throws:

AlgoliaException