| Modifier and Type | Method and Description |
|---|---|
org.json.JSONObject |
Index.addObject(org.json.JSONObject obj)
Add an object in this index
|
org.json.JSONObject |
Index.addObject(org.json.JSONObject obj,
String objectID)
Add an object in this index with a uniq identifier
|
org.json.JSONObject |
Index.addObjects(org.json.JSONArray inputArray)
Add several objects
|
org.json.JSONObject |
Index.addObjects(List<org.json.JSONObject> objects)
Add several objects
|
org.json.JSONObject |
Index.addUserKey(org.json.JSONObject params)
Create a new user key
|
org.json.JSONObject |
APIClient.addUserKey(org.json.JSONObject params)
Create a new user key
|
org.json.JSONObject |
Index.addUserKey(List<String> acls)
Create a new user key
|
org.json.JSONObject |
APIClient.addUserKey(List<String> acls)
Create a new user key
|
org.json.JSONObject |
Index.addUserKey(List<String> acls,
int validity,
int maxQueriesPerIPPerHour,
int maxHitsPerQuery)
Create a new user key
|
org.json.JSONObject |
APIClient.addUserKey(List<String> acls,
int validity,
int maxQueriesPerIPPerHour,
int maxHitsPerQuery)
Create a new user key
|
org.json.JSONObject |
APIClient.addUserKey(List<String> acls,
int validity,
int maxQueriesPerIPPerHour,
int maxHitsPerQuery,
List<String> indexes)
Create a new user key
|
org.json.JSONObject |
Index.batch(org.json.JSONArray actions)
Custom batch
|
org.json.JSONObject |
APIClient.batch(org.json.JSONArray actions)
Custom batch
|
org.json.JSONObject |
Index.batch(List<org.json.JSONObject> actions)
Custom batch
|
org.json.JSONObject |
APIClient.batch(List<org.json.JSONObject> actions)
Custom batch
|
org.json.JSONObject |
Index.browse(int page)
Deprecated.
Use the `browse(Query params)` version
|
org.json.JSONObject |
Index.browse(int page,
int hitsPerPage)
Browse all index content
|
Iterator<org.json.JSONObject> |
Index.browse(Query params)
Browse all index content
|
Iterator<org.json.JSONObject> |
Index.browseFrow(Query params,
String cursor)
Browse all index content starting from a cursor
|
org.json.JSONObject |
Index.clearIndex()
Delete the index content without removing settings and index specific API keys.
|
org.json.JSONObject |
APIClient.copyIndex(String srcIndexName,
String dstIndexName)
Copy an existing index.
|
void |
Index.deleteByQuery(Query query)
Delete all objects matching a query
|
org.json.JSONObject |
APIClient.deleteIndex(String indexName)
Delete an index
|
org.json.JSONObject |
Index.deleteObject(String objectID)
Delete an object from the index
|
org.json.JSONObject |
Index.deleteObjects(List<String> objects)
Delete several objects
|
protected org.json.JSONObject |
APIClient.deleteRequest(String url,
boolean build) |
org.json.JSONObject |
Index.deleteUserKey(String key)
Delete an existing user key
|
org.json.JSONObject |
APIClient.deleteUserKey(String key)
Delete an existing user key
|
org.json.JSONObject |
APIClient.getLogs()
Return 10 last log entries.
|
org.json.JSONObject |
APIClient.getLogs(int offset,
int length)
Return last logs entries.
|
org.json.JSONObject |
APIClient.getLogs(int offset,
int length,
APIClient.LogType logType)
Return last logs entries.
|
org.json.JSONObject |
APIClient.getLogs(int offset,
int length,
boolean onlyErrors)
Return last logs entries.
|
org.json.JSONObject |
Index.getObject(String objectID)
Get an object from this index.
|
org.json.JSONObject |
Index.getObject(String objectID,
List<String> attributesToRetrieve)
Get an object from this index
|
org.json.JSONObject |
Index.getObjects(List<String> objectIDs)
Get several objects from this index
|
protected org.json.JSONObject |
APIClient.getRequest(String url,
boolean search) |
org.json.JSONObject |
Index.getSettings()
Get settings of this index
|
org.json.JSONObject |
Index.getUserKeyACL(String key)
Get ACL of a user key
|
org.json.JSONObject |
APIClient.getUserKeyACL(String key)
Get ACL of a user key
|
org.json.JSONObject |
APIClient.listIndexes()
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 |
Index.listUserKeys()
List all existing user keys with their associated ACLs
|
org.json.JSONObject |
APIClient.listUserKeys()
List all existing user keys with their associated ACLs
|
org.json.JSONObject |
APIClient.moveIndex(String srcIndexName,
String dstIndexName)
Move an existing index.
|
org.json.JSONObject |
APIClient.multipleQueries(List<APIClient.IndexQuery> queries)
This method allows to query multiple indexes with one API call
|
org.json.JSONObject |
APIClient.multipleQueries(List<APIClient.IndexQuery> queries,
String strategy) |
org.json.JSONObject |
Index.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 |
Index.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 |
Index.partialUpdateObjects(org.json.JSONArray inputArray)
Partially Override the content of several objects
|
org.json.JSONObject |
Index.partialUpdateObjects(List<org.json.JSONObject> objects)
Partially Override the content of several objects
|
protected org.json.JSONObject |
APIClient.postRequest(String url,
String obj,
boolean build,
boolean search) |
protected org.json.JSONObject |
APIClient.putRequest(String url,
String obj,
boolean build) |
org.json.JSONObject |
Index.saveObject(org.json.JSONObject object,
String objectID)
Override the content of object
|
org.json.JSONObject |
Index.saveObjects(org.json.JSONArray inputArray)
Override the content of several objects
|
org.json.JSONObject |
Index.saveObjects(List<org.json.JSONObject> objects)
Override the content of several objects
|
org.json.JSONObject |
Index.search(Query params)
Search inside the index
|
org.json.JSONObject |
Index.searchDisjunctiveFaceting(Query query,
List<String> disjunctiveFacets) |
org.json.JSONObject |
Index.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 |
Index.setSettings(org.json.JSONObject settings)
Set settings for this index
|
org.json.JSONObject |
Index.updateUserKey(String key,
org.json.JSONObject params)
Update a new user key
|
org.json.JSONObject |
APIClient.updateUserKey(String key,
org.json.JSONObject params)
Update a user key
|
org.json.JSONObject |
Index.updateUserKey(String key,
List<String> acls)
Update a user key
|
org.json.JSONObject |
APIClient.updateUserKey(String key,
List<String> acls)
Update a user key
|
org.json.JSONObject |
Index.updateUserKey(String key,
List<String> acls,
int validity,
int maxQueriesPerIPPerHour,
int maxHitsPerQuery)
Update a user key
|
org.json.JSONObject |
APIClient.updateUserKey(String key,
List<String> acls,
int validity,
int maxQueriesPerIPPerHour,
int maxHitsPerQuery)
Update a user key
|
org.json.JSONObject |
APIClient.updateUserKey(String key,
List<String> acls,
int validity,
int maxQueriesPerIPPerHour,
int maxHitsPerQuery,
List<String> indexes)
Update a user key
|
void |
Index.waitTask(String taskID)
Wait the publication of a task on the server.
|
void |
Index.waitTask(String taskID,
long timeToWait)
Wait the publication of a task on the server.
|
Copyright © 2015. All rights reserved.