Index (Algolia Search Offline API Client for Android)

Object
- com.algolia.search.saas.Searchable
- - com.algolia.search.saas.Index

Direct Known Subclasses:

MirroredIndex
```
public class Index
extends Searchable
```
A proxy to an Algolia index.
You cannot construct this class directly. Please use Client.getIndex(String) to obtain an instance.

WARNING: For performance reasons, arguments to asynchronous methods are not cloned. Therefore, you should not modify mutable arguments after they have been passed (unless explicitly noted).

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_SETTINGS_VERSION

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_SETTINGS_VERSION`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`JSONObject`	`addObject(JSONObject obj, RequestOptions requestOptions)` Adds an object in this index.
`JSONObject`	`addObject(JSONObject obj, String objectID, RequestOptions requestOptions)` Adds an object in this index.
`Request`	`addObjectAsync(JSONObject object, CompletionHandler completionHandler)` Adds an object to this index (asynchronously).
`Request`	`addObjectAsync(JSONObject object, String objectID, CompletionHandler completionHandler)` Adds an object to this index, assigning it the specified object ID (asynchronously).
`Request`	`addObjectAsync(JSONObject object, String objectID, RequestOptions requestOptions, CompletionHandler completionHandler)` Adds an object to this index, assigning it the specified object ID (asynchronously).
`JSONObject`	`addObjects(JSONArray inputArray, RequestOptions requestOptions)` Adds several objects.
`Request`	`addObjectsAsync(JSONArray objects, CompletionHandler completionHandler)` Adds several objects to this index (asynchronously).
`Request`	`addObjectsAsync(JSONArray objects, RequestOptions requestOptions, CompletionHandler completionHandler)` Adds several objects to this index (asynchronously).
`Request`	`browseAsync(Query query, CompletionHandler completionHandler)` Browse all index content (initial call).
`Request`	`browseAsync(Query query, RequestOptions requestOptions, CompletionHandler completionHandler)` Browse all index content (initial call).
`Request`	`browseFromAsync(String cursor, CompletionHandler completionHandler)` Browse the index from a cursor.
`Request`	`browseFromAsync(String cursor, RequestOptions requestOptions, CompletionHandler completionHandler)` Browse the index from a cursor.
`JSONObject`	`clearIndex(RequestOptions requestOptions)` Deletes the index content without removing settings and index specific API keys.
`Request`	`clearIndexAsync(CompletionHandler completionHandler)` Clear this index.
`Request`	`clearIndexAsync(RequestOptions requestOptions, CompletionHandler completionHandler)` Clear this index.
`void`	`clearSearchCache()` Remove all entries from cache
`JSONObject`	`deleteBy(Query query)` Deletes all records matching the query.
`JSONObject`	`deleteBy(Query query, RequestOptions requestOptions)` Deletes all records matching the query.
`Request`	`deleteByAsync(Query query, CompletionHandler completionHandler)` Deletes all objects matching a query (helper).
`Request`	`deleteByAsync(Query query, RequestOptions requestOptions, CompletionHandler completionHandler)` Deletes all objects matching a query (helper).
`void`	`deleteByQuery(Query query, RequestOptions requestOptions)` Deprecated. use `deleteBy(Query)` instead.
`Request`	`deleteByQueryAsync(Query query, CompletionHandler completionHandler)` Deprecated. use `deleteByAsync(Query, CompletionHandler)` instead.
`Request`	`deleteByQueryAsync(Query query, RequestOptions requestOptions, CompletionHandler completionHandler)` Deprecated. use `deleteByAsync(Query, CompletionHandler)` instead.
`JSONObject`	`deleteObject(String objectID, RequestOptions requestOptions)` Deletes an object from the index.
`Request`	`deleteObjectAsync(String objectID, CompletionHandler completionHandler)` Deletes an object from this index (asynchronously).
`Request`	`deleteObjectAsync(String objectID, RequestOptions requestOptions, CompletionHandler completionHandler)` Deletes an object from this index (asynchronously).
`JSONObject`	`deleteObjects(Collection<String> objects, RequestOptions requestOptions)` Deletes several objects.
`Request`	`deleteObjectsAsync(Collection<String> objectIDs, CompletionHandler completionHandler)` Deletes several objects from this index (asynchronously).
`Request`	`deleteObjectsAsync(Collection<String> objectIDs, RequestOptions requestOptions, CompletionHandler completionHandler)` Deletes several objects from this index (asynchronously).
`void`	`disableSearchCache()` Disable and reset cache
`void`	`enableSearchCache()` Enable search cache with default parameters
`void`	`enableSearchCache(int timeoutInSeconds, int maxRequests)` Enable search cache with custom parameters
`Client`	`getClient()`
`JSONObject`	`getObject(String objectID, Collection<String> attributesToRetrieve, RequestOptions requestOptions)` Gets an object from this index.
`JSONObject`	`getObject(String objectID, RequestOptions requestOptions)` Gets an object from this index.
`Request`	`getObjectAsync(String objectID, Collection<String> attributesToRetrieve, CompletionHandler completionHandler)` Gets an object from this index, optionally restricting the retrieved content (asynchronously).
`Request`	`getObjectAsync(String objectID, Collection<String> attributesToRetrieve, RequestOptions requestOptions, CompletionHandler completionHandler)` Gets an object from this index, optionally restricting the retrieved content (asynchronously).
`Request`	`getObjectAsync(String objectID, CompletionHandler completionHandler)` Gets an object from this index (asynchronously).
`JSONObject`	`getObjects(Collection<String> objectIDs)` Gets several objects from this index.
`JSONObject`	`getObjects(Collection<String> objectIDs, Collection<String> attributesToRetrieve, RequestOptions requestOptions)` Gets several objects from this index.
`Request`	`getObjectsAsync(Collection<String> objectIDs, Collection<String> attributesToRetrieve, RequestOptions requestOptions, CompletionHandler completionHandler)` Gets several objects from this index (asynchronously), optionally restricting the retrieved content (asynchronously).
`Request`	`getObjectsAsync(Collection<String> objectIDs, CompletionHandler completionHandler)` Gets several objects from this index (asynchronously).
`Request`	`getObjectsAsync(Collection<String> objectIDs, List<String> attributesToRetrieve, CompletionHandler completionHandler)` Gets several objects from this index (asynchronously), optionally restricting the retrieved content (asynchronously).
`Request`	`getObjectsAsync(Collection<String> objectIDs, RequestOptions requestOptions, CompletionHandler completionHandler)` Gets several objects from this index (asynchronously), optionally restricting the retrieved content (asynchronously).
`String`	`getRawIndexName()`
`JSONObject`	`getSettings(int formatVersion, RequestOptions requestOptions)` Gets the settings of this index for a specific settings format.
`JSONObject`	`getSettings(RequestOptions requestOptions)` Gets the settings of this index.
`Request`	`getSettingsAsync(CompletionHandler completionHandler)` Gets this index's settings (asynchronously).
`Request`	`getSettingsAsync(RequestOptions requestOptions, CompletionHandler completionHandler)` Gets this index's settings (asynchronously).
`Request`	`multipleQueriesAsync(Collection<Query> queries, Client.MultipleQueriesStrategy strategy, CompletionHandler completionHandler)` Run multiple queries on this index with one API call.
`Request`	`multipleQueriesAsync(Collection<Query> queries, Client.MultipleQueriesStrategy strategy, RequestOptions requestOptions, CompletionHandler completionHandler)` Run multiple queries on this index with one API call.
`JSONObject`	`partialUpdateObject(JSONObject partialObject, String objectID, Boolean createIfNotExists, RequestOptions requestOptions)` Update partially an object (only update attributes passed in argument).
`Request`	`partialUpdateObjectAsync(JSONObject partialObject, String objectID, boolean createIfNotExists, CompletionHandler completionHandler)` Partially update an object (asynchronously).
`Request`	`partialUpdateObjectAsync(JSONObject partialObject, String objectID, boolean createIfNotExists, RequestOptions requestOptions, CompletionHandler completionHandler)` Partially update an object (asynchronously).
`Request`	`partialUpdateObjectAsync(JSONObject partialObject, String objectID, CompletionHandler completionHandler)` Partially update an object (asynchronously).
`JSONObject`	`partialUpdateObjects(JSONArray inputArray, boolean createIfNotExists, RequestOptions requestOptions)` Partially Override the content of several objects.
`Request`	`partialUpdateObjectsAsync(JSONArray partialObjects, boolean createIfNotExists, CompletionHandler completionHandler)` Partially update several objects (asynchronously).
`Request`	`partialUpdateObjectsAsync(JSONArray partialObjects, boolean createIfNotExists, RequestOptions requestOptions, CompletionHandler completionHandler)` Partially update several objects (asynchronously).
`Request`	`partialUpdateObjectsAsync(JSONArray partialObjects, CompletionHandler completionHandler)` Partially update several objects (asynchronously).
`JSONObject`	`saveObject(JSONObject object, String objectID, RequestOptions requestOptions)` Override the content of object.
`Request`	`saveObjectAsync(JSONObject object, String objectID, CompletionHandler completionHandler)` Update an object (asynchronously).
`Request`	`saveObjectAsync(JSONObject object, String objectID, RequestOptions requestOptions, CompletionHandler completionHandler)` Update an object (asynchronously).
`JSONObject`	`saveObjects(JSONArray inputArray, RequestOptions requestOptions)` Override the content of several objects.
`Request`	`saveObjectsAsync(JSONArray objects, CompletionHandler completionHandler)` Update several objects (asynchronously).
`Request`	`saveObjectsAsync(JSONArray objects, RequestOptions requestOptions, CompletionHandler completionHandler)` Update several objects (asynchronously).
`JSONObject`	`search(Query query, RequestOptions requestOptions)` Searches inside the index.
`Request`	`searchAsync(Query query, RequestOptions requestOptions, CompletionHandler completionHandler)` Searches inside this index (asynchronously).
`Request`	`searchDisjunctiveFacetingAsync(Query query, Collection<String> disjunctiveFacets, Map<String,? extends Collection<String>> refinements, CompletionHandler completionHandler)` Perform a search with disjunctive facets, generating as many queries as number of disjunctive facets (helper).
`Request`	`searchDisjunctiveFacetingAsync(Query query, Collection<String> disjunctiveFacets, Map<String,? extends Collection<String>> refinements, RequestOptions requestOptions, CompletionHandler completionHandler)` Perform a search with disjunctive facets, generating as many queries as number of disjunctive facets (helper).
`Request`	`searchForFacetValues(String facetName, String text, CompletionHandler handler)` Deprecated. Please use `searchForFacetValuesAsync(String, String, CompletionHandler)` instead.
`Request`	`searchForFacetValues(String facetName, String facetText, Query query, CompletionHandler handler)` Deprecated. Please use `searchForFacetValuesAsync(String, String, Query, CompletionHandler)` instead.
`Request`	`searchForFacetValuesAsync(String facetName, String text, CompletionHandler handler)` Searches (asynchronously) for some text in a facet values.
`Request`	`searchForFacetValuesAsync(String facetName, String facetText, Query query, CompletionHandler handler)` Searches for some text in a facet values, optionally restricting the returned values to those contained in objects matching other (regular) search criteria.
`Request`	`searchForFacetValuesAsync(String facetName, String facetText, Query query, RequestOptions requestOptions, CompletionHandler handler)` Searches for some text in a facet values, optionally restricting the returned values to those contained in objects matching other (regular) search criteria.
`JSONObject`	`searchSync(Query query)` Searches inside this index (synchronously).
`JSONObject`	`searchSync(Query query, RequestOptions requestOptions)` Searches inside this index (synchronously).
`JSONObject`	`setSettings(JSONObject settings, boolean forwardToReplicas, RequestOptions requestOptions)` Set settings for this index.
`Request`	`setSettingsAsync(JSONObject settings, boolean forwardToReplicas, RequestOptions requestOptions, CompletionHandler completionHandler)` Set this index's settings (asynchronously).
`Request`	`setSettingsAsync(JSONObject settings, CompletionHandler completionHandler)` Set this index's settings (asynchronously).
`String`	`toString()` If you override this please be sure it returns a unique string per instance
`JSONObject`	`waitTask(String taskID)` Waits for the publication of a task on the server.
`JSONObject`	`waitTask(String taskID, long timeToWait)` Wait the publication of a task on the server.
`Request`	`waitTaskAsync(long taskID, CompletionHandler completionHandler)` Wait until the publication of a task on the server (helper).
`Request`	`waitTaskAsync(String taskID, CompletionHandler completionHandler)` Wait until the publication of a task on the server (helper).

Methods inherited from class com.algolia.search.saas.Searchable
searchAsync

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- DEFAULT_SETTINGS_VERSION
```
public static final int DEFAULT_SETTINGS_VERSION
```
  See Also:
  
  Constant Field Values

Method Detail

toString
```
public String toString()
```
Description copied from class: Searchable

If you override this please be sure it returns a unique string per instance

Overrides:

toString in class Searchable

getRawIndexName
```
public String getRawIndexName()
```

getClient
```
public Client getClient()
```

searchAsync

public Request searchAsync(@Nullable
                           Query query,
                           @Nullable
                           RequestOptions requestOptions,
                           @Nullable
                           CompletionHandler completionHandler)

Searches inside this index (asynchronously).

Specified by:: searchAsync in class Searchable
Parameters:: query - Search parameters. May be null to use an empty query.; requestOptions - Request-specific options.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

searchSync

public JSONObject searchSync(@Nullable
                             Query query,
                             @Nullable
                             RequestOptions requestOptions)
                      throws AlgoliaException

Searches inside this index (synchronously).

Parameters:: query - Search parameters.; requestOptions - Request-specific options.
Returns:: Search results.
Throws:: AlgoliaException

searchSync

public JSONObject searchSync(@Nullable
                             Query query)
                      throws AlgoliaException

Searches inside this index (synchronously).

Returns:: Search results.
Throws:: AlgoliaException

multipleQueriesAsync

public Request multipleQueriesAsync(@NonNull
                                    Collection<Query> queries,
                                    Client.MultipleQueriesStrategy strategy,
                                    @Nullable
                                    RequestOptions requestOptions,
                                    @Nullable
                                    CompletionHandler completionHandler)

Run multiple queries on this index with one API call. A variant of Client.multipleQueriesAsync(List, Client.MultipleQueriesStrategy, CompletionHandler) where the targeted index is always the receiver.

Parameters:: queries - The queries to run.; strategy - The strategy to use.; requestOptions - Request-specific options.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

multipleQueriesAsync
```
public Request multipleQueriesAsync(@NonNull
                                    Collection<Query> queries,
                                    Client.MultipleQueriesStrategy strategy,
                                    @Nullable
                                    CompletionHandler completionHandler)
```
Run multiple queries on this index with one API call. A variant of Client.multipleQueriesAsync(List, Client.MultipleQueriesStrategy, CompletionHandler) where the targeted index is always the receiver.

Parameters:

queries - The queries to run.

strategy - The strategy to use.

completionHandler - The listener that will be notified of the request's outcome.

Returns:

A cancellable request.

searchDisjunctiveFacetingAsync

public Request searchDisjunctiveFacetingAsync(@NonNull
                                              Query query,
                                              @NonNull
                                              Collection<String> disjunctiveFacets,
                                              @NonNull
                                              Map<String,? extends Collection<String>> refinements,
                                              @Nullable
                                              RequestOptions requestOptions,
                                              @NonNull
                                              CompletionHandler completionHandler)

Perform a search with disjunctive facets, generating as many queries as number of disjunctive facets (helper).

Overrides:: searchDisjunctiveFacetingAsync in class Searchable
Parameters:: query - The query.; disjunctiveFacets - List of disjunctive facets.; refinements - The current refinements, mapping facet names to a list of values.; requestOptions - Request-specific options.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

searchDisjunctiveFacetingAsync

public Request searchDisjunctiveFacetingAsync(@NonNull
                                              Query query,
                                              @NonNull
                                              Collection<String> disjunctiveFacets,
                                              @NonNull
                                              Map<String,? extends Collection<String>> refinements,
                                              @NonNull
                                              CompletionHandler completionHandler)

Perform a search with disjunctive facets, generating as many queries as number of disjunctive facets (helper).

Parameters:: query - The query.; disjunctiveFacets - List of disjunctive facets.; refinements - The current refinements, mapping facet names to a list of values.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

searchForFacetValuesAsync

public Request searchForFacetValuesAsync(@NonNull
                                         String facetName,
                                         @NonNull
                                         String text,
                                         @NonNull
                                         CompletionHandler handler)
                                  throws AlgoliaException

Searches (asynchronously) for some text in a facet values.

Parameters:: facetName - The name of the facet to search. It must have been declared in the index's `attributesForFaceting` setting with the `searchable()` modifier.; text - The text to search for in the facet's values.; handler - A Completion handler that will be notified of the request's outcome.
Returns:: A cancellable request.
Throws:: AlgoliaException

searchForFacetValues
```
public Request searchForFacetValues(@NonNull
                                    String facetName,
                                    @NonNull
                                    String text,
                                    @NonNull
                                    CompletionHandler handler)
```
Deprecated. Please use searchForFacetValuesAsync(String, String, CompletionHandler) instead.

Searches (asynchronously) for some text in a facet values.

Parameters:

facetName - The name of the facet to search. It must have been declared in the index's `attributesForFaceting` setting with the `searchable()` modifier.

text - The text to search for in the facet's values.

handler - A Completion handler that will be notified of the request's outcome.

Returns:

A cancellable request.

searchForFacetValuesAsync
```
public Request searchForFacetValuesAsync(@NonNull
                                         String facetName,
                                         @NonNull
                                         String facetText,
                                         @Nullable
                                         Query query,
                                         @NonNull
                                         CompletionHandler handler)
```
Searches for some text in a facet values, optionally restricting the returned values to those contained in objects matching other (regular) search criteria.

Parameters:

facetName - The name of the facet to search. It must have been declared in the index's `attributesForFaceting` setting with the `searchable()` modifier.

facetText - The text to search for in the facet's values.

query - An optional query to take extra search parameters into account. There parameters apply to index objects like in a regular search query. Only facet values contained in the matched objects will be returned

handler - A Completion handler that will be notified of the request's outcome.

Returns:

A cancellable request.

searchForFacetValuesAsync
```
public Request searchForFacetValuesAsync(@NonNull
                                         String facetName,
                                         @NonNull
                                         String facetText,
                                         @Nullable
                                         Query query,
                                         @Nullable
                                         RequestOptions requestOptions,
                                         @NonNull
                                         CompletionHandler handler)
```
Searches for some text in a facet values, optionally restricting the returned values to those contained in objects matching other (regular) search criteria.

Overrides:

searchForFacetValuesAsync in class Searchable

Parameters:

facetName - The name of the facet to search. It must have been declared in the index's `attributesForFaceting` setting with the `searchable()` modifier.

facetText - The text to search for in the facet's values.

query - An optional query to take extra search parameters into account. There parameters apply to index objects like in a regular search query. Only facet values contained in the matched objects will be returned

requestOptions - Request-specific options.

handler - A Completion handler that will be notified of the request's outcome.

Returns:

A cancellable request.

searchForFacetValues
```
public Request searchForFacetValues(@NonNull
                                    String facetName,
                                    @NonNull
                                    String facetText,
                                    @Nullable
                                    Query query,
                                    @NonNull
                                    CompletionHandler handler)
```
Deprecated. Please use searchForFacetValuesAsync(String, String, Query, CompletionHandler) instead.

Searches (asynchronously) for some text in a facet values, optionally restricting the returned values to those contained in objects matching other (regular) search criteria.

Parameters:

facetName - The name of the facet to search. It must have been declared in the index's `attributesForFaceting` setting with the `searchable()` modifier.

facetText - The text to search for in the facet's values.

query - An optional query to take extra search parameters into account. There parameters apply to index objects like in a regular search query. Only facet values contained in the matched objects will be returned

handler - A Completion handler that will be notified of the request's outcome.

Returns:

A cancellable request.

addObjectAsync
```
public Request addObjectAsync(@NonNull
                              JSONObject object,
                              @Nullable
                              CompletionHandler completionHandler)
```
Adds an object to this index (asynchronously).
WARNING: For performance reasons, the arguments are not cloned. Since the method is executed in the background, you should not modify the object after it has been passed.

Parameters:

object - The object to add.

completionHandler - The listener that will be notified of the request's outcome.

Returns:

A cancellable request.

addObjectAsync
```
public Request addObjectAsync(@NonNull
                              JSONObject object,
                              @NonNull
                              String objectID,
                              @Nullable
                              CompletionHandler completionHandler)
```
Adds an object to this index, assigning it the specified object ID (asynchronously). If an object already exists with the same object ID, the existing object will be overwritten.
WARNING: For performance reasons, the arguments are not cloned. Since the method is executed in the background, you should not modify the object after it has been passed.

Parameters:

object - The object to add.

objectID - Identifier that you want to assign this object.

completionHandler - The listener that will be notified of the request's outcome.

Returns:

A cancellable request.

addObjectAsync
```
public Request addObjectAsync(@NonNull
                              JSONObject object,
                              @NonNull
                              String objectID,
                              @Nullable
                              RequestOptions requestOptions,
                              @Nullable
                              CompletionHandler completionHandler)
```
Adds an object to this index, assigning it the specified object ID (asynchronously). If an object already exists with the same object ID, the existing object will be overwritten.
WARNING: For performance reasons, the arguments are not cloned. Since the method is executed in the background, you should not modify the object after it has been passed.

Parameters:

object - The object to add.

objectID - Identifier that you want to assign this object.

requestOptions - Request-specific options.

completionHandler - The listener that will be notified of the request's outcome.

Returns:

A cancellable request.

addObjectsAsync

public Request addObjectsAsync(@NonNull
                               JSONArray objects,
                               @Nullable
                               RequestOptions requestOptions,
                               @Nullable
                               CompletionHandler completionHandler)

Adds several objects to this index (asynchronously).

Parameters:: objects - Objects to add.; requestOptions - Request-specific options.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

addObjectsAsync

public Request addObjectsAsync(@NonNull
                               JSONArray objects,
                               @Nullable
                               CompletionHandler completionHandler)

Adds several objects to this index (asynchronously).

Parameters:: objects - Objects to add.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

saveObjectAsync

public Request saveObjectAsync(@NonNull
                               JSONObject object,
                               @NonNull
                               String objectID,
                               @Nullable
                               CompletionHandler completionHandler)

Update an object (asynchronously).

Parameters:: object - New version of the object to update.; objectID - Identifier of the object to update.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

saveObjectAsync

public Request saveObjectAsync(@NonNull
                               JSONObject object,
                               @NonNull
                               String objectID,
                               @Nullable
                               RequestOptions requestOptions,
                               @Nullable
                               CompletionHandler completionHandler)

Update an object (asynchronously).

Parameters:: object - New version of the object to update.; objectID - Identifier of the object to update.; requestOptions - Request-specific options.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

saveObjectsAsync
```
public Request saveObjectsAsync(@NonNull
                                JSONArray objects,
                                @Nullable
                                CompletionHandler completionHandler)
```
Update several objects (asynchronously).

Parameters:

objects - Objects to update. Each object must contain an objectID attribute.

completionHandler - The listener that will be notified of the request's outcome.

Returns:

A cancellable request.

saveObjectsAsync

public Request saveObjectsAsync(@NonNull
                                JSONArray objects,
                                @Nullable
                                RequestOptions requestOptions,
                                @Nullable
                                CompletionHandler completionHandler)

Update several objects (asynchronously).

Parameters:: objects - Objects to update. Each object must contain an objectID attribute.; requestOptions - Request-specific options.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

partialUpdateObjectAsync
```
public Request partialUpdateObjectAsync(@NonNull
                                        JSONObject partialObject,
                                        @NonNull
                                        String objectID,
                                        @Nullable
                                        CompletionHandler completionHandler)
```
Partially update an object (asynchronously).
**Note:** This method will create the object if it does not exist already. If you don't wish to, you can use partialUpdateObjectAsync(JSONObject, String, boolean, CompletionHandler) and specify `false` for the `createIfNotExists` argument.

Parameters:

partialObject - New value/operations for the object.

objectID - Identifier of object to be updated.

completionHandler - The listener that will be notified of the request's outcome.

Returns:

A cancellable request.

partialUpdateObjectAsync

public Request partialUpdateObjectAsync(@NonNull
                                        JSONObject partialObject,
                                        @NonNull
                                        String objectID,
                                        boolean createIfNotExists,
                                        @Nullable
                                        CompletionHandler completionHandler)

Partially update an object (asynchronously).

Parameters:: partialObject - New value/operations for the object.; objectID - Identifier of object to be updated.; createIfNotExists - Whether the object should be created if it does not exist already.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

partialUpdateObjectAsync

public Request partialUpdateObjectAsync(@NonNull
                                        JSONObject partialObject,
                                        @NonNull
                                        String objectID,
                                        boolean createIfNotExists,
                                        @Nullable
                                        RequestOptions requestOptions,
                                        @Nullable
                                        CompletionHandler completionHandler)

Partially update an object (asynchronously).

Parameters:: partialObject - New value/operations for the object.; objectID - Identifier of object to be updated.; createIfNotExists - Whether the object should be created if it does not exist already.; requestOptions - Request-specific options.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

partialUpdateObjectsAsync
```
public Request partialUpdateObjectsAsync(@NonNull
                                         JSONArray partialObjects,
                                         @Nullable
                                         CompletionHandler completionHandler)
```
Partially update several objects (asynchronously).
**Note:** This method will create the objects if they do not exist already. If you don't wish to, you can use partialUpdateObjectsAsync(JSONArray, boolean, CompletionHandler) and specify `false` for the `createIfNotExists` argument.

Parameters:

partialObjects - New values/operations for the objects. Each object must contain an objectID attribute.

completionHandler - The listener that will be notified of the request's outcome.

Returns:

A cancellable request.

partialUpdateObjectsAsync
```
public Request partialUpdateObjectsAsync(@NonNull
                                         JSONArray partialObjects,
                                         boolean createIfNotExists,
                                         @Nullable
                                         CompletionHandler completionHandler)
```
Partially update several objects (asynchronously).

Parameters:

partialObjects - New values/operations for the objects. Each object must contain an objectID attribute.

createIfNotExists - Whether objects should be created if they do not exist already.

completionHandler - The listener that will be notified of the request's outcome.

Returns:

A cancellable request.

partialUpdateObjectsAsync

public Request partialUpdateObjectsAsync(@NonNull
                                         JSONArray partialObjects,
                                         boolean createIfNotExists,
                                         @Nullable
                                         RequestOptions requestOptions,
                                         @Nullable
                                         CompletionHandler completionHandler)

Partially update several objects (asynchronously).

Parameters:: partialObjects - New values/operations for the objects. Each object must contain an objectID attribute.; createIfNotExists - Whether objects should be created if they do not exist already.; requestOptions - Request-specific options.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

getObjectAsync

public Request getObjectAsync(@NonNull
                              String objectID,
                              @Nullable
                              CompletionHandler completionHandler)

Gets an object from this index (asynchronously).

Parameters:: objectID - Identifier of the object to retrieve.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

getObjectAsync
```
public Request getObjectAsync(@NonNull
                              String objectID,
                              Collection<String> attributesToRetrieve,
                              @Nullable
                              CompletionHandler completionHandler)
```
Gets an object from this index, optionally restricting the retrieved content (asynchronously).

Parameters:

objectID - Identifier of the object to retrieve.

attributesToRetrieve - List of attributes to retrieve.

completionHandler - The listener that will be notified of the request's outcome.

Returns:

A cancellable request.

getObjectAsync

public Request getObjectAsync(@NonNull
                              String objectID,
                              Collection<String> attributesToRetrieve,
                              @Nullable
                              RequestOptions requestOptions,
                              @Nullable
                              CompletionHandler completionHandler)

Gets an object from this index, optionally restricting the retrieved content (asynchronously).

Parameters:: objectID - Identifier of the object to retrieve.; attributesToRetrieve - List of attributes to retrieve.; requestOptions - Request-specific options.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

getObjectsAsync

public Request getObjectsAsync(@NonNull
                               Collection<String> objectIDs,
                               @Nullable
                               CompletionHandler completionHandler)

Gets several objects from this index (asynchronously).

Parameters:: objectIDs - Identifiers of objects to retrieve.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

getObjectsAsync
```
public Request getObjectsAsync(@NonNull
                               Collection<String> objectIDs,
                               List<String> attributesToRetrieve,
                               @Nullable
                               CompletionHandler completionHandler)
```
Gets several objects from this index (asynchronously), optionally restricting the retrieved content (asynchronously).

Parameters:

objectIDs - Identifiers of objects to retrieve.

attributesToRetrieve - List of attributes to retrieve.

completionHandler - The listener that will be notified of the request's outcome.

Returns:

A cancellable request.

getObjectsAsync

public Request getObjectsAsync(@NonNull
                               Collection<String> objectIDs,
                               @Nullable
                               RequestOptions requestOptions,
                               @Nullable
                               CompletionHandler completionHandler)

Gets several objects from this index (asynchronously), optionally restricting the retrieved content (asynchronously).

Parameters:: objectIDs - Identifiers of objects to retrieve.; requestOptions - Request-specific options.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

getObjectsAsync

public Request getObjectsAsync(@NonNull
                               Collection<String> objectIDs,
                               Collection<String> attributesToRetrieve,
                               @Nullable
                               RequestOptions requestOptions,
                               @Nullable
                               CompletionHandler completionHandler)

Gets several objects from this index (asynchronously), optionally restricting the retrieved content (asynchronously).

Parameters:: objectIDs - Identifiers of objects to retrieve.; attributesToRetrieve - List of attributes to retrieve.; requestOptions - Request-specific options.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

waitTaskAsync
```
public Request waitTaskAsync(@NonNull
                             String taskID,
                             @Nullable
                             CompletionHandler completionHandler)
```
Wait until the publication of a task on the server (helper). All server tasks are asynchronous. This method helps you check that a task is published.

Parameters:

taskID - Identifier of the task (as returned by the server).

completionHandler - The listener that will be notified of the request's outcome.

Returns:

A cancellable request.

waitTaskAsync
```
public Request waitTaskAsync(long taskID,
                             @Nullable
                             CompletionHandler completionHandler)
```
Wait until the publication of a task on the server (helper). All server tasks are asynchronous. This method helps you check that a task is published.

Parameters:

taskID - Identifier of the task (as returned by the server).

completionHandler - The listener that will be notified of the request's outcome.

Returns:

A cancellable request.

deleteObjectAsync

public Request deleteObjectAsync(@NonNull
                                 String objectID,
                                 @Nullable
                                 CompletionHandler completionHandler)

Deletes an object from this index (asynchronously).

Parameters:: objectID - Identifier of the object to delete.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

deleteObjectAsync

public Request deleteObjectAsync(@NonNull
                                 String objectID,
                                 @Nullable
                                 RequestOptions requestOptions,
                                 @Nullable
                                 CompletionHandler completionHandler)

Deletes an object from this index (asynchronously).

Parameters:: objectID - Identifier of the object to delete.; requestOptions - Request-specific options.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

deleteObjectsAsync

public Request deleteObjectsAsync(@NonNull
                                  Collection<String> objectIDs,
                                  @Nullable
                                  CompletionHandler completionHandler)

Deletes several objects from this index (asynchronously).

Parameters:: objectIDs - Identifiers of objects to delete.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

deleteObjectsAsync

public Request deleteObjectsAsync(@NonNull
                                  Collection<String> objectIDs,
                                  @Nullable
                                  RequestOptions requestOptions,
                                  @Nullable
                                  CompletionHandler completionHandler)

Deletes several objects from this index (asynchronously).

Parameters:: objectIDs - Identifiers of objects to delete.; requestOptions - Request-specific options.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

deleteByQueryAsync
```
public Request deleteByQueryAsync(@NonNull
                                  Query query,
                                  @Nullable
                                  CompletionHandler completionHandler)
```
Deprecated. use deleteByAsync(Query, CompletionHandler) instead.

Deletes all objects matching a query (helper) using browse and deleteObjects.

Parameters:

query - The query that objects to delete must match.

completionHandler - The listener that will be notified of the request's outcome.

Returns:

A cancellable request.

deleteByQueryAsync

public Request deleteByQueryAsync(@NonNull
                                  Query query,
                                  @Nullable
                                  RequestOptions requestOptions,
                                  @Nullable
                                  CompletionHandler completionHandler)

Deprecated. use deleteByAsync(Query, CompletionHandler) instead.

Deletes all objects matching a query (helper).

Parameters:: query - The query that objects to delete must match.; requestOptions - Request-specific options.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

deleteByAsync

public Request deleteByAsync(@NonNull
                             Query query,
                             @Nullable
                             RequestOptions requestOptions,
                             @Nullable
                             CompletionHandler completionHandler)

Deletes all objects matching a query (helper).

Parameters:: query - The query that objects to delete must match.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

deleteByAsync

public Request deleteByAsync(@NonNull
                             Query query,
                             @Nullable
                             CompletionHandler completionHandler)

Deletes all objects matching a query (helper).

Parameters:: query - The query that objects to delete must match.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

getSettingsAsync
```
public Request getSettingsAsync(@Nullable
                                CompletionHandler completionHandler)
```
Gets this index's settings (asynchronously).

Parameters:

completionHandler - The listener that will be notified of the request's outcome.

Returns:

A cancellable request.

getSettingsAsync

public Request getSettingsAsync(@Nullable
                                RequestOptions requestOptions,
                                @Nullable
                                CompletionHandler completionHandler)

Gets this index's settings (asynchronously).

Parameters:: requestOptions - Request-specific options.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

setSettingsAsync
```
public Request setSettingsAsync(@NonNull
                                JSONObject settings,
                                @Nullable
                                CompletionHandler completionHandler)
```
Set this index's settings (asynchronously).
Please refer to our API documentation for the list of supported settings.

Parameters:

settings - New settings.

completionHandler - The listener that will be notified of the request's outcome.

Returns:

A cancellable request.

setSettingsAsync

public Request setSettingsAsync(@NonNull
                                JSONObject settings,
                                boolean forwardToReplicas,
                                @Nullable
                                RequestOptions requestOptions,
                                @Nullable
                                CompletionHandler completionHandler)

Set this index's settings (asynchronously).

Please refer to our API documentation for the list of supported settings.

Parameters:: settings - New settings.; requestOptions - Request-specific options.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

browseAsync
```
public Request browseAsync(@NonNull
                           Query query,
                           @Nullable
                           CompletionHandler completionHandler)
```
Browse all index content (initial call). This method should be called once to initiate a browse. It will return the first page of results and a cursor, unless the end of the index has been reached. To retrieve subsequent pages, call `browseFromAsync` with that cursor.

Parameters:

query - The query parameters for the browse.

completionHandler - The listener that will be notified of the request's outcome.

Returns:

A cancellable request.

browseAsync
```
public Request browseAsync(@NonNull
                           Query query,
                           @Nullable
                           RequestOptions requestOptions,
                           @Nullable
                           CompletionHandler completionHandler)
```
Browse all index content (initial call). This method should be called once to initiate a browse. It will return the first page of results and a cursor, unless the end of the index has been reached. To retrieve subsequent pages, call `browseFromAsync` with that cursor.

Parameters:

query - The query parameters for the browse.

requestOptions - Request-specific options.

completionHandler - The listener that will be notified of the request's outcome.

Returns:

A cancellable request.

browseFromAsync
```
public Request browseFromAsync(@NonNull
                               String cursor,
                               @Nullable
                               CompletionHandler completionHandler)
```
Browse the index from a cursor. This method should be called after an initial call to `browseAsync()`. It returns a cursor, unless the end of the index has been reached.

Parameters:

cursor - The cursor of the next page to retrieve.

completionHandler - The listener that will be notified of the request's outcome.

Returns:

A cancellable request.

browseFromAsync
```
public Request browseFromAsync(@NonNull
                               String cursor,
                               @Nullable
                               RequestOptions requestOptions,
                               @Nullable
                               CompletionHandler completionHandler)
```
Browse the index from a cursor. This method should be called after an initial call to `browseAsync()`. It returns a cursor, unless the end of the index has been reached.

Parameters:

cursor - The cursor of the next page to retrieve.

requestOptions - Request-specific options.

completionHandler - The listener that will be notified of the request's outcome.

Returns:

A cancellable request.

clearIndexAsync
```
public Request clearIndexAsync(@Nullable
                               CompletionHandler completionHandler)
```
Clear this index.

Parameters:

completionHandler - The listener that will be notified of the request's outcome.

Returns:

A cancellable request.

clearIndexAsync

public Request clearIndexAsync(@Nullable
                               RequestOptions requestOptions,
                               @Nullable
                               CompletionHandler completionHandler)

Clear this index.

Parameters:: requestOptions - Request-specific options.; completionHandler - The listener that will be notified of the request's outcome.
Returns:: A cancellable request.

enableSearchCache
```
public void enableSearchCache()
```
Enable search cache with default parameters

enableSearchCache
```
public void enableSearchCache(int timeoutInSeconds,
                              int maxRequests)
```
Enable search cache with custom parameters

Parameters:

timeoutInSeconds - duration during which an request is kept in cache

maxRequests - maximum amount of requests to keep before removing the least recently used

disableSearchCache
```
public void disableSearchCache()
```
Disable and reset cache

clearSearchCache
```
public void clearSearchCache()
```
Remove all entries from cache

addObject

public JSONObject addObject(JSONObject obj,
                            @Nullable
                            RequestOptions requestOptions)
                     throws AlgoliaException

Adds an object in this index.

Parameters:: obj - the object to add.; requestOptions - Request-specific options.
Throws:: AlgoliaException

addObject
```
public JSONObject addObject(JSONObject obj,
                            String objectID,
                            @Nullable
                            RequestOptions requestOptions)
                     throws AlgoliaException
```
Adds an object in this index.

Parameters:

obj - the object to add.

objectID - an objectID you want to attribute to this object (if the attribute already exist the old object will be overwrite)

requestOptions - Request-specific options.

Throws:

AlgoliaException

addObjects

public JSONObject addObjects(JSONArray inputArray,
                             @Nullable
                             RequestOptions requestOptions)
                      throws AlgoliaException

Adds several objects.

Parameters:: inputArray - contains an array of objects to add.; requestOptions - Request-specific options.
Throws:: AlgoliaException

getObject

public JSONObject getObject(String objectID,
                            @Nullable
                            RequestOptions requestOptions)
                     throws AlgoliaException

Gets an object from this index.

Parameters:: objectID - the unique identifier of the object to retrieve; requestOptions - Request-specific options.
Throws:: AlgoliaException

getObject

public JSONObject getObject(String objectID,
                            Collection<String> attributesToRetrieve,
                            @Nullable
                            RequestOptions requestOptions)
                     throws AlgoliaException

Gets an object from this index.

Parameters:: objectID - the unique identifier of the object to retrieve; attributesToRetrieve - contains the list of attributes to retrieve.; requestOptions - Request-specific options.
Throws:: AlgoliaException

getObjects
```
public JSONObject getObjects(Collection<String> objectIDs)
                      throws AlgoliaException
```
Gets several objects from this index.

Parameters:

objectIDs - the array of unique identifier of objects to retrieve

Throws:

AlgoliaException

getObjects

public JSONObject getObjects(@NonNull
                             Collection<String> objectIDs,
                             @Nullable
                             Collection<String> attributesToRetrieve,
                             @Nullable
                             RequestOptions requestOptions)
                      throws AlgoliaException

Gets several objects from this index.

Parameters:: objectIDs - the array of unique identifier of objects to retrieve; attributesToRetrieve - contains the list of attributes to retrieve.; requestOptions - Request-specific options.
Throws:: AlgoliaException

partialUpdateObject

public JSONObject partialUpdateObject(JSONObject partialObject,
                                      String objectID,
                                      Boolean createIfNotExists,
                                      @Nullable
                                      RequestOptions requestOptions)
                               throws AlgoliaException

Update partially an object (only update attributes passed in argument).

Parameters:: partialObject - the object attributes to override; requestOptions - Request-specific options.
Throws:: AlgoliaException

partialUpdateObjects

public JSONObject partialUpdateObjects(JSONArray inputArray,
                                       boolean createIfNotExists,
                                       @Nullable
                                       RequestOptions requestOptions)
                                throws AlgoliaException

Partially Override the content of several objects.

Parameters:: inputArray - the array of objects to update (each object must contains an objectID attribute); requestOptions - Request-specific options.
Throws:: AlgoliaException

saveObject

public JSONObject saveObject(JSONObject object,
                             String objectID,
                             @Nullable
                             RequestOptions requestOptions)
                      throws AlgoliaException

Override the content of object.

Parameters:: object - the object to save; requestOptions - Request-specific options.
Throws:: AlgoliaException

saveObjects

public JSONObject saveObjects(JSONArray inputArray,
                              @Nullable
                              RequestOptions requestOptions)
                       throws AlgoliaException

Override the content of several objects.

Parameters:: inputArray - contains an array of objects to update (each object must contains an objectID attribute); requestOptions - Request-specific options.
Throws:: AlgoliaException

deleteObject

public JSONObject deleteObject(String objectID,
                               @Nullable
                               RequestOptions requestOptions)
                        throws AlgoliaException

Deletes an object from the index.

Parameters:: objectID - the unique identifier of object to delete; requestOptions - Request-specific options.
Throws:: AlgoliaException

deleteObjects

public JSONObject deleteObjects(Collection<String> objects,
                                @Nullable
                                RequestOptions requestOptions)
                         throws AlgoliaException

Deletes several objects.

Parameters:: objects - the array of objectIDs to delete; requestOptions - Request-specific options.
Throws:: AlgoliaException

deleteByQuery

@Deprecated
public void deleteByQuery(@NonNull
                                      Query query,
                                      @Nullable
                                      RequestOptions requestOptions)
                               throws AlgoliaException

Deprecated. use deleteBy(Query) instead.

Deletes all objects matching a query using browse and deleteObjects.

Parameters:: query - the query string; requestOptions - Request-specific options.
Throws:: AlgoliaException

deleteBy

public JSONObject deleteBy(@NonNull
                           Query query)
                    throws AlgoliaException

Deletes all records matching the query.

Parameters:: query - the query string
Throws:: AlgoliaException

deleteBy

public JSONObject deleteBy(@NonNull
                           Query query,
                           RequestOptions requestOptions)
                    throws AlgoliaException

Deletes all records matching the query.

Parameters:: query - the query string
Throws:: AlgoliaException

search

public JSONObject search(@Nullable
                         Query query,
                         @Nullable
                         RequestOptions requestOptions)
                  throws AlgoliaException

Searches inside the index.

Parameters:: requestOptions - Request-specific options.
Returns:: a JSONObject containing search results
Throws:: AlgoliaException

waitTask
```
public JSONObject waitTask(String taskID,
                           long timeToWait)
                    throws AlgoliaException
```
Wait the publication of a task on the server. All server task are asynchronous and you can check with this method that the task is published.

Parameters:

taskID - the id of the task returned by server

timeToWait - time to sleep seed

Throws:

AlgoliaException

waitTask
```
public JSONObject waitTask(String taskID)
                    throws AlgoliaException
```
Waits for the publication of a task on the server. All server task are asynchronous and you can check with this method that the task is published.

Parameters:

taskID - the id of the task returned by server

Throws:

AlgoliaException

getSettings

public JSONObject getSettings(@Nullable
                              RequestOptions requestOptions)
                       throws AlgoliaException

Gets the settings of this index.

Parameters:: requestOptions - Request-specific options.
Throws:: AlgoliaException

getSettings

public JSONObject getSettings(int formatVersion,
                              @Nullable
                              RequestOptions requestOptions)
                       throws AlgoliaException

Gets the settings of this index for a specific settings format.

Parameters:: formatVersion - the version of a settings format.; requestOptions - Request-specific options.
Throws:: AlgoliaException

setSettings

public JSONObject setSettings(JSONObject settings,
                              boolean forwardToReplicas,
                              @Nullable
                              RequestOptions requestOptions)
                       throws AlgoliaException

Set settings for this index.

Parameters:: settings - the settings object.; forwardToReplicas - if true, the new settings will be forwarded to replica indices.; requestOptions - Request-specific options.
Throws:: AlgoliaException

clearIndex

public JSONObject clearIndex(@Nullable
                             RequestOptions requestOptions)
                      throws AlgoliaException

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

Parameters:: requestOptions - Request-specific options.
Throws:: AlgoliaException

Class Index

Field Summary

Method Summary

Methods inherited from class com.algolia.search.saas.Searchable

Methods inherited from class Object

Field Detail

DEFAULT_SETTINGS_VERSION

Method Detail

toString

getRawIndexName

getClient

searchAsync

searchSync

searchSync

multipleQueriesAsync

multipleQueriesAsync

searchDisjunctiveFacetingAsync

searchDisjunctiveFacetingAsync

searchForFacetValuesAsync

searchForFacetValues

searchForFacetValuesAsync

searchForFacetValuesAsync

searchForFacetValues

addObjectAsync

addObjectAsync

addObjectAsync

addObjectsAsync

addObjectsAsync

saveObjectAsync

saveObjectAsync

saveObjectsAsync

saveObjectsAsync

partialUpdateObjectAsync

partialUpdateObjectAsync

partialUpdateObjectAsync

partialUpdateObjectsAsync

partialUpdateObjectsAsync

partialUpdateObjectsAsync

getObjectAsync

getObjectAsync

getObjectAsync

getObjectsAsync

getObjectsAsync

getObjectsAsync

getObjectsAsync

waitTaskAsync

waitTaskAsync

deleteObjectAsync

deleteObjectAsync

deleteObjectsAsync

deleteObjectsAsync

deleteByQueryAsync

deleteByQueryAsync

deleteByAsync

deleteByAsync

getSettingsAsync

getSettingsAsync

setSettingsAsync

setSettingsAsync

browseAsync

browseAsync

browseFromAsync

browseFromAsync

clearIndexAsync

clearIndexAsync

enableSearchCache

enableSearchCache

disableSearchCache

clearSearchCache

addObject

addObject

addObjects

getObject

getObject

getObjects

getObjects

partialUpdateObject

partialUpdateObjects

saveObject

saveObjects