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
CreateUpdateKey	addKey(ApiKey key) Create a new key
TasksMultipleIndex	batch(List<BatchOperation> operations) Custom batch
DeleteKey	deleteKey(String key) Delete an existing key
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
Optional<ApiKey>	getKey(String key) Get an Key from it's name
List<Log>	getLogs() Return 10 last log entries.
List<Log>	getLogs(Integer offset, Integer length, LogType logType) Return last logs entries
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<Index.Attributes>	listIndices() List all existing indexes
List<ApiKey>	listKeys() List all existing user keys with their associated ACLs
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
CreateUpdateKey	updateKey(String keyName, ApiKey key) Update a key
<T> void	waitTask(GenericTask<T> task, long timeToWait)

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

listIndices

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

List all existing indexes

Returns:

A List of the indices and their metadata

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

getLogs

public List<Log> getLogs()
                  throws AlgoliaException

Return 10 last log entries.

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

listKeys

public List<ApiKey> listKeys()
                      throws AlgoliaException

List all existing user keys with their associated ACLs

Returns:

A List of Keys

Throws:

AlgoliaException

getKey

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

Get an Key from it's name

Parameters:

key - name of the key

Returns:

the key

Throws:

AlgoliaException

deleteKey

public DeleteKey deleteKey(@Nonnull
                           String key)
                    throws AlgoliaException

Delete an existing key

Parameters:

key - name of the key

Throws:

AlgoliaException

addKey

public CreateUpdateKey addKey(@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

updateKey

public CreateUpdateKey updateKey(@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

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,
                         long timeToWait)
                  throws AlgoliaException

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

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
                                          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