| Package | Description |
|---|---|
| com.algolia.search | |
| com.algolia.search.http | |
| com.algolia.search.objects |
| Modifier and Type | Method and Description |
|---|---|
CompletableFuture<CreateUpdateKey> |
AsyncAPIClient.addApiKey(ApiKey key,
RequestOptions requestOptions)
Create a new key
|
CreateUpdateKey |
APIClient.addApiKey(ApiKey key,
RequestOptions requestOptions)
Create a new key
|
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
|
TasksMultipleIndex |
APIClient.batch(List<BatchOperation> operations,
RequestOptions requestOptions)
Custom batch
|
CompletableFuture<DeleteKey> |
AsyncAPIClient.deleteApiKey(String key,
RequestOptions requestOptions)
Delete an existing key
|
DeleteKey |
APIClient.deleteApiKey(String key,
RequestOptions requestOptions)
Delete an existing key
|
CompletableFuture<Optional<ApiKey>> |
AsyncAPIClient.getApiKey(String key,
RequestOptions requestOptions)
Get an Key from it's name
|
Optional<ApiKey> |
APIClient.getApiKey(String key,
RequestOptions requestOptions)
Get a Key from it's name
|
CompletableFuture<List<Log>> |
AsyncAPIClient.getLogs(Integer offset,
Integer length,
LogType logType,
RequestOptions requestOptions)
Return last logs 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.
|
List<Log> |
APIClient.getLogs(RequestOptions requestOptions)
Return 10 last log entries.
|
CompletableFuture<List<ApiKey>> |
AsyncAPIClient.listApiKeys(RequestOptions requestOptions)
List all existing user keys with their associated ACLs
|
List<ApiKey> |
APIClient.listApiKeys(RequestOptions requestOptions)
List all existing user keys with their associated ACLs
|
CompletableFuture<List<Index.Attributes>> |
AsyncAPIClient.listIndices(RequestOptions requestOptions)
List all existing indexes
|
List<Index.Attributes> |
APIClient.listIndices(RequestOptions requestOptions)
List all existing indexes
|
CompletableFuture<MultiQueriesResult> |
AsyncAPIClient.multipleQueries(List<IndexQuery> queries,
MultiQueriesStrategy strategy,
RequestOptions requestOptions)
Performs multiple searches on multiple indices
|
MultiQueriesResult |
APIClient.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 |
MultiQueriesResult |
APIClient.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 |
CompletableFuture<CreateUpdateKey> |
AsyncAPIClient.updateApiKey(String keyName,
ApiKey key,
RequestOptions requestOptions)
Update a key
|
CreateUpdateKey |
APIClient.updateApiKey(String keyName,
ApiKey key,
RequestOptions requestOptions)
Update a key
|
<T> void |
AsyncAPIClient.waitTask(AsyncGenericTask<T> task,
long timeToWait,
RequestOptions requestOptions)
Wait for the completion of this task /!\ WARNING /!\ This method is blocking
|
<T> void |
APIClient.waitTask(GenericTask<T> task,
long timeToWait,
RequestOptions requestOptions) |
| Constructor and 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) |
| Modifier and Type | Field and Description |
|---|---|
static RequestOptions |
RequestOptions.empty |
| Modifier and Type | Method and Description |
|---|---|
RequestOptions |
RequestOptions.addExtraHeader(String key,
String value) |
RequestOptions |
RequestOptions.addExtraQueryParameters(String key,
String value) |
RequestOptions |
RequestOptions.setForwardedFor(String forwardedFor) |
Copyright © 2017. All rights reserved.