Package com.algolia.search

Interface SyncKey<T>

All Superinterfaces:

AbstractIndex<T>, Serializable, SyncBaseIndex<T>

All Known Implementing Classes:

Index

public interface SyncKey<T>
extends SyncBaseIndex<T>

Method Summary

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

Methods inherited from interface com.algolia.search.AbstractIndex

getKlass, getName

Methods inherited from interface com.algolia.search.SyncBaseIndex

getApiClient

Method Detail

listKeys

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

Deprecated.

Deprecated: use listApiKeys()

Throws:

AlgoliaException

listApiKeys

default List<ApiKey> listApiKeys()
                          throws AlgoliaException

List keys of this index

Returns:

the list of keys

Throws:

AlgoliaException

listApiKeys

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

List keys of this index

Parameters:

requestOptions - Options to pass to this request

Returns:

the list of keys

Throws:

AlgoliaException

getKey

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

Deprecated.

Deprecated: use getApiKey(String)

Throws:

AlgoliaException

getApiKey

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

Get a key by name from this index

Parameters:

key - the key name

Returns:

the key

Throws:

AlgoliaException

getApiKey

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

Get a key by name from this index

Parameters:

key - the key name

requestOptions - Options to pass to this request

Returns:

the key

Throws:

AlgoliaException

deleteKey

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

Deprecated.

Deprecated: use deleteApiKey(String)

Throws:

AlgoliaException

deleteApiKey

default DeleteKey deleteApiKey(@Nonnull
                               String key)
                        throws AlgoliaException

Delete a key by name from this index

Parameters:

key - the key name

Returns:

the deleted key

Throws:

AlgoliaException

deleteApiKey

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

Delete a key by name from this index

Parameters:

key - the key name

requestOptions - Options to pass to this request

Returns:

the deleted key

Throws:

AlgoliaException

addKey

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

Deprecated.

Deprecated: use addApiKey(ApiKey)

Throws:

AlgoliaException

addApiKey

default CreateUpdateKey addApiKey(@Nonnull
                                  ApiKey key)
                           throws AlgoliaException

Add a key to this index

Parameters:

key - the key

Returns:

the created key

Throws:

AlgoliaException

addApiKey

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

Add a key to this index

Parameters:

key - the key

requestOptions - Options to pass to this request

Returns:

the created key

Throws:

AlgoliaException

updateKey

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

Deprecated.

Deprecated: use updateApiKey(String, ApiKey)

Throws:

AlgoliaException

updateApiKey

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

Update a key by name from this index

Parameters:

keyName - the key name

key - the key to update

Returns:

the updated key

Throws:

AlgoliaException

updateKey

@Deprecated
default CreateUpdateKey updateKey(@Nonnull
                                  String keyName,
                                  @Nonnull
                                  ApiKey key,
                                  @Nonnull
                                  RequestOptions requestOptions)
                           throws AlgoliaException

Deprecated.

Deprecated: use updateApiKey(String, ApiKey, RequestOptions)

Throws:

AlgoliaException

updateApiKey

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

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

Throws:

AlgoliaException