Uses of Class
com.algolia.search.objects.RequestOptions

Packages that use RequestOptions

Package	Description
com.algolia.search
com.algolia.search.http
com.algolia.search.iterators
com.algolia.search.objects
com.algolia.search.objects.tasks.sync

Uses of RequestOptions in com.algolia.search

Methods in com.algolia.search with parameters of type RequestOptions

Modifier and Type	Method	Description
CreateUpdateKey	APIClient.addApiKey(ApiKey key, RequestOptions requestOptions)	Create a new key
CompletableFuture<CreateUpdateKey>	AsyncAPIClient.addApiKey(ApiKey key, RequestOptions requestOptions)	Create a new key
TasksMultipleIndex	APIClient.batch(List<BatchOperation> operations, RequestOptions requestOptions)	Custom batch
CompletableFuture<AsyncTasksMultipleIndex>	AsyncAPIClient.batch(List<BatchOperation> operations, RequestOptions requestOptions)	Custom batch
CompletableFuture<AsyncTaskSingleIndex>	AsyncIndex.batch(List<BatchOperation> operations, RequestOptions requestOptions)	Custom batch
TaskSingleIndex	Index.batch(List<BatchOperation> operations, RequestOptions requestOptions)	Custom batch
<T> BrowseResult<T>	APIClient.browse(String indexName, Query query, String cursor, Class<T> klass, RequestOptions requestOptions)
DeleteKey	APIClient.deleteApiKey(String key, RequestOptions requestOptions)	Delete an existing key
CompletableFuture<DeleteKey>	AsyncAPIClient.deleteApiKey(String key, RequestOptions requestOptions)	Delete an existing key
Optional<ApiKey>	APIClient.getApiKey(String key, RequestOptions requestOptions)	Get a Key from it's name
CompletableFuture<Optional<ApiKey>>	AsyncAPIClient.getApiKey(String key, RequestOptions requestOptions)	Get an Key from it's name
List<Log>	APIClient.getLogs(RequestOptions requestOptions)	Return 10 last log entries.
List<Log>	APIClient.getLogs(Integer offset, Integer length, LogType logType, RequestOptions requestOptions)	Return last logs entries
CompletableFuture<List<Log>>	AsyncAPIClient.getLogs(RequestOptions requestOptions)	Return 10 last log entries.
CompletableFuture<List<Log>>	AsyncAPIClient.getLogs(Integer offset, Integer length, LogType logType, RequestOptions requestOptions)	Return last logs entries
List<ApiKey>	APIClient.listApiKeys(RequestOptions requestOptions)	List all existing user keys with their associated ACLs
CompletableFuture<List<ApiKey>>	AsyncAPIClient.listApiKeys(RequestOptions requestOptions)	List all existing user keys with their associated ACLs
List<Index.Attributes>	APIClient.listIndices(RequestOptions requestOptions)	List all existing indexes
CompletableFuture<List<Index.Attributes>>	AsyncAPIClient.listIndices(RequestOptions requestOptions)	List all existing indexes
MultiQueriesResult	APIClient.multipleQueries(List<IndexQuery> queries, MultiQueriesStrategy strategy, RequestOptions requestOptions)	Performs multiple searches on multiple indices
MultiQueriesResult	APIClient.multipleQueries(List<IndexQuery> queries, RequestOptions requestOptions)	Performs multiple searches on multiple indices with the strategy MultiQueriesStrategy.NONE
CompletableFuture<MultiQueriesResult>	AsyncAPIClient.multipleQueries(List<IndexQuery> queries, MultiQueriesStrategy strategy, RequestOptions requestOptions)	Performs multiple searches on multiple indices
CompletableFuture<MultiQueriesResult>	AsyncAPIClient.multipleQueries(List<IndexQuery> queries, RequestOptions requestOptions)	Performs multiple searches on multiple indices with the strategy MultiQueriesStrategy.NONE
CompletableFuture<SearchResult<T>>	AsyncIndex.search(Query query, RequestOptions requestOptions)	Search in the index
SearchResult<T>	Index.search(Query query, RequestOptions requestOptions)	Search in the index throws a AlgoliaIndexNotFoundException if the index does not exists
CreateUpdateKey	APIClient.updateApiKey(String keyName, ApiKey key, RequestOptions requestOptions)	Update a key
CompletableFuture<CreateUpdateKey>	AsyncAPIClient.updateApiKey(String keyName, ApiKey key, RequestOptions requestOptions)	Update a key
<T> void	APIClient.waitTask(GenericTask<T> task, long timeToWait, RequestOptions requestOptions)
<T> void	AsyncAPIClient.waitTask(AsyncGenericTask<T> task, long timeToWait, RequestOptions requestOptions)	Wait for the completion of this task /!\ WARNING /!\ This method is blocking

Uses of RequestOptions in com.algolia.search.http

Constructors in com.algolia.search.http with parameters of type RequestOptions

Constructor	Description
AlgoliaRequest(HttpMethod method, boolean isSearch, List<String> path, RequestOptions options, Class<T> resultClass)
AlgoliaRequest(HttpMethod method, boolean isSearch, List<String> path, RequestOptions options, Class<T> collectionClass, Class<?> elementClass)

Uses of RequestOptions in com.algolia.search.iterators

Constructors in com.algolia.search.iterators with parameters of type RequestOptions

Constructor	Description
IndexIterable(APIClient apiClient, String indexName, Query query, RequestOptions requestOptions, Class<T> klass)
IndexIterable(APIClient apiClient, String indexName, Query query, RequestOptions requestOptions, String cursor, Class<T> klass)

Uses of RequestOptions in com.algolia.search.objects

Fields in com.algolia.search.objects declared as RequestOptions

Modifier and Type	Field	Description
static RequestOptions	RequestOptions.empty

Methods in com.algolia.search.objects that return RequestOptions

Modifier and Type	Method	Description
RequestOptions	RequestOptions.addExtraHeader(String key, String value)
RequestOptions	RequestOptions.addExtraQueryParameters(String key, String value)
RequestOptions	RequestOptions.setForwardedFor(String forwardedFor)

Uses of RequestOptions in com.algolia.search.objects.tasks.sync

Methods in com.algolia.search.objects.tasks.sync with parameters of type RequestOptions

Modifier and Type	Method	Description
void	Task.waitForCompletion(long timeToWait, RequestOptions requestOptions)	Wait for the completion of this task
void	Task.waitForCompletion(RequestOptions requestOptions)	Wait for the completion of this task