Uses of Class
com.algolia.search.models.apikeys.ApiKey

Packages that use ApiKey

Package	Description
com.algolia.search
com.algolia.search.models.apikeys

Uses of ApiKey in com.algolia.search

Methods in com.algolia.search that return ApiKey

Modifier and Type	Method	Description
default ApiKey	SearchClientAPIKeys.getApiKey(String apiKey)	Get the permissions of an API Key.
default ApiKey	SearchClientAPIKeys.getApiKey(String apiKey, RequestOptions requestOptions)	Get the permissions of an API Key.

Methods in com.algolia.search that return types with arguments of type ApiKey

Modifier and Type	Method	Description
default CompletableFuture<ApiKey>	SearchClientAPIKeys.getApiKeyAsync(String apiKey)	Get the permissions of an API Key.
default CompletableFuture<ApiKey>	SearchClientAPIKeys.getApiKeyAsync(String apiKey, RequestOptions requestOptions)	Get the permissions of an API Key.
default List<ApiKey>	SearchClientAPIKeys.listApiKeys()	List all existing user keys with their associated ACLs
default List<ApiKey>	SearchClientAPIKeys.listApiKeys(RequestOptions requestOptions)	List all existing user keys with their associated ACLs
default CompletableFuture<List<ApiKey>>	SearchClientAPIKeys.listApiKeysAsync()	List asynchronously all existing user keys with their associated ACLs
default CompletableFuture<List<ApiKey>>	SearchClientAPIKeys.listApiKeysAsync(RequestOptions requestOptions)	List asynchronously all existing user keys with their associated ACLs

Methods in com.algolia.search with parameters of type ApiKey

Modifier and Type	Method	Description
default AddApiKeyResponse	SearchClientAPIKeys.addApiKey(ApiKey acl)	Add a new API Key with specific permissions/restrictions
default AddApiKeyResponse	SearchClientAPIKeys.addApiKey(ApiKey acl, RequestOptions requestOptions)	Add a new API Key with specific permissions/restrictions
default CompletableFuture<AddApiKeyResponse>	SearchClientAPIKeys.addApiKeyAsync(ApiKey acl)	Add a new API Key with specific permissions/restrictions
default CompletableFuture<AddApiKeyResponse>	SearchClientAPIKeys.addApiKeyAsync(ApiKey acl, RequestOptions requestOptions)	Add a new API Key with specific permissions/restrictions
default UpdateApiKeyResponse	SearchClientAPIKeys.updateApiKey(ApiKey request)	Update the permissions of an existing API Key.
default UpdateApiKeyResponse	SearchClientAPIKeys.updateApiKey(ApiKey request, RequestOptions requestOptions)	Update the permissions of an existing API Key.
default CompletableFuture<UpdateApiKeyResponse>	SearchClientAPIKeys.updateApiKeyAsync(ApiKey request)	Update the permissions of an existing API Key.
default CompletableFuture<UpdateApiKeyResponse>	SearchClientAPIKeys.updateApiKeyAsync(ApiKey request, RequestOptions requestOptions)	Update the permissions of an existing API Key.

Uses of ApiKey in com.algolia.search.models.apikeys

Methods in com.algolia.search.models.apikeys that return ApiKey

Modifier and Type	Method	Description
ApiKey	UpdateApiKeyResponse.getPendingKey()
ApiKey	ApiKey.setAcl(List<String> acl)
ApiKey	ApiKey.setDescription(String description)
ApiKey	ApiKey.setIndexes(List<String> indexes)
ApiKey	ApiKey.setMaxHitsPerQuery(Integer maxHitsPerQuery)
ApiKey	ApiKey.setMaxHitsPerQuery(Long maxHitsPerQuery)
ApiKey	ApiKey.setMaxQueriesPerIPPerHour(Integer maxQueriesPerIPPerHour)
ApiKey	ApiKey.setQueryParameters(String queryParameters)
ApiKey	ApiKey.setReferers(List<String> referers)
ApiKey	ApiKey.setValidity(Long validity)

Methods in com.algolia.search.models.apikeys that return types with arguments of type ApiKey

Modifier and Type	Method	Description
Function<String,ApiKey>	UpdateApiKeyResponse.getGetApiKeyFunction()
List<ApiKey>	ApiKeys.getKeys()

Methods in com.algolia.search.models.apikeys with parameters of type ApiKey

Modifier and Type	Method	Description
void	UpdateApiKeyResponse.setPendingKey(ApiKey pendingKey)

Method parameters in com.algolia.search.models.apikeys with type arguments of type ApiKey

Modifier and Type	Method	Description
void	AddApiKeyResponse.setGetApiKeyFunction(Function<String,ApiKey> getApiKeyConsumer)
void	DeleteApiKeyResponse.setGetApiKeyFunction(Function<String,ApiKey> getApiKeyConsumer)
void	RestoreApiKeyResponse.setGetApiKeyFunction(Function<String,ApiKey> getApiKeyConsumer)
void	UpdateApiKeyResponse.setGetApiKeyFunction(Function<String,ApiKey> getApiKeyConsumer)
ApiKeys	ApiKeys.setKeys(List<ApiKey> keys)