APIClient (Algolia Search Client 1.12.2 API)

java.lang.Object
- com.algolia.search.saas.APIClient

```
public class APIClient
extends Object
```
Entry point in the Java API. You should instantiate a Client object with your ApplicationID, ApiKey and Hosts to start using Algolia Search API

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class APIClient.IndexQuery

static class APIClient.LogType

Nested Classes
Modifier and Type	Class	Description
`static class`	`APIClient.IndexQuery`
`static class`	`APIClient.LogType`

Constructor Summary

Constructors
Constructor	Description
`APIClient(String applicationID, String apiKey)`	Algolia Search initialization
`APIClient(String applicationID, String apiKey, List<String> hostsArray)`	Algolia Search initialization
`APIClient(String applicationID, String apiKey, List<String> buildHostsArray, List<String> queryHostsArray)`	Algolia Search initialization

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`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`	`addApiKey(List<String> acls, int validity, int maxQueriesPerIPPerHour, int maxHitsPerQuery, List<String> indexes)`	Create a new user key
`org.json.JSONObject`	`addApiKey(List<String> acls, int validity, int maxQueriesPerIPPerHour, int maxHitsPerQuery, List<String> indexes, RequestOptions requestOptions)`	Create a new user key
`org.json.JSONObject`	`addApiKey(List<String> acls, RequestOptions requestOptions)`	Create a new api key
`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`	`addUserKey(List<String> acls)`	Deprecated.
`org.json.JSONObject`	`addUserKey(List<String> acls, int validity, int maxQueriesPerIPPerHour, int maxHitsPerQuery)`	Deprecated.
`org.json.JSONObject`	`addUserKey(List<String> acls, int validity, int maxQueriesPerIPPerHour, int maxHitsPerQuery, List<String> indexes)`	Deprecated.
`org.json.JSONObject`	`addUserKey(org.json.JSONObject params)`	Deprecated.
`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`	`batch(org.json.JSONArray actions)`	Custom batch
`org.json.JSONObject`	`batch(org.json.JSONArray actions, RequestOptions requestOptions)`	Custom batch
`org.json.JSONObject`	`copyIndex(String srcIndexName, String dstIndexName)`	Copy an existing index.
`org.json.JSONObject`	`copyIndex(String srcIndexName, String dstIndexName, RequestOptions requestOptions)`	Copy an existing index.
`org.json.JSONObject`	`copyIndex(String srcIndexName, String dstIndexName, List<String> scopes)`	Copy an existing index.
`org.json.JSONObject`	`copyIndex(String srcIndexName, String dstIndexName, List<String> scopes, RequestOptions requestOptions)`	Copy an existing index.
`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`	`deleteIndex(String indexName)`	Delete an index
`org.json.JSONObject`	`deleteIndex(String indexName, RequestOptions requestOptions)`	Delete an index
`protected org.json.JSONObject`	`deleteRequest(String url, RequestOptions requestOptions)`
`org.json.JSONObject`	`deleteUserKey(String key)`	Deprecated.
`void`	`disableRateLimitForward()`	Disable IP rate limit enabled with enableRateLimitForward() function
`void`	`enableRateLimitForward(String adminAPIKey, String endUserIP, String rateLimitAPIKey)`	Allow to use IP rate limit when you have a proxy between end-user and Algolia.
`String`	`generateSecuredApiKey(String privateApiKey, Query query)`	Generate a secured and public API Key from a query and an optional user token identifying the current user
`String`	`generateSecuredApiKey(String privateApiKey, Query query, String userToken)`	Generate a secured and public API Key from a query and an optional user token identifying the current user
`String`	`generateSecuredApiKey(String privateApiKey, String tagFilters)`	Deprecated. Use `generateSecuredApiKey(String privateApiKey, Query query)` version
`String`	`generateSecuredApiKey(String privateApiKey, String tagFilters, String userToken)`	Deprecated. Use `generateSecuredApiKey(String privateApiKey, Query query, String userToken)` version
`org.json.JSONObject`	`getApiKey(String key)`	Get an api key
`org.json.JSONObject`	`getApiKey(String key, RequestOptions requestOptions)`	Get an api key
`org.json.JSONObject`	`getLogs()`	Return 10 last log entries.
`org.json.JSONObject`	`getLogs(int offset, int length)`	Return last logs entries.
`org.json.JSONObject`	`getLogs(int offset, int length, boolean onlyErrors)`	Return last logs entries.
`org.json.JSONObject`	`getLogs(int offset, int length, boolean onlyErrors, RequestOptions requestOptions)`	Return last logs entries.
`org.json.JSONObject`	`getLogs(int offset, int length, APIClient.LogType logType)`	Return last logs entries.
`org.json.JSONObject`	`getLogs(int offset, int length, APIClient.LogType logType, RequestOptions requestOptions)`	Return last logs entries.
`org.json.JSONObject`	`getLogs(int offset, int length, RequestOptions requestOptions)`	Return last logs entries.
`org.json.JSONObject`	`getLogs(RequestOptions requestOptions)`	Return 10 last log entries.
`protected org.json.JSONObject`	`getRequest(String url, boolean search, RequestOptions requestOptions)`
`org.json.JSONObject`	`getUserKeyACL(String key)`	Deprecated.
`Index`	`initIndex(String indexName)`	Get the index object initialized (no server call needed for initialization)
`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`	`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`	`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`	`listUserKeys()`	Deprecated.
`org.json.JSONObject`	`moveIndex(String srcIndexName, String dstIndexName)`	Move an existing index.
`org.json.JSONObject`	`moveIndex(String srcIndexName, String dstIndexName, RequestOptions requestOptions)`	Move an existing index.
`org.json.JSONObject`	`multipleQueries(List<APIClient.IndexQuery> queries)`	This method allows to query multiple indexes with one API call
`org.json.JSONObject`	`multipleQueries(List<APIClient.IndexQuery> queries, RequestOptions requestOptions)`	This method allows to query multiple indexes with one API call
`org.json.JSONObject`	`multipleQueries(List<APIClient.IndexQuery> queries, String strategy, RequestOptions requestOptions)`
`protected org.json.JSONObject`	`postRequest(String url, String obj, boolean build, boolean search, RequestOptions requestOptions)`
`protected org.json.JSONObject`	`putRequest(String url, String obj, RequestOptions requestOptions)`
`void`	`setExtraHeader(String key, String value)`	Allow to set custom headers
`void`	`setHostDownTimeoutMS(int hostDownTimeoutMS)`	Allow to set the timeout for a down host
`void`	`setTimeout(int connectTimeout, int readTimeout)`	Allow to set the timeout
`void`	`setUserAgent(String agent, String agentVersion)`	Allow to modify the user-agent in order to add the user agent of the integration
`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`	`updateApiKey(String key, List<String> acls, int validity, int maxQueriesPerIPPerHour, int maxHitsPerQuery, List<String> indexes)`	Update an api key
`org.json.JSONObject`	`updateApiKey(String key, List<String> acls, int validity, int maxQueriesPerIPPerHour, int maxHitsPerQuery, List<String> indexes, RequestOptions requestOptions)`	Update an api key
`org.json.JSONObject`	`updateApiKey(String key, List<String> acls, RequestOptions requestOptions)`	Update an api key
`org.json.JSONObject`	`updateApiKey(String key, org.json.JSONObject params)`	Update an api key
`org.json.JSONObject`	`updateApiKey(String key, org.json.JSONObject params, RequestOptions requestOptions)`	Update an api key
`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.
`org.json.JSONObject`	`updateUserKey(String key, List<String> acls, int validity, int maxQueriesPerIPPerHour, int maxHitsPerQuery, List<String> indexes)`	Deprecated.
`org.json.JSONObject`	`updateUserKey(String key, org.json.JSONObject params)`	Deprecated.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - APIClient
```
public APIClient(String applicationID,
                 String apiKey)
```
    Algolia Search initialization
    
    Parameters:
    
    applicationID - the application ID you have in your admin interface
    
    apiKey - a valid API key for the service
  - APIClient
```
public APIClient(String applicationID,
                 String apiKey,
                 List<String> hostsArray)
```
    Algolia Search initialization
    
    Parameters:
    
    applicationID - the application ID you have in your admin interface
    
    apiKey - a valid API key for the service
    
    hostsArray - the list of hosts that you have received for the service
  - APIClient
```
public APIClient(String applicationID,
                 String apiKey,
                 List<String> buildHostsArray,
                 List<String> queryHostsArray)
```
    Algolia Search initialization
    
    Parameters:
    
    applicationID - the application ID you have in your admin interface
    
    apiKey - a valid API key for the service
    
    buildHostsArray - the list of hosts that you have received for the service
    
    queryHostsArray - the list of hosts that you have received for the service
- Method Detail
  - setUserAgent
```
public void setUserAgent(String agent,
                         String agentVersion)
```
    Allow to modify the user-agent in order to add the user agent of the integration
  - enableRateLimitForward
```
public void enableRateLimitForward(String adminAPIKey,
                                   String endUserIP,
                                   String rateLimitAPIKey)
```
    Allow to use IP rate limit when you have a proxy between end-user and Algolia. This option will set the X-Forwarded-For HTTP header with the client IP and the X-Forwarded-API-Key with the API Key having rate limits.
    
    Parameters:
    
    adminAPIKey - the admin API Key you can find in your dashboard
    
    endUserIP - the end user IP (you can use both IPV4 or IPV6 syntax)
    
    rateLimitAPIKey - the API key on which you have a rate limit
  - disableRateLimitForward
```
public void disableRateLimitForward()
```
    Disable IP rate limit enabled with enableRateLimitForward() function
  - setExtraHeader
```
public void setExtraHeader(String key,
                           String value)
```
    Allow to set custom headers
  - setTimeout
```
public void setTimeout(int connectTimeout,
                       int readTimeout)
```
    Allow to set the timeout
    
    Parameters:
    
    connectTimeout - connection timeout in MS
    
    readTimeout - socket timeout in MS
  - setHostDownTimeoutMS
```
public void setHostDownTimeoutMS(int hostDownTimeoutMS)
```
    Allow to set the timeout for a down host
    
    Parameters:
    
    hostDownTimeoutMS - host down timeout in MS
  - listIndexes
```
public org.json.JSONObject listIndexes()
                                throws AlgoliaException
```
    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"}]}
    
    Throws:
    
    AlgoliaException
  - listIndexes
```
public org.json.JSONObject listIndexes(RequestOptions requestOptions)
                                throws AlgoliaException
```
    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"}]}
    
    Parameters:
    
    requestOptions - Options to pass to this request
    
    Throws:
    
    AlgoliaException
  - deleteIndex
```
public org.json.JSONObject deleteIndex(String indexName)
                                throws AlgoliaException
```
    Delete an index
    
    Parameters:
    
    indexName - the name of index to delete return an object containing a "deletedAt" attribute
    
    Throws:
    
    AlgoliaException
  - deleteIndex
```
public org.json.JSONObject deleteIndex(String indexName,
                                       RequestOptions requestOptions)
                                throws AlgoliaException
```
    Delete an index
    
    Parameters:
    
    indexName - the name of index to delete return an object containing a "deletedAt" attribute
    
    requestOptions - Options to pass to this request
    
    Throws:
    
    AlgoliaException
  - moveIndex
```
public org.json.JSONObject moveIndex(String srcIndexName,
                                     String dstIndexName)
                              throws AlgoliaException
```
    Move an existing index.
    
    Parameters:
    
    srcIndexName - the name of index to copy.
    
    dstIndexName - the new index name that will contains a copy of srcIndexName (destination will be overriten if it already exist).
    
    Throws:
    
    AlgoliaException
  - moveIndex
```
public org.json.JSONObject moveIndex(String srcIndexName,
                                     String dstIndexName,
                                     RequestOptions requestOptions)
                              throws AlgoliaException
```
    Move an existing index.
    
    Parameters:
    
    srcIndexName - the name of index to copy.
    
    dstIndexName - the new index name that will contains a copy of srcIndexName (destination will be overriten if it already exist).
    
    requestOptions - Options to pass to this request
    
    Throws:
    
    AlgoliaException
  - copyIndex
```
public org.json.JSONObject copyIndex(String srcIndexName,
                                     String dstIndexName)
                              throws AlgoliaException
```
    Copy an existing index.
    
    Parameters:
    
    srcIndexName - the name of index to copy.
    
    dstIndexName - the new index name that will contains a copy of srcIndexName (destination will be overriten if it already exist).
    
    Throws:
    
    AlgoliaException
  - copyIndex
```
public org.json.JSONObject copyIndex(String srcIndexName,
                                     String dstIndexName,
                                     RequestOptions requestOptions)
                              throws AlgoliaException
```
    Copy an existing index.
    
    Parameters:
    
    srcIndexName - the name of index to copy.
    
    dstIndexName - the new index name that will contains a copy of srcIndexName (destination will be overriten if it already exist).
    
    requestOptions - Options to pass to this request
    
    Throws:
    
    AlgoliaException
  - copyIndex
```
public org.json.JSONObject copyIndex(String srcIndexName,
                                     String dstIndexName,
                                     List<String> scopes)
                              throws AlgoliaException
```
    Copy an existing index.
    
    Parameters:
    
    srcIndexName - the name of index to copy.
    
    dstIndexName - the new index name that will contains a copy of srcIndexName (destination will be overriten if it already exist).
    
    scopes - the list of scopes to copy
    
    Throws:
    
    AlgoliaException
  - copyIndex
```
public org.json.JSONObject copyIndex(String srcIndexName,
                                     String dstIndexName,
                                     List<String> scopes,
                                     RequestOptions requestOptions)
                              throws AlgoliaException
```
    Copy an existing index.
    
    Parameters:
    
    srcIndexName - the name of index to copy.
    
    dstIndexName - the new index name that will contains a copy of srcIndexName (destination will be overriten if it already exist).
    
    scopes - the list of scopes to copy
    
    requestOptions - Options to pass to this request
    
    Throws:
    
    AlgoliaException
  - getLogs
```
public org.json.JSONObject getLogs()
                            throws AlgoliaException
```
    Return 10 last log entries.
    
    Throws:
    
    AlgoliaException
  - getLogs
```
public org.json.JSONObject getLogs(RequestOptions requestOptions)
                            throws AlgoliaException
```
    Return 10 last log entries.
    
    Parameters:
    
    requestOptions - Options to pass to this request
    
    Throws:
    
    AlgoliaException
  - getLogs
```
public org.json.JSONObject getLogs(int offset,
                                   int length)
                            throws AlgoliaException
```
    Return last logs entries.
    
    Parameters:
    
    offset - Specify the first entry to retrieve (0-based, 0 is the most recent log entry).
    
    length - Specify the maximum number of entries to retrieve starting at offset. Maximum allowed value: 1000.
    
    Throws:
    
    AlgoliaException
  - getLogs
```
public org.json.JSONObject getLogs(int offset,
                                   int length,
                                   RequestOptions requestOptions)
                            throws AlgoliaException
```
    Return last logs entries.
    
    Parameters:
    
    offset - Specify the first entry to retrieve (0-based, 0 is the most recent log entry).
    
    length - Specify the maximum number of entries to retrieve starting at offset. Maximum allowed value: 1000.
    
    requestOptions - Options to pass to this request
    
    Throws:
    
    AlgoliaException
  - getLogs
```
public org.json.JSONObject getLogs(int offset,
                                   int length,
                                   boolean onlyErrors)
                            throws AlgoliaException
```
    Return last logs entries.
    
    Parameters:
    
    offset - Specify the first entry to retrieve (0-based, 0 is the most recent log entry).
    
    length - Specify the maximum number of entries to retrieve starting at offset. Maximum allowed value: 1000.
    
    onlyErrors - Retrieve only logs with an httpCode different than 200 and 201
    
    Throws:
    
    AlgoliaException
  - getLogs
```
public org.json.JSONObject getLogs(int offset,
                                   int length,
                                   boolean onlyErrors,
                                   RequestOptions requestOptions)
                            throws AlgoliaException
```
    Return last logs entries.
    
    Parameters:
    
    offset - Specify the first entry to retrieve (0-based, 0 is the most recent log entry).
    
    length - Specify the maximum number of entries to retrieve starting at offset. Maximum allowed value: 1000.
    
    onlyErrors - Retrieve only logs with an httpCode different than 200 and 201
    
    requestOptions - Options to pass to this request
    
    Throws:
    
    AlgoliaException
  - getLogs
```
public org.json.JSONObject getLogs(int offset,
                                   int length,
                                   APIClient.LogType logType)
                            throws AlgoliaException
```
    Return last logs entries.
    
    Parameters:
    
    offset - Specify the first entry to retrieve (0-based, 0 is the most recent log entry).
    
    length - Specify the maximum number of entries to retrieve starting at offset. Maximum allowed value: 1000.
    
    logType - Specify the type of log to retrieve
    
    Throws:
    
    AlgoliaException
  - getLogs
```
public org.json.JSONObject getLogs(int offset,
                                   int length,
                                   APIClient.LogType logType,
                                   RequestOptions requestOptions)
                            throws AlgoliaException
```
    Return last logs entries.
    
    Parameters:
    
    offset - Specify the first entry to retrieve (0-based, 0 is the most recent log entry).
    
    length - Specify the maximum number of entries to retrieve starting at offset. Maximum allowed value: 1000.
    
    logType - Specify the type of log to retrieve
    
    requestOptions - Options to pass to this request
    
    Throws:
    
    AlgoliaException
  - initIndex
```
public Index initIndex(String indexName)
```
    Get the index object initialized (no server call needed for initialization)
    
    Parameters:
    
    indexName - the name of index
  - 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 an api key
    
    Throws:
    
    AlgoliaException
  - getApiKey
```
public org.json.JSONObject getApiKey(String key,
                                     RequestOptions requestOptions)
                              throws AlgoliaException
```
    Get 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
  - addApiKey
```
public org.json.JSONObject addApiKey(List<String> acls,
                                     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)
    
    requestOptions - Options to pass to this request
    
    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 an 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 an 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: use 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
  - updateApiKey
```
public org.json.JSONObject updateApiKey(String key,
                                        List<String> acls,
                                        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)
    
    requestOptions - Options to pass to this request
    
    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
  - addUserKey
```
@Deprecated
public org.json.JSONObject addUserKey(List<String> acls,
                                      int validity,
                                      int maxQueriesPerIPPerHour,
                                      int maxHitsPerQuery,
                                      List<String> indexes)
                               throws AlgoliaException
```
    Deprecated.
    
    Deprecated: use addApiKey
    
    Throws:
    
    AlgoliaException
  - addApiKey
```
public org.json.JSONObject addApiKey(List<String> acls,
                                     int validity,
                                     int maxQueriesPerIPPerHour,
                                     int maxHitsPerQuery,
                                     List<String> indexes)
                              throws AlgoliaException
```
    Create a new user 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)
    
    indexes - the list of targeted indexes
    
    Throws:
    
    AlgoliaException
  - addApiKey
```
public org.json.JSONObject addApiKey(List<String> acls,
                                     int validity,
                                     int maxQueriesPerIPPerHour,
                                     int maxHitsPerQuery,
                                     List<String> indexes,
                                     RequestOptions requestOptions)
                              throws AlgoliaException
```
    Create a new user 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)
    
    indexes - the list of targeted indexes
    
    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,
                                         List<String> indexes)
                                  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,
                                        List<String> indexes)
                                 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)
    
    indexes - the list of targeted indexes
    
    Throws:
    
    AlgoliaException
  - updateApiKey
```
public org.json.JSONObject updateApiKey(String key,
                                        List<String> acls,
                                        int validity,
                                        int maxQueriesPerIPPerHour,
                                        int maxHitsPerQuery,
                                        List<String> indexes,
                                        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)
    
    indexes - the list of targeted indexes
    
    requestOptions - Options to pass to this request
    
    Throws:
    
    AlgoliaException
  - generateSecuredApiKey
```
@Deprecated
public String generateSecuredApiKey(String privateApiKey,
                                    String tagFilters)
                             throws NoSuchAlgorithmException,
                                    InvalidKeyException
```
    Deprecated. Use `generateSecuredApiKey(String privateApiKey, Query query)` version
    
    Generate a secured and public API Key from a list of tagFilters and an optional user token identifying the current user
    
    Parameters:
    
    privateApiKey - your private API Key
    
    tagFilters - the list of tags applied to the query (used as security)
    
    Throws:
    
    NoSuchAlgorithmException
    
    InvalidKeyException
  - generateSecuredApiKey
```
public String generateSecuredApiKey(String privateApiKey,
                                    Query query)
                             throws NoSuchAlgorithmException,
                                    InvalidKeyException
```
    Generate a secured and public API Key from a query and an optional user token identifying the current user
    
    Parameters:
    
    privateApiKey - your private API Key
    
    query - contains the parameter applied to the query (used as security)
    
    Throws:
    
    NoSuchAlgorithmException
    
    InvalidKeyException
  - generateSecuredApiKey
```
@Deprecated
public String generateSecuredApiKey(String privateApiKey,
                                    String tagFilters,
                                    String userToken)
                             throws NoSuchAlgorithmException,
                                    InvalidKeyException,
                                    AlgoliaException
```
    Deprecated. Use `generateSecuredApiKey(String privateApiKey, Query query, String userToken)` version
    
    Generate a secured and public API Key from a list of tagFilters and an optional user token identifying the current user
    
    Parameters:
    
    privateApiKey - your private API Key
    
    tagFilters - the list of tags applied to the query (used as security)
    
    userToken - an optional token identifying the current user
    
    Throws:
    
    NoSuchAlgorithmException
    
    InvalidKeyException
    
    AlgoliaException
  - generateSecuredApiKey
```
public String generateSecuredApiKey(String privateApiKey,
                                    Query query,
                                    String userToken)
                             throws NoSuchAlgorithmException,
                                    InvalidKeyException
```
    Generate a secured and public API Key from a query and an optional user token identifying the current user
    
    Parameters:
    
    privateApiKey - your private API Key
    
    query - contains the parameter applied to the query (used as security)
    
    userToken - an optional token identifying the current user
    
    Throws:
    
    NoSuchAlgorithmException
    
    InvalidKeyException
  - getRequest
```
protected org.json.JSONObject getRequest(String url,
                                         boolean search,
                                         RequestOptions requestOptions)
                                  throws AlgoliaException
```
    Throws:
    
    AlgoliaException
  - deleteRequest
```
protected org.json.JSONObject deleteRequest(String url,
                                            RequestOptions requestOptions)
                                     throws AlgoliaException
```
    Throws:
    
    AlgoliaException
  - postRequest
```
protected org.json.JSONObject postRequest(String url,
                                          String obj,
                                          boolean build,
                                          boolean search,
                                          RequestOptions requestOptions)
                                   throws AlgoliaException
```
    Throws:
    
    AlgoliaException
  - putRequest
```
protected org.json.JSONObject putRequest(String url,
                                         String obj,
                                         RequestOptions requestOptions)
                                  throws AlgoliaException
```
    Throws:
    
    AlgoliaException
  - multipleQueries
```
public org.json.JSONObject multipleQueries(List<APIClient.IndexQuery> queries)
                                    throws AlgoliaException
```
    This method allows to query multiple indexes with one API call
    
    Throws:
    
    AlgoliaException
  - multipleQueries
```
public org.json.JSONObject multipleQueries(List<APIClient.IndexQuery> queries,
                                           RequestOptions requestOptions)
                                    throws AlgoliaException
```
    This method allows to query multiple indexes with one API call
    
    Parameters:
    
    requestOptions - Options to pass to this request
    
    Throws:
    
    AlgoliaException
  - multipleQueries
```
public org.json.JSONObject multipleQueries(List<APIClient.IndexQuery> queries,
                                           String strategy,
                                           RequestOptions requestOptions)
                                    throws AlgoliaException
```
    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

Class APIClient

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

APIClient

APIClient

APIClient

Method Detail

setUserAgent

enableRateLimitForward

disableRateLimitForward

setExtraHeader

setTimeout

setHostDownTimeoutMS

listIndexes

listIndexes

deleteIndex

deleteIndex

moveIndex

moveIndex

copyIndex

copyIndex

copyIndex

copyIndex

getLogs

getLogs

getLogs

getLogs

getLogs

getLogs

getLogs

getLogs

initIndex

listUserKeys

listApiKeys

listApiKeys

getUserKeyACL

getApiKey

getApiKey

deleteUserKey

deleteApiKey

deleteApiKey

addUserKey

addApiKey

addApiKey

addUserKey

addApiKey

addApiKey

updateUserKey

updateApiKey

updateApiKey

updateUserKey

updateApiKey

updateApiKey

addUserKey

addApiKey

addApiKey

updateUserKey

updateApiKey

updateApiKey

addUserKey

addApiKey

addApiKey

updateUserKey

updateApiKey

updateApiKey

generateSecuredApiKey

generateSecuredApiKey

generateSecuredApiKey

generateSecuredApiKey

getRequest

deleteRequest

postRequest

putRequest

multipleQueries

multipleQueries

multipleQueries

batch