| Modifier and Type | Field and Description |
|---|---|
static RequestOptions |
RequestOptions.empty |
| Modifier and Type | Method and Description |
|---|---|
RequestOptions |
RequestOptions.addExtraHeader(String key,
String value) |
RequestOptions |
RequestOptions.addExtraQueryParameters(String key,
String value) |
RequestOptions |
RequestOptions.setForwardedFor(String forwardedFor) |
| Modifier and Type | Method and Description |
|---|---|
org.json.JSONObject |
APIClient.addApiKey(org.json.JSONObject params,
RequestOptions requestOptions)
Create a new api key
|
org.json.JSONObject |
Index.addApiKey(org.json.JSONObject params,
RequestOptions requestOptions)
Create a new api key
|
org.json.JSONObject |
APIClient.addApiKey(List<String> acls,
int validity,
int maxQueriesPerIPPerHour,
int maxHitsPerQuery,
List<String> indexes,
RequestOptions requestOptions)
Create a new user key
|
org.json.JSONObject |
APIClient.addApiKey(List<String> acls,
int validity,
int maxQueriesPerIPPerHour,
int maxHitsPerQuery,
RequestOptions requestOptions)
Create a new api key
|
org.json.JSONObject |
Index.addApiKey(List<String> acls,
int validity,
int maxQueriesPerIPPerHour,
int maxHitsPerQuery,
RequestOptions requestOptions)
Create a new api key
|
org.json.JSONObject |
APIClient.addApiKey(List<String> acls,
RequestOptions requestOptions)
Create a new api key
|
org.json.JSONObject |
Index.addObject(org.json.JSONObject obj,
RequestOptions requestOptions)
Add an object in this index
|
org.json.JSONObject |
Index.addObject(org.json.JSONObject obj,
String objectID,
RequestOptions requestOptions)
Add an object in this index with a uniq identifier
|
org.json.JSONObject |
Index.addObjects(org.json.JSONArray objects,
RequestOptions requestOptions)
Add several objects
|
org.json.JSONObject |
Index.addObjects(List<org.json.JSONObject> objects,
RequestOptions requestOptions)
Add several objects
|
org.json.JSONObject |
APIClient.batch(org.json.JSONArray actions,
RequestOptions requestOptions)
Custom batch
|
org.json.JSONObject |
Index.batch(org.json.JSONArray actions,
RequestOptions requestOptions)
Custom batch
|
org.json.JSONObject |
APIClient.batch(List<org.json.JSONObject> actions,
RequestOptions requestOptions)
Custom batch
|
org.json.JSONObject |
Index.batch(List<org.json.JSONObject> actions,
RequestOptions requestOptions)
Custom batch
|
org.json.JSONObject |
Index.batchRules(List<org.json.JSONObject> rules,
boolean forwardToReplicas,
boolean clearExistingRules,
RequestOptions requestOptions)
Add or Replace a list of synonyms
|
org.json.JSONObject |
Index.batchSynonyms(List<org.json.JSONObject> objects,
boolean forwardToReplicas,
boolean replaceExistingSynonyms,
RequestOptions requestOptions)
Add or Replace a list of synonyms
|
org.json.JSONObject |
Index.batchSynonyms(List<org.json.JSONObject> objects,
boolean forwardToReplicas,
RequestOptions requestOptions)
Add or Replace a list of synonyms
|
org.json.JSONObject |
Index.batchSynonyms(List<org.json.JSONObject> objects,
RequestOptions requestOptions)
Add or Replace a list of synonyms
|
org.json.JSONObject |
Index.browse(int page,
int hitsPerPage,
RequestOptions requestOptions)
Browse all index content
|
Index.IndexBrowser |
Index.browse(Query params,
RequestOptions requestOptions)
Browse all index content
|
Index.IndexBrowser |
Index.browseFrom(Query params,
String cursor,
RequestOptions requestOptions)
Browse all index content starting from a cursor
|
org.json.JSONObject |
Index.clearIndex(RequestOptions requestOptions)
Delete the index content without removing settings and index specific API keys.
|
org.json.JSONObject |
Index.clearRules(boolean forwardToReplicas,
RequestOptions requestOptions)
Delete all query rules
|
org.json.JSONObject |
Index.clearSynonyms(boolean forwardToReplicas,
RequestOptions requestOptions)
Delete all synonym set
|
org.json.JSONObject |
Index.clearSynonyms(RequestOptions requestOptions)
Delete all synonym set
|
org.json.JSONObject |
APIClient.copyIndex(String srcIndexName,
String dstIndexName,
List<String> scopes,
RequestOptions requestOptions)
Copy an existing index.
|
org.json.JSONObject |
APIClient.copyIndex(String srcIndexName,
String dstIndexName,
RequestOptions requestOptions)
Copy an existing index.
|
org.json.JSONObject |
APIClient.deleteApiKey(String key,
RequestOptions requestOptions)
Delete an existing api key
|
org.json.JSONObject |
Index.deleteApiKey(String key,
RequestOptions requestOptions)
Delete an existing api key
|
org.json.JSONObject |
Index.deleteBy(Query query,
RequestOptions requestOptions)
Delete all objects matching a query
|
void |
Index.deleteByQuery(Query query,
int batchLimit,
RequestOptions requestOptions)
Deprecated.
use deleteBy
|
void |
Index.deleteByQuery(Query query,
RequestOptions requestOptions)
Deprecated.
use deleteBy
|
org.json.JSONObject |
APIClient.deleteIndex(String indexName,
RequestOptions requestOptions)
Delete an index
|
org.json.JSONObject |
Index.deleteObject(String objectID,
RequestOptions requestOptions)
Delete an object from the index
|
org.json.JSONObject |
Index.deleteObjects(List<String> objects,
RequestOptions requestOptions)
Delete several objects
|
protected org.json.JSONObject |
APIClient.deleteRequest(String url,
RequestOptions requestOptions) |
org.json.JSONObject |
Index.deleteRule(String objectID,
RequestOptions requestOptions)
Delete a query rule
|
org.json.JSONObject |
Index.deleteSynonym(String objectID,
boolean forwardToReplicas,
RequestOptions requestOptions)
Delete one synonym
|
org.json.JSONObject |
Index.deleteSynonym(String objectID,
RequestOptions requestOptions)
Delete one synonym
|
org.json.JSONObject |
APIClient.getApiKey(String key,
RequestOptions requestOptions)
Get an api key
|
org.json.JSONObject |
Index.getApiKey(String key,
RequestOptions requestOptions)
Get ACL of an api key
|
org.json.JSONObject |
APIClient.getLogs(int offset,
int length,
APIClient.LogType logType,
RequestOptions requestOptions)
Return last logs entries.
|
org.json.JSONObject |
APIClient.getLogs(int offset,
int length,
boolean onlyErrors,
RequestOptions requestOptions)
Return last logs entries.
|
org.json.JSONObject |
APIClient.getLogs(int offset,
int length,
RequestOptions requestOptions)
Return last logs entries.
|
org.json.JSONObject |
APIClient.getLogs(RequestOptions requestOptions)
Return 10 last log entries.
|
org.json.JSONObject |
Index.getObject(String objectID,
List<String> attributesToRetrieve,
RequestOptions requestOptions)
Get an object from this index
|
org.json.JSONObject |
Index.getObject(String objectID,
RequestOptions requestOptions)
Get an object from this index.
|
org.json.JSONObject |
Index.getObjects(List<String> objectIDs,
List<String> attributesToRetrieve,
RequestOptions requestOptions)
Get several objects from this index
|
org.json.JSONObject |
Index.getObjects(List<String> objectIDs,
RequestOptions requestOptions)
Get several objects from this index
|
protected org.json.JSONObject |
APIClient.getRequest(String url,
boolean search,
RequestOptions requestOptions) |
org.json.JSONObject |
Index.getRule(String objectID,
RequestOptions requestOptions)
Get a query rule
|
org.json.JSONObject |
Index.getSettings(RequestOptions requestOptions)
Get settings of this index
|
org.json.JSONObject |
Index.getSynonym(String objectID,
RequestOptions requestOptions)
Get one synonym
|
org.json.JSONObject |
APIClient.listApiKeys(RequestOptions requestOptions)
List all existing api keys with their associated ACLs
|
org.json.JSONObject |
Index.listApiKeys(RequestOptions requestOptions)
List all existing api keys with their associated ACLs
|
org.json.JSONObject |
APIClient.listIndexes(RequestOptions requestOptions)
List all existing indexes
return an JSON Object in the form:
{ "items": [ {"name": "contacts", "createdAt": "2013-01-18T15:33:13.556Z"},
{"name": "notes", "createdAt": "2013-01-18T15:33:13.556Z"}]}
|
org.json.JSONObject |
APIClient.moveIndex(String srcIndexName,
String dstIndexName,
RequestOptions requestOptions)
Move an existing index.
|
org.json.JSONObject |
APIClient.multipleQueries(List<APIClient.IndexQuery> queries,
RequestOptions requestOptions)
This method allows to query multiple indexes with one API call
|
org.json.JSONObject |
APIClient.multipleQueries(List<APIClient.IndexQuery> queries,
String strategy,
RequestOptions requestOptions) |
org.json.JSONObject |
Index.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 |
Index.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 |
Index.partialUpdateObjects(org.json.JSONArray objects,
RequestOptions requestOptions)
Partially Override the content of several objects
|
org.json.JSONObject |
Index.partialUpdateObjects(List<org.json.JSONObject> objects,
RequestOptions requestOptions)
Partially Override the content of several objects
|
protected org.json.JSONObject |
APIClient.postRequest(String url,
String obj,
boolean build,
boolean search,
RequestOptions requestOptions) |
protected org.json.JSONObject |
APIClient.putRequest(String url,
String obj,
RequestOptions requestOptions) |
org.json.JSONObject |
Index.saveObject(org.json.JSONObject object,
String objectID,
RequestOptions requestOptions)
Override the content of object
|
org.json.JSONObject |
Index.saveObjects(org.json.JSONArray objects,
RequestOptions requestOptions)
Override the content of several objects
|
org.json.JSONObject |
Index.saveObjects(List<org.json.JSONObject> objects,
RequestOptions requestOptions)
Override the content of several objects
|
org.json.JSONObject |
Index.saveRule(String objectID,
org.json.JSONObject rule,
boolean forwardToReplicas,
RequestOptions requestOptions)
Save a query rule
|
org.json.JSONObject |
Index.saveSynonym(String objectID,
org.json.JSONObject content,
boolean forwardToReplicas,
RequestOptions requestOptions)
Update one synonym
|
org.json.JSONObject |
Index.saveSynonym(String objectID,
org.json.JSONObject content,
RequestOptions requestOptions)
Update one synonym
|
org.json.JSONObject |
Index.search(Query params,
RequestOptions requestOptions)
Search inside the index
|
org.json.JSONObject |
Index.searchInFacetValues(String facetName,
String facetQuery,
Query params,
RequestOptions requestOptions)
Search into a facet value
|
org.json.JSONObject |
Index.searchRules(RuleQuery query,
RequestOptions requestOptions)
Search for query rules
|
org.json.JSONObject |
Index.searchSynonyms(SynonymQuery query,
RequestOptions requestOptions)
Search for synonyms
|
org.json.JSONObject |
Index.setSettings(org.json.JSONObject settings,
Boolean forwardToReplicas,
RequestOptions requestOptions) |
org.json.JSONObject |
Index.setSettings(org.json.JSONObject settings,
RequestOptions requestOptions)
Set settings for this index
|
org.json.JSONObject |
APIClient.updateApiKey(String key,
org.json.JSONObject params,
RequestOptions requestOptions)
Update an api key
|
org.json.JSONObject |
Index.updateApiKey(String key,
org.json.JSONObject params,
RequestOptions requestOptions)
Update a new api key
|
org.json.JSONObject |
APIClient.updateApiKey(String key,
List<String> acls,
int validity,
int maxQueriesPerIPPerHour,
int maxHitsPerQuery,
List<String> indexes,
RequestOptions requestOptions)
Update an api key
|
org.json.JSONObject |
APIClient.updateApiKey(String key,
List<String> acls,
int validity,
int maxQueriesPerIPPerHour,
int maxHitsPerQuery,
RequestOptions requestOptions)
Update an api key
|
org.json.JSONObject |
Index.updateApiKey(String key,
List<String> acls,
int validity,
int maxQueriesPerIPPerHour,
int maxHitsPerQuery,
RequestOptions requestOptions)
Update an api key
|
org.json.JSONObject |
APIClient.updateApiKey(String key,
List<String> acls,
RequestOptions requestOptions)
Update an api key
|
void |
Index.waitTask(String taskID,
long timeToWait,
RequestOptions requestOptions)
Wait the publication of a task on the server.
|
Copyright © 2019. All rights reserved.