Uses of Class
com.algolia.search.objects.ApiKey

Packages that use ApiKey

Package	Description
com.algolia.search
com.algolia.search.inputs
com.algolia.search.objects

Uses of ApiKey in com.algolia.search

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

Modifier and Type	Method	Description
Optional<ApiKey>	APIClient.getApiKey(String key)	Get a Key from its name
Optional<ApiKey>	APIClient.getApiKey(String key, RequestOptions requestOptions)	Get a Key from its name
CompletableFuture<Optional<ApiKey>>	AsyncAPIClient.getApiKey(String key)	Get an Key from it's name
CompletableFuture<Optional<ApiKey>>	AsyncAPIClient.getApiKey(String key, RequestOptions requestOptions)	Get an Key from it's name
default CompletableFuture<Optional<ApiKey>>	AsyncKey.getApiKey(String key)	Get a key by name from this index
default CompletableFuture<Optional<ApiKey>>	AsyncKey.getApiKey(String key, RequestOptions requestOptions)	Get a key by name from this index
default Optional<ApiKey>	SyncKey.getApiKey(String key)	Get a key by name from this index
default Optional<ApiKey>	SyncKey.getApiKey(String key, RequestOptions requestOptions)	Get a key by name from this index
Optional<ApiKey>	APIClient.getKey(String key)	Deprecated.
CompletableFuture<Optional<ApiKey>>	AsyncAPIClient.getKey(String key)	Deprecated.
default CompletableFuture<Optional<ApiKey>>	AsyncKey.getKey(String key)	Deprecated.
default Optional<ApiKey>	SyncKey.getKey(String key)	Deprecated.
List<ApiKey>	APIClient.listApiKeys()	List all existing user keys with their associated ACLs
List<ApiKey>	APIClient.listApiKeys(RequestOptions requestOptions)	List all existing user keys with their associated ACLs
CompletableFuture<List<ApiKey>>	AsyncAPIClient.listApiKeys()	List all existing user keys with their associated ACLs
CompletableFuture<List<ApiKey>>	AsyncAPIClient.listApiKeys(RequestOptions requestOptions)	List all existing user keys with their associated ACLs
default CompletableFuture<List<ApiKey>>	AsyncKey.listApiKeys()	List keys of this index
default CompletableFuture<List<ApiKey>>	AsyncKey.listApiKeys(RequestOptions requestOptions)	List keys of this index
default List<ApiKey>	SyncKey.listApiKeys()	List keys of this index
default List<ApiKey>	SyncKey.listApiKeys(RequestOptions requestOptions)	List keys of this index
List<ApiKey>	APIClient.listKeys()	Deprecated.
CompletableFuture<List<ApiKey>>	AsyncAPIClient.listKeys()	Deprecated.
default CompletableFuture<List<ApiKey>>	AsyncKey.listKeys()	Deprecated.
default List<ApiKey>	SyncKey.listKeys()	Deprecated.

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

Modifier and Type	Method	Description
CreateUpdateKey	APIClient.addApiKey(ApiKey key)	Create a new key
CreateUpdateKey	APIClient.addApiKey(ApiKey key, RequestOptions requestOptions)	Create a new key
CompletableFuture<CreateUpdateKey>	AsyncAPIClient.addApiKey(ApiKey key)	Create a new key
CompletableFuture<CreateUpdateKey>	AsyncAPIClient.addApiKey(ApiKey key, RequestOptions requestOptions)	Create a new key
default CompletableFuture<CreateUpdateKey>	AsyncKey.addApiKey(ApiKey key)	Add a key to this index
default CompletableFuture<CreateUpdateKey>	AsyncKey.addApiKey(ApiKey key, RequestOptions requestOptions)	Add a key to this index
default CreateUpdateKey	SyncKey.addApiKey(ApiKey key)	Add a key to this index
default CreateUpdateKey	SyncKey.addApiKey(ApiKey key, RequestOptions requestOptions)	Add a key to this index
CreateUpdateKey	APIClient.addKey(ApiKey key)	Deprecated.
CompletableFuture<CreateUpdateKey>	AsyncAPIClient.addKey(ApiKey key)	Deprecated.
default CompletableFuture<CreateUpdateKey>	AsyncKey.addKey(ApiKey key)	Deprecated.
default CreateUpdateKey	SyncKey.addKey(ApiKey key)	Deprecated.
CreateUpdateKey	APIClient.updateApiKey(String keyName, ApiKey key)	Update a key
CreateUpdateKey	APIClient.updateApiKey(String keyName, ApiKey key, RequestOptions requestOptions)	Update a key
CompletableFuture<CreateUpdateKey>	AsyncAPIClient.updateApiKey(String keyName, ApiKey key)	Update a key
CompletableFuture<CreateUpdateKey>	AsyncAPIClient.updateApiKey(String keyName, ApiKey key, RequestOptions requestOptions)	Update a key
default CompletableFuture<CreateUpdateKey>	AsyncKey.updateApiKey(String keyName, ApiKey key)	Update a key by name from this index
default CompletableFuture<CreateUpdateKey>	AsyncKey.updateApiKey(String keyName, ApiKey key, RequestOptions requestOptions)	Update a key by name from this index
default CreateUpdateKey	SyncKey.updateApiKey(String keyName, ApiKey key)	Update a key by name from this index
default CreateUpdateKey	SyncKey.updateApiKey(String keyName, ApiKey key, RequestOptions requestOptions)	Update a key by name from this index
CreateUpdateKey	APIClient.updateKey(String keyName, ApiKey key)	Deprecated.
CompletableFuture<CreateUpdateKey>	AsyncAPIClient.updateKey(String keyName, ApiKey key)	Deprecated.
default CompletableFuture<CreateUpdateKey>	AsyncKey.updateKey(String keyName, ApiKey key)	Deprecated.
default CreateUpdateKey	SyncKey.updateKey(String keyName, ApiKey key)	Deprecated.
default CreateUpdateKey	SyncKey.updateKey(String keyName, ApiKey key, RequestOptions requestOptions)	Deprecated.

Uses of ApiKey in com.algolia.search.inputs

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

Modifier and Type	Method	Description
List<ApiKey>	ApiKeys.getKeys()

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

Modifier and Type	Method	Description
ApiKeys	ApiKeys.setKeys(List<ApiKey> keys)

Uses of ApiKey in com.algolia.search.objects

Methods in com.algolia.search.objects that return ApiKey

Modifier and Type	Method	Description
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.setRestrictSources(String restrictSources)
ApiKey	ApiKey.setValidity(Integer validity)