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 and Description
default CreateUpdateKey	addApiKey(ApiKey key) Deprecated.
default CreateUpdateKey	addApiKey(ApiKey key, RequestOptions requestOptions) Deprecated.
default CreateUpdateKey	addKey(ApiKey key) Deprecated.
default DeleteKey	deleteApiKey(String key) Deprecated.
default DeleteKey	deleteApiKey(String key, RequestOptions requestOptions) Deprecated.
default DeleteKey	deleteKey(String key) Deprecated.
default Optional<ApiKey>	getApiKey(String key) Deprecated.
default Optional<ApiKey>	getApiKey(String key, RequestOptions requestOptions) Deprecated.
default Optional<ApiKey>	getKey(String key) Deprecated.
default List<ApiKey>	listApiKeys() Deprecated.
default List<ApiKey>	listApiKeys(RequestOptions requestOptions) Deprecated.
default List<ApiKey>	listKeys() Deprecated.
default CreateUpdateKey	updateApiKey(String keyName, ApiKey key) Deprecated.
default CreateUpdateKey	updateApiKey(String keyName, ApiKey key, RequestOptions requestOptions) Deprecated.
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.SyncBaseIndex

getApiClient

Methods inherited from interface com.algolia.search.AbstractIndex

getKlass, getName

Method Detail

listKeys

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

Deprecated.

Deprecated: use APIClient.listApiKeys()

Throws:

AlgoliaException

listApiKeys

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

Deprecated.

Deprecated: use APIClient.listApiKeys()

Throws:

AlgoliaException

listApiKeys

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

Deprecated.

Deprecated: use APIClient.listApiKeys(RequestOptions)

Throws:

AlgoliaException

getKey

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

Deprecated.

Deprecated: use APIClient.getApiKey(String)

Throws:

AlgoliaException

getApiKey

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

Deprecated.

Deprecated: use APIClient.getApiKey(String)

Throws:

AlgoliaException

getApiKey

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

Deprecated.

Deprecated: use APIClient.getApiKey(String, RequestOptions)

Throws:

AlgoliaException

deleteKey

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

Deprecated.

Deprecated: use APIClient.deleteApiKey(String)

Throws:

AlgoliaException

deleteApiKey

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

Deprecated.

Deprecated: use APIClient.deleteApiKey(String)

Throws:

AlgoliaException

deleteApiKey

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

Deprecated.

Deprecated: use APIClient.deleteApiKey(String, RequestOptions)

Throws:

AlgoliaException

addKey

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

Deprecated.

Deprecated: use APIClient.addApiKey(ApiKey)

Throws:

AlgoliaException

addApiKey

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

Deprecated.

Deprecated: use APIClient.addApiKey(ApiKey)

Throws:

AlgoliaException

addApiKey

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

Deprecated.

Deprecated: use APIClient.addApiKey(ApiKey, RequestOptions)

Throws:

AlgoliaException

updateKey

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

Deprecated.

Deprecated: use APIClient.updateApiKey(String, ApiKey)

Throws:

AlgoliaException

updateApiKey

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

Deprecated.

Deprecated: use APIClient.updateApiKey(String, ApiKey)

Throws:

AlgoliaException

updateKey

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

Deprecated.

Deprecated: use APIClient.updateApiKey(String, ApiKey, RequestOptions)

Throws:

AlgoliaException

updateApiKey

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

Deprecated.

Deprecated: use APIClient.updateApiKey(String, ApiKey, RequestOptions)

Throws:

AlgoliaException