Index (algoliasearch-common 2.15.2 API)

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

```
public class Index<T>
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class Index.Attributes

Nested Classes
Modifier and Type	Class	Description
`static class`	`Index.Attributes`

Method Summary

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

search
```
public SearchResult<T> search(@Nonnull
                              Query query)
                       throws AlgoliaException
```
Search in the index throws a AlgoliaIndexNotFoundException if the index does not exists

Parameters:

query - the query

Returns:

the result of the search

Throws:

AlgoliaException

search

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

Search in the index throws a AlgoliaIndexNotFoundException if the index does not exists

Parameters:: query - the query
Returns:: the result of the search
Throws:: AlgoliaException

batch
```
public TaskSingleIndex batch(@Nonnull
                             List<BatchOperation> operations)
                      throws AlgoliaException
```
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

Throws:

AlgoliaException

See Also:

subclasses

batch

public TaskSingleIndex batch(@Nonnull
                             List<BatchOperation> operations,
                             @Nonnull
                             RequestOptions requestOptions)
                      throws AlgoliaException

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
Throws:: AlgoliaException
See Also:: subclasses

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

toString in class Object

deleteByQuery

@Deprecated
public default void deleteByQuery(@Nonnull
                                  Query query)
                           throws AlgoliaException

Deprecated. , use deleteBy

Delete records matching a query, with a batch size of 1000, internally uses browse

Parameters:: query - The query
Throws:: AlgoliaException

deleteBy

public default Task deleteBy(@Nonnull
                             Query query)
                      throws AlgoliaException

Delete records matching a query

Parameters:: query - The query
Throws:: AlgoliaException

deleteByQuery

@Deprecated
public default void deleteByQuery(@Nonnull
                                  Query query,
                                  @Nonnull
                                  RequestOptions requestOptions)
                           throws AlgoliaException

Deprecated. , use deleteBy

Delete records matching a query, with a batch size of 1000, internally uses browse

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

deleteBy

public default Task deleteBy(@Nonnull
                             Query query,
                             @Nonnull
                             RequestOptions requestOptions)
                      throws AlgoliaException

Delete records matching a query

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

deleteByQuery

@Deprecated
public default void deleteByQuery(@Nonnull
                                  Query query,
                                  int batchSize)
                           throws AlgoliaException

Deprecated. use deleteBy

Delete records matching a query, internally uses browse

Parameters:: query - The query; batchSize - the size of the batches
Throws:: AlgoliaException

deleteByQuery

@Deprecated
public default void deleteByQuery(@Nonnull
                                  Query query,
                                  int batchSize,
                                  @Nonnull
                                  RequestOptions requestOptions)
                           throws AlgoliaException

Deprecated. use deleteBy

Delete records matching a query, internally uses browse

Parameters:: query - The query; batchSize - the size of the batches; requestOptions - Options to pass to this request
Throws:: AlgoliaException

browse

public default IndexIterable<T> browse(@Nonnull
                                       Query query)
                                throws AlgoliaException

Browse all the content of this index

Parameters:: query - The query to use to browse
Returns:: the iterator on top of this index
Throws:: AlgoliaException

browse

public default IndexIterable<T> browse(@Nonnull
                                       Query query,
                                       @Nonnull
                                       RequestOptions requestOptions)
                                throws AlgoliaException

Browse all the content of this index

Parameters:: query - The query to use to browse; requestOptions - Options to pass to this request
Returns:: the iterator on top of this index
Throws:: AlgoliaException

browseFrom

public default IndexIterable<T> browseFrom(@Nonnull
                                           Query query,
                                           @Nullable
                                           String cursor)
                                    throws AlgoliaException

Browse all the content of this index

Parameters:: query - The query to use to browse; cursor - the cursor to start from
Returns:: the iterator on top of this index
Throws:: AlgoliaException

browseFrom

public default IndexIterable<T> browseFrom(@Nonnull
                                           Query query,
                                           @Nullable
                                           String cursor,
                                           @Nonnull
                                           RequestOptions requestOptions)
                                    throws AlgoliaException

Browse all the content of this index

Parameters:: query - The query to use to browse; cursor - the cursor to start from; requestOptions - Options to pass to this request
Returns:: the iterator on top of this index
Throws:: AlgoliaException

saveSynonym

public default Task saveSynonym(@Nonnull
                                String synonymID,
                                @Nonnull
                                AbstractSynonym content)
                         throws AlgoliaException

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
Throws:: AlgoliaException

saveSynonym

public default Task saveSynonym(@Nonnull
                                String synonymID,
                                @Nonnull
                                AbstractSynonym content,
                                @Nonnull
                                RequestOptions requestOptions)
                         throws AlgoliaException

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
Throws:: AlgoliaException

saveSynonym

public default Task saveSynonym(@Nonnull
                                String synonymID,
                                @Nonnull
                                AbstractSynonym content,
                                boolean forwardToReplicas)
                         throws AlgoliaException

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
Throws:: AlgoliaException

saveSynonym

public default Task saveSynonym(@Nonnull
                                String synonymID,
                                @Nonnull
                                AbstractSynonym content,
                                boolean forwardToReplicas,
                                @Nonnull
                                RequestOptions requestOptions)
                         throws AlgoliaException

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
Throws:: AlgoliaException

saveSynonym

public default Task saveSynonym(@Nonnull
                                String synonymID,
                                @Nonnull
                                AbstractSynonym content,
                                boolean forwardToReplicas,
                                boolean replaceExistingSynonyms)
                         throws AlgoliaException

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
Throws:: AlgoliaException

saveSynonym

public default Task saveSynonym(@Nonnull
                                String synonymID,
                                @Nonnull
                                AbstractSynonym content,
                                boolean forwardToReplicas,
                                boolean replaceExistingSynonyms,
                                @Nonnull
                                RequestOptions requestOptions)
                         throws AlgoliaException

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
Throws:: AlgoliaException

getSynonym

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

Get a synonym by ID

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

getSynonym

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

Get a synonym by ID

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

deleteSynonym

public default Task deleteSynonym(@Nonnull
                                  String synonymID)
                           throws AlgoliaException

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

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

deleteSynonym

public default Task deleteSynonym(@Nonnull
                                  String synonymID,
                                  @Nonnull
                                  RequestOptions requestOptions)
                           throws AlgoliaException

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

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

deleteSynonym

public default Task deleteSynonym(@Nonnull
                                  String synonymID,
                                  boolean forwardToReplicas)
                           throws AlgoliaException

Deletes a synonym

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

deleteSynonym

public default Task deleteSynonym(@Nonnull
                                  String synonymID,
                                  boolean forwardToReplicas,
                                  @Nonnull
                                  RequestOptions requestOptions)
                           throws AlgoliaException

Deletes a synonym

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

clearSynonyms
```
public default Task clearSynonyms()
                           throws AlgoliaException
```
Clear all synonyms and NOT forwarding it to the replicas

Returns:

the associated task

Throws:

AlgoliaException

clearSynonyms

public default Task clearSynonyms(@Nonnull
                                  RequestOptions requestOptions)
                           throws AlgoliaException

Clear all synonyms and NOT forwarding it to the replicas

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

clearSynonyms
```
public default Task clearSynonyms(boolean forwardToReplicas)
                           throws AlgoliaException
```
Clears all synonyms

Parameters:

forwardToReplicas - should this request be forwarded to replicas

Returns:

the associated task

Throws:

AlgoliaException

clearSynonyms

public default Task clearSynonyms(boolean forwardToReplicas,
                                  @Nonnull
                                  RequestOptions requestOptions)
                           throws AlgoliaException

Clears all synonyms

Parameters:: forwardToReplicas - should this request be forwarded to replicas; requestOptions - Options to pass to this request
Returns:: the associated task
Throws:: AlgoliaException

searchSynonyms

public default SearchSynonymResult searchSynonyms(@Nonnull
                                                  SynonymQuery query)
                                           throws AlgoliaException

Search for synonyms

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

searchSynonyms

public default SearchSynonymResult searchSynonyms(@Nonnull
                                                  SynonymQuery query,
                                                  @Nonnull
                                                  RequestOptions requestOptions)
                                           throws AlgoliaException

Search for synonyms

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

batchSynonyms

public default Task batchSynonyms(@Nonnull
                                  List<AbstractSynonym> synonyms,
                                  boolean forwardToReplicas,
                                  boolean replaceExistingSynonyms)
                           throws AlgoliaException

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
Throws:: AlgoliaException

batchSynonyms

public default Task batchSynonyms(@Nonnull
                                  List<AbstractSynonym> synonyms,
                                  boolean forwardToReplicas,
                                  boolean replaceExistingSynonyms,
                                  @Nonnull
                                  RequestOptions requestOptions)
                           throws AlgoliaException

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
Throws:: AlgoliaException

batchSynonyms

public default Task batchSynonyms(@Nonnull
                                  List<AbstractSynonym> synonyms,
                                  boolean forwardToReplicas)
                           throws AlgoliaException

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
Throws:: AlgoliaException

batchSynonyms

public default Task batchSynonyms(@Nonnull
                                  List<AbstractSynonym> synonyms,
                                  boolean forwardToReplicas,
                                  @Nonnull
                                  RequestOptions requestOptions)
                           throws AlgoliaException

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
Throws:: AlgoliaException

batchSynonyms

public default Task batchSynonyms(@Nonnull
                                  List<AbstractSynonym> synonyms)
                           throws AlgoliaException

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

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

batchSynonyms

public default Task batchSynonyms(@Nonnull
                                  List<AbstractSynonym> synonyms,
                                  @Nonnull
                                  RequestOptions requestOptions)
                           throws AlgoliaException

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
Throws:: AlgoliaException

partialUpdateObject

public default TaskSingleIndex partialUpdateObject(@Nonnull
                                                   String objectID,
                                                   @Nonnull
                                                   Object object)
                                            throws AlgoliaException

Partially update an object

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

partialUpdateObject

public default TaskSingleIndex partialUpdateObject(@Nonnull
                                                   String objectID,
                                                   @Nonnull
                                                   Object object,
                                                   @Nonnull
                                                   RequestOptions requestOptions)
                                            throws AlgoliaException

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
Throws:: AlgoliaException
See Also:: subclasses

partialUpdateObjects

public default TaskSingleIndex partialUpdateObjects(@Nonnull
                                                    List<Object> objects)
                                             throws AlgoliaException

Partially update a objects

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

partialUpdateObjects

public default TaskSingleIndex partialUpdateObjects(@Nonnull
                                                    List<Object> objects,
                                                    @Nonnull
                                                    RequestOptions requestOptions)
                                             throws AlgoliaException

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
Throws:: AlgoliaException

partialUpdateObject

public default TaskSingleIndex partialUpdateObject(@Nonnull
                                                   PartialUpdateOperation operation)
                                            throws AlgoliaException

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
Throws:: AlgoliaException
See Also:: subclasses

partialUpdateObject

public default TaskSingleIndex partialUpdateObject(@Nonnull
                                                   PartialUpdateOperation operation,
                                                   @Nonnull
                                                   RequestOptions requestOptions)
                                            throws AlgoliaException

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
Throws:: AlgoliaException
See Also:: subclasses

partialUpdateObject

public default TaskSingleIndex partialUpdateObject(@Nonnull
                                                   PartialUpdateOperation operation,
                                                   boolean createIfNotExists)
                                            throws AlgoliaException

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
Throws:: AlgoliaException
See Also:: subclasses

partialUpdateObject

public default TaskSingleIndex partialUpdateObject(@Nonnull
                                                   PartialUpdateOperation operation,
                                                   boolean createIfNotExists,
                                                   @Nonnull
                                                   RequestOptions requestOptions)
                                            throws AlgoliaException

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
Throws:: AlgoliaException
See Also:: subclasses

searchForFacetValues

public default SearchFacetResult searchForFacetValues(@Nonnull
                                                      String facetName,
                                                      @Nonnull
                                                      String facetQuery,
                                                      Query query)
                                               throws AlgoliaException

Search in a facet throws a AlgoliaIndexNotFoundException if the index does not exists

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
Throws:: AlgoliaException

searchForFacetValues

public default SearchFacetResult searchForFacetValues(@Nonnull
                                                      String facetName,
                                                      @Nonnull
                                                      String facetQuery,
                                                      Query query,
                                                      @Nonnull
                                                      RequestOptions requestOptions)
                                               throws AlgoliaException

Search in a facet throws a AlgoliaIndexNotFoundException if the index does not exists

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
Throws:: AlgoliaException

searchForFacetValues

public default SearchFacetResult searchForFacetValues(@Nonnull
                                                      String facetName,
                                                      @Nonnull
                                                      String facetQuery)
                                               throws AlgoliaException

Search in a facet throws a AlgoliaIndexNotFoundException if the index does not exists

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

searchForFacetValues

public default SearchFacetResult searchForFacetValues(@Nonnull
                                                      String facetName,
                                                      @Nonnull
                                                      String facetQuery,
                                                      @Nonnull
                                                      RequestOptions requestOptions)
                                               throws AlgoliaException

Search in a facet throws a AlgoliaIndexNotFoundException if the index does not exists

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
Throws:: AlgoliaException

searchInFacetValues

@Deprecated
public default SearchFacetResult searchInFacetValues(@Nonnull
                                                     String facetName,
                                                     @Nonnull
                                                     String facetQuery,
                                                     Query query)
                                              throws AlgoliaException

Deprecated.

Throws:: AlgoliaException

searchInFacetValues

@Deprecated
public default SearchFacetResult searchInFacetValues(@Nonnull
                                                     String facetName,
                                                     @Nonnull
                                                     String facetQuery)
                                              throws AlgoliaException

Deprecated.

Throws:: AlgoliaException

searchFacet

@Deprecated
public default SearchFacetResult searchFacet(@Nonnull
                                             String facetName,
                                             @Nonnull
                                             String facetQuery,
                                             Query query)
                                      throws AlgoliaException

Deprecated.

Throws:: AlgoliaException

searchFacet

@Deprecated
public default SearchFacetResult searchFacet(@Nonnull
                                             String facetName,
                                             @Nonnull
                                             String facetQuery)
                                      throws AlgoliaException

Deprecated.

Throws:: AlgoliaException

listKeys

@Deprecated
public default List<ApiKey> listKeys()
                              throws AlgoliaException

Deprecated.

Deprecated: use listApiKeys

Throws:: AlgoliaException

listApiKeys

public default List<ApiKey> listApiKeys()
                                 throws AlgoliaException

List keys of this index

Returns:: the list of keys
Throws:: AlgoliaException

listApiKeys

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

List keys of this index

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

getKey

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

Deprecated.

Deprecated: use getApiKey

Throws:: AlgoliaException

getApiKey

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

Get a key by name from this index

Parameters:: key - the key name
Returns:: the key
Throws:: AlgoliaException

getApiKey

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

Get a key by name from this index

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

deleteKey

@Deprecated
public default DeleteKey deleteKey(@Nonnull
                                   String key)
                            throws AlgoliaException

Deprecated.

Deprecated: use deleteApiKey

Throws:: AlgoliaException

deleteApiKey

public default DeleteKey deleteApiKey(@Nonnull
                                      String key)
                               throws AlgoliaException

Delete a key by name from this index

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

deleteApiKey

public default DeleteKey deleteApiKey(@Nonnull
                                      String key,
                                      @Nonnull
                                      RequestOptions requestOptions)
                               throws AlgoliaException

Delete a key by name from this index

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

addKey

@Deprecated
public default CreateUpdateKey addKey(@Nonnull
                                      ApiKey key)
                               throws AlgoliaException

Deprecated.

Deprecated: use addApiKey

Throws:: AlgoliaException

addApiKey

public default CreateUpdateKey addApiKey(@Nonnull
                                         ApiKey key)
                                  throws AlgoliaException

Add a key to this index

Parameters:: key - the key
Returns:: the created key
Throws:: AlgoliaException

addApiKey

public default CreateUpdateKey addApiKey(@Nonnull
                                         ApiKey key,
                                         @Nonnull
                                         RequestOptions requestOptions)
                                  throws AlgoliaException

Add a key to this index

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

updateKey

public default CreateUpdateKey updateKey(@Nonnull
                                         String keyName,
                                         @Nonnull
                                         ApiKey key)
                                  throws AlgoliaException

Update a key by name from this index

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

updateKey

public default CreateUpdateKey updateKey(@Nonnull
                                         String keyName,
                                         @Nonnull
                                         ApiKey key,
                                         @Nonnull
                                         RequestOptions requestOptions)
                                  throws AlgoliaException

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
Throws:: AlgoliaException

getSettings

public default IndexSettings getSettings()
                                  throws AlgoliaException

Get settings of this index

Returns:: the settings
Throws:: AlgoliaException

getSettings

public default IndexSettings getSettings(@Nonnull
                                         RequestOptions requestOptions)
                                  throws AlgoliaException

Get settings of this index

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

setSettings

public default Task setSettings(@Nonnull
                                IndexSettings settings)
                         throws AlgoliaException

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

Parameters:: settings - the settings to set
Returns:: the related Task
Throws:: AlgoliaException

setSettings

public default Task setSettings(@Nonnull
                                IndexSettings settings,
                                @Nonnull
                                RequestOptions requestOptions)
                         throws AlgoliaException

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 Task
Throws:: AlgoliaException

setSettings

public default Task setSettings(@Nonnull
                                IndexSettings settings,
                                @Nonnull
                                Boolean forwardToReplicas)
                         throws AlgoliaException

Set settings of this index

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

setSettings

public default Task setSettings(@Nonnull
                                IndexSettings settings,
                                @Nonnull
                                Boolean forwardToReplicas,
                                @Nonnull
                                RequestOptions requestOptions)
                         throws AlgoliaException

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 Task
Throws:: AlgoliaException

addObject

public default TaskIndexing addObject(@Nonnull
                                      T object)
                               throws AlgoliaException

Add an object in this index

Parameters:: object - object to add
Returns:: the related Task
Throws:: AlgoliaException

addObject

public default TaskIndexing addObject(@Nonnull
                                      T object,
                                      @Nonnull
                                      RequestOptions requestOptions)
                               throws AlgoliaException

Add an object in this index

Parameters:: object - object to add; requestOptions - Options to pass to this request
Returns:: the related Task
Throws:: AlgoliaException

addObject

public default TaskIndexing addObject(@Nonnull
                                      String objectID,
                                      @Nonnull
                                      T object)
                               throws AlgoliaException

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 Task
Throws:: AlgoliaException

addObject

public default TaskIndexing addObject(@Nonnull
                                      String objectID,
                                      @Nonnull
                                      T object,
                                      @Nonnull
                                      RequestOptions requestOptions)
                               throws AlgoliaException

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 Task
Throws:: AlgoliaException

addObjects

public default TaskSingleIndex addObjects(@Nonnull
                                          List<T> objects)
                                   throws AlgoliaException

Add several objects

Parameters:: objects - objects to add
Returns:: the related Task
Throws:: AlgoliaException

addObjects

public default TaskSingleIndex addObjects(@Nonnull
                                          List<T> objects,
                                          @Nonnull
                                          RequestOptions requestOptions)
                                   throws AlgoliaException

Add several objects

Parameters:: objects - objects to add; requestOptions - Options to pass to this request
Returns:: the related Task
Throws:: AlgoliaException

getObject

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

Get an object from this index

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

getObject

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

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
Throws:: AlgoliaException

getObjects

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

Get several objects from this index

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

getObjects

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

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
Throws:: AlgoliaException

getObjects

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

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
Throws:: AlgoliaException

getObjects

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

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
Throws:: AlgoliaException

saveObject

public default Task saveObject(@Nonnull
                               String objectID,
                               @Nonnull
                               T object)
                        throws AlgoliaException

Override the content of object

Parameters:: objectID - the unique identifier of the object to retrieve; object - the object to update
Returns:: the related Task
Throws:: AlgoliaException

saveObject

public default Task saveObject(@Nonnull
                               String objectID,
                               @Nonnull
                               T object,
                               @Nonnull
                               RequestOptions requestOptions)
                        throws AlgoliaException

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 Task
Throws:: AlgoliaException

saveObjects

public default TaskSingleIndex saveObjects(@Nonnull
                                           List<T> objects)
                                    throws AlgoliaException

Override the content the list of objects

Parameters:: objects - the list objects to update
Returns:: the related Task
Throws:: AlgoliaException

saveObjects

public default TaskSingleIndex saveObjects(@Nonnull
                                           List<T> objects,
                                           @Nonnull
                                           RequestOptions requestOptions)
                                    throws AlgoliaException

Override the content the list of objects

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

deleteObject

public default Task deleteObject(@Nonnull
                                 String objectID)
                          throws AlgoliaException

Delete an object from the index

Parameters:: objectID - the unique identifier of the object to retrieve
Returns:: the related Task
Throws:: AlgoliaException

deleteObject

public default Task deleteObject(@Nonnull
                                 String objectID,
                                 @Nonnull
                                 RequestOptions requestOptions)
                          throws AlgoliaException

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 Task
Throws:: AlgoliaException

deleteObjects

public default TaskSingleIndex deleteObjects(@Nonnull
                                             List<String> objectIDs)
                                      throws AlgoliaException

Delete objects from the index

Parameters:: objectIDs - the list of unique identifier of the object to retrieve
Returns:: the related Task
Throws:: AlgoliaException

deleteObjects

public default TaskSingleIndex deleteObjects(@Nonnull
                                             List<String> objectIDs,
                                             @Nonnull
                                             RequestOptions requestOptions)
                                      throws AlgoliaException

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 Task
Throws:: AlgoliaException

waitTask

public default void waitTask(@Nonnull
                             Task task,
                             long timeToWait)
                      throws AlgoliaException

Wait for the completion of a task

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

waitTask

public default void waitTask(@Nonnull
                             Task task,
                             long timeToWait,
                             @Nonnull
                             RequestOptions requestOptions)
                      throws AlgoliaException

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
Throws:: AlgoliaException

waitTask

public default void waitTask(@Nonnull
                             Task task)
                      throws AlgoliaException

Wait for the completion of a task, for 100ms

Parameters:: task - task to wait for
Throws:: AlgoliaException

waitTask

public default void waitTask(@Nonnull
                             Task task,
                             @Nonnull
                             RequestOptions requestOptions)
                      throws AlgoliaException

Wait for the completion of a task, for 100ms

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

delete

public default Task delete()
                    throws AlgoliaException

Deletes the index

Returns:: the related Task
Throws:: AlgoliaException

delete

public default Task delete(@Nonnull
                           RequestOptions requestOptions)
                    throws AlgoliaException

Deletes the index

Parameters:: requestOptions - Options to pass to this request
Returns:: the related Task
Throws:: AlgoliaException

clear
```
public default Task clear()
                   throws AlgoliaException
```
Delete the index content without removing settings and index specific API keys.

Returns:

the related Task

Throws:

AlgoliaException

clear
```
public default Task clear(@Nonnull
                          RequestOptions requestOptions)
                   throws AlgoliaException
```
Delete the index content without removing settings and index specific API keys.

Parameters:

requestOptions - Options to pass to this request

Returns:

the related Task

Throws:

AlgoliaException

moveTo
```
public default Task moveTo(@Nonnull
                           String dstIndexName)
                    throws AlgoliaException
```
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

Throws:

AlgoliaException

moveTo

public default Task moveTo(@Nonnull
                           String dstIndexName,
                           @Nonnull
                           RequestOptions requestOptions)
                    throws AlgoliaException

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
Throws:: AlgoliaException

copyTo
```
public default Task copyTo(@Nonnull
                           String dstIndexName)
                    throws AlgoliaException
```
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

Throws:

AlgoliaException

copyTo

public default Task copyTo(@Nonnull
                           String dstIndexName,
                           @Nonnull
                           RequestOptions requestOptions)
                    throws AlgoliaException

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
Throws:: AlgoliaException

copyTo

public default Task copyTo(@Nonnull
                           String dstIndexName,
                           @Nonnull
                           List<String> scopes,
                           @Nonnull
                           RequestOptions requestOptions)
                    throws AlgoliaException

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
Throws:: AlgoliaException

copyTo

public default Task copyTo(@Nonnull
                           String dstIndexName,
                           @Nonnull
                           List<String> scopes)
                    throws AlgoliaException

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
Throws:: AlgoliaException

saveRule

public default Task saveRule(@Nonnull
                             String queryRuleID,
                             @Nonnull
                             Rule content)
                      throws AlgoliaException

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

Parameters:: queryRuleID - the id of the queryRule; content - the queryRule
Returns:: the associated task
Throws:: AlgoliaException

saveRule

public default Task saveRule(@Nonnull
                             String queryRuleID,
                             @Nonnull
                             Rule content,
                             @Nonnull
                             RequestOptions requestOptions)
                      throws AlgoliaException

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

Parameters:: queryRuleID - the id of the queryRule; content - the queryRule; requestOptions - Options to pass to this request
Returns:: the associated task
Throws:: AlgoliaException

saveRule

public default Task saveRule(@Nonnull
                             String queryRuleID,
                             @Nonnull
                             Rule content,
                             boolean forwardToReplicas)
                      throws AlgoliaException

Saves/updates a queryRule without replacing

Parameters:: queryRuleID - the id of the queryRule; content - the queryRule; forwardToReplicas - should this request be forwarded to replicas
Returns:: the associated task
Throws:: AlgoliaException

saveRule

public default Task saveRule(@Nonnull
                             String queryRuleID,
                             @Nonnull
                             Rule content,
                             boolean forwardToReplicas,
                             @Nonnull
                             RequestOptions requestOptions)
                      throws AlgoliaException

Saves/updates a queryRule without replacing

Parameters:: queryRuleID - the id of the queryRule; content - the queryRule; forwardToReplicas - should this request be forwarded to replicas; requestOptions - Options to pass to this request
Returns:: the associated task
Throws:: AlgoliaException

getRule

public default Optional<Rule> getRule(@Nonnull
                                      String ruleId)
                               throws AlgoliaException

Get a rule by Id

Parameters:: ruleId - the id of the query rule
Returns:: the associated task
Throws:: AlgoliaException

getRule

public default Optional<Rule> getRule(@Nonnull
                                      String ruleId,
                                      @Nonnull
                                      RequestOptions requestOptions)
                               throws AlgoliaException

Get a rule by Id

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

deleteRule

public default Task deleteRule(@Nonnull
                               String ruleId)
                        throws AlgoliaException

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

Parameters:: ruleId - the id of the queryRule
Returns:: the associated task
Throws:: AlgoliaException

deleteRule

public default Task deleteRule(@Nonnull
                               String ruleId,
                               @Nonnull
                               RequestOptions requestOptions)
                        throws AlgoliaException

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

Parameters:: ruleId - the id of the queryRule; requestOptions - Options to pass to this request
Returns:: the associated task
Throws:: AlgoliaException

deleteRule

public default Task deleteRule(@Nonnull
                               String ruleId,
                               boolean forwardToReplicas,
                               @Nonnull
                               RequestOptions requestOptions)
                        throws AlgoliaException

Deletes a query rule

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

clearRules
```
public default Task clearRules()
                        throws AlgoliaException
```
Clear all query Rules and NOT forwarding it to the replicas

Returns:

the associated task

Throws:

AlgoliaException

clearRules

public default Task clearRules(@Nonnull
                               RequestOptions requestOptions)
                        throws AlgoliaException

Clear all query Rules and NOT forwarding it to the replicas

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

clearRules

public default Task clearRules(boolean forwardToReplicas)
                        throws AlgoliaException

Clears all Rules

Returns:: the associated task
Throws:: AlgoliaException

clearRules

public default Task clearRules(boolean forwardToReplicas,
                               @Nonnull
                               RequestOptions requestOptions)
                        throws AlgoliaException

Clears all Rules

Parameters:: forwardToReplicas - should this request be forwarded to replicas; requestOptions - Options to pass to this request
Returns:: the associated task
Throws:: AlgoliaException

searchRules

public default SearchRuleResult searchRules(@Nonnull
                                            RuleQuery query)
                                     throws AlgoliaException

Search for Rules

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

searchRules

public default SearchRuleResult searchRules(@Nonnull
                                            RuleQuery query,
                                            @Nonnull
                                            RequestOptions requestOptions)
                                     throws AlgoliaException

Search for Rules

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

batchRules

public default Task batchRules(@Nonnull
                               List<Rule> rules,
                               boolean forwardToReplicas,
                               boolean clearExistingRules)
                        throws AlgoliaException

Add or replace a list of query Rules

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

batchRules

public default Task batchRules(@Nonnull
                               List<Rule> rules,
                               boolean forwardToReplicas,
                               boolean clearExistingRules,
                               @Nonnull
                               RequestOptions requestOptions)
                        throws AlgoliaException

Add or replace a list of query Rules

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

batchRules

public default Task batchRules(@Nonnull
                               List<Rule> rules,
                               boolean forwardToReplicas)
                        throws AlgoliaException

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
Throws:: AlgoliaException

batchRules

public default Task batchRules(@Nonnull
                               List<Rule> rules,
                               boolean forwardToReplicas,
                               @Nonnull
                               RequestOptions requestOptions)
                        throws AlgoliaException

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
Throws:: AlgoliaException

batchRules

public default Task batchRules(@Nonnull
                               List<Rule> rules)
                        throws AlgoliaException

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

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

batchRules

public default Task batchRules(@Nonnull
                               List<Rule> rules,
                               @Nonnull
                               RequestOptions requestOptions)
                        throws AlgoliaException

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
Throws:: AlgoliaException

Class Index<T>

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getName

getKlass

getApiClient

search

search

batch

batch

toString

deleteByQuery

deleteBy

deleteByQuery

deleteBy

deleteByQuery

deleteByQuery

browse

browse

browseFrom

browseFrom

saveSynonym

saveSynonym

saveSynonym

saveSynonym

saveSynonym

saveSynonym

getSynonym

getSynonym

deleteSynonym

deleteSynonym

deleteSynonym

deleteSynonym

clearSynonyms

clearSynonyms

clearSynonyms

clearSynonyms

searchSynonyms

searchSynonyms

batchSynonyms

batchSynonyms

batchSynonyms

batchSynonyms

batchSynonyms

batchSynonyms

partialUpdateObject

partialUpdateObject

partialUpdateObjects

partialUpdateObjects

partialUpdateObject

partialUpdateObject

partialUpdateObject

partialUpdateObject

searchForFacetValues

searchForFacetValues

searchForFacetValues

searchForFacetValues

searchInFacetValues

searchInFacetValues

searchFacet

searchFacet

listKeys

listApiKeys

listApiKeys

getKey

getApiKey

getApiKey

deleteKey

deleteApiKey

deleteApiKey

addKey

addApiKey

addApiKey

updateKey

updateKey

getSettings

getSettings

setSettings