Package com.algolia.search

Interface SearchClientAdvanced

All Superinterfaces:

SearchClientBase

All Known Implementing Classes:

SearchClient

public interface SearchClientAdvanced
extends SearchClientBase

Method Summary

Modifier and Type	Method	Description
default <U> U	customRequest(Class<U> returnClazz, HttpMethod httpMethod, String path, CallType callType)	Executes a custom to the Algolia API under the retry strategy.
default <U> U	customRequest(Class<U> returnClazz, HttpMethod httpMethod, String path, CallType callType, RequestOptions requestOptions)	Executes a custom to the Algolia API under the retry strategy.
default <T,U> U	customRequest(T data, Class<U> returnClazz, HttpMethod httpMethod, String path, CallType callType)	Executes a custom to the Algolia API under the retry strategy.
default <T,U> U	customRequest(T data, Class<U> returnClazz, HttpMethod httpMethod, String path, CallType callType, RequestOptions requestOptions)	Executes a custom to the Algolia API under the retry strategy.
default <U> CompletableFuture<U>	customRequestAsync(Class<U> returnClazz, HttpMethod httpMethod, String path, CallType callType)	Executes a custom to the Algolia API under the retry strategy.
default <U> CompletableFuture<U>	customRequestAsync(Class<U> returnClazz, HttpMethod httpMethod, String path, CallType callType, RequestOptions requestOptions)	Executes a custom to the Algolia API under the retry strategy.
default <T,U> CompletableFuture<U>	customRequestAsync(T data, Class<U> returnClazz, HttpMethod httpMethod, String path, CallType callType)	Executes a custom to the Algolia API under the retry strategy.
default <T,U> CompletableFuture<U>	customRequestAsync(T data, Class<U> returnClazz, HttpMethod httpMethod, String path, CallType callType, RequestOptions requestOptions)	Executes a custom to the Algolia API under the retry strategy.
default List<Log>	getLogs()	Get the logs of the latest search and indexing operations You can retrieve the logs of your last 1,000 API calls.
default List<Log>	getLogs(int offset, int length)	Get the logs of the latest search and indexing operations You can retrieve the logs of your last 1,000 API calls.
default List<Log>	getLogs(int offset, int length, RequestOptions requestOptions)	Get the logs of the latest search and indexing operations You can retrieve the logs of your last 1,000 API calls.
default List<Log>	getLogs(int offset, int length, String logType)	Get the logs of the latest search and indexing operations You can retrieve the logs of your last 1,000 API calls.
default List<Log>	getLogs(RequestOptions requestOptions)	Get the logs of the latest search and indexing operations You can retrieve the logs of your last 1,000 API calls.
default CompletableFuture<List<Log>>	getLogsAsync()	Get the logs of the latest search and indexing operations You can retrieve the logs of your last 1,000 API calls.
default CompletableFuture<List<Log>>	getLogsAsync(int offset, int length)	Get the logs of the latest search and indexing operations You can retrieve the logs of your last 1,000 API calls.
default CompletableFuture<List<Log>>	getLogsAsync(int offset, int length, String logType)	Get the logs of the latest search and indexing operations You can retrieve the logs of your last 1,000 API calls.
default CompletableFuture<List<Log>>	getLogsAsync(int offset, int length, String logType, RequestOptions requestOptions)	Get the logs of the latest search and indexing operations You can retrieve the logs of your last 1,000 API calls.
default CompletableFuture<List<Log>>	getLogsAsync(RequestOptions requestOptions)	Get the logs of the latest search and indexing operations You can retrieve the logs of your last 1,000 API calls.
default List<IndicesResponse>	listIndices()	List all existing indexes
default List<IndicesResponse>	listIndices(RequestOptions requestOptions)	List all existing indexes
default CompletableFuture<List<IndicesResponse>>	listIndicesAsync()	List asynchronously all existing indexes
default CompletableFuture<List<IndicesResponse>>	listIndicesAsync(RequestOptions requestOptions)	List asynchronously all existing indexes

Methods inherited from interface com.algolia.search.SearchClientBase

getConfig, getTransport, waitAppTask, waitAppTask, waitTask, waitTask

Method Detail

listIndices

default List<IndicesResponse> listIndices()

List all existing indexes

Returns:

A List of the indices and their metadata

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

listIndices

default List<IndicesResponse> listIndices(RequestOptions requestOptions)

List all existing indexes

Parameters:

requestOptions - Options to pass to this request

Returns:

A List of the indices and their metadata

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

listIndicesAsync

default CompletableFuture<List<IndicesResponse>> listIndicesAsync()

List asynchronously all existing indexes

Returns:

A List of the indices and their metadata

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

listIndicesAsync

default CompletableFuture<List<IndicesResponse>> listIndicesAsync(RequestOptions requestOptions)

List asynchronously all existing indexes

Parameters:

requestOptions - Options to pass to this request

Returns:

A List of the indices and their metadata

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getLogs

default List<Log> getLogs()

Get the logs of the latest search and indexing operations You can retrieve the logs of your last 1,000 API calls. It is designed for immediate, real-time debugging.

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getLogs

default List<Log> getLogs(RequestOptions requestOptions)

Get the logs of the latest search and indexing operations You can retrieve the logs of your last 1,000 API calls. It is designed for immediate, real-time debugging.

Parameters:

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getLogs

default List<Log> getLogs(int offset,
                          int length)

Get the logs of the latest search and indexing operations You can retrieve the logs of your last 1,000 API calls. It is designed for immediate, real-time debugging.

Parameters:

offset - Specify the first entry to retrieve (0-based, 0 is the most recent log entry).

length - Specify the maximum number of entries to retrieve starting at the offset. Maximum allowed value: 1,000.

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getLogs

default List<Log> getLogs(int offset,
                          int length,
                          @Nonnull
                          String logType)

Get the logs of the latest search and indexing operations You can retrieve the logs of your last 1,000 API calls. It is designed for immediate, real-time debugging.

Parameters:

offset - Specify the first entry to retrieve (0-based, 0 is the most recent log entry).

length - Specify the maximum number of entries to retrieve starting at the offset. Maximum allowed value: 1,000.

logType - Log type values can be found in LogType

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getLogs

default List<Log> getLogs(int offset,
                          int length,
                          RequestOptions requestOptions)

Get the logs of the latest search and indexing operations You can retrieve the logs of your last 1,000 API calls. It is designed for immediate, real-time debugging.

Parameters:

offset - Specify the first entry to retrieve (0-based, 0 is the most recent log entry).

length - Specify the maximum number of entries to retrieve starting at the offset. Maximum allowed value: 1,000.

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getLogsAsync

default CompletableFuture<List<Log>> getLogsAsync()

Get the logs of the latest search and indexing operations You can retrieve the logs of your last 1,000 API calls. It is designed for immediate, real-time debugging.

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getLogsAsync

default CompletableFuture<List<Log>> getLogsAsync(int offset,
                                                  int length)

Get the logs of the latest search and indexing operations You can retrieve the logs of your last 1,000 API calls. It is designed for immediate, real-time debugging.

Parameters:

offset - Specify the first entry to retrieve (0-based, 0 is the most recent log entry).

length - Specify the maximum number of entries to retrieve starting at the offset. Maximum allowed value: 1,000.

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getLogsAsync

default CompletableFuture<List<Log>> getLogsAsync(int offset,
                                                  int length,
                                                  @Nonnull
                                                  String logType)

Get the logs of the latest search and indexing operations You can retrieve the logs of your last 1,000 API calls. It is designed for immediate, real-time debugging.

Parameters:

offset - Specify the first entry to retrieve (0-based, 0 is the most recent log entry).

length - Specify the maximum number of entries to retrieve starting at the offset. Maximum allowed value: 1,000.

logType - Log type values can be found in LogType

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getLogsAsync

default CompletableFuture<List<Log>> getLogsAsync(RequestOptions requestOptions)

Get the logs of the latest search and indexing operations You can retrieve the logs of your last 1,000 API calls. It is designed for immediate, real-time debugging.

Parameters:

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getLogsAsync

default CompletableFuture<List<Log>> getLogsAsync(int offset,
                                                  int length,
                                                  @Nonnull
                                                  String logType,
                                                  RequestOptions requestOptions)

Get the logs of the latest search and indexing operations You can retrieve the logs of your last 1,000 API calls. It is designed for immediate, real-time debugging.

Parameters:

offset - Specify the first entry to retrieve (0-based, 0 is the most recent log entry).

length - Specify the maximum number of entries to retrieve starting at the offset. Maximum allowed value: 1,000.

logType - Log type values can be found in LogType

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

customRequest

default <T,U> U customRequest(T data,
                                    Class<U> returnClazz,
                                    @Nonnull
                                    HttpMethod httpMethod,
                                    @Nonnull
                                    String path,
                                    @Nonnull
                                    CallType callType)

Executes a custom to the Algolia API under the retry strategy.

Type Parameters:

U - The return class

T - The data class

Parameters:

data - The data to send to the API

returnClazz - The return class

httpMethod - The http method. HttpMethod

path - The path to the Algolia REST API method

callType - The CallType. CallType

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

customRequest

default <T,U> U customRequest(T data,
                                    Class<U> returnClazz,
                                    @Nonnull
                                    HttpMethod httpMethod,
                                    @Nonnull
                                    String path,
                                    @Nonnull
                                    CallType callType,
                                    RequestOptions requestOptions)

Executes a custom to the Algolia API under the retry strategy.

Type Parameters:

U - The return class

T - The data class

Parameters:

data - The data to send to the API

returnClazz - The return class

httpMethod - The http method. HttpMethod

path - The path to the Algolia REST API method

callType - The CallType. CallType

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

customRequest

default <U> U customRequest(Class<U> returnClazz,
                            @Nonnull
                            HttpMethod httpMethod,
                            @Nonnull
                            String path,
                            @Nonnull
                            CallType callType)

Executes a custom to the Algolia API under the retry strategy.

Type Parameters:

U - The return class

Parameters:

returnClazz - The return class

httpMethod - The http method. HttpMethod

path - The path to the Algolia REST API method

callType - The CallType. CallType

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

customRequest

default <U> U customRequest(Class<U> returnClazz,
                            @Nonnull
                            HttpMethod httpMethod,
                            @Nonnull
                            String path,
                            @Nonnull
                            CallType callType,
                            RequestOptions requestOptions)

Executes a custom to the Algolia API under the retry strategy.

Type Parameters:

U - The return class

Parameters:

returnClazz - The return class

httpMethod - The http method. HttpMethod

path - The path to the Algolia REST API method

callType - The CallType. CallType

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

customRequestAsync

default <T,U> CompletableFuture<U> customRequestAsync(T data,
                                                            Class<U> returnClazz,
                                                            @Nonnull
                                                            HttpMethod httpMethod,
                                                            @Nonnull
                                                            String path,
                                                            @Nonnull
                                                            CallType callType)

Executes a custom to the Algolia API under the retry strategy.

Type Parameters:

U - The return class

T - The data class

Parameters:

data - The data to send to the API

returnClazz - The return class

httpMethod - The http method. HttpMethod

path - The path to the Algolia REST API method

callType - The CallType. CallType

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

customRequestAsync

default <T,U> CompletableFuture<U> customRequestAsync(T data,
                                                            Class<U> returnClazz,
                                                            @Nonnull
                                                            HttpMethod httpMethod,
                                                            @Nonnull
                                                            String path,
                                                            @Nonnull
                                                            CallType callType,
                                                            RequestOptions requestOptions)

Executes a custom to the Algolia API under the retry strategy.

Type Parameters:

U - The return class

T - The data class

Parameters:

data - The data to send to the API

returnClazz - The return class

httpMethod - The http method. HttpMethod

path - The path to the Algolia REST API method

callType - The CallType. CallType

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

customRequestAsync

default <U> CompletableFuture<U> customRequestAsync(Class<U> returnClazz,
                                                    @Nonnull
                                                    HttpMethod httpMethod,
                                                    @Nonnull
                                                    String path,
                                                    @Nonnull
                                                    CallType callType)

Executes a custom to the Algolia API under the retry strategy.

Type Parameters:

U - The return class

Parameters:

returnClazz - The return class

httpMethod - The http method. HttpMethod

path - The path to the Algolia REST API method

callType - The CallType. CallType

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

customRequestAsync

default <U> CompletableFuture<U> customRequestAsync(Class<U> returnClazz,
                                                    @Nonnull
                                                    HttpMethod httpMethod,
                                                    @Nonnull
                                                    String path,
                                                    @Nonnull
                                                    CallType callType,
                                                    RequestOptions requestOptions)

Executes a custom to the Algolia API under the retry strategy.

Type Parameters:

U - The return class

Parameters:

returnClazz - The return class

httpMethod - The http method. HttpMethod

path - The path to the Algolia REST API method

callType - The CallType. CallType

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization