AsyncIndex (algoliasearch-common 2.15.2 API)

java.lang.Object
- com.algolia.search.AsyncIndex<T>

public class AsyncIndex<T>
extends Object

Method Summary

All Methods Instance Methods Concrete Methods Default Methods Deprecated Methods
Modifier and Type	Method	Description
`default CompletableFuture<CreateUpdateKey>`	`addApiKey(ApiKey key)`	Add a key to this index
`default CompletableFuture<CreateUpdateKey>`	`addApiKey(ApiKey key, RequestOptions requestOptions)`	Add a key to this index
`default CompletableFuture<CreateUpdateKey>`	`addKey(ApiKey key)`	Deprecated.
`default CompletableFuture<AsyncTaskIndexing>`	`addObject(String objectID, T object)`	Add an object in this index with a unique identifier
`default CompletableFuture<AsyncTaskIndexing>`	`addObject(String objectID, T object, RequestOptions requestOptions)`	Add an object in this index with a unique identifier
`default CompletableFuture<AsyncTaskIndexing>`	`addObject(T object)`	Add an object in this index
`default CompletableFuture<AsyncTaskIndexing>`	`addObject(T object, RequestOptions requestOptions)`	Add an object in this index
`default CompletableFuture<AsyncTaskSingleIndex>`	`addObjects(List<T> objects)`	Add several objects
`default CompletableFuture<AsyncTaskSingleIndex>`	`addObjects(List<T> objects, RequestOptions requestOptions)`	Add several objects
`CompletableFuture<AsyncTaskSingleIndex>`	`batch(List<BatchOperation> operations)`	Custom batch
`CompletableFuture<AsyncTaskSingleIndex>`	`batch(List<BatchOperation> operations, RequestOptions requestOptions)`	Custom batch
`default CompletableFuture<AsyncTask>`	`batchRules(List<Rule> rules)`	Add or Replace a list of Rules, no forward to replicas, and no replacement
`default CompletableFuture<AsyncTask>`	`batchRules(List<Rule> rules, boolean forwardToReplicas)`	Add or Replace a list of Rules, no replacement
`default CompletableFuture<AsyncTask>`	`batchRules(List<Rule> rules, boolean forwardToReplicas, boolean clearExistingRules)`	Add or replace a list of Rules
`default CompletableFuture<AsyncTask>`	`batchRules(List<Rule> rules, boolean forwardToReplicas, boolean clearExistingRules, RequestOptions requestOptions)`	Add or replace a list of Rules
`default CompletableFuture<AsyncTask>`	`batchRules(List<Rule> rules, boolean forwardToReplicas, RequestOptions requestOptions)`	Add or Replace a list of Rules, no replacement
`default CompletableFuture<AsyncTask>`	`batchRules(List<Rule> rules, RequestOptions requestOptions)`	Add or Replace a list of Rules, no forward to replicas, and no replacement
`default CompletableFuture<AsyncTask>`	`batchSynonyms(List<AbstractSynonym> synonyms)`	Add or Replace a list of synonyms, no forward to slaves, and no replacement
`default CompletableFuture<AsyncTask>`	`batchSynonyms(List<AbstractSynonym> synonyms, boolean forwardToReplicas)`	Add or Replace a list of synonyms, no replacement
`default CompletableFuture<AsyncTask>`	`batchSynonyms(List<AbstractSynonym> synonyms, boolean forwardToReplicas, boolean replaceExistingSynonyms)`	Add or Replace a list of synonyms
`default CompletableFuture<AsyncTask>`	`batchSynonyms(List<AbstractSynonym> synonyms, boolean forwardToReplicas, boolean replaceExistingSynonyms, RequestOptions requestOptions)`	Add or Replace a list of synonyms
`default CompletableFuture<AsyncTask>`	`batchSynonyms(List<AbstractSynonym> synonyms, boolean forwardToReplicas, RequestOptions requestOptions)`	Add or Replace a list of synonyms, no replacement
`default CompletableFuture<AsyncTask>`	`batchSynonyms(List<AbstractSynonym> synonyms, RequestOptions requestOptions)`	Add or Replace a list of synonyms, no forward to slaves, and no replacement
`default CompletableFuture<AsyncTask>`	`clear()`	Delete the index content without removing settings and index specific API keys.
`default CompletableFuture<AsyncTask>`	`clear(RequestOptions requestOptions)`	Delete the index content without removing settings and index specific API keys.
`default CompletableFuture<AsyncTask>`	`clearRules()`	Clear all Rules and NOT forwarding it to the replicas
`default CompletableFuture<AsyncTask>`	`clearRules(boolean forwardToReplicas)`	Clears all Rules
`default CompletableFuture<AsyncTask>`	`clearRules(boolean forwardToReplicas, RequestOptions requestOptions)`	Clears all Rules
`default CompletableFuture<AsyncTask>`	`clearRules(RequestOptions requestOptions)`	Clear all Rules and NOT forwarding it to the replicas
`default CompletableFuture<AsyncTask>`	`clearSynonyms()`	Clear all synonyms and NOT forwarding it to the replicas
`default CompletableFuture<AsyncTask>`	`clearSynonyms(boolean forwardToReplicas)`	Clears all synonyms
`default CompletableFuture<AsyncTask>`	`clearSynonyms(boolean forwardToReplicas, RequestOptions requestOptions)`	Clears all synonyms
`default CompletableFuture<AsyncTask>`	`clearSynonyms(RequestOptions requestOptions)`	Clear all synonyms and NOT forwarding it to the slaves
`default CompletableFuture<AsyncTask>`	`copyTo(String dstIndexName)`	Copy an existing index
`default CompletableFuture<AsyncTask>`	`copyTo(String dstIndexName, RequestOptions requestOptions)`	Copy an existing index
`default CompletableFuture<AsyncTask>`	`copyTo(String dstIndexName, List<String> scopes)`	Copy an existing index
`default CompletableFuture<AsyncTask>`	`copyTo(String dstIndexName, List<String> scopes, RequestOptions requestOptions)`	Copy an existing index
`default CompletableFuture<AsyncTask>`	`delete()`	Deletes the index
`default CompletableFuture<AsyncTask>`	`delete(RequestOptions requestOptions)`	Deletes the index
`default CompletableFuture<DeleteKey>`	`deleteApiKey(String key)`	Delete a key by name from this index
`default CompletableFuture<DeleteKey>`	`deleteApiKey(String key, RequestOptions requestOptions)`	Delete a key by name from this index
`default CompletableFuture<AsyncTask>`	`deleteBy(Query query)`	Delete records matching a query
`default CompletableFuture<AsyncTask>`	`deleteBy(Query query, RequestOptions requestOptions)`	Delete records matching a query Deprecated, use deleteBy
`default CompletableFuture<DeleteKey>`	`deleteKey(String key)`	Deprecated.
`default CompletableFuture<AsyncTask>`	`deleteObject(String objectID)`	Delete an object from the index
`default CompletableFuture<AsyncTask>`	`deleteObject(String objectID, RequestOptions requestOptions)`	Delete an object from the index
`default CompletableFuture<AsyncTaskSingleIndex>`	`deleteObjects(List<String> objectIDs)`	Delete objects from the index
`default CompletableFuture<AsyncTaskSingleIndex>`	`deleteObjects(List<String> objectIDs, RequestOptions requestOptions)`	Delete objects from the index
`default CompletableFuture<AsyncTask>`	`deleteRule(String ruleID)`	Deletes a rule by ID and NOT forwarding it to the replicas
`default CompletableFuture<AsyncTask>`	`deleteRule(String ruleID, boolean forwardToReplicas)`	Deletes a rule
`default CompletableFuture<AsyncTask>`	`deleteRule(String ruleID, boolean forwardToReplicas, RequestOptions requestOptions)`	Deletes a rule
`default CompletableFuture<AsyncTask>`	`deleteRule(String ruleID, RequestOptions requestOptions)`	Deletes a rule by ID and NOT forwarding it to the replicas
`default CompletableFuture<AsyncTask>`	`deleteSynonym(String synonymID)`	Deletes a synonym by ID and NOT forwarding it to the replicas
`default CompletableFuture<AsyncTask>`	`deleteSynonym(String synonymID, boolean forwardToReplicas)`	Deletes a synonym
`default CompletableFuture<AsyncTask>`	`deleteSynonym(String synonymID, boolean forwardToReplicas, RequestOptions requestOptions)`	Deletes a synonym
`default CompletableFuture<AsyncTask>`	`deleteSynonym(String synonymID, RequestOptions requestOptions)`	Deletes a synonym by ID and NOT forwarding it to the slaves
`AsyncAPIClient`	`getApiClient()`
`default CompletableFuture<Optional<ApiKey>>`	`getApiKey(String key)`	Get a key by name from this index
`default CompletableFuture<Optional<ApiKey>>`	`getApiKey(String key, RequestOptions requestOptions)`	Get a key by name from this index
`default CompletableFuture<Optional<ApiKey>>`	`getKey(String key)`	Deprecated.
`Class<T>`	`getKlass()`
`String`	`getName()`
`default CompletableFuture<Optional<T>>`	`getObject(String objectID)`	Get an object from this index
`default CompletableFuture<Optional<T>>`	`getObject(String objectID, RequestOptions requestOptions)`	Get an object from this index
`default CompletableFuture<List<T>>`	`getObjects(List<String> objectIDs)`	Get several objects from this index
`default CompletableFuture<List<T>>`	`getObjects(List<String> objectIDs, RequestOptions requestOptions)`	Get several objects from this index
`default CompletableFuture<List<T>>`	`getObjects(List<String> objectIDs, List<String> attributesToRetrieve)`	Get several objects from this index
`default CompletableFuture<List<T>>`	`getObjects(List<String> objectIDs, List<String> attributesToRetrieve, RequestOptions requestOptions)`	Get several objects from this index
`default CompletableFuture<Optional<Rule>>`	`getRule(String ruleID)`	Get a rule by ID
`default CompletableFuture<Optional<Rule>>`	`getRule(String ruleID, RequestOptions requestOptions)`	Get a rule by ID
`default CompletableFuture<IndexSettings>`	`getSettings()`	Get settings of this index
`default CompletableFuture<IndexSettings>`	`getSettings(RequestOptions requestOptions)`	Get settings of this index
`default CompletableFuture<Optional<AbstractSynonym>>`	`getSynonym(String synonymID)`	Get a synonym by ID
`default CompletableFuture<Optional<AbstractSynonym>>`	`getSynonym(String synonymID, RequestOptions requestOptions)`	Get a synonym by ID
`default CompletableFuture<List<ApiKey>>`	`listApiKeys()`	List keys of this index
`default CompletableFuture<List<ApiKey>>`	`listApiKeys(RequestOptions requestOptions)`	List keys of this index
`default CompletableFuture<List<ApiKey>>`	`listKeys()`	Deprecated.
`default CompletableFuture<AsyncTask>`	`moveTo(String dstIndexName)`	Moves an existing index
`default CompletableFuture<AsyncTask>`	`moveTo(String dstIndexName, RequestOptions requestOptions)`	Moves an existing index
`default CompletableFuture<AsyncTaskSingleIndex>`	`partialUpdateObject(PartialUpdateOperation operation)`	Partially update an object, create the object if it does not exist
`default CompletableFuture<AsyncTaskSingleIndex>`	`partialUpdateObject(PartialUpdateOperation operation, boolean createIfNotExists)`	Partially update an object
`default CompletableFuture<AsyncTaskSingleIndex>`	`partialUpdateObject(PartialUpdateOperation operation, boolean createIfNotExists, RequestOptions requestOptions)`	Partially update an object
`default CompletableFuture<AsyncTaskSingleIndex>`	`partialUpdateObject(PartialUpdateOperation operation, RequestOptions requestOptions)`	Partially update an object, create the object if it does not exist
`default CompletableFuture<AsyncTaskSingleIndex>`	`partialUpdateObject(String objectID, Object object)`	Partially update an object
`default CompletableFuture<AsyncTaskSingleIndex>`	`partialUpdateObject(String objectID, Object object, RequestOptions requestOptions)`	Partially update an object
`default CompletableFuture<AsyncTaskSingleIndex>`	`partialUpdateObjects(List<Object> objects)`	Partially update a objects
`default CompletableFuture<AsyncTaskSingleIndex>`	`partialUpdateObjects(List<Object> objects, RequestOptions requestOptions)`	Partially update a objects
`default CompletableFuture<AsyncTask>`	`saveObject(String objectID, T object)`	Override the content of object
`default CompletableFuture<AsyncTask>`	`saveObject(String objectID, T object, RequestOptions requestOptions)`	Override the content of object
`default CompletableFuture<AsyncTaskSingleIndex>`	`saveObjects(List<T> objects)`	Override the content the list of objects
`default CompletableFuture<AsyncTaskSingleIndex>`	`saveObjects(List<T> objects, RequestOptions requestOptions)`	Override the content the list of objects
`default CompletableFuture<AsyncTask>`	`saveRule(String ruleID, Rule rule)`	Saves/updates a rule without replacing it and NOT forwarding it to the replicas
`default CompletableFuture<AsyncTask>`	`saveRule(String ruleID, Rule rule, boolean forwardToReplicas)`	Saves/updates a rule
`default CompletableFuture<AsyncTask>`	`saveRule(String ruleID, Rule rule, boolean forwardToReplicas, RequestOptions requestOptions)`	Saves/updates a rule
`default CompletableFuture<AsyncTask>`	`saveRule(String ruleID, Rule rule, RequestOptions requestOptions)`	Saves/updates a rule without replacing it and NOT forwarding it to the replicas
`default CompletableFuture<AsyncTask>`	`saveSynonym(String synonymID, AbstractSynonym content)`	Saves/updates a synonym without replacing it and NOT forwarding it to the replicas
`default CompletableFuture<AsyncTask>`	`saveSynonym(String synonymID, AbstractSynonym content, boolean forwardToReplicas)`	Saves/updates a synonym without replacing
`default CompletableFuture<AsyncTask>`	`saveSynonym(String synonymID, AbstractSynonym content, boolean forwardToReplicas, boolean replaceExistingSynonyms)`	Saves/updates a synonym
`default CompletableFuture<AsyncTask>`	`saveSynonym(String synonymID, AbstractSynonym content, boolean forwardToReplicas, boolean replaceExistingSynonyms, RequestOptions requestOptions)`	Saves/updates a synonym
`default CompletableFuture<AsyncTask>`	`saveSynonym(String synonymID, AbstractSynonym content, boolean forwardToReplicas, RequestOptions requestOptions)`	Saves/updates a synonym without replacing
`default CompletableFuture<AsyncTask>`	`saveSynonym(String synonymID, AbstractSynonym content, RequestOptions requestOptions)`	Saves/updates a synonym without replacing it and NOT forwarding it to the slaves
`CompletableFuture<SearchResult<T>>`	`search(Query query)`	Search in the index
`CompletableFuture<SearchResult<T>>`	`search(Query query, RequestOptions requestOptions)`	Search in the index
`default CompletableFuture<SearchFacetResult>`	`searchFacet(String facetName, String facetQuery)`	Deprecated.
`default CompletableFuture<SearchFacetResult>`	`searchFacet(String facetName, String facetQuery, Query query)`	Deprecated.
`default CompletableFuture<SearchFacetResult>`	`searchForFacetValues(String facetName, String facetQuery)`	Search in a facet
`default CompletableFuture<SearchFacetResult>`	`searchForFacetValues(String facetName, String facetQuery, Query query)`	Search in a facet
`default CompletableFuture<SearchFacetResult>`	`searchForFacetValues(String facetName, String facetQuery, Query query, RequestOptions requestOptions)`	Search in a facet
`default CompletableFuture<SearchFacetResult>`	`searchForFacetValues(String facetName, String facetQuery, RequestOptions requestOptions)`	Search in a facet
`default CompletableFuture<SearchFacetResult>`	`searchInFacetValues(String facetName, String facetQuery)`	Deprecated.
`default CompletableFuture<SearchFacetResult>`	`searchInFacetValues(String facetName, String facetQuery, Query query)`	Deprecated.
`default CompletableFuture<SearchRuleResult>`	`searchRules(RuleQuery query)`	Search for Rules
`default CompletableFuture<SearchRuleResult>`	`searchRules(RuleQuery query, RequestOptions requestOptions)`	Search for Rules
`default CompletableFuture<SearchSynonymResult>`	`searchSynonyms(SynonymQuery query)`	Search for synonyms
`default CompletableFuture<SearchSynonymResult>`	`searchSynonyms(SynonymQuery query, RequestOptions requestOptions)`	Search for synonyms
`default CompletableFuture<AsyncTask>`	`setSettings(IndexSettings settings)`	Set settings of this index, and do not forward to replicas
`default CompletableFuture<AsyncTask>`	`setSettings(IndexSettings settings, RequestOptions requestOptions)`	Set settings of this index, and do not forward to slaves
`default CompletableFuture<AsyncTask>`	`setSettings(IndexSettings settings, Boolean forwardToReplicas)`	Set settings of this index
`default CompletableFuture<AsyncTask>`	`setSettings(IndexSettings settings, Boolean forwardToReplicas, RequestOptions requestOptions)`	Set settings of this index
`String`	`toString()`
`default CompletableFuture<CreateUpdateKey>`	`updateApiKey(String keyName, ApiKey key)`	Update a key by name from this index
`default CompletableFuture<CreateUpdateKey>`	`updateApiKey(String keyName, ApiKey key, RequestOptions requestOptions)`	Update a key by name from this index
`default CompletableFuture<CreateUpdateKey>`	`updateKey(String keyName, ApiKey key)`	Deprecated.
`default void`	`waitTask(AsyncTask task)`	Wait for the completion of a task, for 100ms
`default void`	`waitTask(AsyncTask task, long timeToWait)`	Wait for the completion of a task
`default void`	`waitTask(AsyncTask task, long timeToWait, RequestOptions requestOptions)`	Wait for the completion of a task
`default void`	`waitTask(AsyncTask task, RequestOptions requestOptions)`	Wait for the completion of a task, for 100ms

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getName
```
public String getName()
```

getKlass
```
public Class<T> getKlass()
```

getApiClient

public AsyncAPIClient getApiClient()

search

public CompletableFuture<SearchResult<T>> search(@Nonnull
                                                 Query query)

Search in the index

Parameters:: query - the query
Returns:: the result of the search, or a failed Future if the index does not exists

search

public CompletableFuture<SearchResult<T>> search(@Nonnull
                                                 Query query,
                                                 @Nonnull
                                                 RequestOptions requestOptions)

Search in the index

Parameters:: query - the query; requestOptions - Options to pass to this request
Returns:: the result of the search, or a failed Future if the index does not exists

batch

public CompletableFuture<AsyncTaskSingleIndex> batch(@Nonnull
                                                     List<BatchOperation> operations)

Custom batch

All operations must have index name set to null

Parameters:: operations - the list of operations to perform on this index
Returns:: the associated task
See Also:: subclasses

batch

public CompletableFuture<AsyncTaskSingleIndex> batch(@Nonnull
                                                     List<BatchOperation> operations,
                                                     @Nonnull
                                                     RequestOptions requestOptions)

Custom batch

All operations must have index name set to null

Parameters:: operations - the list of operations to perform on this index; requestOptions - Options to pass to this request
Returns:: the associated task
See Also:: subclasses

toString
```
public String toString()
```
Overrides:

toString in class Object

moveTo
```
public default CompletableFuture<AsyncTask> moveTo(@Nonnull
                                                   String dstIndexName)
```
Moves an existing index

Parameters:

dstIndexName - the new index name that will contains a copy of srcIndexName (destination will be overriten if it already exist)

Returns:

The task associated

moveTo

public default CompletableFuture<AsyncTask> moveTo(@Nonnull
                                                   String dstIndexName,
                                                   @Nonnull
                                                   RequestOptions requestOptions)

Moves an existing index

Parameters:: dstIndexName - the new index name that will contains a copy of srcIndexName (destination will be overriten if it already exist); requestOptions - Options to pass to this request
Returns:: The task associated

copyTo
```
public default CompletableFuture<AsyncTask> copyTo(@Nonnull
                                                   String dstIndexName)
```
Copy an existing index

Parameters:

dstIndexName - the new index name that will contains a copy of srcIndexName (destination will be overridden if it already exist)

Returns:

The task associated

copyTo

public default CompletableFuture<AsyncTask> copyTo(@Nonnull
                                                   String dstIndexName,
                                                   @Nonnull
                                                   RequestOptions requestOptions)

Copy an existing index

Parameters:: dstIndexName - the new index name that will contains a copy of srcIndexName (destination will be overridden if it already exist); requestOptions - Options to pass to this request
Returns:: The task associated

copyTo

public default CompletableFuture<AsyncTask> copyTo(@Nonnull
                                                   String dstIndexName,
                                                   @Nonnull
                                                   List<String> scopes,
                                                   @Nonnull
                                                   RequestOptions requestOptions)

Copy an existing index

Parameters:: dstIndexName - the new index name that will contains a copy of srcIndexName (destination will be overridden if it already exist); scopes - the list of scopes to copy; requestOptions - Options to pass to this request
Returns:: The task associated

copyTo

public default CompletableFuture<AsyncTask> copyTo(@Nonnull
                                                   String dstIndexName,
                                                   @Nonnull
                                                   List<String> scopes)

Copy an existing index

Parameters:: dstIndexName - the new index name that will contains a copy of srcIndexName (destination will be overridden if it already exist); scopes - the list of scopes to copy
Returns:: The task associated

delete

public default CompletableFuture<AsyncTask> delete()

Deletes the index

Returns:: the related AsyncTask

delete

public default CompletableFuture<AsyncTask> delete(@Nonnull
                                                   RequestOptions requestOptions)

Deletes the index

Parameters:: requestOptions - Options to pass to this request
Returns:: the related AsyncTask

clear
```
public default CompletableFuture<AsyncTask> clear()
```
Delete the index content without removing settings and index specific API keys.

Returns:

the related AsyncTask

clear

public default CompletableFuture<AsyncTask> clear(@Nonnull
                                                  RequestOptions requestOptions)

Delete the index content without removing settings and index specific API keys.

Parameters:: requestOptions - Options to pass to this request
Returns:: the related AsyncTask

waitTask

public default void waitTask(@Nonnull
                             AsyncTask task,
                             long timeToWait)

Wait for the completion of a task

Parameters:: task - task to wait for; timeToWait - the time to wait in milliseconds

waitTask

public default void waitTask(@Nonnull
                             AsyncTask task,
                             long timeToWait,
                             @Nonnull
                             RequestOptions requestOptions)

Wait for the completion of a task

Parameters:: task - task to wait for; timeToWait - the time to wait in milliseconds; requestOptions - Options to pass to this request

waitTask

public default void waitTask(@Nonnull
                             AsyncTask task)

Wait for the completion of a task, for 100ms

Parameters:: task - task to wait for

waitTask

public default void waitTask(@Nonnull
                             AsyncTask task,
                             @Nonnull
                             RequestOptions requestOptions)

Wait for the completion of a task, for 100ms

Parameters:: task - task to wait for; requestOptions - Options to pass to this request

addObject

public default CompletableFuture<AsyncTaskIndexing> addObject(@Nonnull
                                                              T object)

Add an object in this index

Parameters:: object - object to add
Returns:: the related AsyncTask

addObject

public default CompletableFuture<AsyncTaskIndexing> addObject(@Nonnull
                                                              T object,
                                                              @Nonnull
                                                              RequestOptions requestOptions)

Add an object in this index

Parameters:: object - object to add; requestOptions - Options to pass to this request
Returns:: the related AsyncTask

addObject

public default CompletableFuture<AsyncTaskIndexing> addObject(@Nonnull
                                                              String objectID,
                                                              @Nonnull
                                                              T object)

Add an object in this index with a unique identifier

Parameters:: objectID - the objectID associated to this object (if this objectID already exist the old object will be overridden); object - object to add
Returns:: the related AsyncTask

addObject

public default CompletableFuture<AsyncTaskIndexing> addObject(@Nonnull
                                                              String objectID,
                                                              @Nonnull
                                                              T object,
                                                              @Nonnull
                                                              RequestOptions requestOptions)

Add an object in this index with a unique identifier

Parameters:: objectID - the objectID associated to this object (if this objectID already exist the old object will be overridden); object - object to add; requestOptions - Options to pass to this request
Returns:: the related AsyncTask

addObjects

public default CompletableFuture<AsyncTaskSingleIndex> addObjects(@Nonnull
                                                                  List<T> objects)

Add several objects

Parameters:: objects - objects to add
Returns:: the related AsyncTask

addObjects

public default CompletableFuture<AsyncTaskSingleIndex> addObjects(@Nonnull
                                                                  List<T> objects,
                                                                  @Nonnull
                                                                  RequestOptions requestOptions)

Add several objects

Parameters:: objects - objects to add; requestOptions - Options to pass to this request
Returns:: the related AsyncTask

getObject

public default CompletableFuture<Optional<T>> getObject(@Nonnull
                                                        String objectID)

Get an object from this index

Parameters:: objectID - the unique identifier of the object to retrieve
Returns:: The object

getObject

public default CompletableFuture<Optional<T>> getObject(@Nonnull
                                                        String objectID,
                                                        @Nonnull
                                                        RequestOptions requestOptions)

Get an object from this index

Parameters:: objectID - the unique identifier of the object to retrieve; requestOptions - Options to pass to this request
Returns:: The object

getObjects

public default CompletableFuture<List<T>> getObjects(@Nonnull
                                                     List<String> objectIDs)

Get several objects from this index

Parameters:: objectIDs - the list of unique identifier of objects to retrieve
Returns:: the list of objects

getObjects

public default CompletableFuture<List<T>> getObjects(@Nonnull
                                                     List<String> objectIDs,
                                                     @Nonnull
                                                     RequestOptions requestOptions)

Get several objects from this index

Parameters:: objectIDs - the list of unique identifier of objects to retrieve; requestOptions - Options to pass to this request
Returns:: the list of objects

getObjects

public default CompletableFuture<List<T>> getObjects(@Nonnull
                                                     List<String> objectIDs,
                                                     @Nonnull
                                                     List<String> attributesToRetrieve)

Get several objects from this index

Parameters:: objectIDs - the list of unique identifier of objects to retrieve; attributesToRetrieve - the list of attributes to retrieve for these objects
Returns:: the list of objects

getObjects

public default CompletableFuture<List<T>> getObjects(@Nonnull
                                                     List<String> objectIDs,
                                                     @Nonnull
                                                     List<String> attributesToRetrieve,
                                                     @Nonnull
                                                     RequestOptions requestOptions)

Get several objects from this index

Parameters:: objectIDs - the list of unique identifier of objects to retrieve; attributesToRetrieve - the list of attributes to retrieve for these objects; requestOptions - Options to pass to this request
Returns:: the list of objects

saveObject

public default CompletableFuture<AsyncTask> saveObject(@Nonnull
                                                       String objectID,
                                                       @Nonnull
                                                       T object)

Override the content of object

Parameters:: objectID - the unique identifier of the object to retrieve; object - the object to update
Returns:: the related AsyncTask

saveObject

public default CompletableFuture<AsyncTask> saveObject(@Nonnull
                                                       String objectID,
                                                       @Nonnull
                                                       T object,
                                                       @Nonnull
                                                       RequestOptions requestOptions)

Override the content of object

Parameters:: objectID - the unique identifier of the object to retrieve; object - the object to update; requestOptions - Options to pass to this request
Returns:: the related AsyncTask

saveObjects

public default CompletableFuture<AsyncTaskSingleIndex> saveObjects(@Nonnull
                                                                   List<T> objects)

Override the content the list of objects

Parameters:: objects - the list objects to update
Returns:: the related AsyncTask

saveObjects

public default CompletableFuture<AsyncTaskSingleIndex> saveObjects(@Nonnull
                                                                   List<T> objects,
                                                                   @Nonnull
                                                                   RequestOptions requestOptions)

Override the content the list of objects

Parameters:: objects - the list objects to update; requestOptions - Options to pass to this request
Returns:: the related AsyncTask

deleteObject

public default CompletableFuture<AsyncTask> deleteObject(@Nonnull
                                                         String objectID)

Delete an object from the index

Parameters:: objectID - the unique identifier of the object to retrieve
Returns:: the related AsyncTask

deleteObject

public default CompletableFuture<AsyncTask> deleteObject(@Nonnull
                                                         String objectID,
                                                         @Nonnull
                                                         RequestOptions requestOptions)

Delete an object from the index

Parameters:: objectID - the unique identifier of the object to retrieve; requestOptions - Options to pass to this request
Returns:: the related AsyncTask

deleteObjects

public default CompletableFuture<AsyncTaskSingleIndex> deleteObjects(@Nonnull
                                                                     List<String> objectIDs)

Delete objects from the index

Parameters:: objectIDs - the list of unique identifier of the object to retrieve
Returns:: the related AsyncTask

deleteObjects

public default CompletableFuture<AsyncTaskSingleIndex> deleteObjects(@Nonnull
                                                                     List<String> objectIDs,
                                                                     @Nonnull
                                                                     RequestOptions requestOptions)

Delete objects from the index

Parameters:: objectIDs - the list of unique identifier of the object to retrieve; requestOptions - Options to pass to this request
Returns:: the related AsyncTask

getSettings

public default CompletableFuture<IndexSettings> getSettings()

Get settings of this index

Returns:: the settings

getSettings

public default CompletableFuture<IndexSettings> getSettings(@Nonnull
                                                            RequestOptions requestOptions)

Get settings of this index

Parameters:: requestOptions - Options to pass to this request
Returns:: the settings

setSettings

public default CompletableFuture<AsyncTask> setSettings(@Nonnull
                                                        IndexSettings settings)

Set settings of this index, and do not forward to replicas

Parameters:: settings - the settings to set
Returns:: the related AsyncTask

setSettings

public default CompletableFuture<AsyncTask> setSettings(@Nonnull
                                                        IndexSettings settings,
                                                        @Nonnull
                                                        RequestOptions requestOptions)

Set settings of this index, and do not forward to slaves

Parameters:: settings - the settings to set; requestOptions - Options to pass to this request
Returns:: the related AsyncTask

setSettings

public default CompletableFuture<AsyncTask> setSettings(@Nonnull
                                                        IndexSettings settings,
                                                        @Nonnull
                                                        Boolean forwardToReplicas)

Set settings of this index

Parameters:: settings - the settings to set; forwardToReplicas - should these updates be forwarded to the replicas
Returns:: the related AsyncTask

setSettings

public default CompletableFuture<AsyncTask> setSettings(@Nonnull
                                                        IndexSettings settings,
                                                        @Nonnull
                                                        Boolean forwardToReplicas,
                                                        @Nonnull
                                                        RequestOptions requestOptions)

Set settings of this index

Parameters:: settings - the settings to set; forwardToReplicas - should these updates be forwarded to the slaves; requestOptions - Options to pass to this request
Returns:: the related AsyncTask

listKeys

@Deprecated
public default CompletableFuture<List<ApiKey>> listKeys()

Deprecated.

Deprecated: use listApiKeys

listApiKeys

public default CompletableFuture<List<ApiKey>> listApiKeys()

List keys of this index

Returns:: the list of keys

listApiKeys

public default CompletableFuture<List<ApiKey>> listApiKeys(@Nonnull
                                                           RequestOptions requestOptions)

List keys of this index

Parameters:: requestOptions - Options to pass to this request
Returns:: the list of keys

getKey

@Deprecated
public default CompletableFuture<Optional<ApiKey>> getKey(@Nonnull
                                                          String key)

Deprecated.

Deprecated: use getApiKey

getApiKey

public default CompletableFuture<Optional<ApiKey>> getApiKey(@Nonnull
                                                             String key)

Get a key by name from this index

Parameters:: key - the key name
Returns:: the key

getApiKey

public default CompletableFuture<Optional<ApiKey>> getApiKey(@Nonnull
                                                             String key,
                                                             @Nonnull
                                                             RequestOptions requestOptions)

Get a key by name from this index

Parameters:: key - the key name; requestOptions - Options to pass to this request
Returns:: the key

deleteKey

@Deprecated
public default CompletableFuture<DeleteKey> deleteKey(@Nonnull
                                                      String key)

Deprecated.

Deprecated: use deleteApiKey

deleteApiKey

public default CompletableFuture<DeleteKey> deleteApiKey(@Nonnull
                                                         String key)

Delete a key by name from this index

Parameters:: key - the key name
Returns:: the deleted key

deleteApiKey

public default CompletableFuture<DeleteKey> deleteApiKey(@Nonnull
                                                         String key,
                                                         @Nonnull
                                                         RequestOptions requestOptions)

Delete a key by name from this index

Parameters:: key - the key name; requestOptions - Options to pass to this request
Returns:: the deleted key

addKey

@Deprecated
public default CompletableFuture<CreateUpdateKey> addKey(@Nonnull
                                                         ApiKey key)

Deprecated.

Deprecated: use addApiKey

addApiKey

public default CompletableFuture<CreateUpdateKey> addApiKey(@Nonnull
                                                            ApiKey key)

Add a key to this index

Parameters:: key - the key
Returns:: the created key

addApiKey

public default CompletableFuture<CreateUpdateKey> addApiKey(@Nonnull
                                                            ApiKey key,
                                                            @Nonnull
                                                            RequestOptions requestOptions)

Add a key to this index

Parameters:: key - the key; requestOptions - Options to pass to this request
Returns:: the created key

updateKey

@Deprecated
public default CompletableFuture<CreateUpdateKey> updateKey(@Nonnull
                                                            String keyName,
                                                            @Nonnull
                                                            ApiKey key)

Deprecated.

Deprecated: use updateApiKey

updateApiKey

public default CompletableFuture<CreateUpdateKey> updateApiKey(@Nonnull
                                                               String keyName,
                                                               @Nonnull
                                                               ApiKey key)

Update a key by name from this index

Parameters:: keyName - the key name; key - the key to update
Returns:: the updated key

updateApiKey

public default CompletableFuture<CreateUpdateKey> updateApiKey(@Nonnull
                                                               String keyName,
                                                               @Nonnull
                                                               ApiKey key,
                                                               @Nonnull
                                                               RequestOptions requestOptions)

Update a key by name from this index

Parameters:: keyName - the key name; key - the key to update; requestOptions - Options to pass to this request
Returns:: the updated key

searchForFacetValues

public default CompletableFuture<SearchFacetResult> searchForFacetValues(@Nonnull
                                                                         String facetName,
                                                                         @Nonnull
                                                                         String facetQuery,
                                                                         Query query)

Search in a facet

Parameters:: facetName - The name of the facet to search in; facetQuery - The search query for this facet; query - the query (not required)
Returns:: the result of the search

searchForFacetValues

public default CompletableFuture<SearchFacetResult> searchForFacetValues(@Nonnull
                                                                         String facetName,
                                                                         @Nonnull
                                                                         String facetQuery,
                                                                         Query query,
                                                                         @Nonnull
                                                                         RequestOptions requestOptions)

Search in a facet

Parameters:: facetName - The name of the facet to search in; facetQuery - The search query for this facet; query - the query (not required); requestOptions - Options to pass to this request
Returns:: the result of the search

searchForFacetValues

public default CompletableFuture<SearchFacetResult> searchForFacetValues(@Nonnull
                                                                         String facetName,
                                                                         @Nonnull
                                                                         String facetQuery)

Search in a facet

Parameters:: facetName - The name of the facet to search in; facetQuery - The search query for this facet
Returns:: the result of the search

searchForFacetValues

public default CompletableFuture<SearchFacetResult> searchForFacetValues(@Nonnull
                                                                         String facetName,
                                                                         @Nonnull
                                                                         String facetQuery,
                                                                         @Nonnull
                                                                         RequestOptions requestOptions)

Search in a facet

Parameters:: facetName - The name of the facet to search in; facetQuery - The search query for this facet; requestOptions - Options to pass to this request
Returns:: the result of the search

searchInFacetValues

@Deprecated
public default CompletableFuture<SearchFacetResult> searchInFacetValues(@Nonnull
                                                                        String facetName,
                                                                        @Nonnull
                                                                        String facetQuery,
                                                                        Query query)

Deprecated.

searchInFacetValues

@Deprecated
public default CompletableFuture<SearchFacetResult> searchInFacetValues(@Nonnull
                                                                        String facetName,
                                                                        @Nonnull
                                                                        String facetQuery)

Deprecated.

searchFacet

@Deprecated
public default CompletableFuture<SearchFacetResult> searchFacet(@Nonnull
                                                                String facetName,
                                                                @Nonnull
                                                                String facetQuery,
                                                                Query query)

Deprecated.

searchFacet

@Deprecated
public default CompletableFuture<SearchFacetResult> searchFacet(@Nonnull
                                                                String facetName,
                                                                @Nonnull
                                                                String facetQuery)

Deprecated.

partialUpdateObject

public default CompletableFuture<AsyncTaskSingleIndex> partialUpdateObject(@Nonnull
                                                                           String objectID,
                                                                           @Nonnull
                                                                           Object object)

Partially update an object

Parameters:: objectID - the ID of object to update; object - the object to update
Returns:: the associated task
See Also:: subclasses

partialUpdateObject

public default CompletableFuture<AsyncTaskSingleIndex> partialUpdateObject(@Nonnull
                                                                           String objectID,
                                                                           @Nonnull
                                                                           Object object,
                                                                           @Nonnull
                                                                           RequestOptions requestOptions)

Partially update an object

Parameters:: objectID - the ID of object to update; object - the object to update; requestOptions - Options to pass to this request
Returns:: the associated task
See Also:: subclasses

partialUpdateObjects

public default CompletableFuture<AsyncTaskSingleIndex> partialUpdateObjects(@Nonnull
                                                                            List<Object> objects)

Partially update a objects

Parameters:: objects - the list of objects to update (with an objectID)
Returns:: the associated task

partialUpdateObjects

public default CompletableFuture<AsyncTaskSingleIndex> partialUpdateObjects(@Nonnull
                                                                            List<Object> objects,
                                                                            @Nonnull
                                                                            RequestOptions requestOptions)

Partially update a objects

Parameters:: objects - the list of objects to update (with an objectID); requestOptions - Options to pass to this request
Returns:: the associated task

partialUpdateObject

public default CompletableFuture<AsyncTaskSingleIndex> partialUpdateObject(@Nonnull
                                                                           PartialUpdateOperation operation)

Partially update an object, create the object if it does not exist

Parameters:: operation - the operation to perform on this object
Returns:: the associated task
See Also:: subclasses

partialUpdateObject

public default CompletableFuture<AsyncTaskSingleIndex> partialUpdateObject(@Nonnull
                                                                           PartialUpdateOperation operation,
                                                                           @Nonnull
                                                                           RequestOptions requestOptions)

Partially update an object, create the object if it does not exist

Parameters:: operation - the operation to perform on this object; requestOptions - Options to pass to this request
Returns:: the associated task
See Also:: subclasses

partialUpdateObject

public default CompletableFuture<AsyncTaskSingleIndex> partialUpdateObject(@Nonnull
                                                                           PartialUpdateOperation operation,
                                                                           boolean createIfNotExists)

Partially update an object

Parameters:: operation - the operation to perform on this object; createIfNotExists - should the object be created or not
Returns:: the associated task
See Also:: subclasses

partialUpdateObject

public default CompletableFuture<AsyncTaskSingleIndex> partialUpdateObject(@Nonnull
                                                                           PartialUpdateOperation operation,
                                                                           boolean createIfNotExists,
                                                                           @Nonnull
                                                                           RequestOptions requestOptions)

Partially update an object

Parameters:: operation - the operation to perform on this object; createIfNotExists - should the object be created or not; requestOptions - Options to pass to this request
Returns:: the associated task
See Also:: subclasses

saveSynonym

public default CompletableFuture<AsyncTask> saveSynonym(@Nonnull
                                                        String synonymID,
                                                        @Nonnull
                                                        AbstractSynonym content)

Saves/updates a synonym without replacing it and NOT forwarding it to the replicas

Parameters:: synonymID - the id of the synonym; content - the synonym
Returns:: the associated task

saveSynonym

public default CompletableFuture<AsyncTask> saveSynonym(@Nonnull
                                                        String synonymID,
                                                        @Nonnull
                                                        AbstractSynonym content,
                                                        @Nonnull
                                                        RequestOptions requestOptions)

Saves/updates a synonym without replacing it and NOT forwarding it to the slaves

Parameters:: synonymID - the id of the synonym; content - the synonym; requestOptions - Options to pass to this request
Returns:: the associated task

saveSynonym

public default CompletableFuture<AsyncTask> saveSynonym(@Nonnull
                                                        String synonymID,
                                                        @Nonnull
                                                        AbstractSynonym content,
                                                        boolean forwardToReplicas)

Saves/updates a synonym without replacing

Parameters:: synonymID - the id of the synonym; content - the synonym; forwardToReplicas - should this request be forwarded to replicas
Returns:: the associated task

saveSynonym

public default CompletableFuture<AsyncTask> saveSynonym(@Nonnull
                                                        String synonymID,
                                                        @Nonnull
                                                        AbstractSynonym content,
                                                        boolean forwardToReplicas,
                                                        @Nonnull
                                                        RequestOptions requestOptions)

Saves/updates a synonym without replacing

Parameters:: synonymID - the id of the synonym; content - the synonym; forwardToReplicas - should this request be forwarded to slaves; requestOptions - Options to pass to this request
Returns:: the associated task

saveSynonym

public default CompletableFuture<AsyncTask> saveSynonym(@Nonnull
                                                        String synonymID,
                                                        @Nonnull
                                                        AbstractSynonym content,
                                                        boolean forwardToReplicas,
                                                        boolean replaceExistingSynonyms)

Saves/updates a synonym

Parameters:: synonymID - the id of the synonym; content - the synonym; forwardToReplicas - should this request be forwarded to replicas; replaceExistingSynonyms - should replace if this synonyms exists
Returns:: the associated task

saveSynonym

public default CompletableFuture<AsyncTask> saveSynonym(@Nonnull
                                                        String synonymID,
                                                        @Nonnull
                                                        AbstractSynonym content,
                                                        boolean forwardToReplicas,
                                                        boolean replaceExistingSynonyms,
                                                        @Nonnull
                                                        RequestOptions requestOptions)

Saves/updates a synonym

Parameters:: synonymID - the id of the synonym; content - the synonym; forwardToReplicas - should this request be forwarded to slaves; replaceExistingSynonyms - should replace if this synonyms exists; requestOptions - Options to pass to this request
Returns:: the associated task

getSynonym

public default CompletableFuture<Optional<AbstractSynonym>> getSynonym(@Nonnull
                                                                       String synonymID)

Get a synonym by ID

Parameters:: synonymID - the id of the synonym
Returns:: the associated task

getSynonym

public default CompletableFuture<Optional<AbstractSynonym>> getSynonym(@Nonnull
                                                                       String synonymID,
                                                                       @Nonnull
                                                                       RequestOptions requestOptions)

Get a synonym by ID

Parameters:: synonymID - the id of the synonym; requestOptions - Options to pass to this request
Returns:: the associated task

deleteSynonym

public default CompletableFuture<AsyncTask> deleteSynonym(@Nonnull
                                                          String synonymID)

Deletes a synonym by ID and NOT forwarding it to the replicas

Parameters:: synonymID - the id of the synonym
Returns:: the associated task

deleteSynonym

public default CompletableFuture<AsyncTask> deleteSynonym(@Nonnull
                                                          String synonymID,
                                                          @Nonnull
                                                          RequestOptions requestOptions)

Deletes a synonym by ID and NOT forwarding it to the slaves

Parameters:: synonymID - the id of the synonym; requestOptions - Options to pass to this request
Returns:: the associated task

deleteSynonym

public default CompletableFuture<AsyncTask> deleteSynonym(@Nonnull
                                                          String synonymID,
                                                          boolean forwardToReplicas)

Deletes a synonym

Parameters:: synonymID - the id of the synonym; forwardToReplicas - should this request be forwarded to replicas
Returns:: the associated task

deleteSynonym

public default CompletableFuture<AsyncTask> deleteSynonym(@Nonnull
                                                          String synonymID,
                                                          boolean forwardToReplicas,
                                                          @Nonnull
                                                          RequestOptions requestOptions)

Deletes a synonym

Parameters:: synonymID - the id of the synonym; forwardToReplicas - should this request be forwarded to slaves; requestOptions - Options to pass to this request
Returns:: the associated task

clearSynonyms
```
public default CompletableFuture<AsyncTask> clearSynonyms()
```
Clear all synonyms and NOT forwarding it to the replicas

Returns:

the associated task

clearSynonyms

public default CompletableFuture<AsyncTask> clearSynonyms(@Nonnull
                                                          RequestOptions requestOptions)

Clear all synonyms and NOT forwarding it to the slaves

Parameters:: requestOptions - Options to pass to this request
Returns:: the associated task

clearSynonyms

public default CompletableFuture<AsyncTask> clearSynonyms(boolean forwardToReplicas)

Clears all synonyms

Returns:: the associated task

clearSynonyms

public default CompletableFuture<AsyncTask> clearSynonyms(boolean forwardToReplicas,
                                                          @Nonnull
                                                          RequestOptions requestOptions)

Clears all synonyms

Parameters:: requestOptions - Options to pass to this request
Returns:: the associated task

searchSynonyms

public default CompletableFuture<SearchSynonymResult> searchSynonyms(@Nonnull
                                                                     SynonymQuery query)

Search for synonyms

Parameters:: query - the query
Returns:: the results of the query

searchSynonyms

public default CompletableFuture<SearchSynonymResult> searchSynonyms(@Nonnull
                                                                     SynonymQuery query,
                                                                     @Nonnull
                                                                     RequestOptions requestOptions)

Search for synonyms

Parameters:: query - the query; requestOptions - Options to pass to this request
Returns:: the results of the query

batchSynonyms

public default CompletableFuture<AsyncTask> batchSynonyms(@Nonnull
                                                          List<AbstractSynonym> synonyms,
                                                          boolean forwardToReplicas,
                                                          boolean replaceExistingSynonyms)

Add or Replace a list of synonyms

Parameters:: synonyms - List of synonyms; forwardToReplicas - Forward the operation to the slave indices; replaceExistingSynonyms - Replace the existing synonyms with this batch
Returns:: the associated task

batchSynonyms

public default CompletableFuture<AsyncTask> batchSynonyms(@Nonnull
                                                          List<AbstractSynonym> synonyms,
                                                          boolean forwardToReplicas,
                                                          boolean replaceExistingSynonyms,
                                                          @Nonnull
                                                          RequestOptions requestOptions)

Add or Replace a list of synonyms

Parameters:: synonyms - List of synonyms; forwardToReplicas - Forward the operation to the slave indices; replaceExistingSynonyms - Replace the existing synonyms with this batch; requestOptions - Options to pass to this request
Returns:: the associated task

batchSynonyms

public default CompletableFuture<AsyncTask> batchSynonyms(@Nonnull
                                                          List<AbstractSynonym> synonyms,
                                                          boolean forwardToReplicas)

Add or Replace a list of synonyms, no replacement

Parameters:: synonyms - List of synonyms; forwardToReplicas - Forward the operation to the slave indices
Returns:: the associated task

batchSynonyms

public default CompletableFuture<AsyncTask> batchSynonyms(@Nonnull
                                                          List<AbstractSynonym> synonyms,
                                                          boolean forwardToReplicas,
                                                          @Nonnull
                                                          RequestOptions requestOptions)

Add or Replace a list of synonyms, no replacement

Parameters:: synonyms - List of synonyms; forwardToReplicas - Forward the operation to the slave indices; requestOptions - Options to pass to this request
Returns:: the associated task

batchSynonyms

public default CompletableFuture<AsyncTask> batchSynonyms(@Nonnull
                                                          List<AbstractSynonym> synonyms)

Add or Replace a list of synonyms, no forward to slaves, and no replacement

Parameters:: synonyms - List of synonyms
Returns:: the associated task

batchSynonyms

public default CompletableFuture<AsyncTask> batchSynonyms(@Nonnull
                                                          List<AbstractSynonym> synonyms,
                                                          @Nonnull
                                                          RequestOptions requestOptions)

Add or Replace a list of synonyms, no forward to slaves, and no replacement

Parameters:: synonyms - List of synonyms; requestOptions - Options to pass to this request
Returns:: the associated task

saveRule

public default CompletableFuture<AsyncTask> saveRule(@Nonnull
                                                     String ruleID,
                                                     @Nonnull
                                                     Rule rule)

Saves/updates a rule without replacing it and NOT forwarding it to the replicas

Parameters:: ruleID - the id of the query rule; rule - the query rule
Returns:: the associated task

saveRule

public default CompletableFuture<AsyncTask> saveRule(@Nonnull
                                                     String ruleID,
                                                     @Nonnull
                                                     Rule rule,
                                                     @Nonnull
                                                     RequestOptions requestOptions)

Saves/updates a rule without replacing it and NOT forwarding it to the replicas

Parameters:: ruleID - the id of the query rule; rule - the query rule; requestOptions - Options to pass to this request
Returns:: the associated task

saveRule

public default CompletableFuture<AsyncTask> saveRule(@Nonnull
                                                     String ruleID,
                                                     @Nonnull
                                                     Rule rule,
                                                     boolean forwardToReplicas)

Saves/updates a rule

Parameters:: ruleID - the id of the query rule; rule - the query rule; forwardToReplicas - should this request be forwarded to replicas
Returns:: the associated task

saveRule

public default CompletableFuture<AsyncTask> saveRule(@Nonnull
                                                     String ruleID,
                                                     @Nonnull
                                                     Rule rule,
                                                     boolean forwardToReplicas,
                                                     @Nonnull
                                                     RequestOptions requestOptions)

Saves/updates a rule

Parameters:: ruleID - the id of the query rule; rule - the query rule; forwardToReplicas - should this request be forwarded to replicas; requestOptions - Options to pass to this request
Returns:: the associated task

getRule

public default CompletableFuture<Optional<Rule>> getRule(@Nonnull
                                                         String ruleID)

Get a rule by ID

Parameters:: ruleID - the id of the rule
Returns:: the associated task

getRule

public default CompletableFuture<Optional<Rule>> getRule(@Nonnull
                                                         String ruleID,
                                                         @Nonnull
                                                         RequestOptions requestOptions)

Get a rule by ID

Parameters:: ruleID - the id of the rule; requestOptions - Options to pass to this request
Returns:: the associated task

deleteRule

public default CompletableFuture<AsyncTask> deleteRule(@Nonnull
                                                       String ruleID)

Deletes a rule by ID and NOT forwarding it to the replicas

Parameters:: ruleID - the id of the query rule
Returns:: the associated task

deleteRule

public default CompletableFuture<AsyncTask> deleteRule(@Nonnull
                                                       String ruleID,
                                                       @Nonnull
                                                       RequestOptions requestOptions)

Deletes a rule by ID and NOT forwarding it to the replicas

Parameters:: ruleID - the id of the query rule; requestOptions - Options to pass to this request
Returns:: the associated task

deleteRule

public default CompletableFuture<AsyncTask> deleteRule(@Nonnull
                                                       String ruleID,
                                                       boolean forwardToReplicas)

Deletes a rule

Parameters:: ruleID - the id of the rule; forwardToReplicas - should this request be forwarded to replicas
Returns:: the associated task

deleteRule

public default CompletableFuture<AsyncTask> deleteRule(@Nonnull
                                                       String ruleID,
                                                       boolean forwardToReplicas,
                                                       @Nonnull
                                                       RequestOptions requestOptions)

Deletes a rule

Parameters:: ruleID - the id of the rule; forwardToReplicas - should this request be forwarded to replicas; requestOptions - Options to pass to this request
Returns:: the associated task

clearRules
```
public default CompletableFuture<AsyncTask> clearRules()
```
Clear all Rules and NOT forwarding it to the replicas

Returns:

the associated task

clearRules

public default CompletableFuture<AsyncTask> clearRules(@Nonnull
                                                       RequestOptions requestOptions)

Clear all Rules and NOT forwarding it to the replicas

Parameters:: requestOptions - Options to pass to this request
Returns:: the associated task

clearRules

public default CompletableFuture<AsyncTask> clearRules(boolean forwardToReplicas)

Clears all Rules

Returns:: the associated task

clearRules

public default CompletableFuture<AsyncTask> clearRules(boolean forwardToReplicas,
                                                       @Nonnull
                                                       RequestOptions requestOptions)

Clears all Rules

Parameters:: requestOptions - Options to pass to this request
Returns:: the associated task

searchRules

public default CompletableFuture<SearchRuleResult> searchRules(@Nonnull
                                                               RuleQuery query)

Search for Rules

Parameters:: query - the query
Returns:: the results of the query

searchRules

public default CompletableFuture<SearchRuleResult> searchRules(@Nonnull
                                                               RuleQuery query,
                                                               @Nonnull
                                                               RequestOptions requestOptions)

Search for Rules

Parameters:: requestOptions - Options to pass to this request; query - the query
Returns:: the results of the query

batchRules

public default CompletableFuture<AsyncTask> batchRules(@Nonnull
                                                       List<Rule> rules,
                                                       boolean forwardToReplicas,
                                                       boolean clearExistingRules)

Add or replace a list of Rules

Parameters:: rules - List of Rules; forwardToReplicas - Forward the operation to the replicas indices; clearExistingRules - Replace the existing Rules with this batch
Returns:: the associated task

batchRules

public default CompletableFuture<AsyncTask> batchRules(@Nonnull
                                                       List<Rule> rules,
                                                       boolean forwardToReplicas,
                                                       boolean clearExistingRules,
                                                       @Nonnull
                                                       RequestOptions requestOptions)

Add or replace a list of Rules

Parameters:: rules - List of Rules; forwardToReplicas - Forward the operation to the replicas indices; clearExistingRules - Replace the existing Rules with this batch; requestOptions - Options to pass to this request
Returns:: the associated task

batchRules

public default CompletableFuture<AsyncTask> batchRules(@Nonnull
                                                       List<Rule> rules,
                                                       boolean forwardToReplicas)

Add or Replace a list of Rules, no replacement

Parameters:: rules - List of Rules; forwardToReplicas - Forward the operation to the slave indices
Returns:: the associated task

batchRules

public default CompletableFuture<AsyncTask> batchRules(@Nonnull
                                                       List<Rule> rules,
                                                       boolean forwardToReplicas,
                                                       @Nonnull
                                                       RequestOptions requestOptions)

Add or Replace a list of Rules, no replacement

Parameters:: rules - List of Rules; forwardToReplicas - Forward the operation to the slave indices; requestOptions - Options to pass to this request
Returns:: the associated task

batchRules

public default CompletableFuture<AsyncTask> batchRules(@Nonnull
                                                       List<Rule> rules)

Add or Replace a list of Rules, no forward to replicas, and no replacement

Parameters:: rules - List of Rules
Returns:: the associated task

batchRules

public default CompletableFuture<AsyncTask> batchRules(@Nonnull
                                                       List<Rule> rules,
                                                       @Nonnull
                                                       RequestOptions requestOptions)

Add or Replace a list of Rules, no forward to replicas, and no replacement

Parameters:: rules - List of Rules; requestOptions - Options to pass to this request
Returns:: the associated task

deleteBy

public default CompletableFuture<AsyncTask> deleteBy(@Nonnull
                                                     Query query)

Delete records matching a query

Parameters:: query - The query

deleteBy

public default CompletableFuture<AsyncTask> deleteBy(@Nonnull
                                                     Query query,
                                                     @Nonnull
                                                     RequestOptions requestOptions)

Delete records matching a query Deprecated, use deleteBy

Parameters:: query - The query; requestOptions - Options to pass to this request

Class AsyncIndex<T>

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getName

getKlass

getApiClient

search

search

batch

batch

toString

moveTo

moveTo

copyTo

copyTo

copyTo

copyTo

delete

delete

clear

clear

waitTask

waitTask

waitTask

waitTask

addObject

addObject

addObject

addObject

addObjects

addObjects

getObject

getObject

getObjects

getObjects

getObjects

getObjects

saveObject

saveObject

saveObjects

saveObjects

deleteObject

deleteObject

deleteObjects

deleteObjects

getSettings

getSettings

setSettings

setSettings

setSettings

setSettings

listKeys

listApiKeys

listApiKeys

getKey

getApiKey

getApiKey

deleteKey

deleteApiKey

deleteApiKey

addKey

addApiKey

addApiKey

updateKey

updateApiKey

updateApiKey

searchForFacetValues

searchForFacetValues

searchForFacetValues

searchForFacetValues

searchInFacetValues

searchInFacetValues

searchFacet

searchFacet

partialUpdateObject

partialUpdateObject

partialUpdateObjects

partialUpdateObjects

partialUpdateObject