com.algolia.search.saas

Class Index

java.lang.Object

com.algolia.search.saas.Index

public class Index
extends Object

Contains all the functions related to one index You should use APIClient.initIndex(indexName) to retrieve this object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Index.IndexBrowser This class iterates over an index using the cursor-based browse mechanism

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Index(APIClient client, String indexName) Index initialization (You should not call this yourself)

Method Summary

Modifier and Type	Method and Description
org.json.JSONObject	addApiKey(org.json.JSONObject params) Create a new api key
org.json.JSONObject	addApiKey(org.json.JSONObject params, RequestOptions requestOptions) Create a new api key
org.json.JSONObject	addApiKey(List<String> acls) Create a new api key
org.json.JSONObject	addApiKey(List<String> acls, int validity, int maxQueriesPerIPPerHour, int maxHitsPerQuery) Create a new api key
org.json.JSONObject	addApiKey(List<String> acls, int validity, int maxQueriesPerIPPerHour, int maxHitsPerQuery, RequestOptions requestOptions) Create a new api key
org.json.JSONObject	addObject(org.json.JSONObject obj) Add an object in this index
org.json.JSONObject	addObject(org.json.JSONObject obj, RequestOptions requestOptions) Add an object in this index
org.json.JSONObject	addObject(org.json.JSONObject obj, String objectID) Add an object in this index with a uniq identifier
org.json.JSONObject	addObject(org.json.JSONObject obj, String objectID, RequestOptions requestOptions) Add an object in this index with a uniq identifier
org.json.JSONObject	addObjects(org.json.JSONArray objects) Add several objects
org.json.JSONObject	addObjects(org.json.JSONArray objects, RequestOptions requestOptions) Add several objects
org.json.JSONObject	addObjects(List<org.json.JSONObject> objects) Add several objects
org.json.JSONObject	addObjects(List<org.json.JSONObject> objects, RequestOptions requestOptions) Add several objects
org.json.JSONObject	addUserKey(org.json.JSONObject params) Deprecated.
org.json.JSONObject	addUserKey(List<String> acls) Deprecated.
org.json.JSONObject	addUserKey(List<String> acls, int validity, int maxQueriesPerIPPerHour, int maxHitsPerQuery) Deprecated.
org.json.JSONObject	batch(org.json.JSONArray actions) Custom batch
org.json.JSONObject	batch(org.json.JSONArray actions, RequestOptions requestOptions) Custom batch
org.json.JSONObject	batch(List<org.json.JSONObject> actions) Custom batch
org.json.JSONObject	batch(List<org.json.JSONObject> actions, RequestOptions requestOptions) Custom batch
org.json.JSONObject	batchRules(List<org.json.JSONObject> rules) Add or Replace a list of synonyms
org.json.JSONObject	batchRules(List<org.json.JSONObject> rules, boolean forwardToReplicas) Add or Replace a list of synonyms
org.json.JSONObject	batchRules(List<org.json.JSONObject> rules, boolean forwardToReplicas, boolean clearExistingRules) Add or Replace a list of synonyms
org.json.JSONObject	batchRules(List<org.json.JSONObject> rules, boolean forwardToReplicas, boolean clearExistingRules, RequestOptions requestOptions) Add or Replace a list of synonyms
org.json.JSONObject	batchSynonyms(List<org.json.JSONObject> objects) Add or Replace a list of synonyms
org.json.JSONObject	batchSynonyms(List<org.json.JSONObject> objects, boolean forwardToReplicas) Add or Replace a list of synonyms
org.json.JSONObject	batchSynonyms(List<org.json.JSONObject> objects, boolean forwardToReplicas, boolean replaceExistingSynonyms) Add or Replace a list of synonyms
org.json.JSONObject	batchSynonyms(List<org.json.JSONObject> objects, boolean forwardToReplicas, boolean replaceExistingSynonyms, RequestOptions requestOptions) Add or Replace a list of synonyms
org.json.JSONObject	batchSynonyms(List<org.json.JSONObject> objects, boolean forwardToReplicas, RequestOptions requestOptions) Add or Replace a list of synonyms
org.json.JSONObject	batchSynonyms(List<org.json.JSONObject> objects, RequestOptions requestOptions) Add or Replace a list of synonyms
org.json.JSONObject	browse(int page) Deprecated. Use the `browse(Query params)` version
org.json.JSONObject	browse(int page, int hitsPerPage) Browse all index content
org.json.JSONObject	browse(int page, int hitsPerPage, RequestOptions requestOptions) Browse all index content
Index.IndexBrowser	browse(Query params) Browse all index content
Index.IndexBrowser	browse(Query params, RequestOptions requestOptions) Browse all index content
Index.IndexBrowser	browseFrom(Query params, String cursor) Browse all index content starting from a cursor
Index.IndexBrowser	browseFrom(Query params, String cursor, RequestOptions requestOptions) Browse all index content starting from a cursor
Index.IndexBrowser	browseFrow(Query params, String cursor) Deprecated.
org.json.JSONObject	clearIndex() Delete the index content without removing settings and index specific API keys.
org.json.JSONObject	clearIndex(RequestOptions requestOptions) Delete the index content without removing settings and index specific API keys.
org.json.JSONObject	clearRules() Delete all query rules
org.json.JSONObject	clearRules(boolean forwardToReplicas) Delete all query rules
org.json.JSONObject	clearRules(boolean forwardToReplicas, RequestOptions requestOptions) Delete all query rules
org.json.JSONObject	clearSynonyms() Delete all synonym set
org.json.JSONObject	clearSynonyms(boolean forwardToReplicas) Delete all synonym set
org.json.JSONObject	clearSynonyms(boolean forwardToReplicas, RequestOptions requestOptions) Delete all synonym set
org.json.JSONObject	clearSynonyms(RequestOptions requestOptions) Delete all synonym set
org.json.JSONObject	deleteApiKey(String key) Delete an existing api key
org.json.JSONObject	deleteApiKey(String key, RequestOptions requestOptions) Delete an existing api key
org.json.JSONObject	deleteBy(Query query) Delete all objects matching a query
org.json.JSONObject	deleteBy(Query query, RequestOptions requestOptions) Delete all objects matching a query
void	deleteByQuery(Query query) Deprecated. use deleteBy
void	deleteByQuery(Query query, int batchLimit) Deprecated. use deleteBy
void	deleteByQuery(Query query, int batchLimit, RequestOptions requestOptions) Deprecated. use deleteBy
void	deleteByQuery(Query query, RequestOptions requestOptions) Deprecated. use deleteBy
org.json.JSONObject	deleteObject(String objectID) Delete an object from the index
org.json.JSONObject	deleteObject(String objectID, RequestOptions requestOptions) Delete an object from the index
org.json.JSONObject	deleteObjects(List<String> objects) Delete several objects
org.json.JSONObject	deleteObjects(List<String> objects, RequestOptions requestOptions) Delete several objects
org.json.JSONObject	deleteRule(String objectID) Delete a query rule
org.json.JSONObject	deleteRule(String objectID, RequestOptions requestOptions) Delete a query rule
org.json.JSONObject	deleteSynonym(String objectID) Delete one synonym
org.json.JSONObject	deleteSynonym(String objectID, boolean forwardToReplicas) Delete one synonym
org.json.JSONObject	deleteSynonym(String objectID, boolean forwardToReplicas, RequestOptions requestOptions) Delete one synonym
org.json.JSONObject	deleteSynonym(String objectID, RequestOptions requestOptions) Delete one synonym
org.json.JSONObject	deleteUserKey(String key) Deprecated.
org.json.JSONObject	getApiKey(String key) Get ACL of an api key
org.json.JSONObject	getApiKey(String key, RequestOptions requestOptions) Get ACL of an api key
String	getIndexName()
org.json.JSONObject	getObject(String objectID) Get an object from this index.
org.json.JSONObject	getObject(String objectID, List<String> attributesToRetrieve) Get an object from this index
org.json.JSONObject	getObject(String objectID, List<String> attributesToRetrieve, RequestOptions requestOptions) Get an object from this index
org.json.JSONObject	getObject(String objectID, RequestOptions requestOptions) Get an object from this index.
org.json.JSONObject	getObjects(List<String> objectIDs) Get several objects from this index
org.json.JSONObject	getObjects(List<String> objectIDs, List<String> attributesToRetrieve) Get several objects from this index
org.json.JSONObject	getObjects(List<String> objectIDs, List<String> attributesToRetrieve, RequestOptions requestOptions) Get several objects from this index
org.json.JSONObject	getObjects(List<String> objectIDs, RequestOptions requestOptions) Get several objects from this index
org.json.JSONObject	getRule(String objectID) Get a query rule
org.json.JSONObject	getRule(String objectID, RequestOptions requestOptions) Get a query rule
org.json.JSONObject	getSettings() Get settings of this index
org.json.JSONObject	getSettings(RequestOptions requestOptions) Get settings of this index
org.json.JSONObject	getSynonym(String objectID) Get one synonym
org.json.JSONObject	getSynonym(String objectID, RequestOptions requestOptions) Get one synonym
org.json.JSONObject	getUserKeyACL(String key) Deprecated.
org.json.JSONObject	listApiKeys() List all existing api keys with their associated ACLs
org.json.JSONObject	listApiKeys(RequestOptions requestOptions) List all existing api keys with their associated ACLs
org.json.JSONObject	listUserKeys() Deprecated.
org.json.JSONObject	partialUpdateObject(org.json.JSONObject partialObject, String objectID) Update partially an object (only update attributes passed in argument), create the object if it does not exist
org.json.JSONObject	partialUpdateObject(org.json.JSONObject partialObject, String objectID, RequestOptions requestOptions) Update partially an object (only update attributes passed in argument), create the object if it does not exist
org.json.JSONObject	partialUpdateObjectNoCreate(org.json.JSONObject partialObject, String objectID) Update partially an object (only update attributes passed in argument), do nothing if object does not exist
org.json.JSONObject	partialUpdateObjectNoCreate(org.json.JSONObject partialObject, String objectID, RequestOptions requestOptions) Update partially an object (only update attributes passed in argument), do nothing if object does not exist
org.json.JSONObject	partialUpdateObjects(org.json.JSONArray objects) Partially Override the content of several objects
org.json.JSONObject	partialUpdateObjects(org.json.JSONArray objects, RequestOptions requestOptions) Partially Override the content of several objects
org.json.JSONObject	partialUpdateObjects(List<org.json.JSONObject> objects) Partially Override the content of several objects
org.json.JSONObject	partialUpdateObjects(List<org.json.JSONObject> objects, RequestOptions requestOptions) Partially Override the content of several objects
org.json.JSONObject	saveObject(org.json.JSONObject object, String objectID) Override the content of object
org.json.JSONObject	saveObject(org.json.JSONObject object, String objectID, RequestOptions requestOptions) Override the content of object
org.json.JSONObject	saveObjects(org.json.JSONArray objects) Override the content of several objects
org.json.JSONObject	saveObjects(org.json.JSONArray objects, RequestOptions requestOptions) Override the content of several objects
org.json.JSONObject	saveObjects(List<org.json.JSONObject> objects) Override the content of several objects
org.json.JSONObject	saveObjects(List<org.json.JSONObject> objects, RequestOptions requestOptions) Override the content of several objects
org.json.JSONObject	saveRule(String objectID, org.json.JSONObject rule) Save a query rule
org.json.JSONObject	saveRule(String objectID, org.json.JSONObject rule, boolean forwardToReplicas) Save a query rule
org.json.JSONObject	saveRule(String objectID, org.json.JSONObject rule, boolean forwardToReplicas, RequestOptions requestOptions) Save a query rule
org.json.JSONObject	saveSynonym(String objectID, org.json.JSONObject content) Update one synonym
org.json.JSONObject	saveSynonym(String objectID, org.json.JSONObject content, boolean forwardToReplicas) Update one synonym
org.json.JSONObject	saveSynonym(String objectID, org.json.JSONObject content, boolean forwardToReplicas, RequestOptions requestOptions) Update one synonym
org.json.JSONObject	saveSynonym(String objectID, org.json.JSONObject content, RequestOptions requestOptions) Update one synonym
org.json.JSONObject	search(Query params) Search inside the index
org.json.JSONObject	search(Query params, RequestOptions requestOptions) Search inside the index
org.json.JSONObject	searchDisjunctiveFaceting(Query query, List<String> disjunctiveFacets)
org.json.JSONObject	searchDisjunctiveFaceting(Query query, List<String> disjunctiveFacets, Map<String,List<String>> refinements) Perform a search with disjunctive facets generating as many queries as number of disjunctive facets
org.json.JSONObject	searchInFacetValues(String facetName, String facetQuery, Query params) Search into a facet value
org.json.JSONObject	searchInFacetValues(String facetName, String facetQuery, Query params, RequestOptions requestOptions) Search into a facet value
org.json.JSONObject	searchRules(RuleQuery query) Search for query rules
org.json.JSONObject	searchRules(RuleQuery query, RequestOptions requestOptions) Search for query rules
org.json.JSONObject	searchSynonyms(SynonymQuery query) Search for synonyms
org.json.JSONObject	searchSynonyms(SynonymQuery query, RequestOptions requestOptions) Search for synonyms
org.json.JSONObject	setSettings(org.json.JSONObject settings) Set settings for this index
org.json.JSONObject	setSettings(org.json.JSONObject settings, Boolean forwardToReplicas)
org.json.JSONObject	setSettings(org.json.JSONObject settings, Boolean forwardToReplicas, RequestOptions requestOptions)
org.json.JSONObject	setSettings(org.json.JSONObject settings, RequestOptions requestOptions) Set settings for this index
org.json.JSONObject	updateApiKey(String key, org.json.JSONObject params) Update a new api key
org.json.JSONObject	updateApiKey(String key, org.json.JSONObject params, RequestOptions requestOptions) Update a new api key
org.json.JSONObject	updateApiKey(String key, List<String> acls) Update an api key
org.json.JSONObject	updateApiKey(String key, List<String> acls, int validity, int maxQueriesPerIPPerHour, int maxHitsPerQuery) Update an api key
org.json.JSONObject	updateApiKey(String key, List<String> acls, int validity, int maxQueriesPerIPPerHour, int maxHitsPerQuery, RequestOptions requestOptions) Update an api key
org.json.JSONObject	updateUserKey(String key, org.json.JSONObject params) Deprecated.
org.json.JSONObject	updateUserKey(String key, List<String> acls) Deprecated.
org.json.JSONObject	updateUserKey(String key, List<String> acls, int validity, int maxQueriesPerIPPerHour, int maxHitsPerQuery) Deprecated.
void	waitTask(Long taskID) Wait the publication of a task on the server.
void	waitTask(String taskID) Wait the publication of a task on the server.
void	waitTask(String taskID, long timeToWait) Wait the publication of a task on the server.
void	waitTask(String taskID, long timeToWait, RequestOptions requestOptions) Wait the publication of a task on the server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Index

protected Index(APIClient client,
                String indexName)

Index initialization (You should not call this yourself)

Method Detail

getIndexName

public String getIndexName()

Returns:

the underlying index name

addObject

public org.json.JSONObject addObject(org.json.JSONObject obj)
                              throws AlgoliaException

Add an object in this index

Parameters:

obj - the object to add

Throws:

AlgoliaException

addObject

public org.json.JSONObject addObject(org.json.JSONObject obj,
                                     RequestOptions requestOptions)
                              throws AlgoliaException

Add an object in this index

Parameters:

obj - the object to add

requestOptions - Options to pass to this request

Throws:

AlgoliaException

addObject

public org.json.JSONObject addObject(org.json.JSONObject obj,
                                     String objectID)
                              throws AlgoliaException

Add an object in this index with a uniq identifier

Parameters:

obj - the object to add

objectID - the objectID associated to this object (if this objectID already exist the old object will be overriden)

Throws:

AlgoliaException

addObject

public org.json.JSONObject addObject(org.json.JSONObject obj,
                                     String objectID,
                                     RequestOptions requestOptions)
                              throws AlgoliaException

Add an object in this index with a uniq identifier

Parameters:

obj - the object to add

objectID - the objectID associated to this object (if this objectID already exist the old object will be overriden)

requestOptions - Options to pass to this request

Throws:

AlgoliaException

batch

public org.json.JSONObject batch(org.json.JSONArray actions)
                          throws AlgoliaException

Custom batch

Parameters:

actions - the array of actions

Throws:

AlgoliaException

batch

public org.json.JSONObject batch(org.json.JSONArray actions,
                                 RequestOptions requestOptions)
                          throws AlgoliaException

Custom batch

Parameters:

actions - the array of actions

requestOptions - Options to pass to this request

Throws:

AlgoliaException

batch

public org.json.JSONObject batch(List<org.json.JSONObject> actions)
                          throws AlgoliaException

Custom batch

Parameters:

actions - the array of actions

Throws:

AlgoliaException

batch

public org.json.JSONObject batch(List<org.json.JSONObject> actions,
                                 RequestOptions requestOptions)
                          throws AlgoliaException

Custom batch

Parameters:

actions - the array of actions

requestOptions - Options to pass to this request

Throws:

AlgoliaException

addObjects

public org.json.JSONObject addObjects(List<org.json.JSONObject> objects)
                               throws AlgoliaException

Add several objects

Parameters:

objects - the array of objects to add

Throws:

AlgoliaException

addObjects

public org.json.JSONObject addObjects(List<org.json.JSONObject> objects,
                                      RequestOptions requestOptions)
                               throws AlgoliaException

Add several objects

Parameters:

objects - the array of objects to add

requestOptions - Options to pass to this request

Throws:

AlgoliaException

addObjects

public org.json.JSONObject addObjects(org.json.JSONArray objects)
                               throws AlgoliaException

Add several objects

Parameters:

objects - the array of objects to add

Throws:

AlgoliaException

addObjects

public org.json.JSONObject addObjects(org.json.JSONArray objects,
                                      RequestOptions requestOptions)
                               throws AlgoliaException

Add several objects

Parameters:

objects - the array of objects to add

requestOptions - Options to pass to this request

Throws:

AlgoliaException

getObject

public org.json.JSONObject getObject(String objectID)
                              throws AlgoliaException

Get an object from this index. Return null if the object doens't exist.

Parameters:

objectID - the unique identifier of the object to retrieve

Throws:

AlgoliaException

getObject

public org.json.JSONObject getObject(String objectID,
                                     RequestOptions requestOptions)
                              throws AlgoliaException

Get an object from this index. Return null if the object doens't exist.

Parameters:

objectID - the unique identifier of the object to retrieve

requestOptions - Options to pass to this request

Throws:

AlgoliaException

getObject

public org.json.JSONObject getObject(String objectID,
                                     List<String> attributesToRetrieve)
                              throws AlgoliaException

Get an object from this index

Parameters:

objectID - the unique identifier of the object to retrieve

attributesToRetrieve - contains the list of attributes to retrieve.

Throws:

AlgoliaException

getObject

public org.json.JSONObject getObject(String objectID,
                                     List<String> attributesToRetrieve,
                                     RequestOptions requestOptions)
                              throws AlgoliaException

Get an object from this index

Parameters:

objectID - the unique identifier of the object to retrieve

attributesToRetrieve - contains the list of attributes to retrieve.

requestOptions - Options to pass to this request

Throws:

AlgoliaException

getObjects

public org.json.JSONObject getObjects(List<String> objectIDs)
                               throws AlgoliaException

Get several objects from this index

Parameters:

objectIDs - the array of unique identifier of objects to retrieve

Throws:

AlgoliaException

getObjects

public org.json.JSONObject getObjects(List<String> objectIDs,
                                      RequestOptions requestOptions)
                               throws AlgoliaException

Get several objects from this index

Parameters:

objectIDs - the array of unique identifier of objects to retrieve

requestOptions - Options to pass to this request

Throws:

AlgoliaException

getObjects

public org.json.JSONObject getObjects(List<String> objectIDs,
                                      List<String> attributesToRetrieve)
                               throws AlgoliaException

Get several objects from this index

Parameters:

objectIDs - the array of unique identifier of objects to retrieve

attributesToRetrieve - contains the list of attributes to retrieve.

Throws:

AlgoliaException

getObjects

public org.json.JSONObject getObjects(List<String> objectIDs,
                                      List<String> attributesToRetrieve,
                                      RequestOptions requestOptions)
                               throws AlgoliaException

Get 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 - Options to pass to this request

Throws:

AlgoliaException

partialUpdateObject

public org.json.JSONObject partialUpdateObject(org.json.JSONObject partialObject,
                                               String objectID)
                                        throws AlgoliaException

Update partially an object (only update attributes passed in argument), create the object if it does not exist

Parameters:

partialObject - the object to override

Throws:

AlgoliaException

partialUpdateObject

public org.json.JSONObject partialUpdateObject(org.json.JSONObject partialObject,
                                               String objectID,
                                               RequestOptions requestOptions)
                                        throws AlgoliaException

Update partially an object (only update attributes passed in argument), create the object if it does not exist

Parameters:

partialObject - the object to override

requestOptions - Options to pass to this request

Throws:

AlgoliaException

partialUpdateObjectNoCreate

public org.json.JSONObject partialUpdateObjectNoCreate(org.json.JSONObject partialObject,
                                                       String objectID)
                                                throws AlgoliaException

Update partially an object (only update attributes passed in argument), do nothing if object does not exist

Parameters:

partialObject - the object to override

Throws:

AlgoliaException

partialUpdateObjectNoCreate

public org.json.JSONObject partialUpdateObjectNoCreate(org.json.JSONObject partialObject,
                                                       String objectID,
                                                       RequestOptions requestOptions)
                                                throws AlgoliaException

Update partially an object (only update attributes passed in argument), do nothing if object does not exist

Parameters:

partialObject - the object to override

requestOptions - Options to pass to this request

Throws:

AlgoliaException

partialUpdateObjects

public org.json.JSONObject partialUpdateObjects(org.json.JSONArray objects)
                                         throws AlgoliaException

Partially Override the content of several objects

Parameters:

objects - the array of objects to update (each object must contains an objectID attribute)

Throws:

AlgoliaException

partialUpdateObjects

public org.json.JSONObject partialUpdateObjects(org.json.JSONArray objects,
                                                RequestOptions requestOptions)
                                         throws AlgoliaException

Partially Override the content of several objects

Parameters:

objects - the array of objects to update (each object must contains an objectID attribute)

requestOptions - Options to pass to this request

Throws:

AlgoliaException

partialUpdateObjects

public org.json.JSONObject partialUpdateObjects(List<org.json.JSONObject> objects)
                                         throws AlgoliaException

Partially Override the content of several objects

Parameters:

objects - the array of objects to update (each object must contains an objectID attribute)

Throws:

AlgoliaException

partialUpdateObjects

public org.json.JSONObject partialUpdateObjects(List<org.json.JSONObject> objects,
                                                RequestOptions requestOptions)
                                         throws AlgoliaException

Partially Override the content of several objects

Parameters:

objects - the array of objects to update (each object must contains an objectID attribute)

requestOptions - Options to pass to this request

Throws:

AlgoliaException

saveObject

public org.json.JSONObject saveObject(org.json.JSONObject object,
                                      String objectID)
                               throws AlgoliaException

Override the content of object

Parameters:

object - the object to update

Throws:

AlgoliaException

saveObject

public org.json.JSONObject saveObject(org.json.JSONObject object,
                                      String objectID,
                                      RequestOptions requestOptions)
                               throws AlgoliaException

Override the content of object

Parameters:

object - the object to update

requestOptions - Options to pass to this request

Throws:

AlgoliaException

saveObjects

public org.json.JSONObject saveObjects(List<org.json.JSONObject> objects)
                                throws AlgoliaException

Override the content of several objects

Parameters:

objects - the array of objects to update (each object must contains an objectID attribute)

Throws:

AlgoliaException

saveObjects

public org.json.JSONObject saveObjects(List<org.json.JSONObject> objects,
                                       RequestOptions requestOptions)
                                throws AlgoliaException

Override the content of several objects

Parameters:

objects - the array of objects to update (each object must contains an objectID attribute)

requestOptions - Options to pass to this request

Throws:

AlgoliaException

saveObjects

public org.json.JSONObject saveObjects(org.json.JSONArray objects)
                                throws AlgoliaException

Override the content of several objects

Parameters:

objects - the array of objects to update (each object must contains an objectID attribute)

Throws:

AlgoliaException

saveObjects

public org.json.JSONObject saveObjects(org.json.JSONArray objects,
                                       RequestOptions requestOptions)
                                throws AlgoliaException

Override the content of several objects

Parameters:

objects - the array of objects to update (each object must contains an objectID attribute)

requestOptions - Options to pass to this request

Throws:

AlgoliaException

deleteObject

public org.json.JSONObject deleteObject(String objectID)
                                 throws AlgoliaException

Delete an object from the index

Parameters:

objectID - the unique identifier of object to delete

Throws:

AlgoliaException

deleteObject

public org.json.JSONObject deleteObject(String objectID,
                                        RequestOptions requestOptions)
                                 throws AlgoliaException

Delete an object from the index

Parameters:

objectID - the unique identifier of object to delete

requestOptions - Options to pass to this request

Throws:

AlgoliaException

deleteBy

public org.json.JSONObject deleteBy(Query query)
                             throws AlgoliaException

Delete all objects matching a query

Parameters:

query - the query string

Throws:

AlgoliaException

deleteBy

public org.json.JSONObject deleteBy(Query query,
                                    RequestOptions requestOptions)
                             throws AlgoliaException

Delete all objects matching a query

Parameters:

query - the query string

requestOptions - Options to pass to this request

Throws:

AlgoliaException

deleteByQuery

@Deprecated
public void deleteByQuery(Query query)
                               throws AlgoliaException

Deprecated. use deleteBy

Delete all objects matching a query

Parameters:

query - the query string

Throws:

AlgoliaException

deleteByQuery

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

Deprecated. use deleteBy

Delete all objects matching a query

Parameters:

query - the query string

requestOptions - Options to pass to this request

Throws:

AlgoliaException

deleteByQuery

@Deprecated
public void deleteByQuery(Query query,
                                      int batchLimit,
                                      RequestOptions requestOptions)
                               throws AlgoliaException

Deprecated. use deleteBy

Throws:

AlgoliaException

deleteByQuery

@Deprecated
public void deleteByQuery(Query query,
                                      int batchLimit)
                               throws AlgoliaException

Deprecated. use deleteBy

Throws:

AlgoliaException

search

public org.json.JSONObject search(Query params)
                           throws AlgoliaException

Search inside the index

Parameters:

the - query to search

Throws:

AlgoliaException

search

public org.json.JSONObject search(Query params,
                                  RequestOptions requestOptions)
                           throws AlgoliaException

Search inside the index

Parameters:

the - query to search

requestOptions - Options to pass to this request

Throws:

AlgoliaException

searchInFacetValues

public org.json.JSONObject searchInFacetValues(String facetName,
                                               String facetQuery,
                                               Query params)
                                        throws AlgoliaException

Search into a facet value

Throws:

AlgoliaException

searchInFacetValues

public org.json.JSONObject searchInFacetValues(String facetName,
                                               String facetQuery,
                                               Query params,
                                               RequestOptions requestOptions)
                                        throws AlgoliaException

Search into a facet value

Parameters:

requestOptions - Options to pass to this request

Throws:

AlgoliaException

deleteObjects

public org.json.JSONObject deleteObjects(List<String> objects)
                                  throws AlgoliaException

Delete several objects

Parameters:

objects - the array of objectIDs to delete

Throws:

AlgoliaException

deleteObjects

public org.json.JSONObject deleteObjects(List<String> objects,
                                         RequestOptions requestOptions)
                                  throws AlgoliaException

Delete several objects

Parameters:

objects - the array of objectIDs to delete

requestOptions - Options to pass to this request

Throws:

AlgoliaException

browse

public org.json.JSONObject browse(int page)
                           throws AlgoliaException

Deprecated. Use the `browse(Query params)` version

Browse all index content

Parameters:

page - Pagination parameter used to select the page to retrieve. Page is zero-based and defaults to 0. Thus, to retrieve the 10th page you need to set page=9

Throws:

AlgoliaException

browse

public Index.IndexBrowser browse(Query params)
                          throws AlgoliaException

Browse all index content

Throws:

AlgoliaException

browse

public Index.IndexBrowser browse(Query params,
                                 RequestOptions requestOptions)
                          throws AlgoliaException

Browse all index content

Parameters:

requestOptions - Options to pass to this request

Throws:

AlgoliaException

browseFrom

public Index.IndexBrowser browseFrom(Query params,
                                     String cursor)
                              throws AlgoliaException

Browse all index content starting from a cursor

Throws:

AlgoliaException

browseFrom

public Index.IndexBrowser browseFrom(Query params,
                                     String cursor,
                                     RequestOptions requestOptions)
                              throws AlgoliaException

Browse all index content starting from a cursor

Parameters:

requestOptions - Options to pass to this request

Throws:

AlgoliaException

browseFrow

@Deprecated
public Index.IndexBrowser browseFrow(Query params,
                                                 String cursor)
                                          throws AlgoliaException

Deprecated.

Throws:

AlgoliaException

browse

public org.json.JSONObject browse(int page,
                                  int hitsPerPage)
                           throws AlgoliaException

Browse all index content

Parameters:

page - Pagination parameter used to select the page to retrieve. Page is zero-based and defaults to 0. Thus, to retrieve the 10th page you need to set page=9

hitsPerPage - Pagination parameter used to select the number of hits per page. Defaults to 1000.

Throws:

AlgoliaException

browse

public org.json.JSONObject browse(int page,
                                  int hitsPerPage,
                                  RequestOptions requestOptions)
                           throws AlgoliaException

Browse all index content

Parameters:

page - Pagination parameter used to select the page to retrieve. Page is zero-based and defaults to 0. Thus, to retrieve the 10th page you need to set page=9

hitsPerPage - Pagination parameter used to select the number of hits per page. Defaults to 1000.

requestOptions - Options to pass to this request

Throws:

AlgoliaException

waitTask

public void 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 void waitTask(String taskID,
                     long timeToWait,
                     RequestOptions requestOptions)
              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

requestOptions - Options to pass to this request

Throws:

AlgoliaException

waitTask

public void waitTask(String taskID)
              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

Throws:

AlgoliaException

waitTask

public void waitTask(Long taskID)
              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

Throws:

AlgoliaException

getSettings

public org.json.JSONObject getSettings()
                                throws AlgoliaException

Get settings of this index

Throws:

AlgoliaException

getSettings

public org.json.JSONObject getSettings(RequestOptions requestOptions)
                                throws AlgoliaException

Get settings of this index

Parameters:

requestOptions - Options to pass to this request

Throws:

AlgoliaException

clearIndex

public org.json.JSONObject clearIndex()
                               throws AlgoliaException

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

Throws:

AlgoliaException

clearIndex

public org.json.JSONObject clearIndex(RequestOptions requestOptions)
                               throws AlgoliaException

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

Parameters:

requestOptions - Options to pass to this request

Throws:

AlgoliaException

setSettings

public org.json.JSONObject setSettings(org.json.JSONObject settings)
                                throws AlgoliaException

Set settings for this index

Parameters:

settings - the settings for an index

Throws:

AlgoliaException

setSettings

public org.json.JSONObject setSettings(org.json.JSONObject settings,
                                       RequestOptions requestOptions)
                                throws AlgoliaException

Set settings for this index

Parameters:

settings - the settings for an index

requestOptions - Options to pass to this request

Throws:

AlgoliaException

setSettings

public org.json.JSONObject setSettings(org.json.JSONObject settings,
                                       Boolean forwardToReplicas)
                                throws AlgoliaException

Throws:

AlgoliaException

setSettings

public org.json.JSONObject setSettings(org.json.JSONObject settings,
                                       Boolean forwardToReplicas,
                                       RequestOptions requestOptions)
                                throws AlgoliaException

Throws:

AlgoliaException

listUserKeys

@Deprecated
public org.json.JSONObject listUserKeys()
                                             throws AlgoliaException

Deprecated.

Deprecated: use listApiKeys

Throws:

AlgoliaException

listApiKeys

public org.json.JSONObject listApiKeys()
                                throws AlgoliaException

List all existing api keys with their associated ACLs

Throws:

AlgoliaException

listApiKeys

public org.json.JSONObject listApiKeys(RequestOptions requestOptions)
                                throws AlgoliaException

List all existing api keys with their associated ACLs

Parameters:

requestOptions - Options to pass to this request

Throws:

AlgoliaException

getUserKeyACL

@Deprecated
public org.json.JSONObject getUserKeyACL(String key)
                                              throws AlgoliaException

Deprecated.

Deprecated: use getApiKey

Throws:

AlgoliaException

getApiKey

public org.json.JSONObject getApiKey(String key)
                              throws AlgoliaException

Get ACL of an api key

Throws:

AlgoliaException

getApiKey

public org.json.JSONObject getApiKey(String key,
                                     RequestOptions requestOptions)
                              throws AlgoliaException

Get ACL of an api key

Parameters:

requestOptions - Options to pass to this request

Throws:

AlgoliaException

deleteUserKey

@Deprecated
public org.json.JSONObject deleteUserKey(String key)
                                              throws AlgoliaException

Deprecated.

Deprecated: use deleteApiKey

Throws:

AlgoliaException

deleteApiKey

public org.json.JSONObject deleteApiKey(String key)
                                 throws AlgoliaException

Delete an existing api key

Throws:

AlgoliaException

deleteApiKey

public org.json.JSONObject deleteApiKey(String key,
                                        RequestOptions requestOptions)
                                 throws AlgoliaException

Delete an existing api key

Parameters:

requestOptions - Options to pass to this request

Throws:

AlgoliaException

addUserKey

@Deprecated
public org.json.JSONObject addUserKey(org.json.JSONObject params)
                                           throws AlgoliaException

Deprecated.

Deprecated: use addApiKey

Throws:

AlgoliaException

addApiKey

public org.json.JSONObject addApiKey(org.json.JSONObject params)
                              throws AlgoliaException

Create a new api key

Parameters:

params - the list of parameters for this key. Defined by a JSONObject that can contains the following values: - acl: array of string - indices: array of string - validity: int - referers: array of string - description: string - maxHitsPerQuery: integer - queryParameters: string - maxQueriesPerIPPerHour: integer

Throws:

AlgoliaException

addApiKey

public org.json.JSONObject addApiKey(org.json.JSONObject params,
                                     RequestOptions requestOptions)
                              throws AlgoliaException

Create a new api key

Parameters:

params - the list of parameters for this key. Defined by a JSONObject that can contains the following values: - acl: array of string - indices: array of string - validity: int - referers: array of string - description: string - maxHitsPerQuery: integer - queryParameters: string - maxQueriesPerIPPerHour: integer

requestOptions - Options to pass to this request

Throws:

AlgoliaException

addUserKey

@Deprecated
public org.json.JSONObject addUserKey(List<String> acls)
                                           throws AlgoliaException

Deprecated.

Deprecated: use addApiKey

Throws:

AlgoliaException

addApiKey

public org.json.JSONObject addApiKey(List<String> acls)
                              throws AlgoliaException

Create a new api key

Parameters:

acls - the list of ACL for this key. Defined by an array of strings that can contains the following values: - search: allow to search (https and http) - addObject: allows to add/update an object in the index (https only) - deleteObject : allows to delete an existing object (https only) - deleteIndex : allows to delete index content (https only) - settings : allows to get index settings (https only) - editSettings : allows to change index settings (https only)

Throws:

AlgoliaException

updateUserKey

@Deprecated
public org.json.JSONObject updateUserKey(String key,
                                                     org.json.JSONObject params)
                                              throws AlgoliaException

Deprecated.

Deprecated: use updateApiKey

Throws:

AlgoliaException

updateApiKey

public org.json.JSONObject updateApiKey(String key,
                                        org.json.JSONObject params)
                                 throws AlgoliaException

Update a new api key

Parameters:

params - the list of parameters for this key. Defined by a JSONObject that can contains the following values: - acl: array of string - indices: array of string - validity: int - referers: array of string - description: string - maxHitsPerQuery: integer - queryParameters: string - maxQueriesPerIPPerHour: integer

Throws:

AlgoliaException

updateApiKey

public org.json.JSONObject updateApiKey(String key,
                                        org.json.JSONObject params,
                                        RequestOptions requestOptions)
                                 throws AlgoliaException

Update a new api key

Parameters:

params - the list of parameters for this key. Defined by a JSONObject that can contains the following values: - acl: array of string - indices: array of string - validity: int - referers: array of string - description: string - maxHitsPerQuery: integer - queryParameters: string - maxQueriesPerIPPerHour: integer

requestOptions - Options to pass to this request

Throws:

AlgoliaException

updateUserKey

@Deprecated
public org.json.JSONObject updateUserKey(String key,
                                                     List<String> acls)
                                              throws AlgoliaException

Deprecated.

Deprecated: user updateApiKey

Throws:

AlgoliaException

updateApiKey

public org.json.JSONObject updateApiKey(String key,
                                        List<String> acls)
                                 throws AlgoliaException

Update an api key

Parameters:

acls - the list of ACL for this key. Defined by an array of strings that can contains the following values: - search: allow to search (https and http) - addObject: allows to add/update an object in the index (https only) - deleteObject : allows to delete an existing object (https only) - deleteIndex : allows to delete index content (https only) - settings : allows to get index settings (https only) - editSettings : allows to change index settings (https only)

Throws:

AlgoliaException

addUserKey

@Deprecated
public org.json.JSONObject addUserKey(List<String> acls,
                                                  int validity,
                                                  int maxQueriesPerIPPerHour,
                                                  int maxHitsPerQuery)
                                           throws AlgoliaException

Deprecated.

Deprecated: use addApiKey

Throws:

AlgoliaException

addApiKey

public org.json.JSONObject addApiKey(List<String> acls,
                                     int validity,
                                     int maxQueriesPerIPPerHour,
                                     int maxHitsPerQuery)
                              throws AlgoliaException

Create a new api key

Parameters:

acls - the list of ACL for this key. Defined by an array of strings that can contains the following values: - search: allow to search (https and http) - addObject: allows to add/update an object in the index (https only) - deleteObject : allows to delete an existing object (https only) - deleteIndex : allows to delete index content (https only) - settings : allows to get index settings (https only) - editSettings : allows to change index settings (https only)

validity - the number of seconds after which the key will be automatically removed (0 means no time limit for this key)

maxQueriesPerIPPerHour - Specify the maximum number of API calls allowed from an IP address per hour. Defaults to 0 (no rate limit).

maxHitsPerQuery - Specify the maximum number of hits this API key can retrieve in one call. Defaults to 0 (unlimited)

Throws:

AlgoliaException

addApiKey

public org.json.JSONObject addApiKey(List<String> acls,
                                     int validity,
                                     int maxQueriesPerIPPerHour,
                                     int maxHitsPerQuery,
                                     RequestOptions requestOptions)
                              throws AlgoliaException

Create a new api key

Parameters:

acls - the list of ACL for this key. Defined by an array of strings that can contains the following values: - search: allow to search (https and http) - addObject: allows to add/update an object in the index (https only) - deleteObject : allows to delete an existing object (https only) - deleteIndex : allows to delete index content (https only) - settings : allows to get index settings (https only) - editSettings : allows to change index settings (https only)

validity - the number of seconds after which the key will be automatically removed (0 means no time limit for this key)

maxQueriesPerIPPerHour - Specify the maximum number of API calls allowed from an IP address per hour. Defaults to 0 (no rate limit).

maxHitsPerQuery - Specify the maximum number of hits this API key can retrieve in one call. Defaults to 0 (unlimited)

requestOptions - Options to pass to this request

Throws:

AlgoliaException

updateUserKey

@Deprecated
public org.json.JSONObject updateUserKey(String key,
                                                     List<String> acls,
                                                     int validity,
                                                     int maxQueriesPerIPPerHour,
                                                     int maxHitsPerQuery)
                                              throws AlgoliaException

Deprecated.

Deprecated: use updateApiKey

Throws:

AlgoliaException

updateApiKey

public org.json.JSONObject updateApiKey(String key,
                                        List<String> acls,
                                        int validity,
                                        int maxQueriesPerIPPerHour,
                                        int maxHitsPerQuery)
                                 throws AlgoliaException

Update an api key

Parameters:

acls - the list of ACL for this key. Defined by an array of strings that can contains the following values: - search: allow to search (https and http) - addObject: allows to add/update an object in the index (https only) - deleteObject : allows to delete an existing object (https only) - deleteIndex : allows to delete index content (https only) - settings : allows to get index settings (https only) - editSettings : allows to change index settings (https only)

validity - the number of seconds after which the key will be automatically removed (0 means no time limit for this key)

maxQueriesPerIPPerHour - Specify the maximum number of API calls allowed from an IP address per hour. Defaults to 0 (no rate limit).

maxHitsPerQuery - Specify the maximum number of hits this API key can retrieve in one call. Defaults to 0 (unlimited)

Throws:

AlgoliaException

updateApiKey

public org.json.JSONObject updateApiKey(String key,
                                        List<String> acls,
                                        int validity,
                                        int maxQueriesPerIPPerHour,
                                        int maxHitsPerQuery,
                                        RequestOptions requestOptions)
                                 throws AlgoliaException

Update an api key

Parameters:

acls - the list of ACL for this key. Defined by an array of strings that can contains the following values: - search: allow to search (https and http) - addObject: allows to add/update an object in the index (https only) - deleteObject : allows to delete an existing object (https only) - deleteIndex : allows to delete index content (https only) - settings : allows to get index settings (https only) - editSettings : allows to change index settings (https only)

validity - the number of seconds after which the key will be automatically removed (0 means no time limit for this key)

maxQueriesPerIPPerHour - Specify the maximum number of API calls allowed from an IP address per hour. Defaults to 0 (no rate limit).

maxHitsPerQuery - Specify the maximum number of hits this API key can retrieve in one call. Defaults to 0 (unlimited)

requestOptions - Options to pass to this request

Throws:

AlgoliaException

searchDisjunctiveFaceting

public org.json.JSONObject searchDisjunctiveFaceting(Query query,
                                                     List<String> disjunctiveFacets,
                                                     Map<String,List<String>> refinements)
                                              throws AlgoliaException

Perform a search with disjunctive facets generating as many queries as number of disjunctive facets

Parameters:

query - the query

disjunctiveFacets - the array of disjunctive facets

refinements - Map> representing the current refinements ex: { "my_facet1" => ["my_value1", "my_value2"], "my_disjunctive_facet1" => ["my_value1", "my_value2"] }

Throws:

AlgoliaException

searchDisjunctiveFaceting

public org.json.JSONObject searchDisjunctiveFaceting(Query query,
                                                     List<String> disjunctiveFacets)
                                              throws AlgoliaException

Throws:

AlgoliaException

searchSynonyms

public org.json.JSONObject searchSynonyms(SynonymQuery query)
                                   throws AlgoliaException,
                                          org.json.JSONException

Search for synonyms

Parameters:

query - the query

Throws:

AlgoliaException

org.json.JSONException

searchSynonyms

public org.json.JSONObject searchSynonyms(SynonymQuery query,
                                          RequestOptions requestOptions)
                                   throws AlgoliaException,
                                          org.json.JSONException

Search for synonyms

Parameters:

query - the query

requestOptions - Options to pass to this request

Throws:

AlgoliaException

org.json.JSONException

getSynonym

public org.json.JSONObject getSynonym(String objectID)
                               throws AlgoliaException

Get one synonym

Parameters:

objectID - the objectId of the synonym to get

Throws:

AlgoliaException

getSynonym

public org.json.JSONObject getSynonym(String objectID,
                                      RequestOptions requestOptions)
                               throws AlgoliaException

Get one synonym

Parameters:

objectID - the objectId of the synonym to get

requestOptions - Options to pass to this request

Throws:

AlgoliaException

deleteSynonym

public org.json.JSONObject deleteSynonym(String objectID,
                                         boolean forwardToReplicas)
                                  throws AlgoliaException

Delete one synonym

Parameters:

objectID - The objectId of the synonym to delete

forwardToReplicas - Forward the operation to the replica indices

Throws:

AlgoliaException

deleteSynonym

public org.json.JSONObject deleteSynonym(String objectID,
                                         boolean forwardToReplicas,
                                         RequestOptions requestOptions)
                                  throws AlgoliaException

Delete one synonym

Parameters:

objectID - The objectId of the synonym to delete

forwardToReplicas - Forward the operation to the replica indices

requestOptions - Options to pass to this request

Throws:

AlgoliaException

deleteSynonym

public org.json.JSONObject deleteSynonym(String objectID)
                                  throws AlgoliaException

Delete one synonym

Parameters:

objectID - The objectId of the synonym to delete

Throws:

AlgoliaException

deleteSynonym

public org.json.JSONObject deleteSynonym(String objectID,
                                         RequestOptions requestOptions)
                                  throws AlgoliaException

Delete one synonym

Parameters:

objectID - The objectId of the synonym to delete

requestOptions - Options to pass to this request

Throws:

AlgoliaException

clearSynonyms

public org.json.JSONObject clearSynonyms(boolean forwardToReplicas)
                                  throws AlgoliaException

Delete all synonym set

Parameters:

forwardToReplicas - Forward the operation to the replica indices

Throws:

AlgoliaException

clearSynonyms

public org.json.JSONObject clearSynonyms(boolean forwardToReplicas,
                                         RequestOptions requestOptions)
                                  throws AlgoliaException

Delete all synonym set

Parameters:

forwardToReplicas - Forward the operation to the replica indices

requestOptions - Options to pass to this request

Throws:

AlgoliaException

clearSynonyms

public org.json.JSONObject clearSynonyms()
                                  throws AlgoliaException

Delete all synonym set

Throws:

AlgoliaException

clearSynonyms

public org.json.JSONObject clearSynonyms(RequestOptions requestOptions)
                                  throws AlgoliaException

Delete all synonym set

Parameters:

requestOptions - Options to pass to this request

Throws:

AlgoliaException

batchSynonyms

public org.json.JSONObject batchSynonyms(List<org.json.JSONObject> objects,
                                         boolean forwardToReplicas,
                                         boolean replaceExistingSynonyms)
                                  throws AlgoliaException

Add or Replace a list of synonyms

Parameters:

objects - List of synonyms

forwardToReplicas - Forward the operation to the replica indices

replaceExistingSynonyms - Replace the existing synonyms with this batch

Throws:

AlgoliaException

batchSynonyms

public org.json.JSONObject batchSynonyms(List<org.json.JSONObject> objects,
                                         boolean forwardToReplicas,
                                         boolean replaceExistingSynonyms,
                                         RequestOptions requestOptions)
                                  throws AlgoliaException

Add or Replace a list of synonyms

Parameters:

objects - List of synonyms

forwardToReplicas - Forward the operation to the replica indices

replaceExistingSynonyms - Replace the existing synonyms with this batch

requestOptions - Options to pass to this request

Throws:

AlgoliaException

batchSynonyms

public org.json.JSONObject batchSynonyms(List<org.json.JSONObject> objects,
                                         boolean forwardToReplicas)
                                  throws AlgoliaException

Add or Replace a list of synonyms

Parameters:

objects - List of synonyms

forwardToReplicas - Forward the operation to the replica indices

Throws:

AlgoliaException

batchSynonyms

public org.json.JSONObject batchSynonyms(List<org.json.JSONObject> objects,
                                         boolean forwardToReplicas,
                                         RequestOptions requestOptions)
                                  throws AlgoliaException

Add or Replace a list of synonyms

Parameters:

objects - List of synonyms

forwardToReplicas - Forward the operation to the replica indices

requestOptions - Options to pass to this request

Throws:

AlgoliaException

batchSynonyms

public org.json.JSONObject batchSynonyms(List<org.json.JSONObject> objects)
                                  throws AlgoliaException

Add or Replace a list of synonyms

Parameters:

objects - List of synonyms

Throws:

AlgoliaException

batchSynonyms

public org.json.JSONObject batchSynonyms(List<org.json.JSONObject> objects,
                                         RequestOptions requestOptions)
                                  throws AlgoliaException

Add or Replace a list of synonyms

Parameters:

objects - List of synonyms

requestOptions - Options to pass to this request

Throws:

AlgoliaException

saveSynonym

public org.json.JSONObject saveSynonym(String objectID,
                                       org.json.JSONObject content,
                                       boolean forwardToReplicas)
                                throws AlgoliaException

Update one synonym

Parameters:

objectID - The objectId of the synonym to save

content - The new content of this synonym

forwardToReplicas - Forward the operation to the replica indices

Throws:

AlgoliaException

saveSynonym

public org.json.JSONObject saveSynonym(String objectID,
                                       org.json.JSONObject content,
                                       boolean forwardToReplicas,
                                       RequestOptions requestOptions)
                                throws AlgoliaException

Update one synonym

Parameters:

objectID - The objectId of the synonym to save

content - The new content of this synonym

forwardToReplicas - Forward the operation to the replica indices

requestOptions - Options to pass to this request

Throws:

AlgoliaException

saveSynonym

public org.json.JSONObject saveSynonym(String objectID,
                                       org.json.JSONObject content)
                                throws AlgoliaException

Update one synonym

Parameters:

objectID - The objectId of the synonym to save

content - The new content of this synonym

Throws:

AlgoliaException

saveSynonym

public org.json.JSONObject saveSynonym(String objectID,
                                       org.json.JSONObject content,
                                       RequestOptions requestOptions)
                                throws AlgoliaException

Update one synonym

Parameters:

objectID - The objectId of the synonym to save

content - The new content of this synonym

requestOptions - Options to pass to this request

Throws:

AlgoliaException

saveRule

public org.json.JSONObject saveRule(String objectID,
                                    org.json.JSONObject rule,
                                    boolean forwardToReplicas)
                             throws AlgoliaException

Save a query rule

Parameters:

objectID - the objectId of the query rule to save

rule - the content of this query rule

forwardToReplicas - Forward this operation to the replica indices

Throws:

AlgoliaException

saveRule

public org.json.JSONObject saveRule(String objectID,
                                    org.json.JSONObject rule,
                                    boolean forwardToReplicas,
                                    RequestOptions requestOptions)
                             throws AlgoliaException

Save a query rule

Parameters:

objectID - the objectId of the query rule to save

rule - the content of this query rule

forwardToReplicas - Forward this operation to the replica indices

requestOptions - Options to pass to this request

Throws:

AlgoliaException

saveRule

public org.json.JSONObject saveRule(String objectID,
                                    org.json.JSONObject rule)
                             throws AlgoliaException

Save a query rule

Parameters:

objectID - the objectId of the query rule to save

rule - the content of this query rule

Throws:

AlgoliaException

batchRules

public org.json.JSONObject batchRules(List<org.json.JSONObject> rules,
                                      boolean forwardToReplicas,
                                      boolean clearExistingRules)
                               throws AlgoliaException

Add or Replace a list of synonyms

Parameters:

rules - the list of rules to add/replace

forwardToReplicas - Forward this operation to the replica indices

clearExistingRules - Replace the existing query rules with this batch

Throws:

AlgoliaException

batchRules

public org.json.JSONObject batchRules(List<org.json.JSONObject> rules,
                                      boolean forwardToReplicas,
                                      boolean clearExistingRules,
                                      RequestOptions requestOptions)
                               throws AlgoliaException

Add or Replace a list of synonyms

Parameters:

rules - the list of rules to add/replace

forwardToReplicas - Forward this operation to the replica indices

clearExistingRules - Replace the existing query rules with this batch

requestOptions - Options to pass to this request

Throws:

AlgoliaException

batchRules

public org.json.JSONObject batchRules(List<org.json.JSONObject> rules,
                                      boolean forwardToReplicas)
                               throws AlgoliaException

Add or Replace a list of synonyms

Parameters:

rules - the list of rules to add/replace

forwardToReplicas - Forward this operation to the replica indices

Throws:

AlgoliaException

batchRules

public org.json.JSONObject batchRules(List<org.json.JSONObject> rules)
                               throws AlgoliaException

Add or Replace a list of synonyms

Parameters:

rules - the list of rules to add/replace

Throws:

AlgoliaException

getRule

public org.json.JSONObject getRule(String objectID)
                            throws AlgoliaException

Get a query rule

Parameters:

objectID - the objectID of the query rule to get

Throws:

AlgoliaException

getRule

public org.json.JSONObject getRule(String objectID,
                                   RequestOptions requestOptions)
                            throws AlgoliaException

Get a query rule

Parameters:

objectID - the objectID of the query rule to get

requestOptions - Options to pass to this request

Throws:

AlgoliaException

deleteRule

public org.json.JSONObject deleteRule(String objectID)
                               throws AlgoliaException

Delete a query rule

Parameters:

objectID - the objectID of the query rule to delete

Throws:

AlgoliaException

deleteRule

public org.json.JSONObject deleteRule(String objectID,
                                      RequestOptions requestOptions)
                               throws AlgoliaException

Delete a query rule

Parameters:

objectID - the objectID of the query rule to delete

requestOptions - Options to pass to this request

Throws:

AlgoliaException

clearRules

public org.json.JSONObject clearRules(boolean forwardToReplicas)
                               throws AlgoliaException

Delete all query rules

Parameters:

forwardToReplicas - Forward the operation to the replica indices

Throws:

AlgoliaException

clearRules

public org.json.JSONObject clearRules(boolean forwardToReplicas,
                                      RequestOptions requestOptions)
                               throws AlgoliaException

Delete all query rules

Parameters:

forwardToReplicas - Forward the operation to the replica indices

requestOptions - Options to pass to this request

Throws:

AlgoliaException

clearRules

public org.json.JSONObject clearRules()
                               throws AlgoliaException

Delete all query rules

Throws:

AlgoliaException

searchRules

public org.json.JSONObject searchRules(RuleQuery query)
                                throws AlgoliaException,
                                       org.json.JSONException

Search for query rules

Parameters:

query - the query

Throws:

AlgoliaException

org.json.JSONException

searchRules

public org.json.JSONObject searchRules(RuleQuery query,
                                       RequestOptions requestOptions)
                                throws AlgoliaException,
                                       org.json.JSONException

Search for query rules

Parameters:

query - the query

requestOptions - Options to pass to this request

Throws:

AlgoliaException

org.json.JSONException