Package com.algolia.search

Interface AsyncKey<T>

All Superinterfaces:

AbstractIndex<T>, AsyncBaseIndex<T>, Serializable

All Known Implementing Classes:

AsyncIndex

public interface AsyncKey<T>
extends AsyncBaseIndex<T>

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<CreateUpdateKey>	addApiKey(ApiKey key)	Add a key to this index
default CompletableFuture<CreateUpdateKey>	addApiKey(ApiKey key, RequestOptions requestOptions)	Add a key to this index
default CompletableFuture<CreateUpdateKey>	addKey(ApiKey key)	Deprecated.
default CompletableFuture<DeleteKey>	deleteApiKey(String key)	Delete a key by name from this index
default CompletableFuture<DeleteKey>	deleteApiKey(String key, RequestOptions requestOptions)	Delete a key by name from this index
default CompletableFuture<DeleteKey>	deleteKey(String key)	Deprecated.
default CompletableFuture<Optional<ApiKey>>	getApiKey(String key)	Get a key by name from this index
default CompletableFuture<Optional<ApiKey>>	getApiKey(String key, RequestOptions requestOptions)	Get a key by name from this index
default CompletableFuture<Optional<ApiKey>>	getKey(String key)	Deprecated.
default CompletableFuture<List<ApiKey>>	listApiKeys()	List keys of this index
default CompletableFuture<List<ApiKey>>	listApiKeys(RequestOptions requestOptions)	List keys of this index
default CompletableFuture<List<ApiKey>>	listKeys()	Deprecated.
default CompletableFuture<CreateUpdateKey>	updateApiKey(String keyName, ApiKey key)	Update a key by name from this index
default CompletableFuture<CreateUpdateKey>	updateApiKey(String keyName, ApiKey key, RequestOptions requestOptions)	Update a key by name from this index
default CompletableFuture<CreateUpdateKey>	updateKey(String keyName, ApiKey key)	Deprecated.

Methods inherited from interface com.algolia.search.AbstractIndex

getKlass, getName

Methods inherited from interface com.algolia.search.AsyncBaseIndex

getApiClient

Method Detail

listKeys

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

Deprecated.

Deprecated: use listApiKeys()

listApiKeys

default CompletableFuture<List<ApiKey>> listApiKeys()

List keys of this index

Returns:

the list of keys

listApiKeys

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

List keys of this index

Parameters:

requestOptions - Options to pass to this request

Returns:

the list of keys

getKey

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

Deprecated.

Deprecated: use getApiKey(String)

getApiKey

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

Get a key by name from this index

Parameters:

key - the key name

Returns:

the key

getApiKey

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

Get a key by name from this index

Parameters:

key - the key name

requestOptions - Options to pass to this request

Returns:

the key

deleteKey

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

Deprecated.

Deprecated: use deleteApiKey(String)

deleteApiKey

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

Delete a key by name from this index

Parameters:

key - the key name

Returns:

the deleted key

deleteApiKey

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

Delete a key by name from this index

Parameters:

key - the key name

requestOptions - Options to pass to this request

Returns:

the deleted key

addKey

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

Deprecated.

Deprecated: use addApiKey(ApiKey)

addApiKey

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

Add a key to this index

Parameters:

key - the key

Returns:

the created key

addApiKey

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

Add a key to this index

Parameters:

key - the key

requestOptions - Options to pass to this request

Returns:

the created key

updateKey

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

Deprecated.

Deprecated: use updateApiKey(String, ApiKey)

updateApiKey

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

Update a key by name from this index

Parameters:

keyName - the key name

key - the key to update

Returns:

the updated key

updateApiKey

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

Update a key by name from this index

Parameters:

keyName - the key name

key - the key to update

requestOptions - Options to pass to this request

Returns:

the updated key