public interface SearchClientAPIKeys extends SearchClientBase
| Modifier and Type | Method and Description |
|---|---|
default AddApiKeyResponse |
addApiKey(ApiKey acl)
Add a new API Key with specific permissions/restrictions
|
default AddApiKeyResponse |
addApiKey(ApiKey acl,
RequestOptions requestOptions)
Add a new API Key with specific permissions/restrictions
|
default CompletableFuture<AddApiKeyResponse> |
addApiKeyAsync(ApiKey acl)
Add a new API Key with specific permissions/restrictions
|
default CompletableFuture<AddApiKeyResponse> |
addApiKeyAsync(ApiKey acl,
RequestOptions requestOptions)
Add a new API Key with specific permissions/restrictions
|
default DeleteApiKeyResponse |
deleteApiKey(String apiKey)
Delete an existing API Key
|
default DeleteApiKeyResponse |
deleteApiKey(String apiKey,
RequestOptions requestOptions)
Delete an existing API Key
|
default CompletableFuture<DeleteApiKeyResponse> |
deleteApiKeyAsync(String apiKey)
Delete an existing API Key
|
default CompletableFuture<DeleteApiKeyResponse> |
deleteApiKeyAsync(String apiKey,
RequestOptions requestOptions)
Delete an existing API Key
|
default String |
generateSecuredAPIKey(String parentAPIKey,
SecuredApiKeyRestriction restriction)
Generate a virtual API Key without any call to the server.
|
default ApiKey |
getApiKey(String apiKey)
Get the permissions of an API Key.
|
default ApiKey |
getApiKey(String apiKey,
RequestOptions requestOptions)
Get the permissions of an API Key.
|
default CompletableFuture<ApiKey> |
getApiKeyAsync(String apiKey)
Get the permissions of an API Key.
|
default CompletableFuture<ApiKey> |
getApiKeyAsync(String apiKey,
RequestOptions requestOptions)
Get the permissions of an API Key.
|
default List<ApiKey> |
listApiKeys()
List all existing user keys with their associated ACLs
|
default List<ApiKey> |
listApiKeys(RequestOptions requestOptions)
List all existing user keys with their associated ACLs
|
default CompletableFuture<List<ApiKey>> |
listApiKeysAsync()
List asynchronously all existing user keys with their associated ACLs
|
default CompletableFuture<List<ApiKey>> |
listApiKeysAsync(RequestOptions requestOptions)
List asynchronously all existing user keys with their associated ACLs
|
default RestoreApiKeyResponse |
restoreApiKey(String apiKey)
Restore the given API Key
|
default RestoreApiKeyResponse |
restoreApiKey(String apiKey,
RequestOptions requestOptions)
Restore the given API Key
|
default CompletableFuture<RestoreApiKeyResponse> |
restoreApiKeyAsync(String apiKey)
Restore the given API Key
|
default CompletableFuture<RestoreApiKeyResponse> |
restoreApiKeyAsync(String apiKey,
RequestOptions requestOptions)
Restore the given API Key
|
default UpdateApiKeyResponse |
updateApiKey(ApiKey request)
Update the permissions of an existing API Key.
|
default UpdateApiKeyResponse |
updateApiKey(ApiKey request,
RequestOptions requestOptions)
Update the permissions of an existing API Key.
|
default CompletableFuture<UpdateApiKeyResponse> |
updateApiKeyAsync(ApiKey request)
Update the permissions of an existing API Key.
|
default CompletableFuture<UpdateApiKeyResponse> |
updateApiKeyAsync(ApiKey request,
RequestOptions requestOptions)
Update the permissions of an existing API Key.
|
getConfig, getTransport, waitTask, waitTaskdefault List<ApiKey> listApiKeys()
AlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationdefault List<ApiKey> listApiKeys(RequestOptions requestOptions)
requestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationdefault CompletableFuture<List<ApiKey>> listApiKeysAsync()
AlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationdefault CompletableFuture<List<ApiKey>> listApiKeysAsync(RequestOptions requestOptions)
requestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationdefault ApiKey getApiKey(@Nonnull String apiKey)
apiKey - The API key to retrieveAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationdefault ApiKey getApiKey(@Nonnull String apiKey, RequestOptions requestOptions)
apiKey - The API key to retrieverequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationdefault CompletableFuture<ApiKey> getApiKeyAsync(@Nonnull String apiKey)
apiKey - The API key to retrieveAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationdefault CompletableFuture<ApiKey> getApiKeyAsync(@Nonnull String apiKey, RequestOptions requestOptions)
apiKey - The API key to retrieverequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationdefault AddApiKeyResponse addApiKey(@Nonnull ApiKey acl)
acl - The api with the restrictions/permissions to addAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationdefault AddApiKeyResponse addApiKey(@Nonnull ApiKey acl, RequestOptions requestOptions)
acl - The api with the restrictions/permissions to addrequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationdefault CompletableFuture<AddApiKeyResponse> addApiKeyAsync(@Nonnull ApiKey acl)
acl - The api with the restrictions/permissions to addAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationdefault CompletableFuture<AddApiKeyResponse> addApiKeyAsync(@Nonnull ApiKey acl, RequestOptions requestOptions)
acl - The api with the restrictions/permissions to addrequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationdefault DeleteApiKeyResponse deleteApiKey(@Nonnull String apiKey)
apiKey - The API Key to deleteAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationdefault DeleteApiKeyResponse deleteApiKey(@Nonnull String apiKey, RequestOptions requestOptions)
apiKey - The API Key to deleterequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationdefault CompletableFuture<DeleteApiKeyResponse> deleteApiKeyAsync(@Nonnull String apiKey)
apiKey - The API Key to deleteAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationdefault CompletableFuture<DeleteApiKeyResponse> deleteApiKeyAsync(@Nonnull String apiKey, RequestOptions requestOptions)
apiKey - The API Key to deleterequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationdefault UpdateApiKeyResponse updateApiKey(@Nonnull ApiKey request)
request - The API key to updateAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationdefault UpdateApiKeyResponse updateApiKey(@Nonnull ApiKey request, RequestOptions requestOptions)
request - The API key to updaterequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationdefault CompletableFuture<UpdateApiKeyResponse> updateApiKeyAsync(@Nonnull ApiKey request)
request - The API key to updateAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationdefault CompletableFuture<UpdateApiKeyResponse> updateApiKeyAsync(@Nonnull ApiKey request, RequestOptions requestOptions)
request - The API key to updaterequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationdefault RestoreApiKeyResponse restoreApiKey(@Nonnull String apiKey)
apiKey - The given API KeyAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serialization or
deserializationdefault RestoreApiKeyResponse restoreApiKey(@Nonnull String apiKey, RequestOptions requestOptions)
apiKey - The given API KeyrequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationdefault CompletableFuture<RestoreApiKeyResponse> restoreApiKeyAsync(@Nonnull String apiKey)
apiKey - The given API KeyAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serialization or
deserializationdefault CompletableFuture<RestoreApiKeyResponse> restoreApiKeyAsync(@Nonnull String apiKey, RequestOptions requestOptions)
apiKey - The given API KeyrequestOptions - Options to pass to this requestAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationdefault String generateSecuredAPIKey(@Nonnull String parentAPIKey, SecuredApiKeyRestriction restriction) throws Exception
parentAPIKey - API key to generate from.restriction - Restriction to add the keyException - if an error occurs during the encodingAlgoliaRetryException - When the retry has failed on all hostsAlgoliaApiException - When the API sends an http error codeAlgoliaRuntimeException - When an error occurred during the serializationCopyright © 2019. All rights reserved.