com.algolia.search

Class APIClient

java.lang.Object

com.algolia.search.APIClient

public class APIClient
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected APIClientConfiguration	configuration
protected AlgoliaHttpClient	httpClient Constructor & protected stuff

Method Summary

Modifier and Type	Method and Description
TaskABTest	addABTest(ABTest abtest)
CreateUpdateKey	addApiKey(ApiKey key) Create a new key
CreateUpdateKey	addApiKey(ApiKey key, RequestOptions requestOptions) Create a new key
CreateUpdateKey	addKey(ApiKey key) Deprecated.
AssignUserID	assignUserID(String userID, String clusterName)
AssignUserID	assignUserID(String userID, String clusterName, RequestOptions requestOptions)
TasksMultipleIndex	batch(List<BatchOperation> operations) Custom batch
TasksMultipleIndex	batch(List<BatchOperation> operations, RequestOptions requestOptions) Custom batch
<T> BrowseResult<T>	browse(String indexName, Query query, String cursor, Class<T> klass, RequestOptions requestOptions)
void	close() Close the internal HTTP client
Task	copyIndex(String srcIndexName, String dstIndexName) Copy an existing index
Task	copyIndex(String srcIndexName, String dstIndexName, List<String> scope) Copy an existing index
Task	copyIndex(String srcIndexName, String dstIndexName, List<String> scope, RequestOptions requestOptions) Copy an existing index
Task	copyIndex(String srcIndexName, String dstIndexName, RequestOptions requestOptions) Copy an existing index
TaskABTest	deleteABTest(long id)
DeleteKey	deleteApiKey(String key) Delete an existing key
DeleteKey	deleteApiKey(String key, RequestOptions requestOptions) Delete an existing key
Task	deleteIndex(String indexName) Delete an existing index
Task	deleteIndex(String indexName, RequestOptions requestOptions) Delete an existing index
DeleteKey	deleteKey(String key) Deprecated.
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
ABTest	getABTest(long id)
ABTests	getABTests(int offset, int limit)
Optional<ApiKey>	getApiKey(String key) Get a Key from its name
Optional<ApiKey>	getApiKey(String key, RequestOptions requestOptions) Get a Key from its name
Optional<ApiKey>	getKey(String key) Deprecated.
List<Log>	getLogs() Return 10 last log entries.
List<Log>	getLogs(Integer offset, Integer length, LogType logType) Return last logs entries
List<Log>	getLogs(Integer offset, Integer length, LogType logType, RequestOptions requestOptions) Return last logs entries
List<Log>	getLogs(RequestOptions requestOptions) Return 10 last log entries.
Map<String,List<UserID>>	getTopUserID()
Map<String,List<UserID>>	getTopUserID(RequestOptions requestOptions)
UserID	getUserID(String userID)
UserID	getUserID(String userID, RequestOptions requestOptions)
Analytics	initAnalytics()
Index<?>	initIndex(String name) Get the index object initialized (no server call needed for initialization)
<T> Index<T>	initIndex(String name, Class<T> klass) Get the index object initialized (no server call needed for initialization)
List<ApiKey>	listApiKeys() List all existing user keys with their associated ACLs
List<ApiKey>	listApiKeys(RequestOptions requestOptions) List all existing user keys with their associated ACLs
List<Cluster>	listClusters()
List<Cluster>	listClusters(RequestOptions requestOptions)
List<Index.Attributes>	listIndexes() List all existing indexes
List<Index.Attributes>	listIndexes(RequestOptions requestOptions) List all existing indexes
List<Index.Attributes>	listIndices() Deprecated.
List<Index.Attributes>	listIndices(RequestOptions requestOptions) Deprecated.
List<ApiKey>	listKeys() Deprecated.
UserIDs	listUserIDs()
UserIDs	listUserIDs(Integer page, Integer hitsPerPage)
UserIDs	listUserIDs(Integer page, Integer hitsPerPage, RequestOptions requestOptions)
Task	moveIndex(String srcIndexName, String dstIndexName) Moves an existing index
Task	moveIndex(String srcIndexName, String dstIndexName, RequestOptions requestOptions) Moves an existing index
MultiQueriesResult	multipleQueries(List<IndexQuery> queries) Performs multiple searches on multiple indices with the strategy MultiQueriesStrategy.NONE
MultiQueriesResult	multipleQueries(List<IndexQuery> queries, MultiQueriesStrategy strategy) Performs multiple searches on multiple indices
MultiQueriesResult	multipleQueries(List<IndexQuery> queries, MultiQueriesStrategy strategy, RequestOptions requestOptions) Performs multiple searches on multiple indices
MultiQueriesResult	multipleQueries(List<IndexQuery> queries, RequestOptions requestOptions) Performs multiple searches on multiple indices with the strategy MultiQueriesStrategy.NONE
DeleteUserID	removeUserID(String userID)
DeleteUserID	removeUserID(String userID, RequestOptions requestOptions)
SearchUserIDs	searchUserIDs(String query, String clusterName)
SearchUserIDs	searchUserIDs(String query, String clusterName, int page, int hitsPerPage)
SearchUserIDs	searchUserIDs(String query, String clusterName, int page, int hitsPerPage, RequestOptions requestOptions)
SearchUserIDs	searchUserIDs(String query, String clusterName, RequestOptions requestOptions)
TaskABTest	stopABTest(long id)
CreateUpdateKey	updateApiKey(String keyName, ApiKey key) Update a key
CreateUpdateKey	updateApiKey(String keyName, ApiKey key, RequestOptions requestOptions) Update a key
CreateUpdateKey	updateKey(String keyName, ApiKey key) Deprecated.
<T> void	waitTask(GenericTask<T> task) Wait for the completion of this task
<T> void	waitTask(GenericTask<T> task, long timeToWait) Wait for the completion of this task
<T> void	waitTask(GenericTask<T> task, long timeToWait, RequestOptions requestOptions) Wait for the completion of this task

Methods inherited from class java.lang.Object

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

Field Detail

httpClient

protected final AlgoliaHttpClient httpClient

Constructor & protected stuff

configuration

protected final APIClientConfiguration configuration

Method Detail

close

public void close()
           throws AlgoliaException

Close the internal HTTP client

Throws:

AlgoliaException

listIndexes

public List<Index.Attributes> listIndexes()
                                   throws AlgoliaException

List all existing indexes

Returns:

A List of the indices and their metadata

Throws:

AlgoliaException

listIndexes

public List<Index.Attributes> listIndexes(@Nonnull
                                          RequestOptions requestOptions)
                                   throws AlgoliaException

List all existing indexes

Parameters:

requestOptions - Options to pass to this request

Returns:

A List of the indices and their metadata

Throws:

AlgoliaException

listIndices

@Deprecated
public List<Index.Attributes> listIndices()
                                               throws AlgoliaException

Deprecated.

Deprecated: use listIndexes()

Throws:

AlgoliaException

listIndices

@Deprecated
public List<Index.Attributes> listIndices(@Nonnull
                                                      RequestOptions requestOptions)
                                               throws AlgoliaException

Deprecated.

Deprecated: use listIndexes(RequestOptions)

Throws:

AlgoliaException

initIndex

public <T> Index<T> initIndex(@Nonnull
                              String name,
                              @Nonnull
                              Class<T> klass)

Get the index object initialized (no server call needed for initialization)

Type Parameters:

T - the type of the objects in this index

Parameters:

name - name of the index

klass - class of the object in this index

Returns:

The initialized index

initIndex

public Index<?> initIndex(@Nonnull
                          String name)

Get the index object initialized (no server call needed for initialization)

Parameters:

name - name of the index

Returns:

The initialized index

initAnalytics

public Analytics initAnalytics()

moveIndex

public Task moveIndex(@Nonnull
                      String srcIndexName,
                      @Nonnull
                      String dstIndexName)
               throws AlgoliaException

Moves an existing index

Parameters:

srcIndexName - the index name that will be the source of the copy

dstIndexName - the new index name that will contains a copy of srcIndexName (destination will be overwritten if it already exist)

Returns:

The associated task

Throws:

AlgoliaException

moveIndex

public Task moveIndex(@Nonnull
                      String srcIndexName,
                      @Nonnull
                      String dstIndexName,
                      @Nonnull
                      RequestOptions requestOptions)
               throws AlgoliaException

Moves an existing index

Parameters:

srcIndexName - the index name that will be the source of the copy

dstIndexName - the new index name that will contains a copy of srcIndexName (destination will be overwritten if it already exist)

requestOptions - Options to pass to this request

Returns:

The associated task

Throws:

AlgoliaException

copyIndex

public Task copyIndex(@Nonnull
                      String srcIndexName,
                      @Nonnull
                      String dstIndexName)
               throws AlgoliaException

Copy an existing index

Parameters:

srcIndexName - the index name that will be the source of the copy

dstIndexName - the new index name that will contains a copy of srcIndexName (destination will be overwritten if it already exist)

Returns:

The associated task

Throws:

AlgoliaException

copyIndex

public Task copyIndex(@Nonnull
                      String srcIndexName,
                      @Nonnull
                      String dstIndexName,
                      @Nonnull
                      RequestOptions requestOptions)
               throws AlgoliaException

Copy an existing index

Parameters:

srcIndexName - the index name that will be the source of the copy

dstIndexName - the new index name that will contains a copy of srcIndexName (destination will be overwritten if it already exist)

requestOptions - Options to pass to this request

Returns:

The associated task

Throws:

AlgoliaException

copyIndex

public Task copyIndex(@Nonnull
                      String srcIndexName,
                      @Nonnull
                      String dstIndexName,
                      List<String> scope,
                      @Nonnull
                      RequestOptions requestOptions)
               throws AlgoliaException

Copy an existing index

Parameters:

srcIndexName - the index name that will be the source of the copy

dstIndexName - the new index name that will contains a copy of srcIndexName (destination will be overwritten if it already exist)

scope - the list of scope to copy

requestOptions - Options to pass to this request

Returns:

The associated task

Throws:

AlgoliaException

copyIndex

public Task copyIndex(@Nonnull
                      String srcIndexName,
                      @Nonnull
                      String dstIndexName,
                      @Nonnull
                      List<String> scope)
               throws AlgoliaException

Copy an existing index

Parameters:

srcIndexName - the index name that will be the source of the copy

dstIndexName - the new index name that will contains a copy of srcIndexName (destination will be overwritten if it already exist)

scope - the list of scope to copy

Returns:

The task associated

Throws:

AlgoliaException

deleteIndex

public Task deleteIndex(@Nonnull
                        String indexName)
                 throws AlgoliaException

Delete an existing index

Parameters:

indexName - The index name that will be deleted

Returns:

The associated task

Throws:

AlgoliaException

deleteIndex

public Task deleteIndex(@Nonnull
                        String indexName,
                        @Nonnull
                        RequestOptions requestOptions)
                 throws AlgoliaException

Delete an existing index

Parameters:

indexName - The index name that will be deleted

requestOptions - Options to pass to this request

Returns:

The associated task

Throws:

AlgoliaException

getLogs

public List<Log> getLogs()
                  throws AlgoliaException

Return 10 last log entries.

Returns:

A List

Throws:

AlgoliaException

getLogs

public List<Log> getLogs(@Nonnull
                         RequestOptions requestOptions)
                  throws AlgoliaException

Return 10 last log entries.

Parameters:

requestOptions - Options to pass to this request

Returns:

A List

Throws:

AlgoliaException

getLogs

public List<Log> getLogs(@Nonnull
                         Integer offset,
                         @Nonnull
                         Integer length,
                         @Nonnull
                         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

Returns:

The List of Logs

Throws:

AlgoliaException

getLogs

public List<Log> getLogs(@Nonnull
                         Integer offset,
                         @Nonnull
                         Integer length,
                         @Nonnull
                         LogType logType,
                         @Nonnull
                         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

Returns:

The List of Logs

Throws:

AlgoliaException

listKeys

@Deprecated
public List<ApiKey> listKeys()
                                  throws AlgoliaException

Deprecated.

Deprecated: use listApiKeys()

Throws:

AlgoliaException

listApiKeys

public List<ApiKey> listApiKeys()
                         throws AlgoliaException

List all existing user keys with their associated ACLs

Returns:

A List of Keys

Throws:

AlgoliaException

listApiKeys

public List<ApiKey> listApiKeys(@Nonnull
                                RequestOptions requestOptions)
                         throws AlgoliaException

List all existing user keys with their associated ACLs

Parameters:

requestOptions - Options to pass to this request

Returns:

A List of Keys

Throws:

AlgoliaException

getKey

@Deprecated
public Optional<ApiKey> getKey(@Nonnull
                                           String key)
                                    throws AlgoliaException

Deprecated.

Deprecated: use getApiKey(String)

Throws:

AlgoliaException

getApiKey

public Optional<ApiKey> getApiKey(@Nonnull
                                  String key)
                           throws AlgoliaException

Get a Key from its name

Parameters:

key - name of the key

Returns:

the key

Throws:

AlgoliaException

getApiKey

public Optional<ApiKey> getApiKey(@Nonnull
                                  String key,
                                  @Nonnull
                                  RequestOptions requestOptions)
                           throws AlgoliaException

Get a Key from its name

Parameters:

key - name of the key

requestOptions - Options to pass to this request

Returns:

the key

Throws:

AlgoliaException

deleteKey

@Deprecated
public DeleteKey deleteKey(@Nonnull
                                       String key)
                                throws AlgoliaException

Deprecated.

Deprecated: use deleteApiKey(String)

Throws:

AlgoliaException

deleteApiKey

public DeleteKey deleteApiKey(@Nonnull
                              String key)
                       throws AlgoliaException

Delete an existing key

Parameters:

key - name of the key

Throws:

AlgoliaException

deleteApiKey

public DeleteKey deleteApiKey(@Nonnull
                              String key,
                              @Nonnull
                              RequestOptions requestOptions)
                       throws AlgoliaException

Delete an existing key

Parameters:

key - name of the key

requestOptions - Options to pass to this request

Throws:

AlgoliaException

addKey

@Deprecated
public CreateUpdateKey addKey(@Nonnull
                                          ApiKey key)
                                   throws AlgoliaException

Deprecated.

Deprecated: use addApiKey(ApiKey)

Throws:

AlgoliaException

addApiKey

public CreateUpdateKey addApiKey(@Nonnull
                                 ApiKey key)
                          throws AlgoliaException

Create a new key

Parameters:

key - the key with the ACLs

Returns:

the metadata of the key (such as it's name)

Throws:

AlgoliaException

addApiKey

public CreateUpdateKey addApiKey(@Nonnull
                                 ApiKey key,
                                 @Nonnull
                                 RequestOptions requestOptions)
                          throws AlgoliaException

Create a new key

Parameters:

key - the key with the ACLs

requestOptions - Options to pass to this request

Returns:

the metadata of the key (such as it's name)

Throws:

AlgoliaException

updateKey

@Deprecated
public CreateUpdateKey updateKey(@Nonnull
                                             String keyName,
                                             @Nonnull
                                             ApiKey key)
                                      throws AlgoliaException

Deprecated.

Deprecated: use updateApiKey(String, ApiKey)

Throws:

AlgoliaException

updateApiKey

public CreateUpdateKey updateApiKey(@Nonnull
                                    String keyName,
                                    @Nonnull
                                    ApiKey key)
                             throws AlgoliaException

Update a key

Parameters:

keyName - name of the key to update

key - the key with the ACLs

Returns:

the metadata of the key (such as it's name)

Throws:

AlgoliaException

updateApiKey

public CreateUpdateKey updateApiKey(@Nonnull
                                    String keyName,
                                    @Nonnull
                                    ApiKey key,
                                    @Nonnull
                                    RequestOptions requestOptions)
                             throws AlgoliaException

Update a key

Parameters:

keyName - name of the key to update

key - the key with the ACLs

requestOptions - Options to pass to this request

Returns:

the metadata of the key (such as it's name)

Throws:

AlgoliaException

generateSecuredApiKey

public String generateSecuredApiKey(@Nonnull
                                    String privateApiKey,
                                    @Nonnull
                                    Query query)
                             throws AlgoliaException

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:

AlgoliaException

generateSecuredApiKey

public String generateSecuredApiKey(@Nonnull
                                    String privateApiKey,
                                    @Nonnull
                                    Query query,
                                    String userToken)
                             throws AlgoliaException

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:

AlgoliaException

waitTask

public <T> void waitTask(@Nonnull
                         GenericTask<T> task)
                  throws AlgoliaException

Wait for the completion of this task

Parameters:

task - the task to wait

Throws:

AlgoliaException

waitTask

public <T> void waitTask(@Nonnull
                         GenericTask<T> task,
                         long timeToWait)
                  throws AlgoliaException

Wait for the completion of this task

Parameters:

task - the task to wait

timeToWait - the time to wait in milliseconds

Throws:

AlgoliaException

waitTask

public <T> void waitTask(@Nonnull
                         GenericTask<T> task,
                         long timeToWait,
                         @Nonnull
                         RequestOptions requestOptions)
                  throws AlgoliaException

Wait for the completion of this task

Parameters:

task - the task to wait

timeToWait - the time to wait in milliseconds

requestOptions - Options to pass to this request

Throws:

AlgoliaException

batch

public TasksMultipleIndex batch(@Nonnull
                                List<BatchOperation> operations)
                         throws AlgoliaException

Custom batch

All operations must have a valid index name (not null)

Parameters:

operations - the list of operations to perform

Returns:

the associated task

Throws:

AlgoliaException

batch

public TasksMultipleIndex batch(@Nonnull
                                List<BatchOperation> operations,
                                @Nonnull
                                RequestOptions requestOptions)
                         throws AlgoliaException

Custom batch

All operations must have a valid index name (not null)

Parameters:

operations - the list of operations to perform

requestOptions - Options to pass to this request

Returns:

the associated task

Throws:

AlgoliaException

multipleQueries

public MultiQueriesResult multipleQueries(@Nonnull
                                          List<IndexQuery> queries)
                                   throws AlgoliaException

Performs multiple searches on multiple indices with the strategy MultiQueriesStrategy.NONE

Parameters:

queries - the queries

Returns:

the result of the queries

Throws:

AlgoliaException

multipleQueries

public MultiQueriesResult multipleQueries(@Nonnull
                                          List<IndexQuery> queries,
                                          @Nonnull
                                          RequestOptions requestOptions)
                                   throws AlgoliaException

Performs multiple searches on multiple indices with the strategy MultiQueriesStrategy.NONE

Parameters:

queries - the queries

requestOptions - Options to pass to this request

Returns:

the result of the queries

Throws:

AlgoliaException

multipleQueries

public MultiQueriesResult multipleQueries(@Nonnull
                                          List<IndexQuery> queries,
                                          @Nonnull
                                          MultiQueriesStrategy strategy)
                                   throws AlgoliaException

Performs multiple searches on multiple indices

Parameters:

queries - the queries

strategy - the strategy to apply to this multiple queries

Returns:

the result of the queries

Throws:

AlgoliaException

multipleQueries

public MultiQueriesResult multipleQueries(@Nonnull
                                          List<IndexQuery> queries,
                                          @Nonnull
                                          MultiQueriesStrategy strategy,
                                          @Nonnull
                                          RequestOptions requestOptions)
                                   throws AlgoliaException

Performs multiple searches on multiple indices

Parameters:

queries - the queries

strategy - the strategy to apply to this multiple queries

requestOptions - Options to pass to this request

Returns:

the result of the queries

Throws:

AlgoliaException

browse

public <T> BrowseResult<T> browse(String indexName,
                                  Query query,
                                  String cursor,
                                  Class<T> klass,
                                  RequestOptions requestOptions)
                           throws AlgoliaException

Throws:

AlgoliaException

addABTest

public TaskABTest addABTest(ABTest abtest)
                     throws AlgoliaException

Throws:

AlgoliaException

stopABTest

public TaskABTest stopABTest(long id)
                      throws AlgoliaException

Throws:

AlgoliaException

deleteABTest

public TaskABTest deleteABTest(long id)
                        throws AlgoliaException

Throws:

AlgoliaException

getABTest

public ABTest getABTest(long id)
                 throws AlgoliaException

Throws:

AlgoliaException

getABTests

public ABTests getABTests(int offset,
                          int limit)
                   throws AlgoliaException

Throws:

AlgoliaException

listClusters

public List<Cluster> listClusters()
                           throws AlgoliaException

Throws:

AlgoliaException

listClusters

public List<Cluster> listClusters(@Nonnull
                                  RequestOptions requestOptions)
                           throws AlgoliaException

Throws:

AlgoliaException

listUserIDs

public UserIDs listUserIDs()
                    throws AlgoliaException

Throws:

AlgoliaException

listUserIDs

public UserIDs listUserIDs(Integer page,
                           Integer hitsPerPage)
                    throws AlgoliaException

Throws:

AlgoliaException

listUserIDs

public UserIDs listUserIDs(@Nonnull
                           Integer page,
                           @Nonnull
                           Integer hitsPerPage,
                           @Nonnull
                           RequestOptions requestOptions)
                    throws AlgoliaException

Throws:

AlgoliaException

getTopUserID

public Map<String,List<UserID>> getTopUserID()
                                      throws AlgoliaException

Throws:

AlgoliaException

getTopUserID

public Map<String,List<UserID>> getTopUserID(RequestOptions requestOptions)
                                      throws AlgoliaException

Throws:

AlgoliaException

assignUserID

public AssignUserID assignUserID(@Nonnull
                                 String userID,
                                 @Nonnull
                                 String clusterName)
                          throws AlgoliaException

Throws:

AlgoliaException

assignUserID

public AssignUserID assignUserID(@Nonnull
                                 String userID,
                                 @Nonnull
                                 String clusterName,
                                 RequestOptions requestOptions)
                          throws AlgoliaException

Throws:

AlgoliaException

getUserID

public UserID getUserID(@Nonnull
                        String userID)
                 throws AlgoliaException

Throws:

AlgoliaException

getUserID

public UserID getUserID(@Nonnull
                        String userID,
                        RequestOptions requestOptions)
                 throws AlgoliaException

Throws:

AlgoliaException

removeUserID

public DeleteUserID removeUserID(@Nonnull
                                 String userID)
                          throws AlgoliaException

Throws:

AlgoliaException

removeUserID

public DeleteUserID removeUserID(@Nonnull
                                 String userID,
                                 RequestOptions requestOptions)
                          throws AlgoliaException

Throws:

AlgoliaException

searchUserIDs

public SearchUserIDs searchUserIDs(@Nonnull
                                   String query,
                                   @Nonnull
                                   String clusterName)
                            throws AlgoliaException

Throws:

AlgoliaException

searchUserIDs

public SearchUserIDs searchUserIDs(@Nonnull
                                   String query,
                                   @Nonnull
                                   String clusterName,
                                   RequestOptions requestOptions)
                            throws AlgoliaException

Throws:

AlgoliaException

searchUserIDs

public SearchUserIDs searchUserIDs(@Nonnull
                                   String query,
                                   @Nonnull
                                   String clusterName,
                                   int page,
                                   int hitsPerPage)
                            throws AlgoliaException

Throws:

AlgoliaException

searchUserIDs

public SearchUserIDs searchUserIDs(@Nonnull
                                   String query,
                                   @Nonnull
                                   String clusterName,
                                   int page,
                                   int hitsPerPage,
                                   RequestOptions requestOptions)
                            throws AlgoliaException

Throws:

AlgoliaException