| 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 |
Index.addKey(ApiKey key)
Add a key to this index
|
CompletableFuture<CreateUpdateKey> |
AsyncIndex.addKey(ApiKey key)
Add a key to this index
|
CreateUpdateKey |
APIClient.addKey(ApiKey key)
Create a new key
|
TaskIndexing |
Index.addObject(String objectID,
T object)
Add an object in this index with a unique identifier
|
CompletableFuture<AsyncTaskIndexing> |
AsyncIndex.addObject(String objectID,
T object)
Add an object in this index with a unique identifier
|
TaskIndexing |
Index.addObject(T object)
Add an object in this index
|
CompletableFuture<AsyncTaskIndexing> |
AsyncIndex.addObject(T object)
Add an object in this index
|
TaskSingleIndex |
Index.addObjects(List<T> objects)
Add several objects
|
CompletableFuture<AsyncTaskSingleIndex> |
AsyncIndex.addObjects(List<T> objects)
Add several objects
|
TaskSingleIndex |
Index.batch(List<BatchOperation> operations)
Custom batch
|
CompletableFuture<AsyncTaskSingleIndex> |
AsyncIndex.batch(List<BatchOperation> operations)
Custom batch
|
TasksMultipleIndex |
APIClient.batch(List<BatchOperation> operations)
Custom batch
|
Task |
Index.batchSynonyms(List<AbstractSynonym> synonyms)
Add or Replace a list of synonyms, no forward to slaves, and no replacement
|
CompletableFuture<AsyncTask> |
AsyncIndex.batchSynonyms(List<AbstractSynonym> synonyms)
Add or Replace a list of synonyms, no forward to slaves, and no replacement
|
Task |
Index.batchSynonyms(List<AbstractSynonym> synonyms,
boolean forwardToReplicas)
Add or Replace a list of synonyms, no replacement
|
CompletableFuture<AsyncTask> |
AsyncIndex.batchSynonyms(List<AbstractSynonym> synonyms,
boolean forwardToReplicas)
Add or Replace a list of synonyms, no replacement
|
Task |
Index.batchSynonyms(List<AbstractSynonym> synonyms,
boolean forwardToReplicas,
boolean replaceExistingSynonyms)
Add or Replace a list of synonyms
|
CompletableFuture<AsyncTask> |
AsyncIndex.batchSynonyms(List<AbstractSynonym> synonyms,
boolean forwardToReplicas,
boolean replaceExistingSynonyms)
Add or Replace a list of synonyms
|
IndexIterable<T> |
Index.browse(Query query)
Browse all the content of this index
|
IndexIterable<T> |
Index.browseFrom(Query query,
String cursor)
Browse all the content of this index
|
Task |
Index.clear()
Delete the index content without removing settings and index specific API keys.
|
CompletableFuture<AsyncTask> |
AsyncIndex.clear()
Delete the index content without removing settings and index specific API keys.
|
Task |
Index.clearSynonyms()
Clear all synonyms and NOT forwarding it to the slaves
|
CompletableFuture<AsyncTask> |
AsyncIndex.clearSynonyms()
Clear all synonyms and NOT forwarding it to the slaves
|
Task |
Index.clearSynonyms(boolean forwardToReplicas)
Clears all synonyms
|
CompletableFuture<AsyncTask> |
AsyncIndex.clearSynonyms(boolean forwardToReplicas)
Clears all synonyms
|
Task |
Index.copyTo(String dstIndexName)
Copy an existing index
|
CompletableFuture<AsyncTask> |
AsyncIndex.copyTo(String dstIndexName)
Copy an existing index
|
Task |
Index.delete()
Deletes the index
|
CompletableFuture<AsyncTask> |
AsyncIndex.delete()
Deletes the index
|
void |
Index.deleteByQuery(Query query)
Delete records matching a query, with a batch size of 1000, internally uses browse
|
void |
Index.deleteByQuery(Query query,
int batchSize)
Delete records matching a query, internally uses browse
|
DeleteKey |
Index.deleteKey(String key)
Delete a key by name from this index
|
CompletableFuture<DeleteKey> |
AsyncIndex.deleteKey(String key)
Delete a key by name from this index
|
DeleteKey |
APIClient.deleteKey(String key)
Delete an existing key
|
Task |
Index.deleteObject(String objectID)
Delete an object from the index
|
CompletableFuture<AsyncTask> |
AsyncIndex.deleteObject(String objectID)
Delete an object from the index
|
TaskSingleIndex |
Index.deleteObjects(List<String> objectIDs)
Delete objects from the index
|
CompletableFuture<AsyncTaskSingleIndex> |
AsyncIndex.deleteObjects(List<String> objectIDs)
Delete objects from the index
|
Task |
Index.deleteSynonym(String synonymID)
Deletes a synonym by ID and NOT forwarding it to the slaves
|
CompletableFuture<AsyncTask> |
AsyncIndex.deleteSynonym(String synonymID)
Deletes a synonym by ID and NOT forwarding it to the slaves
|
Task |
Index.deleteSynonym(String synonymID,
boolean forwardToReplicas)
Deletes a synonym
|
CompletableFuture<AsyncTask> |
AsyncIndex.deleteSynonym(String synonymID,
boolean forwardToReplicas)
Deletes a synonym
|
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> |
Index.getKey(String key)
Get a key by name from this index
|
CompletableFuture<Optional<ApiKey>> |
AsyncIndex.getKey(String key)
Get a key by name from this index
|
Optional<ApiKey> |
APIClient.getKey(String key)
Get an Key from it's name
|
List<Log> |
APIClient.getLogs()
Return 10 last log entries.
|
List<Log> |
APIClient.getLogs(Integer offset,
Integer length,
LogType logType)
Return last logs entries
|
Optional<T> |
Index.getObject(String objectID)
Get an object from this index
|
CompletableFuture<Optional<T>> |
AsyncIndex.getObject(String objectID)
Get an object from this index
|
List<T> |
Index.getObjects(List<String> objectIDs)
Get several objects from this index
|
CompletableFuture<List<T>> |
AsyncIndex.getObjects(List<String> objectIDs)
Get several objects from this index
|
List<T> |
Index.getObjects(List<String> objectIDs,
List<String> attributesToRetrieve)
Get several objects from this index
|
CompletableFuture<List<T>> |
AsyncIndex.getObjects(List<String> objectIDs,
List<String> attributesToRetrieve)
Get several objects from this index
|
IndexSettings |
Index.getSettings()
Get settings of this index
|
CompletableFuture<IndexSettings> |
AsyncIndex.getSettings()
Get settings of this index
|
Optional<AbstractSynonym> |
Index.getSynonym(String synonymID)
Get a synonym by ID
|
CompletableFuture<Optional<AbstractSynonym>> |
AsyncIndex.getSynonym(String synonymID)
Get a synonym by ID
|
List<Index.Attributes> |
APIClient.listIndices()
List all existing indexes
|
List<ApiKey> |
Index.listKeys()
List keys of this index
|
CompletableFuture<List<ApiKey>> |
AsyncIndex.listKeys()
List keys of this index
|
List<ApiKey> |
APIClient.listKeys()
List all existing user keys with their associated ACLs
|
Task |
Index.moveTo(String dstIndexName)
Moves an existing index
|
CompletableFuture<AsyncTask> |
AsyncIndex.moveTo(String dstIndexName)
Moves an existing index
|
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
|
TaskSingleIndex |
Index.partialUpdateObject(PartialUpdateOperation operation)
Partially update an object, create the object if it does not exist
|
CompletableFuture<AsyncTaskSingleIndex> |
AsyncIndex.partialUpdateObject(PartialUpdateOperation operation)
Partially update an object, create the object if it does not exist
|
TaskSingleIndex |
Index.partialUpdateObject(PartialUpdateOperation operation,
boolean createIfNotExists)
Partially update an object
|
CompletableFuture<AsyncTaskSingleIndex> |
AsyncIndex.partialUpdateObject(PartialUpdateOperation operation,
boolean createIfNotExists)
Partially update an object
|
TaskSingleIndex |
Index.partialUpdateObject(String objectID,
Object object)
Partially update an object
|
CompletableFuture<AsyncTaskSingleIndex> |
AsyncIndex.partialUpdateObject(String objectID,
Object object)
Partially update an object
|
TaskSingleIndex |
Index.partialUpdateObjects(List<Object> objects)
Partially update a objects
|
CompletableFuture<AsyncTaskSingleIndex> |
AsyncIndex.partialUpdateObjects(List<Object> objects)
Partially update a objects
|
Task |
Index.saveObject(String objectID,
T object)
Override the content of object
|
CompletableFuture<AsyncTask> |
AsyncIndex.saveObject(String objectID,
T object)
Override the content of object
|
TaskSingleIndex |
Index.saveObjects(List<T> objects)
Override the content the list of objects
|
CompletableFuture<AsyncTaskSingleIndex> |
AsyncIndex.saveObjects(List<T> objects)
Override the content the list of objects
|
Task |
Index.saveSynonym(String synonymID,
AbstractSynonym content)
Saves/updates a synonym without replacing it and NOT forwarding it to the slaves
|
CompletableFuture<AsyncTask> |
AsyncIndex.saveSynonym(String synonymID,
AbstractSynonym content)
Saves/updates a synonym without replacing it and NOT forwarding it to the slaves
|
Task |
Index.saveSynonym(String synonymID,
AbstractSynonym content,
boolean forwardToReplicas)
Saves/updates a synonym without replacing
|
CompletableFuture<AsyncTask> |
AsyncIndex.saveSynonym(String synonymID,
AbstractSynonym content,
boolean forwardToReplicas)
Saves/updates a synonym without replacing
|
Task |
Index.saveSynonym(String synonymID,
AbstractSynonym content,
boolean forwardToReplicas,
boolean replaceExistingSynonyms)
Saves/updates a synonym
|
CompletableFuture<AsyncTask> |
AsyncIndex.saveSynonym(String synonymID,
AbstractSynonym content,
boolean forwardToReplicas,
boolean replaceExistingSynonyms)
Saves/updates a synonym
|
SearchResult<T> |
Index.search(Query query)
Search in the index
throws a
AlgoliaIndexNotFoundException if the index does not exists |
CompletableFuture<SearchResult<T>> |
AsyncIndex.search(Query query)
Search in the index
|
SearchSynonymResult |
Index.searchSynonyms(SynonymQuery query)
Search for synonyms
|
CompletableFuture<SearchSynonymResult> |
AsyncIndex.searchSynonyms(SynonymQuery query)
Search for synonyms
|
Task |
Index.setSettings(IndexSettings settings)
Set settings of this index, and do not forward to slaves
|
CompletableFuture<AsyncTask> |
AsyncIndex.setSettings(IndexSettings settings)
Set settings of this index, and do not forward to slaves
|
Task |
Index.setSettings(IndexSettings settings,
Boolean forwardToReplicas)
Set settings of this index
|
CompletableFuture<AsyncTask> |
AsyncIndex.setSettings(IndexSettings settings,
Boolean forwardToReplicas)
Set settings of this index
|
CreateUpdateKey |
Index.updateKey(String keyName,
ApiKey key)
Update a key by name from this index
|
CompletableFuture<CreateUpdateKey> |
AsyncIndex.updateKey(String keyName,
ApiKey key)
Update a key by name from this index
|
CreateUpdateKey |
APIClient.updateKey(String keyName,
ApiKey key)
Update a key
|
void |
AsyncIndex.waitTask(AsyncTask task)
Wait for the completion of a task, for 100ms
|
void |
AsyncIndex.waitTask(AsyncTask task,
long timeToWait)
Wait for the completion of a task
|
<T> void |
APIClient.waitTask(GenericTask<T> task,
long timeToWait) |
void |
Index.waitTask(Task task)
Wait for the completion of a task, for 100ms
|
void |
Index.waitTask(Task task,
long timeToWait)
Wait for the completion of a task
|
| 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 © 2016. All rights reserved.