public final class SearchIndex<T> extends Object implements SearchIndexRules<T>, SearchIndexSynonyms<T>, SearchIndexSettings<T>, SearchIndexSearching<T>
| Modifier and Type | Method and Description |
|---|---|
<E> BatchResponse |
batch(BatchRequest<E> request)
Perform several indexing operations in one API call.
|
<E> BatchResponse |
batch(BatchRequest<E> request,
RequestOptions requestOptions)
Perform several indexing operations in one API call.
|
<E> CompletableFuture<BatchResponse> |
batchAsync(BatchRequest<E> request)
Perform several indexing operations in one API call.
|
<E> CompletableFuture<BatchResponse> |
batchAsync(BatchRequest<E> request,
RequestOptions requestOptions)
Perform several indexing operations in one API call.
|
BrowseIndexResponse<T> |
browseFrom(BrowseIndexQuery query)
This method allows you to retrieve all index content It can retrieve up to 1,000 records per
call and supports full text search and filters.
|
BrowseIndexResponse<T> |
browseFrom(BrowseIndexQuery query,
RequestOptions requestOptions)
This method allows you to retrieve all index content It can retrieve up to 1,000 records per
call and supports full text search and filters.
|
CompletableFuture<BrowseIndexResponse<T>> |
browseFromAsync(BrowseIndexQuery query)
This method allows you to retrieve all index content It can retrieve up to 1,000 records per
call and supports full text search and filters.
|
CompletableFuture<BrowseIndexResponse<T>> |
browseFromAsync(BrowseIndexQuery query,
RequestOptions requestOptions)
This method allows you to retrieve all index content It can retrieve up to 1,000 records per
call and supports full text search and filters.
|
IndexIterable<T> |
browseObjects(BrowseIndexQuery query)
This method allows you to retrieve all index content It can retrieve up to 1,000 records per
call and supports full text search and filters.
|
DeleteResponse |
clearObjects()
Clear the records of an index without affecting its settings.
|
DeleteResponse |
clearObjects(RequestOptions requestOptions)
Clear the records of an index without affecting its settings.
|
CompletableFuture<DeleteResponse> |
clearObjectsAsync()
Clear the records of an index without affecting its settings.
|
CompletableFuture<DeleteResponse> |
clearObjectsAsync(RequestOptions requestOptions)
Clear the records of an index without affecting its settings.
|
DeleteResponse |
delete()
Delete the index and all its settings, including links to its replicas.
|
DeleteResponse |
delete(RequestOptions requestOptions)
Delete the index and all its settings, including links to its replicas.
|
CompletableFuture<DeleteResponse> |
deleteAsync()
Delete the index and all its settings, including links to its replicas.
|
CompletableFuture<DeleteResponse> |
deleteAsync(RequestOptions requestOptions)
Delete the index and all its settings, including links to its replicas.
|
DeleteResponse |
deleteBy(Query query)
Remove all objects matching a filter (including geo filters).
|
DeleteResponse |
deleteBy(Query query,
RequestOptions requestOptions)
Remove all objects matching a filter (including geo filters).
|
CompletableFuture<DeleteResponse> |
deleteByAsync(Query query)
Remove all objects matching a filter (including geo filters).
|
CompletableFuture<DeleteResponse> |
deleteByAsync(Query query,
RequestOptions requestOptions)
Remove all objects matching a filter (including geo filters).
|
DeleteResponse |
deleteObject(String objectID)
Remove objects from an index using their object ids.
|
DeleteResponse |
deleteObject(String objectID,
RequestOptions requestOptions)
Remove objects from an index using their object ids.
|
CompletableFuture<DeleteResponse> |
deleteObjectAsync(String objectID)
Remove objects from an index using their object ids.
|
CompletableFuture<DeleteResponse> |
deleteObjectAsync(String objectID,
RequestOptions requestOptions)
Remove objects from an index using their object ids.
|
BatchIndexingResponse |
deleteObjects(List<String> objectIDs)
Remove objects from an index using their object ids.
|
BatchIndexingResponse |
deleteObjects(List<String> objectIDs,
RequestOptions requestOptions)
Remove objects from an index using their object ids.
|
CompletableFuture<BatchIndexingResponse> |
deleteObjectsAsync(List<String> objectIDs)
Remove objects from an index using their object ids.
|
CompletableFuture<BatchIndexingResponse> |
deleteObjectsAsync(List<String> objectIDs,
RequestOptions requestOptions)
Remove objects from an index using their object ids.
|
boolean |
exists()
Return whether an index exists or not
|
CompletableFuture<Boolean> |
existsAsync()
Return whether an index exists or not
|
Class<T> |
getClazz() |
SearchConfig |
getConfig() |
T |
getObject(String objectID)
Retrieve one or more objects, potentially from the index, in a single API call.
|
T |
getObject(String objectID,
List<String> attributesToRetrieve,
RequestOptions requestOptions)
Retrieve one or more objects, potentially from the index, in a single API call.
|
T |
getObject(String objectID,
RequestOptions requestOptions)
Retrieve one or more objects, potentially from the index, in a single API call.
|
CompletableFuture<T> |
getObjectAsync(String objectID)
Retrieve one or more objects, potentially from the index, in a single API call.
|
CompletableFuture<T> |
getObjectAsync(String objectID,
List<String> attributesToRetrieve,
RequestOptions requestOptions)
Retrieve one or more objects, potentially from the index, in a single API call.
|
CompletableFuture<T> |
getObjectAsync(String objectID,
RequestOptions requestOptions)
Retrieve one or more objects, potentially from the index, in a single API call.
|
List<T> |
getObjects(List<String> objectIDs)
Retrieve one or more objects, potentially from the index, in a single API call.
|
List<T> |
getObjects(List<String> objectIDs,
List<String> attributesToRetrieve)
Retrieve one or more objects, potentially from the index, in a single API call.
|
List<T> |
getObjects(List<String> objectIDs,
List<String> attributesToRetrieve,
RequestOptions requestOptions)
Retrieve one or more objects, potentially from the index, in a single API call.
|
List<T> |
getObjects(List<String> objectIDs,
RequestOptions requestOptions)
Retrieve one or more objects, potentially from the index, in a single API call.
|
CompletableFuture<List<T>> |
getObjectsAsync(List<String> objectIDs)
Retrieve one or more objects, potentially from the index, in a single API call.
|
CompletableFuture<List<T>> |
getObjectsAsync(List<String> objectIDs,
List<String> attributesToRetrieve)
Retrieve one or more objects, potentially from the index, in a single API call.
|
CompletableFuture<List<T>> |
getObjectsAsync(List<String> objectIDs,
List<String> attributesToRetrieve,
RequestOptions requestOptions)
Retrieve one or more objects, potentially from the index, in a single API call.
|
CompletableFuture<List<T>> |
getObjectsAsync(List<String> objectIDs,
RequestOptions requestOptions)
Retrieve one or more objects, potentially from the index, in a single API call.
|
TaskStatusResponse |
getTask(long taskID)
Get the status of the given task
|
TaskStatusResponse |
getTask(long taskID,
RequestOptions requestOptions)
Get the status of the given task
|
CompletableFuture<TaskStatusResponse> |
getTaskAsync(long taskID)
Get the status of the given task
|
CompletableFuture<TaskStatusResponse> |
getTaskAsync(long taskID,
RequestOptions requestOptions)
Get the status of the given task
|
com.algolia.search.HttpTransport |
getTransport() |
String |
getUrlEncodedIndexName() |
MoveIndexResponse |
moveFrom(String sourceIndex)
Rename an index.
|
MoveIndexResponse |
moveFrom(String sourceIndex,
RequestOptions requestOptions)
Rename an index.
|
CompletableFuture<MoveIndexResponse> |
moveFromAsync(String sourceIndex)
Rename an index.
|
CompletableFuture<MoveIndexResponse> |
moveFromAsync(String sourceIndex,
RequestOptions requestOptions)
Rename an index.
|
UpdateObjectResponse |
partialUpdateObject(T data)
Update one or more attributes of an existing object.
|
UpdateObjectResponse |
partialUpdateObject(T data,
Boolean createIfNotExists)
Update one or more attributes of an existing object.
|
UpdateObjectResponse |
partialUpdateObject(T data,
Boolean createIfNotExists,
RequestOptions requestOptions)
Update one or more attributes of an existing object.
|
UpdateObjectResponse |
partialUpdateObject(T data,
RequestOptions requestOptions)
Update one or more attributes of an existing object.
|
CompletableFuture<UpdateObjectResponse> |
partialUpdateObjectAsync(T data)
Update one or more attributes of an existing object.
|
CompletableFuture<UpdateObjectResponse> |
partialUpdateObjectAsync(T data,
Boolean createIfNotExists)
Update one or more attributes of an existing object.
|
CompletableFuture<UpdateObjectResponse> |
partialUpdateObjectAsync(T data,
Boolean createIfNotExists,
RequestOptions requestOptions)
Update one or more attributes of an existing object.
|
CompletableFuture<UpdateObjectResponse> |
partialUpdateObjectAsync(T data,
RequestOptions requestOptions)
Update one or more attributes of an existing object.
|
BatchIndexingResponse |
partialUpdateObjects(Iterable<T> data)
Update one or more attributes of an existing object.
|
BatchIndexingResponse |
partialUpdateObjects(Iterable<T> data,
boolean createIfNotExists)
Update one or more attributes of an existing object.
|
BatchIndexingResponse |
partialUpdateObjects(Iterable<T> data,
boolean createIfNotExists,
RequestOptions requestOptions)
Update one or more attributes of an existing object.
|
BatchIndexingResponse |
partialUpdateObjects(Iterable<T> data,
RequestOptions requestOptions)
Update one or more attributes of an existing object.
|
CompletableFuture<BatchIndexingResponse> |
partialUpdateObjectsAsync(Iterable<T> data)
Update one or more attributes of an existing object.
|
CompletableFuture<BatchIndexingResponse> |
partialUpdateObjectsAsync(Iterable<T> data,
boolean createIfNotExists)
Update one or more attributes of an existing object.
|
CompletableFuture<BatchIndexingResponse> |
partialUpdateObjectsAsync(Iterable<T> data,
boolean createIfNotExists,
RequestOptions requestOptions)
Update one or more attributes of an existing object.
|
CompletableFuture<BatchIndexingResponse> |
partialUpdateObjectsAsync(Iterable<T> data,
RequestOptions requestOptions)
Update one or more attributes of an existing object.
|
MultiResponse |
replaceAllObjects(Iterable<T> data)
Push a new set of objects and remove all previous ones.
|
MultiResponse |
replaceAllObjects(Iterable<T> data,
boolean safe)
Push a new set of objects and remove all previous ones.
|
MultiResponse |
replaceAllObjects(Iterable<T> data,
RequestOptions requestOptions,
boolean safe)
Push a new set of objects and remove all previous ones.
|
CompletableFuture<MultiResponse> |
replaceAllObjectsAsync(Iterable<T> data)
Push a new set of objects and remove all previous ones.
|
CompletableFuture<MultiResponse> |
replaceAllObjectsAsync(Iterable<T> data,
boolean safe)
Push a new set of objects and remove all previous ones.
|
CompletableFuture<MultiResponse> |
replaceAllObjectsAsync(Iterable<T> data,
RequestOptions requestOptions,
boolean safe)
Push a new set of objects and remove all previous ones.
|
BatchIndexingResponse |
saveObject(T data)
This method allows you to create records on your index by sending one or more objects Each
object contains a set of attributes and values, which represents a full record on an index.
|
BatchIndexingResponse |
saveObject(T data,
boolean autoGenerateObjectID)
This method allows you to create records on your index by sending one or more objects Each
object contains a set of attributes and values, which represents a full record on an index.
|
BatchIndexingResponse |
saveObject(T data,
boolean autoGenerateObjectID,
RequestOptions requestOptions)
This method allows you to create records on your index by sending one or more objects Each
object contains a set of attributes and values, which represents a full record on an index.
|
BatchIndexingResponse |
saveObject(T data,
RequestOptions requestOptions)
This method allows you to create records on your index by sending one or more objects Each
object contains a set of attributes and values, which represents a full record on an index.
|
CompletableFuture<BatchIndexingResponse> |
saveObjectAsync(T data)
This method allows you to create records on your index by sending one or more objects Each
object contains a set of attributes and values, which represents a full record on an index.
|
CompletableFuture<BatchIndexingResponse> |
saveObjectAsync(T data,
boolean autoGenerateObjectID)
This method allows you to create records on your index by sending one or more objects Each
object contains a set of attributes and values, which represents a full record on an index.
|
CompletableFuture<BatchIndexingResponse> |
saveObjectAsync(T data,
boolean autoGenerateObjectID,
RequestOptions requestOptions)
This method allows you to create records on your index by sending one or more objects Each
object contains a set of attributes and values, which represents a full record on an index.
|
CompletableFuture<BatchIndexingResponse> |
saveObjectAsync(T data,
RequestOptions requestOptions)
This method allows you to create records on your index by sending one or more objects Each
object contains a set of attributes and values, which represents a full record on an index.
|
BatchIndexingResponse |
saveObjects(Iterable<T> data)
This method allows you to create records on your index by sending one or more objects Each
object contains a set of attributes and values, which represents a full record on an index.
|
BatchIndexingResponse |
saveObjects(Iterable<T> data,
boolean autoGenerateObjectID)
This method allows you to create records on your index by sending one or more objects Each
object contains a set of attributes and values, which represents a full record on an index.
|
BatchIndexingResponse |
saveObjects(Iterable<T> data,
boolean autoGenerateObjectID,
RequestOptions requestOptions)
This method allows you to create records on your index by sending one or more objects Each
object contains a set of attributes and values, which represents a full record on an index.
|
BatchIndexingResponse |
saveObjects(Iterable<T> data,
RequestOptions requestOptions)
This method allows you to create records on your index by sending one or more objects Each
object contains a set of attributes and values, which represents a full record on an index.
|
CompletableFuture<BatchIndexingResponse> |
saveObjectsAsync(Iterable<T> data)
This method allows you to create records on your index by sending one or more objects Each
object contains a set of attributes and values, which represents a full record on an index.
|
CompletableFuture<BatchIndexingResponse> |
saveObjectsAsync(Iterable<T> data,
boolean autoGenerateObjectID)
This method allows you to create records on your index by sending one or more objects Each
object contains a set of attributes and values, which represents a full record on an index.
|
CompletableFuture<BatchIndexingResponse> |
saveObjectsAsync(Iterable<T> data,
boolean autoGenerateObjectID,
RequestOptions requestOptions)
This method allows you to create records on your index by sending one or more objects Each
object contains a set of attributes and values, which represents a full record on an index.
|
CompletableFuture<BatchIndexingResponse> |
saveObjectsAsync(Iterable<T> data,
RequestOptions requestOptions)
This method allows you to create records on your index by sending one or more objects Each
object contains a set of attributes and values, which represents a full record on an index.
|
void |
waitTask(long taskId)
Wait for a task to complete before executing the next line of code, to synchronize index
updates.
|
void |
waitTask(long taskId,
long timeToWait,
RequestOptions requestOptions)
Wait for a task to complete before executing the next line of code, to synchronize index
updates.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitbrowseRules, browseRules, browseRules, clearRules, clearRules, clearRules, clearRules, clearRulesAsync, clearRulesAsync, clearRulesAsync, clearRulesAsync, deleteRule, deleteRule, deleteRuleAsync, deleteRuleAsync, getRule, getRule, getRuleAsync, getRuleAsync, replaceAllRules, replaceAllRules, replaceAllRules, replaceAllRulesAsync, replaceAllRulesAsync, replaceAllRulesAsync, saveRule, saveRule, saveRule, saveRule, saveRuleAsync, saveRuleAsync, saveRuleAsync, saveRuleAsync, saveRules, saveRules, saveRules, saveRules, saveRulesAsync, saveRulesAsync, saveRulesAsync, saveRulesAsync, searchRules, searchRules, searchRulesAsync, searchRulesAsyncbrowseSynonyms, browseSynonyms, browseSynonyms, clearSynonyms, clearSynonyms, clearSynonyms, clearSynonymsAsync, clearSynonymsAsync, clearSynonymsAsync, deleteSynonym, deleteSynonym, deleteSynonym, deleteSynonymAsync, deleteSynonymAsync, deleteSynonymAsync, getSynonym, getSynonym, getSynonymAsync, getSynonymAsync, replaceAllSynonyms, replaceAllSynonyms, replaceAllSynonyms, replaceAllSynonymsAsync, replaceAllSynonymsAsync, replaceAllSynonymsAsync, saveSynonym, saveSynonym, saveSynonym, saveSynonym, saveSynonymAsync, saveSynonymAsync, saveSynonymAsync, saveSynonymAsync, saveSynonyms, saveSynonyms, saveSynonyms, saveSynonyms, saveSynonymsAsync, saveSynonymsAsync, saveSynonymsAsync, saveSynonymsAsync, searchSynonyms, searchSynonyms, searchSynonymsAsync, searchSynonymsAsyncgetSettings, getSettings, getSettingsAsync, getSettingsAsync, setSettings, setSettings, setSettings, setSettings, setSettingsAsync, setSettingsAsync, setSettingsAsync, setSettingsAsyncsearch, search, searchAsync, searchAsync, searchForFacetValues, searchForFacetValues, searchForFacetValuesAsync, searchForFacetValuesAsyncpublic SearchConfig getConfig()
getConfig in interface SearchIndexBase<T>public Class<T> getClazz()
getClazz in interface SearchIndexBase<T>public com.algolia.search.HttpTransport getTransport()
getTransport in interface SearchIndexBase<T>public String getUrlEncodedIndexName()
getUrlEncodedIndexName in interface SearchIndexBase<T>public T getObject(@Nonnull String objectID)
objectID - ID of the object within that indexAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic T getObject(@Nonnull String objectID, @Nonnull List<String> attributesToRetrieve, RequestOptions requestOptions)
objectID - ID of the object within that indexattributesToRetrieve - List of attributes to retrieve. By default, all retrievable
attributes are returned.requestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic T getObject(@Nonnull String objectID, RequestOptions requestOptions)
objectID - ID of the object within that indexrequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic CompletableFuture<T> getObjectAsync(@Nonnull String objectID)
objectID - ID of the object within that indexAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When the class doesn't have an objectID field or a
Jacksonannotation @JsonProperty(\"objectID\"")public CompletableFuture<T> getObjectAsync(@Nonnull String objectID, @Nonnull List<String> attributesToRetrieve, RequestOptions requestOptions)
objectID - ID of the object within that indexattributesToRetrieve - List of attributes to retrieve. By default, all retrievable
attributes are returned.requestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic CompletableFuture<T> getObjectAsync(@Nonnull String objectID, RequestOptions requestOptions)
objectID - ID of the object within that indexrequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serialization)public List<T> getObjects(@Nonnull List<String> objectIDs)
objectIDs - ID of the object within that indexAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic List<T> getObjects(@Nonnull List<String> objectIDs, List<String> attributesToRetrieve)
objectIDs - ID of the object within that indexattributesToRetrieve - List of attributes to retrieve. By default, all retrievable
attributes are returned.AlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic List<T> getObjects(@Nonnull List<String> objectIDs, RequestOptions requestOptions)
objectIDs - ID of the object within that indexrequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic List<T> getObjects(@Nonnull List<String> objectIDs, List<String> attributesToRetrieve, RequestOptions requestOptions)
objectIDs - ID of the object within that indexattributesToRetrieve - List of attributes to retrieve. By default, all retrievable
attributes are returned.requestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic CompletableFuture<List<T>> getObjectsAsync(@Nonnull List<String> objectIDs)
objectIDs - ID of the object within that indexAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic CompletableFuture<List<T>> getObjectsAsync(@Nonnull List<String> objectIDs, List<String> attributesToRetrieve)
objectIDs - ID of the object within that indexattributesToRetrieve - List of attributes to retrieve. By default, all retrievable
attributes are returned.AlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic CompletableFuture<List<T>> getObjectsAsync(@Nonnull List<String> objectIDs, RequestOptions requestOptions)
objectIDs - ID of the object within that indexrequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic CompletableFuture<List<T>> getObjectsAsync(@Nonnull List<String> objectIDs, List<String> attributesToRetrieve, RequestOptions requestOptions)
objectIDs - ID of the object within that indexattributesToRetrieve - List of attributes to retrieve. By default, all retrievable
attributes are returned.requestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic UpdateObjectResponse partialUpdateObject(@Nonnull T data)
data - Data to updateAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic UpdateObjectResponse partialUpdateObject(@Nonnull T data, RequestOptions requestOptions)
data - Data to updaterequestOptions - Options to pass to this requestAlgoliaRuntimeException - When the class doesn't have an objectID field or a Jackson
annotation @JsonProperty(\"objectID\"")AlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codepublic UpdateObjectResponse partialUpdateObject(@Nonnull T data, @Nonnull Boolean createIfNotExists)
data - Data to updatecreateIfNotExists - When true, a partial update on a nonexistent object will create the
object (generating the objectID and using the attributes as defined in the object). WHen
false, a partial update on a nonexistent object will be ignored (but no error will be sent
back).AlgoliaRuntimeException - When the class doesn't have an objectID field or a Jackson
annotation @JsonProperty(\"objectID\"")AlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codepublic UpdateObjectResponse partialUpdateObject(@Nonnull T data, @Nonnull Boolean createIfNotExists, RequestOptions requestOptions)
data - Data to updatecreateIfNotExists - When true, a partial update on a nonexistent object will create the
object (generating the objectID and using the attributes as defined in the object). WHen
false, a partial update on a nonexistent object will be ignored (but no error will be sent
back).requestOptions - Options to pass to this requestAlgoliaRuntimeException - When the class doesn't have an objectID field or a Jackson
annotation @JsonProperty(\"objectID\"")AlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codepublic CompletableFuture<UpdateObjectResponse> partialUpdateObjectAsync(@Nonnull T data)
data - Data to updateAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic CompletableFuture<UpdateObjectResponse> partialUpdateObjectAsync(@Nonnull T data, RequestOptions requestOptions)
data - Data to updaterequestOptions - Options to pass to this requestAlgoliaRuntimeException - When the class doesn't have an objectID field or a Jackson
annotation @JsonProperty(\"objectID\"")AlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codepublic CompletableFuture<UpdateObjectResponse> partialUpdateObjectAsync(@Nonnull T data, @Nonnull Boolean createIfNotExists)
data - Data to updatecreateIfNotExists - When true, a partial update on a nonexistent object will create the
object (generating the objectID and using the attributes as defined in the object). WHen
false, a partial update on a nonexistent object will be ignored (but no error will be sent
back).AlgoliaRuntimeException - When the class doesn't have an objectID field or a Jackson
annotation @JsonProperty(\"objectID\"")AlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codepublic CompletableFuture<UpdateObjectResponse> partialUpdateObjectAsync(@Nonnull T data, @Nonnull Boolean createIfNotExists, RequestOptions requestOptions)
data - Data to updatecreateIfNotExists - When true, a partial update on a nonexistent object will create the
object (generating the objectID and using the attributes as defined in the object). WHen
false, a partial update on a nonexistent object will be ignored (but no error will be sent
back).requestOptions - Options to pass to this requestAlgoliaRuntimeException - When the class doesn't have an objectID field or a Jackson
annotation @JsonProperty(\"objectID\"")AlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codepublic BatchIndexingResponse partialUpdateObjects(@Nonnull Iterable<T> data)
data - The data to send to the APIAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When the class doesn't have an objectID field or a
Jacksonannotation @JsonProperty(\"objectID\"")public BatchIndexingResponse partialUpdateObjects(@Nonnull Iterable<T> data, RequestOptions requestOptions)
data - The data to send to the APIrequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When the class doesn't have an objectID field or a
Jacksonannotation @JsonProperty(\"objectID\"")public BatchIndexingResponse partialUpdateObjects(@Nonnull Iterable<T> data, boolean createIfNotExists)
data - The data to send to the APIcreateIfNotExists - When true, a partial update on a nonexistent object will create the
object (generating the objectID and using the attributes as defined in the object). WHen
false, a partial update on a nonexistent object will be ignored (but no error will be sent
back).AlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When the class doesn't have an objectID field or a
Jacksonannotation @JsonProperty(\"objectID\"")public BatchIndexingResponse partialUpdateObjects(@Nonnull Iterable<T> data, boolean createIfNotExists, RequestOptions requestOptions)
data - The data to send to the APIcreateIfNotExists - When true, a partial update on a nonexistent object will create the
object (generating the objectID and using the attributes as defined in the object). WHen
false, a partial update on a nonexistent object will be ignored (but no error will be sent
back).requestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When the class doesn't have an objectID field or a
Jacksonannotation @JsonProperty(\"objectID\"")public CompletableFuture<BatchIndexingResponse> partialUpdateObjectsAsync(@Nonnull Iterable<T> data)
data - The data to send to the APIAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When the class doesn't have an objectID field or a
Jacksonannotation @JsonProperty(\"objectID\"")public CompletableFuture<BatchIndexingResponse> partialUpdateObjectsAsync(@Nonnull Iterable<T> data, RequestOptions requestOptions)
data - The data to send to the APIrequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When the class doesn't have an objectID field or a
Jacksonannotation @JsonProperty(\"objectID\"")public CompletableFuture<BatchIndexingResponse> partialUpdateObjectsAsync(@Nonnull Iterable<T> data, boolean createIfNotExists)
data - The data to send to the APIcreateIfNotExists - When true, a partial update on a nonexistent object will create the
object (generating the objectID and using the attributes as defined in the object). WHen
false, a partial update on a nonexistent object will be ignored (but no error will be sent
back).AlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When the class doesn't have an objectID field or a
Jacksonannotation @JsonProperty(\"objectID\"")public CompletableFuture<BatchIndexingResponse> partialUpdateObjectsAsync(@Nonnull Iterable<T> data, boolean createIfNotExists, RequestOptions requestOptions)
data - The data to send to the APIcreateIfNotExists - When true, a partial update on a nonexistent object will create the
object (generating the objectID and using the attributes as defined in the object). WHen
false, a partial update on a nonexistent object will be ignored (but no error will be sent
back).requestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When the class doesn't have an objectID field or a
Jacksonannotation @JsonProperty(\"objectID\"")public BatchIndexingResponse saveObject(@Nonnull T data)
data - The data to sendAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When the class doesn't have an objectID field or a
Jacksonannotation @JsonProperty(\"objectID\"")public BatchIndexingResponse saveObject(@Nonnull T data, boolean autoGenerateObjectID)
data - The data to sendautoGenerateObjectID - If set to true, the method will perform "ADD_OBJECT", otherwise
will perform an "UpdateObject"AlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When the class doesn't have an objectID field or a
Jacksonannotation @JsonProperty(\"objectID\"") and autoGenerateObjectID = falsepublic BatchIndexingResponse saveObject(@Nonnull T data, RequestOptions requestOptions)
data - The data to sendrequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When the class doesn't have an objectID field or a
Jacksonannotation @JsonProperty(\"objectID\"")public BatchIndexingResponse saveObject(@Nonnull T data, boolean autoGenerateObjectID, RequestOptions requestOptions)
data - The data to sendautoGenerateObjectID - If set to true, the method will perform "ADD_OBJECT", otherwise
will perform an "UpdateObject"requestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When the class doesn't have an objectID field or a
Jacksonannotation @JsonProperty(\"objectID\"") and autoGenerateObjectID = falsepublic CompletableFuture<BatchIndexingResponse> saveObjectAsync(@Nonnull T data)
data - The data to sendAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When the class doesn't have an objectID field or a
Jacksonannotation @JsonProperty(\"objectID\"")public CompletableFuture<BatchIndexingResponse> saveObjectAsync(@Nonnull T data, boolean autoGenerateObjectID)
data - The data to sendautoGenerateObjectID - If set to true, the method will perform "ADD_OBJECT", otherwise
will perform an "UpdateObject"AlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When the class doesn't have an objectID field or a
Jacksonannotation @JsonProperty(\"objectID\"") and autoGenerateObjectID = falsepublic CompletableFuture<BatchIndexingResponse> saveObjectAsync(@Nonnull T data, RequestOptions requestOptions)
data - The data to sendrequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When the class doesn't have an objectID field or a
Jacksonannotation @JsonProperty(\"objectID\"")public CompletableFuture<BatchIndexingResponse> saveObjectAsync(@Nonnull T data, boolean autoGenerateObjectID, RequestOptions requestOptions)
data - The data to sendautoGenerateObjectID - If set to true, the method will perform "ADD_OBJECT", otherwise
will perform an "UpdateObject"requestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When the class doesn't have an objectID field or a
Jacksonannotation @JsonProperty(\"objectID\"") and autoGenerateObjectID = falsepublic BatchIndexingResponse saveObjects(@Nonnull Iterable<T> data)
data - The data to sendAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When the class doesn't have an objectID field or a
Jacksonannotation @JsonProperty(\"objectID\"")public BatchIndexingResponse saveObjects(@Nonnull Iterable<T> data, boolean autoGenerateObjectID)
data - The data to sendautoGenerateObjectID - If set to true, the method will perform "ADD_OBJECT", otherwise
will perform an "UpdateObject"AlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When the class doesn't have an objectID field or a
Jacksonannotation @JsonProperty(\"objectID\"") and autoGenerateObjectID = falsepublic BatchIndexingResponse saveObjects(@Nonnull Iterable<T> data, RequestOptions requestOptions)
data - The data to sendrequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When the class doesn't have an objectID field or a
Jacksonannotation @JsonProperty(\"objectID\"")public BatchIndexingResponse saveObjects(@Nonnull Iterable<T> data, boolean autoGenerateObjectID, RequestOptions requestOptions)
data - The data to sendautoGenerateObjectID - If set to true, the method will perform "ADD_OBJECT", otherwise
will perform an "UpdateObject"requestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When the class doesn't have an objectID field or a
Jacksonannotation @JsonProperty(\"objectID\"") and autoGenerateObjectID = falsepublic CompletableFuture<BatchIndexingResponse> saveObjectsAsync(@Nonnull Iterable<T> data)
data - The data to sendAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When the class doesn't have an objectID field or a
Jacksonannotation @JsonProperty(\"objectID\"")public CompletableFuture<BatchIndexingResponse> saveObjectsAsync(@Nonnull Iterable<T> data, boolean autoGenerateObjectID)
data - The data to sendautoGenerateObjectID - If set to true, the method will perform "ADD_OBJECT", otherwise
will perform an "UpdateObject"AlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When the class doesn't have an objectID field or a
Jacksonannotation @JsonProperty(\"objectID\"") and autoGenerateObjectID = falsepublic CompletableFuture<BatchIndexingResponse> saveObjectsAsync(@Nonnull Iterable<T> data, RequestOptions requestOptions)
data - The data to sendrequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When the class doesn't have an objectID field or a
Jacksonannotation @JsonProperty(\"objectID\"")public CompletableFuture<BatchIndexingResponse> saveObjectsAsync(@Nonnull Iterable<T> data, boolean autoGenerateObjectID, RequestOptions requestOptions)
data - The data to sendautoGenerateObjectID - If set to true, the method will perform "ADD_OBJECT", otherwise
will perform an "UpdateObject"requestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When the class doesn't have an objectID field or a
Jacksonannotation @JsonProperty(\"objectID\"") and autoGenerateObjectID = falsepublic <E> BatchResponse batch(@Nonnull BatchRequest<E> request)
request - The batch request -AlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic <E> BatchResponse batch(@Nonnull BatchRequest<E> request, RequestOptions requestOptions)
request - The batch requestrequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic <E> CompletableFuture<BatchResponse> batchAsync(@Nonnull BatchRequest<E> request)
request - The batch request -AlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic <E> CompletableFuture<BatchResponse> batchAsync(@Nonnull BatchRequest<E> request, RequestOptions requestOptions)
request - The batch requestrequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic DeleteResponse deleteObject(@Nonnull String objectID)
objectID - The Algolia objectIDAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic DeleteResponse deleteObject(@Nonnull String objectID, RequestOptions requestOptions)
objectID - The Algolia objectIDrequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic CompletableFuture<DeleteResponse> deleteObjectAsync(@Nonnull String objectID)
objectID - The Algolia objectIDAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic CompletableFuture<DeleteResponse> deleteObjectAsync(@Nonnull String objectID, RequestOptions requestOptions)
objectID - The Algolia objectIDrequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic BatchIndexingResponse deleteObjects(@Nonnull List<String> objectIDs)
objectIDs - List of objectIDs to deleteAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic BatchIndexingResponse deleteObjects(@Nonnull List<String> objectIDs, RequestOptions requestOptions)
objectIDs - List of objectIDs to deleterequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic CompletableFuture<BatchIndexingResponse> deleteObjectsAsync(@Nonnull List<String> objectIDs)
objectIDs - List of objectIDs to deleteAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic CompletableFuture<BatchIndexingResponse> deleteObjectsAsync(@Nonnull List<String> objectIDs, RequestOptions requestOptions)
objectIDs - List of objectIDs to deleterequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic DeleteResponse clearObjects()
AlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic DeleteResponse clearObjects(RequestOptions requestOptions)
requestOptions - Options to pass to this requestpublic CompletableFuture<DeleteResponse> clearObjectsAsync()
AlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic CompletableFuture<DeleteResponse> clearObjectsAsync(RequestOptions requestOptions)
requestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic MultiResponse replaceAllObjects(Iterable<T> data)
data - The data to sendAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic MultiResponse replaceAllObjects(Iterable<T> data, boolean safe)
data - The data to sendsafe - Run all API calls synchronouslyAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic MultiResponse replaceAllObjects(Iterable<T> data, RequestOptions requestOptions, boolean safe)
data - The data to sendrequestOptions - Options to pass to this requestsafe - Run all API calls synchronouslyAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic CompletableFuture<MultiResponse> replaceAllObjectsAsync(Iterable<T> data)
data - The data to sendAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic CompletableFuture<MultiResponse> replaceAllObjectsAsync(Iterable<T> data, boolean safe)
data - The data to sendsafe - Run all API calls synchronouslyAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic CompletableFuture<MultiResponse> replaceAllObjectsAsync(Iterable<T> data, RequestOptions requestOptions, boolean safe)
data - The data to sendrequestOptions - Options to pass to this requestsafe - Run all API calls synchronouslyAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic MoveIndexResponse moveFrom(@Nonnull String sourceIndex)
sourceIndex - The source to moveAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic MoveIndexResponse moveFrom(@Nonnull String sourceIndex, RequestOptions requestOptions)
sourceIndex - The source to moverequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic CompletableFuture<MoveIndexResponse> moveFromAsync(@Nonnull String sourceIndex)
sourceIndex - The source to moveAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic CompletableFuture<MoveIndexResponse> moveFromAsync(@Nonnull String sourceIndex, RequestOptions requestOptions)
sourceIndex - The source to moverequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic IndexIterable<T> browseObjects(@Nonnull BrowseIndexQuery query)
query - The browseObjects queryAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic BrowseIndexResponse<T> browseFrom(@Nonnull BrowseIndexQuery query)
query - The browseObjects queryAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic BrowseIndexResponse<T> browseFrom(@Nonnull BrowseIndexQuery query, RequestOptions requestOptions)
query - The browseObjects queryrequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic CompletableFuture<BrowseIndexResponse<T>> browseFromAsync(@Nonnull BrowseIndexQuery query)
query - The browseObjects queryAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic CompletableFuture<BrowseIndexResponse<T>> browseFromAsync(@Nonnull BrowseIndexQuery query, RequestOptions requestOptions)
query - The browseObjects queryrequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic DeleteResponse delete()
AlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic DeleteResponse delete(RequestOptions requestOptions)
requestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic CompletableFuture<DeleteResponse> deleteAsync()
AlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic CompletableFuture<DeleteResponse> deleteAsync(RequestOptions requestOptions)
requestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic DeleteResponse deleteBy(@Nonnull Query query)
query - The query used to select objects to deleteAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic DeleteResponse deleteBy(@Nonnull Query query, RequestOptions requestOptions)
query - The query used to select objects to deleterequestOptions - requestOptions Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic CompletableFuture<DeleteResponse> deleteByAsync(@Nonnull Query query)
query - The query used to select objects to deleteAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic CompletableFuture<DeleteResponse> deleteByAsync(@Nonnull Query query, RequestOptions requestOptions)
query - The query used to select objects to deleterequestOptions - requestOptions Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic TaskStatusResponse getTask(long taskID)
taskID - The Algolia taskIDAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic TaskStatusResponse getTask(long taskID, RequestOptions requestOptions)
taskID - The Algolia taskIDrequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic CompletableFuture<TaskStatusResponse> getTaskAsync(long taskID)
taskID - The Algolia taskIDAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic CompletableFuture<TaskStatusResponse> getTaskAsync(long taskID, RequestOptions requestOptions)
taskID - The Algolia taskIDrequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic boolean exists()
AlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic CompletableFuture<Boolean> existsAsync()
AlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic void waitTask(long taskId)
waitTask in interface SearchIndexBase<T>taskId - The Algolia taskIDAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationpublic void waitTask(long taskId,
long timeToWait,
RequestOptions requestOptions)
waitTask in interface SearchIndexBase<T>taskId - The Algolia taskIDtimeToWait - The time to wait between each callrequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationCopyright © 2019. All rights reserved.