Package com.algolia.search

Class AsyncAPIClient

java.lang.Object

com.algolia.search.AsyncAPIClient

public class AsyncAPIClient
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected AsyncAPIClientConfiguration	configuration
protected Executor	executor
protected AsyncAlgoliaHttpClient	httpClient	Constructor & protected stuff

Method Summary

Modifier and Type	Method	Description
CompletableFuture<CreateUpdateKey>	addApiKey(ApiKey key)	Create a new key
CompletableFuture<CreateUpdateKey>	addApiKey(ApiKey key, RequestOptions requestOptions)	Create a new key
CompletableFuture<CreateUpdateKey>	addKey(ApiKey key)	Deprecated.
CompletableFuture<AsyncTasksMultipleIndex>	batch(List<BatchOperation> operations)	Custom batch
CompletableFuture<AsyncTasksMultipleIndex>	batch(List<BatchOperation> operations, RequestOptions requestOptions)	Custom batch
void	close()	Close the internal HTTP client
CompletableFuture<AsyncTask>	copyIndex(String srcIndexName, String dstIndexName)	Copy an existing index
CompletableFuture<AsyncTask>	copyIndex(String srcIndexName, String dstIndexName, RequestOptions requestOptions)	Copy an existing index
CompletableFuture<AsyncTask>	copyIndex(String srcIndexName, String dstIndexName, List<String> scope)	Copy an existing index
CompletableFuture<AsyncTask>	copyIndex(String srcIndexName, String dstIndexName, List<String> scope, RequestOptions requestOptions)	Copy an existing index
CompletableFuture<DeleteKey>	deleteApiKey(String key)	Delete an existing key
CompletableFuture<DeleteKey>	deleteApiKey(String key, RequestOptions requestOptions)	Delete an existing key
CompletableFuture<AsyncTask>	deleteIndex(String indexName)	Delete an existing index
CompletableFuture<AsyncTask>	deleteIndex(String indexName, RequestOptions requestOptions)	Delete an existing index
CompletableFuture<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
CompletableFuture<Optional<ApiKey>>	getApiKey(String key)	Get an Key from it's name
CompletableFuture<Optional<ApiKey>>	getApiKey(String key, RequestOptions requestOptions)	Get an Key from it's name
CompletableFuture<Optional<ApiKey>>	getKey(String key)	Deprecated.
CompletableFuture<List<Log>>	getLogs()	Return 10 last log entries.
CompletableFuture<List<Log>>	getLogs(RequestOptions requestOptions)	Return 10 last log entries.
CompletableFuture<List<Log>>	getLogs(Integer offset, Integer length, LogType logType)	Return last logs entries
CompletableFuture<List<Log>>	getLogs(Integer offset, Integer length, LogType logType, RequestOptions requestOptions)	Return last logs entries
AsyncIndex<?>	initIndex(String name)	Get the index object initialized (no server call needed for initialization)
<T> AsyncIndex<T>	initIndex(String name, Class<T> klass)	Get the index object initialized (no server call needed for initialization)
CompletableFuture<List<ApiKey>>	listApiKeys()	List all existing user keys with their associated ACLs
CompletableFuture<List<ApiKey>>	listApiKeys(RequestOptions requestOptions)	List all existing user keys with their associated ACLs
CompletableFuture<List<Index.Attributes>>	listIndices()	List all existing indexes
CompletableFuture<List<Index.Attributes>>	listIndices(RequestOptions requestOptions)	List all existing indexes
CompletableFuture<List<ApiKey>>	listKeys()	Deprecated.
CompletableFuture<AsyncTask>	moveIndex(String srcIndexName, String dstIndexName)	Moves an existing index
CompletableFuture<AsyncTask>	moveIndex(String srcIndexName, String dstIndexName, RequestOptions requestOptions)	Moves an existing index
CompletableFuture<MultiQueriesResult>	multipleQueries(List<IndexQuery> queries)	Performs multiple searches on multiple indices with the strategy MultiQueriesStrategy.NONE
CompletableFuture<MultiQueriesResult>	multipleQueries(List<IndexQuery> queries, MultiQueriesStrategy strategy)	Performs multiple searches on multiple indices
CompletableFuture<MultiQueriesResult>	multipleQueries(List<IndexQuery> queries, MultiQueriesStrategy strategy, RequestOptions requestOptions)	Performs multiple searches on multiple indices
CompletableFuture<MultiQueriesResult>	multipleQueries(List<IndexQuery> queries, RequestOptions requestOptions)	Performs multiple searches on multiple indices with the strategy MultiQueriesStrategy.NONE
CompletableFuture<CreateUpdateKey>	updateApiKey(String keyName, ApiKey key)	Update a key
CompletableFuture<CreateUpdateKey>	updateApiKey(String keyName, ApiKey key, RequestOptions requestOptions)	Update a key
CompletableFuture<CreateUpdateKey>	updateKey(String keyName, ApiKey key)	Deprecated.
<T> void	waitTask(AsyncGenericTask<T> task)	Wait for the completion of this task /!\ WARNING /!\ This method is blocking
<T> void	waitTask(AsyncGenericTask<T> task, long timeToWait)	Wait for the completion of this task /!\ WARNING /!\ This method is blocking
<T> void	waitTask(AsyncGenericTask<T> task, long timeToWait, RequestOptions requestOptions)	Wait for the completion of this task /!\ WARNING /!\ This method is blocking

Methods inherited from class java.lang.Object

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

Field Detail

httpClient

protected final AsyncAlgoliaHttpClient httpClient

Constructor & protected stuff

configuration

protected final AsyncAPIClientConfiguration configuration

executor

protected final Executor executor

Method Detail

close

public void close()
           throws AlgoliaException

Close the internal HTTP client

Throws:

AlgoliaException

listIndices

public CompletableFuture<List<Index.Attributes>> listIndices()

List all existing indexes

Returns:

A List of the indices and their metadata

listIndices

public CompletableFuture<List<Index.Attributes>> listIndices(@Nonnull
                                                             RequestOptions requestOptions)

List all existing indexes

Parameters:

requestOptions - Options to pass to this request

Returns:

A List of the indices and their metadata

initIndex

public <T> AsyncIndex<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 AsyncIndex<?> 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

moveIndex

public CompletableFuture<AsyncTask> moveIndex(@Nonnull
                                              String srcIndexName,
                                              @Nonnull
                                              String dstIndexName)

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

moveIndex

public CompletableFuture<AsyncTask> moveIndex(@Nonnull
                                              String srcIndexName,
                                              @Nonnull
                                              String dstIndexName,
                                              @Nonnull
                                              RequestOptions requestOptions)

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

copyIndex

public CompletableFuture<AsyncTask> copyIndex(@Nonnull
                                              String srcIndexName,
                                              @Nonnull
                                              String dstIndexName)

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

copyIndex

public CompletableFuture<AsyncTask> copyIndex(@Nonnull
                                              String srcIndexName,
                                              @Nonnull
                                              String dstIndexName,
                                              @Nonnull
                                              RequestOptions requestOptions)

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

copyIndex

public CompletableFuture<AsyncTask> copyIndex(@Nonnull
                                              String srcIndexName,
                                              @Nonnull
                                              String dstIndexName,
                                              List<String> scope,
                                              @Nonnull
                                              RequestOptions requestOptions)

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

copyIndex

public CompletableFuture<AsyncTask> copyIndex(@Nonnull
                                              String srcIndexName,
                                              @Nonnull
                                              String dstIndexName,
                                              @Nonnull
                                              List<String> scope)

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

getLogs

public CompletableFuture<List<Log>> getLogs()

Return 10 last log entries.

Returns:

A List

getLogs

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

Return 10 last log entries.

Parameters:

requestOptions - Options to pass to this request

Returns:

A List

getLogs

public CompletableFuture<List<Log>> getLogs(@Nonnull
                                            Integer offset,
                                            @Nonnull
                                            Integer length,
                                            @Nonnull
                                            LogType logType)

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

getLogs

public CompletableFuture<List<Log>> getLogs(@Nonnull
                                            Integer offset,
                                            @Nonnull
                                            Integer length,
                                            @Nonnull
                                            LogType logType,
                                            @Nonnull
                                            RequestOptions requestOptions)

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

listKeys

@Deprecated
public CompletableFuture<List<ApiKey>> listKeys()

Deprecated.

Deprecated: use listApiKeys()

listApiKeys

public CompletableFuture<List<ApiKey>> listApiKeys()

List all existing user keys with their associated ACLs

Returns:

A List of Keys

listApiKeys

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

List all existing user keys with their associated ACLs

Parameters:

requestOptions - Options to pass to this request

Returns:

A List of Keys

getKey

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

Deprecated.

Deprecated: use getApiKey(String)

getApiKey

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

Get an Key from it's name

Parameters:

key - name of the key

Returns:

the key

getApiKey

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

Get an Key from it's name

Parameters:

key - name of the key

requestOptions - Options to pass to this request

Returns:

the key

deleteKey

@Deprecated
public CompletableFuture<DeleteKey> deleteKey(@Nonnull
                                              String key)

Deprecated.

Deprecated: use deleteApiKey(String)

deleteApiKey

public CompletableFuture<DeleteKey> deleteApiKey(@Nonnull
                                                 String key)

Delete an existing key

Parameters:

key - name of the key

deleteApiKey

public CompletableFuture<DeleteKey> deleteApiKey(@Nonnull
                                                 String key,
                                                 @Nonnull
                                                 RequestOptions requestOptions)

Delete an existing key

Parameters:

key - name of the key

requestOptions - Options to pass to this request

addKey

@Deprecated
public CompletableFuture<CreateUpdateKey> addKey(@Nonnull
                                                 ApiKey key)

Deprecated.

Deprecated: use addApiKey(ApiKey)

addApiKey

public CompletableFuture<CreateUpdateKey> addApiKey(@Nonnull
                                                    ApiKey key)

Create a new key

Parameters:

key - the key with the ACLs

Returns:

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

addApiKey

public CompletableFuture<CreateUpdateKey> addApiKey(@Nonnull
                                                    ApiKey key,
                                                    @Nonnull
                                                    RequestOptions requestOptions)

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)

updateKey

@Deprecated
public CompletableFuture<CreateUpdateKey> updateKey(@Nonnull
                                                    String keyName,
                                                    @Nonnull
                                                    ApiKey key)

Deprecated.

Deprecated: use updateApiKey(String, ApiKey)

updateApiKey

public CompletableFuture<CreateUpdateKey> updateApiKey(@Nonnull
                                                       String keyName,
                                                       @Nonnull
                                                       ApiKey key)

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)

updateApiKey

public CompletableFuture<CreateUpdateKey> updateApiKey(@Nonnull
                                                       String keyName,
                                                       @Nonnull
                                                       ApiKey key,
                                                       @Nonnull
                                                       RequestOptions requestOptions)

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)

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
                         AsyncGenericTask<T> task)

Wait for the completion of this task /!\ WARNING /!\ This method is blocking

Parameters:

task - the task to wait

waitTask

public <T> void waitTask(@Nonnull
                         AsyncGenericTask<T> task,
                         long timeToWait)

Wait for the completion of this task /!\ WARNING /!\ This method is blocking

Parameters:

task - the task to wait

timeToWait - the time to wait in milliseconds

waitTask

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

Wait for the completion of this task /!\ WARNING /!\ This method is blocking

Parameters:

task - the task to wait

timeToWait - the time to wait in milliseconds

requestOptions - Options to pass to this request

batch

public CompletableFuture<AsyncTasksMultipleIndex> batch(@Nonnull
                                                        List<BatchOperation> operations)

Custom batch

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

Parameters:

operations - the list of operations to perform

Returns:

the associated task

batch

public CompletableFuture<AsyncTasksMultipleIndex> batch(@Nonnull
                                                        List<BatchOperation> operations,
                                                        @Nonnull
                                                        RequestOptions requestOptions)

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

multipleQueries

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

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

Parameters:

queries - the queries

Returns:

the result of the queries

multipleQueries

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

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

multipleQueries

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

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

multipleQueries

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

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

deleteIndex

public CompletableFuture<AsyncTask> deleteIndex(@Nonnull
                                                String indexName)

Delete an existing index

Parameters:

indexName - The index name that will be deleted

Returns:

The associated task

deleteIndex

public CompletableFuture<AsyncTask> deleteIndex(@Nonnull
                                                String indexName,
                                                @Nonnull
                                                RequestOptions requestOptions)

Delete an existing index

Parameters:

indexName - The index name that will be deleted

requestOptions - Options to pass to this request

Returns:

The associated task