| Package | Description |
|---|---|
| com.algolia.search | |
| com.algolia.search.exceptions | |
| com.algolia.search.http | |
| com.algolia.search.objects.tasks.sync |
| Modifier and Type | Method and Description |
|---|---|
CreateUpdateKey |
APIClient.addApiKey(ApiKey key)
Create a new key
|
CreateUpdateKey |
APIClient.addKey(ApiKey key)
Deprecated.
|
TaskSingleIndex |
Index.batch(List<BatchOperation> operations)
Custom batch
|
TasksMultipleIndex |
APIClient.batch(List<BatchOperation> operations)
Custom batch
|
DeleteKey |
APIClient.deleteApiKey(String key)
Delete an existing key
|
DeleteKey |
APIClient.deleteKey(String key)
Deprecated.
|
String |
AsyncAPIClient.generateSecuredApiKey(String privateApiKey,
Query query)
Generate a secured and public API Key from a query and an
optional user token identifying the current user
|
String |
APIClient.generateSecuredApiKey(String privateApiKey,
Query query)
Generate a secured and public API Key from a query and an
optional user token identifying the current user
|
String |
AsyncAPIClient.generateSecuredApiKey(String privateApiKey,
Query query,
String userToken)
Generate a secured and public API Key from a query and an
optional user token identifying the current user
|
String |
APIClient.generateSecuredApiKey(String privateApiKey,
Query query,
String userToken)
Generate a secured and public API Key from a query and an
optional user token identifying the current user
|
Optional<ApiKey> |
APIClient.getApiKey(String key)
Get a Key from it's name
|
Optional<ApiKey> |
APIClient.getKey(String key)
Deprecated.
|
List<Log> |
APIClient.getLogs()
Return 10 last log entries.
|
List<Log> |
APIClient.getLogs(Integer offset,
Integer length,
LogType logType)
Return last logs entries
|
List<ApiKey> |
APIClient.listApiKeys()
List all existing user keys with their associated ACLs
|
List<Index.Attributes> |
APIClient.listIndices()
List all existing indexes
|
List<ApiKey> |
APIClient.listKeys()
Deprecated.
|
MultiQueriesResult |
APIClient.multipleQueries(List<IndexQuery> queries)
Performs multiple searches on multiple indices with the strategy
MultiQueriesStrategy.NONE |
MultiQueriesResult |
APIClient.multipleQueries(List<IndexQuery> queries,
MultiQueriesStrategy strategy)
Performs multiple searches on multiple indices
|
SearchResult<T> |
Index.search(Query query)
Search in the index
throws a
AlgoliaIndexNotFoundException if the index does not exists |
CreateUpdateKey |
APIClient.updateApiKey(String keyName,
ApiKey key)
Update a key
|
CreateUpdateKey |
APIClient.updateKey(String keyName,
ApiKey key)
Deprecated.
|
<T> void |
APIClient.waitTask(GenericTask<T> task,
long timeToWait) |
| Modifier and Type | Class and Description |
|---|---|
class |
AlgoliaHttpException
Algolia Exception if there was an unexpected response code (!= 2XX)
|
class |
AlgoliaHttpRetriesException
Algolia Exception if all retries failed
|
class |
AlgoliaIndexNotFoundException
Algolia Exception if an index does not exists
|
class |
AlgoliaIOException
Algolia Exception if there was an IOError linked to a host
|
| Modifier and Type | Method and Description |
|---|---|
<T> T |
AlgoliaHttpClient.requestWithRetry(AlgoliaRequest<T> request) |
| Modifier and Type | Method and Description |
|---|---|
void |
Task.waitForCompletion()
Wait for the completion of this task
|
void |
GenericTask.waitForCompletion()
Wait for the completion of this task
|
void |
Task.waitForCompletion(long timeToWait)
Wait for the completion of this task
|
void |
GenericTask.waitForCompletion(long timeToWait)
Wait for the completion of this task
|
Copyright © 2017. All rights reserved.