com.algolia.search

Interface SearchClientMultipleOperations

All Superinterfaces:

SearchClientBase

All Known Implementing Classes:

SearchClient

public interface SearchClientMultipleOperations
extends SearchClientBase

Method Summary

Modifier and Type	Method and Description
default <T> MultipleIndexBatchIndexingResponse	multipleBatch(List<BatchOperation<T>> operations) Perform multiple write operations, potentially targeting multiple indices, in a single API call.
default <T> MultipleIndexBatchIndexingResponse	multipleBatch(List<BatchOperation<T>> operations, RequestOptions requestOptions) Perform multiple write operations, potentially targeting multiple indices, in a single API call.
default <T> CompletableFuture<MultipleIndexBatchIndexingResponse>	multipleBatchAsync(List<BatchOperation<T>> operations) Perform multiple write operations, potentially targeting multiple indices, in a single API call.
default <T> CompletableFuture<MultipleIndexBatchIndexingResponse>	multipleBatchAsync(List<BatchOperation<T>> operations, RequestOptions requestOptions) Perform multiple write operations, potentially targeting multiple indices, in a single API call.
default <T> MultipleGetObjectsResponse<T>	multipleGetObjects(List<MultipleGetObject> queries, Class<T> clazz) Retrieve one or more objects, potentially from different indices, in a single API call.
default <T> MultipleGetObjectsResponse<T>	multipleGetObjects(List<MultipleGetObject> queries, Class<T> clazz, RequestOptions requestOptions) Retrieve one or more objects, potentially from different indices, in a single API call.
default <T> CompletableFuture<MultipleGetObjectsResponse<T>>	multipleGetObjectsAsync(List<MultipleGetObject> queries, Class<T> clazz) Retrieve one or more objects, potentially from different indices, in a single API call.
default <T> CompletableFuture<MultipleGetObjectsResponse<T>>	multipleGetObjectsAsync(List<MultipleGetObject> queries, Class<T> clazz, RequestOptions requestOptions) Retrieve one or more objects, potentially from different indices, in a single API call.
default <T> MultipleQueriesResponse<T>	multipleQueries(MultipleQueriesRequest request, Class<T> clazz) This method allows to send multiple search queries, potentially targeting multiple indices, in a single API call.
default <T> MultipleQueriesResponse<T>	multipleQueries(MultipleQueriesRequest request, Class<T> clazz, RequestOptions requestOptions) This method allows to send multiple search queries, potentially targeting multiple indices, in a single API call.
default <T> CompletableFuture<MultipleQueriesResponse<T>>	multipleQueriesAsync(MultipleQueriesRequest request, Class<T> clazz) This method allows to send multiple search queries, potentially targeting multiple indices, in a single API call.
default <T> CompletableFuture<MultipleQueriesResponse<T>>	multipleQueriesAsync(MultipleQueriesRequest request, Class<T> clazz, RequestOptions requestOptions) This method allows to send multiple search queries, potentially targeting multiple indices, in a single API call.

Methods inherited from interface com.algolia.search.SearchClientBase

getConfig, getTransport, waitTask, waitTask

Method Detail

multipleGetObjects

default <T> MultipleGetObjectsResponse<T> multipleGetObjects(List<MultipleGetObject> queries,
                                                             Class<T> clazz)

Retrieve one or more objects, potentially from different indices, in a single API call.

Type Parameters:

T - Type of the data to retrieve

Parameters:

queries - The query object

clazz - Class of the data to retrieve

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

multipleGetObjects

default <T> MultipleGetObjectsResponse<T> multipleGetObjects(List<MultipleGetObject> queries,
                                                             Class<T> clazz,
                                                             RequestOptions requestOptions)

Retrieve one or more objects, potentially from different indices, in a single API call.

Type Parameters:

T - Type of the data to retrieve

Parameters:

queries - The query object

clazz - Class of the data to retrieve

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

multipleGetObjectsAsync

default <T> CompletableFuture<MultipleGetObjectsResponse<T>> multipleGetObjectsAsync(List<MultipleGetObject> queries,
                                                                                     Class<T> clazz)

Retrieve one or more objects, potentially from different indices, in a single API call.

Type Parameters:

T - Type of the data to retrieve

Parameters:

queries - The query object

clazz - Class of the data to retrieve

multipleGetObjectsAsync

default <T> CompletableFuture<MultipleGetObjectsResponse<T>> multipleGetObjectsAsync(List<MultipleGetObject> queries,
                                                                                     Class<T> clazz,
                                                                                     RequestOptions requestOptions)

Retrieve one or more objects, potentially from different indices, in a single API call.

Type Parameters:

T - Type of the data to retrieve

Parameters:

queries - The query object

clazz - Class of the data to retrieve

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

multipleBatch

default <T> MultipleIndexBatchIndexingResponse multipleBatch(@Nonnull
                                                             List<BatchOperation<T>> operations)

Perform multiple write operations, potentially targeting multiple indices, in a single API call.

Parameters:

operations - The batch operations to process. It could be on multiple indices with multiple actions

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

multipleBatch

default <T> MultipleIndexBatchIndexingResponse multipleBatch(@Nonnull
                                                             List<BatchOperation<T>> operations,
                                                             RequestOptions requestOptions)

Perform multiple write operations, potentially targeting multiple indices, in a single API call.

Parameters:

operations - The batch operations to process. It could be on multiple indices with multiple action

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

multipleBatchAsync

default <T> CompletableFuture<MultipleIndexBatchIndexingResponse> multipleBatchAsync(@Nonnull
                                                                                     List<BatchOperation<T>> operations)

Perform multiple write operations, potentially targeting multiple indices, in a single API call.

Parameters:

operations - The batch operations to process. It could be on multiple indices with multiple action

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

multipleBatchAsync

default <T> CompletableFuture<MultipleIndexBatchIndexingResponse> multipleBatchAsync(@Nonnull
                                                                                     List<BatchOperation<T>> operations,
                                                                                     RequestOptions requestOptions)

Perform multiple write operations, potentially targeting multiple indices, in a single API call.

Parameters:

operations - The batch operations to process. It could be on multiple indices with multiple action

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

multipleQueries

default <T> MultipleQueriesResponse<T> multipleQueries(@Nonnull
                                                       MultipleQueriesRequest request,
                                                       @Nonnull
                                                       Class<T> clazz)

This method allows to send multiple search queries, potentially targeting multiple indices, in a single API call.

Type Parameters:

T - Type of the expected results

Parameters:

request - The request

clazz - The class of the expected results

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

multipleQueries

default <T> MultipleQueriesResponse<T> multipleQueries(@Nonnull
                                                       MultipleQueriesRequest request,
                                                       @Nonnull
                                                       Class<T> clazz,
                                                       RequestOptions requestOptions)

This method allows to send multiple search queries, potentially targeting multiple indices, in a single API call.

Type Parameters:

T - Type of the expected results

Parameters:

request - The request

clazz - The class of the expected results

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

multipleQueriesAsync

default <T> CompletableFuture<MultipleQueriesResponse<T>> multipleQueriesAsync(@Nonnull
                                                                               MultipleQueriesRequest request,
                                                                               @Nonnull
                                                                               Class<T> clazz)

This method allows to send multiple search queries, potentially targeting multiple indices, in a single API call.

Type Parameters:

T - Type of the expected results

Parameters:

request - The request

clazz - The class of the expected results

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

multipleQueriesAsync

default <T> CompletableFuture<MultipleQueriesResponse<T>> multipleQueriesAsync(@Nonnull
                                                                               MultipleQueriesRequest request,
                                                                               @Nonnull
                                                                               Class<T> clazz,
                                                                               RequestOptions requestOptions)

This method allows to send multiple search queries, potentially targeting multiple indices, in a single API call.

Type Parameters:

T - Type of the expected results

Parameters:

request - The request

clazz - The class of the expected results

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