Package com.algolia.api

Class SearchClient

java.lang.Object

com.algolia.ApiClient

com.algolia.api.SearchClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class SearchClient
extends ApiClient

Constructor Summary

Constructors

Constructor	Description
SearchClient(String appId, String apiKey)
SearchClient(String appId, String apiKey, ClientOptions options)

Method Summary

Modifier and Type	Method	Description
AddApiKeyResponse	addApiKey(ApiKey apiKey)	Add a new API key with specific permissions and restrictions.
AddApiKeyResponse	addApiKey(ApiKey apiKey, RequestOptions requestOptions)	Add a new API key with specific permissions and restrictions.
CompletableFuture<AddApiKeyResponse>	addApiKeyAsync(ApiKey apiKey)	(asynchronously) Add a new API key with specific permissions and restrictions.
CompletableFuture<AddApiKeyResponse>	addApiKeyAsync(ApiKey apiKey, RequestOptions requestOptions)	(asynchronously) Add a new API key with specific permissions and restrictions.
UpdatedAtWithObjectIdResponse	addOrUpdateObject(String indexName, String objectID, Object body)	If you use an existing `objectID`, the existing record will be replaced with the new one.
UpdatedAtWithObjectIdResponse	addOrUpdateObject(String indexName, String objectID, Object body, RequestOptions requestOptions)	If you use an existing `objectID`, the existing record will be replaced with the new one.
CompletableFuture<UpdatedAtWithObjectIdResponse>	addOrUpdateObjectAsync(String indexName, String objectID, Object body)	(asynchronously) If you use an existing `objectID`, the existing record will be replaced with the new one.
CompletableFuture<UpdatedAtWithObjectIdResponse>	addOrUpdateObjectAsync(String indexName, String objectID, Object body, RequestOptions requestOptions)	(asynchronously) If you use an existing `objectID`, the existing record will be replaced with the new one.
CreatedAtResponse	appendSource(Source source)	Add a source to the list of allowed sources.
CreatedAtResponse	appendSource(Source source, RequestOptions requestOptions)	Add a source to the list of allowed sources.
CompletableFuture<CreatedAtResponse>	appendSourceAsync(Source source)	(asynchronously) Add a source to the list of allowed sources.
CompletableFuture<CreatedAtResponse>	appendSourceAsync(Source source, RequestOptions requestOptions)	(asynchronously) Add a source to the list of allowed sources.
CreatedAtResponse	assignUserId(String xAlgoliaUserID, AssignUserIdParams assignUserIdParams)	Assign or move a user ID to a cluster.
CreatedAtResponse	assignUserId(String xAlgoliaUserID, AssignUserIdParams assignUserIdParams, RequestOptions requestOptions)	Assign or move a user ID to a cluster.
CompletableFuture<CreatedAtResponse>	assignUserIdAsync(String xAlgoliaUserID, AssignUserIdParams assignUserIdParams)	(asynchronously) Assign or move a user ID to a cluster.
CompletableFuture<CreatedAtResponse>	assignUserIdAsync(String xAlgoliaUserID, AssignUserIdParams assignUserIdParams, RequestOptions requestOptions)	(asynchronously) Assign or move a user ID to a cluster.
BatchResponse	batch(String indexName, BatchWriteParams batchWriteParams)	To reduce the time spent on network round trips, you can perform several write actions in a single API call.
BatchResponse	batch(String indexName, BatchWriteParams batchWriteParams, RequestOptions requestOptions)	To reduce the time spent on network round trips, you can perform several write actions in a single API call.
CreatedAtResponse	batchAssignUserIds(String xAlgoliaUserID, BatchAssignUserIdsParams batchAssignUserIdsParams)	Assign multiple user IDs to a cluster.
CreatedAtResponse	batchAssignUserIds(String xAlgoliaUserID, BatchAssignUserIdsParams batchAssignUserIdsParams, RequestOptions requestOptions)	Assign multiple user IDs to a cluster.
CompletableFuture<CreatedAtResponse>	batchAssignUserIdsAsync(String xAlgoliaUserID, BatchAssignUserIdsParams batchAssignUserIdsParams)	(asynchronously) Assign multiple user IDs to a cluster.
CompletableFuture<CreatedAtResponse>	batchAssignUserIdsAsync(String xAlgoliaUserID, BatchAssignUserIdsParams batchAssignUserIdsParams, RequestOptions requestOptions)	(asynchronously) Assign multiple user IDs to a cluster.
CompletableFuture<BatchResponse>	batchAsync(String indexName, BatchWriteParams batchWriteParams)	(asynchronously) To reduce the time spent on network round trips, you can perform several write actions in a single API call.
CompletableFuture<BatchResponse>	batchAsync(String indexName, BatchWriteParams batchWriteParams, RequestOptions requestOptions)	(asynchronously) To reduce the time spent on network round trips, you can perform several write actions in a single API call.
UpdatedAtResponse	batchDictionaryEntries(DictionaryType dictionaryName, BatchDictionaryEntriesParams batchDictionaryEntriesParams)	Add or remove a batch of dictionary entries.
UpdatedAtResponse	batchDictionaryEntries(DictionaryType dictionaryName, BatchDictionaryEntriesParams batchDictionaryEntriesParams, RequestOptions requestOptions)	Add or remove a batch of dictionary entries.
CompletableFuture<UpdatedAtResponse>	batchDictionaryEntriesAsync(DictionaryType dictionaryName, BatchDictionaryEntriesParams batchDictionaryEntriesParams)	(asynchronously) Add or remove a batch of dictionary entries.
CompletableFuture<UpdatedAtResponse>	batchDictionaryEntriesAsync(DictionaryType dictionaryName, BatchDictionaryEntriesParams batchDictionaryEntriesParams, RequestOptions requestOptions)	(asynchronously) Add or remove a batch of dictionary entries.
<T> BrowseResponse<T>	browse(String indexName, BrowseParams browseParams, Class<T> innerType)	Retrieve up to 1,000 records per call.
<T> BrowseResponse<T>	browse(String indexName, BrowseParams browseParams, Class<T> innerType, RequestOptions requestOptions)	Retrieve up to 1,000 records per call.
<T> BrowseResponse<T>	browse(String indexName, Class<T> innerType)	Retrieve up to 1,000 records per call.
<T> BrowseResponse<T>	browse(String indexName, Class<T> innerType, RequestOptions requestOptions)	Retrieve up to 1,000 records per call.
<T> CompletableFuture<BrowseResponse<T>>	browseAsync(String indexName, BrowseParams browseParams, Class<T> innerType)	(asynchronously) Retrieve up to 1,000 records per call.
<T> CompletableFuture<BrowseResponse<T>>	browseAsync(String indexName, BrowseParams browseParams, Class<T> innerType, RequestOptions requestOptions)	(asynchronously) Retrieve up to 1,000 records per call.
<T> CompletableFuture<BrowseResponse<T>>	browseAsync(String indexName, Class<T> innerType)	(asynchronously) Retrieve up to 1,000 records per call.
<T> CompletableFuture<BrowseResponse<T>>	browseAsync(String indexName, Class<T> innerType, RequestOptions requestOptions)	(asynchronously) Retrieve up to 1,000 records per call.
<T> Iterable<T>	browseObjects(String indexName, BrowseParamsObject params, Class<T> innerType)	Helper: Returns an iterator on top of the `browse` method.
<T> Iterable<T>	browseObjects(String indexName, BrowseParamsObject params, Class<T> innerType, RequestOptions requestOptions)	Helper: Returns an iterator on top of the `browse` method.
Iterable<Rule>	browseRules(String indexName)	Helper: Returns an iterator on top of the `searchRules` method.
Iterable<Rule>	browseRules(String indexName, SearchRulesParams params)	Helper: Returns an iterator on top of the `searchRules` method.
Iterable<Rule>	browseRules(String indexName, SearchRulesParams params, RequestOptions requestOptions)	Helper: Returns an iterator on top of the `searchRules` method.
Iterable<SynonymHit>	browseSynonyms(String indexName)	Helper: Returns an iterator on top of the `searchSynonyms` method.
Iterable<SynonymHit>	browseSynonyms(String indexName, SynonymType type, SearchSynonymsParams params)	Helper: Returns an iterator on top of the `searchSynonyms` method.
Iterable<SynonymHit>	browseSynonyms(String indexName, SynonymType type, SearchSynonymsParams params, RequestOptions requestOptions)	Helper: Returns an iterator on top of the `searchSynonyms` method.
UpdatedAtResponse	clearAllSynonyms(String indexName)	Delete all synonyms in the index.
UpdatedAtResponse	clearAllSynonyms(String indexName, RequestOptions requestOptions)	Delete all synonyms in the index.
UpdatedAtResponse	clearAllSynonyms(String indexName, Boolean forwardToReplicas)	Delete all synonyms in the index.
UpdatedAtResponse	clearAllSynonyms(String indexName, Boolean forwardToReplicas, RequestOptions requestOptions)	Delete all synonyms in the index.
CompletableFuture<UpdatedAtResponse>	clearAllSynonymsAsync(String indexName)	(asynchronously) Delete all synonyms in the index.
CompletableFuture<UpdatedAtResponse>	clearAllSynonymsAsync(String indexName, RequestOptions requestOptions)	(asynchronously) Delete all synonyms in the index.
CompletableFuture<UpdatedAtResponse>	clearAllSynonymsAsync(String indexName, Boolean forwardToReplicas)	(asynchronously) Delete all synonyms in the index.
CompletableFuture<UpdatedAtResponse>	clearAllSynonymsAsync(String indexName, Boolean forwardToReplicas, RequestOptions requestOptions)	(asynchronously) Delete all synonyms in the index.
UpdatedAtResponse	clearObjects(String indexName)	Delete the records but leave settings and index-specific API keys untouched.
UpdatedAtResponse	clearObjects(String indexName, RequestOptions requestOptions)	Delete the records but leave settings and index-specific API keys untouched.
CompletableFuture<UpdatedAtResponse>	clearObjectsAsync(String indexName)	(asynchronously) Delete the records but leave settings and index-specific API keys untouched.
CompletableFuture<UpdatedAtResponse>	clearObjectsAsync(String indexName, RequestOptions requestOptions)	(asynchronously) Delete the records but leave settings and index-specific API keys untouched.
UpdatedAtResponse	clearRules(String indexName)	Delete all rules in the index.
UpdatedAtResponse	clearRules(String indexName, RequestOptions requestOptions)	Delete all rules in the index.
UpdatedAtResponse	clearRules(String indexName, Boolean forwardToReplicas)	Delete all rules in the index.
UpdatedAtResponse	clearRules(String indexName, Boolean forwardToReplicas, RequestOptions requestOptions)	Delete all rules in the index.
CompletableFuture<UpdatedAtResponse>	clearRulesAsync(String indexName)	(asynchronously) Delete all rules in the index.
CompletableFuture<UpdatedAtResponse>	clearRulesAsync(String indexName, RequestOptions requestOptions)	(asynchronously) Delete all rules in the index.
CompletableFuture<UpdatedAtResponse>	clearRulesAsync(String indexName, Boolean forwardToReplicas)	(asynchronously) Delete all rules in the index.
CompletableFuture<UpdatedAtResponse>	clearRulesAsync(String indexName, Boolean forwardToReplicas, RequestOptions requestOptions)	(asynchronously) Delete all rules in the index.
Object	del(String path)	This method allow you to send requests to the Algolia REST API.
Object	del(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	del(String path, Map<String,Object> parameters)	This method allow you to send requests to the Algolia REST API.
Object	del(String path, Map<String,Object> parameters, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	delAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	delAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	delAsync(String path, Map<String,Object> parameters)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	delAsync(String path, Map<String,Object> parameters, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
DeleteApiKeyResponse	deleteApiKey(String key)	Delete an existing API key.
DeleteApiKeyResponse	deleteApiKey(String key, RequestOptions requestOptions)	Delete an existing API key.
CompletableFuture<DeleteApiKeyResponse>	deleteApiKeyAsync(String key)	(asynchronously) Delete an existing API key.
CompletableFuture<DeleteApiKeyResponse>	deleteApiKeyAsync(String key, RequestOptions requestOptions)	(asynchronously) Delete an existing API key.
DeletedAtResponse	deleteBy(String indexName, DeleteByParams deleteByParams)	This operation doesn't support all the query options, only its filters (numeric, facet, or tag) and geo queries.
DeletedAtResponse	deleteBy(String indexName, DeleteByParams deleteByParams, RequestOptions requestOptions)	This operation doesn't support all the query options, only its filters (numeric, facet, or tag) and geo queries.
CompletableFuture<DeletedAtResponse>	deleteByAsync(String indexName, DeleteByParams deleteByParams)	(asynchronously) This operation doesn't support all the query options, only its filters (numeric, facet, or tag) and geo queries.
CompletableFuture<DeletedAtResponse>	deleteByAsync(String indexName, DeleteByParams deleteByParams, RequestOptions requestOptions)	(asynchronously) This operation doesn't support all the query options, only its filters (numeric, facet, or tag) and geo queries.
DeletedAtResponse	deleteIndex(String indexName)	Delete an existing index.
DeletedAtResponse	deleteIndex(String indexName, RequestOptions requestOptions)	Delete an existing index.
CompletableFuture<DeletedAtResponse>	deleteIndexAsync(String indexName)	(asynchronously) Delete an existing index.
CompletableFuture<DeletedAtResponse>	deleteIndexAsync(String indexName, RequestOptions requestOptions)	(asynchronously) Delete an existing index.
DeletedAtResponse	deleteObject(String indexName, String objectID)	To delete a set of records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy) instead.
DeletedAtResponse	deleteObject(String indexName, String objectID, RequestOptions requestOptions)	To delete a set of records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy) instead.
CompletableFuture<DeletedAtResponse>	deleteObjectAsync(String indexName, String objectID)	(asynchronously) To delete a set of records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy) instead.
CompletableFuture<DeletedAtResponse>	deleteObjectAsync(String indexName, String objectID, RequestOptions requestOptions)	(asynchronously) To delete a set of records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy) instead.
UpdatedAtResponse	deleteRule(String indexName, String objectID)	Delete a rule by its `objectID`.
UpdatedAtResponse	deleteRule(String indexName, String objectID, RequestOptions requestOptions)	Delete a rule by its `objectID`.
UpdatedAtResponse	deleteRule(String indexName, String objectID, Boolean forwardToReplicas)	Delete a rule by its `objectID`.
UpdatedAtResponse	deleteRule(String indexName, String objectID, Boolean forwardToReplicas, RequestOptions requestOptions)	Delete a rule by its `objectID`.
CompletableFuture<UpdatedAtResponse>	deleteRuleAsync(String indexName, String objectID)	(asynchronously) Delete a rule by its `objectID`.
CompletableFuture<UpdatedAtResponse>	deleteRuleAsync(String indexName, String objectID, RequestOptions requestOptions)	(asynchronously) Delete a rule by its `objectID`.
CompletableFuture<UpdatedAtResponse>	deleteRuleAsync(String indexName, String objectID, Boolean forwardToReplicas)	(asynchronously) Delete a rule by its `objectID`.
CompletableFuture<UpdatedAtResponse>	deleteRuleAsync(String indexName, String objectID, Boolean forwardToReplicas, RequestOptions requestOptions)	(asynchronously) Delete a rule by its `objectID`.
DeleteSourceResponse	deleteSource(String source)	Remove a source from the list of allowed sources.
DeleteSourceResponse	deleteSource(String source, RequestOptions requestOptions)	Remove a source from the list of allowed sources.
CompletableFuture<DeleteSourceResponse>	deleteSourceAsync(String source)	(asynchronously) Remove a source from the list of allowed sources.
CompletableFuture<DeleteSourceResponse>	deleteSourceAsync(String source, RequestOptions requestOptions)	(asynchronously) Remove a source from the list of allowed sources.
DeletedAtResponse	deleteSynonym(String indexName, String objectID)	Delete a synonym by its `objectID`.
DeletedAtResponse	deleteSynonym(String indexName, String objectID, RequestOptions requestOptions)	Delete a synonym by its `objectID`.
DeletedAtResponse	deleteSynonym(String indexName, String objectID, Boolean forwardToReplicas)	Delete a synonym by its `objectID`.
DeletedAtResponse	deleteSynonym(String indexName, String objectID, Boolean forwardToReplicas, RequestOptions requestOptions)	Delete a synonym by its `objectID`.
CompletableFuture<DeletedAtResponse>	deleteSynonymAsync(String indexName, String objectID)	(asynchronously) Delete a synonym by its `objectID`.
CompletableFuture<DeletedAtResponse>	deleteSynonymAsync(String indexName, String objectID, RequestOptions requestOptions)	(asynchronously) Delete a synonym by its `objectID`.
CompletableFuture<DeletedAtResponse>	deleteSynonymAsync(String indexName, String objectID, Boolean forwardToReplicas)	(asynchronously) Delete a synonym by its `objectID`.
CompletableFuture<DeletedAtResponse>	deleteSynonymAsync(String indexName, String objectID, Boolean forwardToReplicas, RequestOptions requestOptions)	(asynchronously) Delete a synonym by its `objectID`.
Object	get(String path)	This method allow you to send requests to the Algolia REST API.
Object	get(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	get(String path, Map<String,Object> parameters)	This method allow you to send requests to the Algolia REST API.
Object	get(String path, Map<String,Object> parameters, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
GetApiKeyResponse	getApiKey(String key)	Get the permissions and restrictions of a specific API key.
GetApiKeyResponse	getApiKey(String key, RequestOptions requestOptions)	Get the permissions and restrictions of a specific API key.
CompletableFuture<GetApiKeyResponse>	getApiKeyAsync(String key)	(asynchronously) Get the permissions and restrictions of a specific API key.
CompletableFuture<GetApiKeyResponse>	getApiKeyAsync(String key, RequestOptions requestOptions)	(asynchronously) Get the permissions and restrictions of a specific API key.
CompletableFuture<Object>	getAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	getAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	getAsync(String path, Map<String,Object> parameters)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	getAsync(String path, Map<String,Object> parameters, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
Map<String,Languages>	getDictionaryLanguages()	Lists Algolia's [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) and any customizations applied to each language's [stop word](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plural](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), and [segmentation (compound)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) features.
Map<String,Languages>	getDictionaryLanguages(RequestOptions requestOptions)	Lists Algolia's [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) and any customizations applied to each language's [stop word](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plural](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), and [segmentation (compound)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) features.
CompletableFuture<Map<String,Languages>>	getDictionaryLanguagesAsync()	(asynchronously) Lists Algolia's [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) and any customizations applied to each language's [stop word](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plural](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), and [segmentation (compound)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) features.
CompletableFuture<Map<String,Languages>>	getDictionaryLanguagesAsync(RequestOptions requestOptions)	(asynchronously) Lists Algolia's [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) and any customizations applied to each language's [stop word](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plural](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), and [segmentation (compound)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) features.
GetDictionarySettingsResponse	getDictionarySettings()	Get the languages for which [stop words are turned off](#tag/Dictionaries/operation/setDictionarySettings).
GetDictionarySettingsResponse	getDictionarySettings(RequestOptions requestOptions)	Get the languages for which [stop words are turned off](#tag/Dictionaries/operation/setDictionarySettings).
CompletableFuture<GetDictionarySettingsResponse>	getDictionarySettingsAsync()	(asynchronously) Get the languages for which [stop words are turned off](#tag/Dictionaries/operation/setDictionarySettings).
CompletableFuture<GetDictionarySettingsResponse>	getDictionarySettingsAsync(RequestOptions requestOptions)	(asynchronously) Get the languages for which [stop words are turned off](#tag/Dictionaries/operation/setDictionarySettings).
GetLogsResponse	getLogs()	The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).
GetLogsResponse	getLogs(RequestOptions requestOptions)	The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).
GetLogsResponse	getLogs(Integer offset, Integer length, String indexName, LogType type)	The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).
GetLogsResponse	getLogs(Integer offset, Integer length, String indexName, LogType type, RequestOptions requestOptions)	The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).
CompletableFuture<GetLogsResponse>	getLogsAsync()	(asynchronously) The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).
CompletableFuture<GetLogsResponse>	getLogsAsync(RequestOptions requestOptions)	(asynchronously) The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).
CompletableFuture<GetLogsResponse>	getLogsAsync(Integer offset, Integer length, String indexName, LogType type)	(asynchronously) The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).
CompletableFuture<GetLogsResponse>	getLogsAsync(Integer offset, Integer length, String indexName, LogType type, RequestOptions requestOptions)	(asynchronously) The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl).
Map<String,String>	getObject(String indexName, String objectID)	To get more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).
Map<String,String>	getObject(String indexName, String objectID, RequestOptions requestOptions)	To get more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).
Map<String,String>	getObject(String indexName, String objectID, List<String> attributesToRetrieve)	To get more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).
Map<String,String>	getObject(String indexName, String objectID, List<String> attributesToRetrieve, RequestOptions requestOptions)	To get more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).
CompletableFuture<Map<String,String>>	getObjectAsync(String indexName, String objectID)	(asynchronously) To get more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).
CompletableFuture<Map<String,String>>	getObjectAsync(String indexName, String objectID, RequestOptions requestOptions)	(asynchronously) To get more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).
CompletableFuture<Map<String,String>>	getObjectAsync(String indexName, String objectID, List<String> attributesToRetrieve)	(asynchronously) To get more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).
CompletableFuture<Map<String,String>>	getObjectAsync(String indexName, String objectID, List<String> attributesToRetrieve, RequestOptions requestOptions)	(asynchronously) To get more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).
<T> GetObjectsResponse<T>	getObjects(GetObjectsParams getObjectsParams, Class<T> innerType)	Retrieve one or more records, potentially from different indices, in a single API operation.
<T> GetObjectsResponse<T>	getObjects(GetObjectsParams getObjectsParams, Class<T> innerType, RequestOptions requestOptions)	Retrieve one or more records, potentially from different indices, in a single API operation.
<T> CompletableFuture<GetObjectsResponse<T>>	getObjectsAsync(GetObjectsParams getObjectsParams, Class<T> innerType)	(asynchronously) Retrieve one or more records, potentially from different indices, in a single API operation.
<T> CompletableFuture<GetObjectsResponse<T>>	getObjectsAsync(GetObjectsParams getObjectsParams, Class<T> innerType, RequestOptions requestOptions)	(asynchronously) Retrieve one or more records, potentially from different indices, in a single API operation.
Rule	getRule(String indexName, String objectID)	Get a rule by its `objectID`.
Rule	getRule(String indexName, String objectID, RequestOptions requestOptions)	Get a rule by its `objectID`.
CompletableFuture<Rule>	getRuleAsync(String indexName, String objectID)	(asynchronously) Get a rule by its `objectID`.
CompletableFuture<Rule>	getRuleAsync(String indexName, String objectID, RequestOptions requestOptions)	(asynchronously) Get a rule by its `objectID`.
IndexSettings	getSettings(String indexName)	Return an object containing an index's [configuration settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/).
IndexSettings	getSettings(String indexName, RequestOptions requestOptions)	Return an object containing an index's [configuration settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/).
CompletableFuture<IndexSettings>	getSettingsAsync(String indexName)	(asynchronously) Return an object containing an index's [configuration settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/).
CompletableFuture<IndexSettings>	getSettingsAsync(String indexName, RequestOptions requestOptions)	(asynchronously) Return an object containing an index's [configuration settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/).
List<Source>	getSources()	Get all allowed sources (IP addresses).
List<Source>	getSources(RequestOptions requestOptions)	Get all allowed sources (IP addresses).
CompletableFuture<List<Source>>	getSourcesAsync()	(asynchronously) Get all allowed sources (IP addresses).
CompletableFuture<List<Source>>	getSourcesAsync(RequestOptions requestOptions)	(asynchronously) Get all allowed sources (IP addresses).
SynonymHit	getSynonym(String indexName, String objectID)	Get a syonym by its `objectID`.
SynonymHit	getSynonym(String indexName, String objectID, RequestOptions requestOptions)	Get a syonym by its `objectID`.
CompletableFuture<SynonymHit>	getSynonymAsync(String indexName, String objectID)	(asynchronously) Get a syonym by its `objectID`.
CompletableFuture<SynonymHit>	getSynonymAsync(String indexName, String objectID, RequestOptions requestOptions)	(asynchronously) Get a syonym by its `objectID`.
GetTaskResponse	getTask(String indexName, Long taskID)	Some operations, such as copying an index, will respond with a `taskID` value.
GetTaskResponse	getTask(String indexName, Long taskID, RequestOptions requestOptions)	Some operations, such as copying an index, will respond with a `taskID` value.
CompletableFuture<GetTaskResponse>	getTaskAsync(String indexName, Long taskID)	(asynchronously) Some operations, such as copying an index, will respond with a `taskID` value.
CompletableFuture<GetTaskResponse>	getTaskAsync(String indexName, Long taskID, RequestOptions requestOptions)	(asynchronously) Some operations, such as copying an index, will respond with a `taskID` value.
GetTopUserIdsResponse	getTopUserIds()	Get the IDs of the 10 users with the highest number of records per cluster.
GetTopUserIdsResponse	getTopUserIds(RequestOptions requestOptions)	Get the IDs of the 10 users with the highest number of records per cluster.
CompletableFuture<GetTopUserIdsResponse>	getTopUserIdsAsync()	(asynchronously) Get the IDs of the 10 users with the highest number of records per cluster.
CompletableFuture<GetTopUserIdsResponse>	getTopUserIdsAsync(RequestOptions requestOptions)	(asynchronously) Get the IDs of the 10 users with the highest number of records per cluster.
UserId	getUserId(String userID)	Returns the userID data stored in the mapping.
UserId	getUserId(String userID, RequestOptions requestOptions)	Returns the userID data stored in the mapping.
CompletableFuture<UserId>	getUserIdAsync(String userID)	(asynchronously) Returns the userID data stored in the mapping.
CompletableFuture<UserId>	getUserIdAsync(String userID, RequestOptions requestOptions)	(asynchronously) Returns the userID data stored in the mapping.
HasPendingMappingsResponse	hasPendingMappings()	To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.
HasPendingMappingsResponse	hasPendingMappings(RequestOptions requestOptions)	To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.
HasPendingMappingsResponse	hasPendingMappings(Boolean getClusters)	To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.
HasPendingMappingsResponse	hasPendingMappings(Boolean getClusters, RequestOptions requestOptions)	To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.
CompletableFuture<HasPendingMappingsResponse>	hasPendingMappingsAsync()	(asynchronously) To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.
CompletableFuture<HasPendingMappingsResponse>	hasPendingMappingsAsync(RequestOptions requestOptions)	(asynchronously) To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.
CompletableFuture<HasPendingMappingsResponse>	hasPendingMappingsAsync(Boolean getClusters)	(asynchronously) To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.
CompletableFuture<HasPendingMappingsResponse>	hasPendingMappingsAsync(Boolean getClusters, RequestOptions requestOptions)	(asynchronously) To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.
ListApiKeysResponse	listApiKeys()	List all API keys associated with your Algolia application, including their permissions and restrictions.
ListApiKeysResponse	listApiKeys(RequestOptions requestOptions)	List all API keys associated with your Algolia application, including their permissions and restrictions.
CompletableFuture<ListApiKeysResponse>	listApiKeysAsync()	(asynchronously) List all API keys associated with your Algolia application, including their permissions and restrictions.
CompletableFuture<ListApiKeysResponse>	listApiKeysAsync(RequestOptions requestOptions)	(asynchronously) List all API keys associated with your Algolia application, including their permissions and restrictions.
ListClustersResponse	listClusters()	List the available clusters in a multi-cluster setup.
ListClustersResponse	listClusters(RequestOptions requestOptions)	List the available clusters in a multi-cluster setup.
CompletableFuture<ListClustersResponse>	listClustersAsync()	(asynchronously) List the available clusters in a multi-cluster setup.
CompletableFuture<ListClustersResponse>	listClustersAsync(RequestOptions requestOptions)	(asynchronously) List the available clusters in a multi-cluster setup.
ListIndicesResponse	listIndices()	List indices in an Algolia application.
ListIndicesResponse	listIndices(RequestOptions requestOptions)	List indices in an Algolia application.
ListIndicesResponse	listIndices(Integer page, Integer hitsPerPage)	List indices in an Algolia application.
ListIndicesResponse	listIndices(Integer page, Integer hitsPerPage, RequestOptions requestOptions)	List indices in an Algolia application.
CompletableFuture<ListIndicesResponse>	listIndicesAsync()	(asynchronously) List indices in an Algolia application.
CompletableFuture<ListIndicesResponse>	listIndicesAsync(RequestOptions requestOptions)	(asynchronously) List indices in an Algolia application.
CompletableFuture<ListIndicesResponse>	listIndicesAsync(Integer page, Integer hitsPerPage)	(asynchronously) List indices in an Algolia application.
CompletableFuture<ListIndicesResponse>	listIndicesAsync(Integer page, Integer hitsPerPage, RequestOptions requestOptions)	(asynchronously) List indices in an Algolia application.
ListUserIdsResponse	listUserIds()	List the userIDs assigned to a multi-cluster application.
ListUserIdsResponse	listUserIds(RequestOptions requestOptions)	List the userIDs assigned to a multi-cluster application.
ListUserIdsResponse	listUserIds(Integer page, Integer hitsPerPage)	List the userIDs assigned to a multi-cluster application.
ListUserIdsResponse	listUserIds(Integer page, Integer hitsPerPage, RequestOptions requestOptions)	List the userIDs assigned to a multi-cluster application.
CompletableFuture<ListUserIdsResponse>	listUserIdsAsync()	(asynchronously) List the userIDs assigned to a multi-cluster application.
CompletableFuture<ListUserIdsResponse>	listUserIdsAsync(RequestOptions requestOptions)	(asynchronously) List the userIDs assigned to a multi-cluster application.
CompletableFuture<ListUserIdsResponse>	listUserIdsAsync(Integer page, Integer hitsPerPage)	(asynchronously) List the userIDs assigned to a multi-cluster application.
CompletableFuture<ListUserIdsResponse>	listUserIdsAsync(Integer page, Integer hitsPerPage, RequestOptions requestOptions)	(asynchronously) List the userIDs assigned to a multi-cluster application.
MultipleBatchResponse	multipleBatch(BatchParams batchParams)	To reduce the time spent on network round trips, you can perform several write actions in a single request.
MultipleBatchResponse	multipleBatch(BatchParams batchParams, RequestOptions requestOptions)	To reduce the time spent on network round trips, you can perform several write actions in a single request.
CompletableFuture<MultipleBatchResponse>	multipleBatchAsync(BatchParams batchParams)	(asynchronously) To reduce the time spent on network round trips, you can perform several write actions in a single request.
CompletableFuture<MultipleBatchResponse>	multipleBatchAsync(BatchParams batchParams, RequestOptions requestOptions)	(asynchronously) To reduce the time spent on network round trips, you can perform several write actions in a single request.
UpdatedAtResponse	operationIndex(String indexName, OperationIndexParams operationIndexParams)	This `operation`, _copy_ or _move_, will copy or move a source index's (`IndexName`) records, settings, synonyms, and rules to a `destination` index.
UpdatedAtResponse	operationIndex(String indexName, OperationIndexParams operationIndexParams, RequestOptions requestOptions)	This `operation`, _copy_ or _move_, will copy or move a source index's (`IndexName`) records, settings, synonyms, and rules to a `destination` index.
CompletableFuture<UpdatedAtResponse>	operationIndexAsync(String indexName, OperationIndexParams operationIndexParams)	(asynchronously) This `operation`, _copy_ or _move_, will copy or move a source index's (`IndexName`) records, settings, synonyms, and rules to a `destination` index.
CompletableFuture<UpdatedAtResponse>	operationIndexAsync(String indexName, OperationIndexParams operationIndexParams, RequestOptions requestOptions)	(asynchronously) This `operation`, _copy_ or _move_, will copy or move a source index's (`IndexName`) records, settings, synonyms, and rules to a `destination` index.
UpdatedAtWithObjectIdResponse	partialUpdateObject(String indexName, String objectID, Map<String,AttributeToUpdate> attributesToUpdate)	Add new attributes or update current ones in an existing record.
UpdatedAtWithObjectIdResponse	partialUpdateObject(String indexName, String objectID, Map<String,AttributeToUpdate> attributesToUpdate, RequestOptions requestOptions)	Add new attributes or update current ones in an existing record.
UpdatedAtWithObjectIdResponse	partialUpdateObject(String indexName, String objectID, Map<String,AttributeToUpdate> attributesToUpdate, Boolean createIfNotExists)	Add new attributes or update current ones in an existing record.
UpdatedAtWithObjectIdResponse	partialUpdateObject(String indexName, String objectID, Map<String,AttributeToUpdate> attributesToUpdate, Boolean createIfNotExists, RequestOptions requestOptions)	Add new attributes or update current ones in an existing record.
CompletableFuture<UpdatedAtWithObjectIdResponse>	partialUpdateObjectAsync(String indexName, String objectID, Map<String,AttributeToUpdate> attributesToUpdate)	(asynchronously) Add new attributes or update current ones in an existing record.
CompletableFuture<UpdatedAtWithObjectIdResponse>	partialUpdateObjectAsync(String indexName, String objectID, Map<String,AttributeToUpdate> attributesToUpdate, RequestOptions requestOptions)	(asynchronously) Add new attributes or update current ones in an existing record.
CompletableFuture<UpdatedAtWithObjectIdResponse>	partialUpdateObjectAsync(String indexName, String objectID, Map<String,AttributeToUpdate> attributesToUpdate, Boolean createIfNotExists)	(asynchronously) Add new attributes or update current ones in an existing record.
CompletableFuture<UpdatedAtWithObjectIdResponse>	partialUpdateObjectAsync(String indexName, String objectID, Map<String,AttributeToUpdate> attributesToUpdate, Boolean createIfNotExists, RequestOptions requestOptions)	(asynchronously) Add new attributes or update current ones in an existing record.
Object	post(String path)	This method allow you to send requests to the Algolia REST API.
Object	post(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	post(String path, Map<String,Object> parameters, Object body)	This method allow you to send requests to the Algolia REST API.
Object	post(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	postAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	postAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	postAsync(String path, Map<String,Object> parameters, Object body)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	postAsync(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
Object	put(String path)	This method allow you to send requests to the Algolia REST API.
Object	put(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	put(String path, Map<String,Object> parameters, Object body)	This method allow you to send requests to the Algolia REST API.
Object	put(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	putAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	putAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	putAsync(String path, Map<String,Object> parameters, Object body)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	putAsync(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
RemoveUserIdResponse	removeUserId(String userID)	Remove a userID and its associated data from the multi-clusters.
RemoveUserIdResponse	removeUserId(String userID, RequestOptions requestOptions)	Remove a userID and its associated data from the multi-clusters.
CompletableFuture<RemoveUserIdResponse>	removeUserIdAsync(String userID)	(asynchronously) Remove a userID and its associated data from the multi-clusters.
CompletableFuture<RemoveUserIdResponse>	removeUserIdAsync(String userID, RequestOptions requestOptions)	(asynchronously) Remove a userID and its associated data from the multi-clusters.
ReplaceSourceResponse	replaceSources(List<Source> source)	Replace all allowed sources.
ReplaceSourceResponse	replaceSources(List<Source> source, RequestOptions requestOptions)	Replace all allowed sources.
CompletableFuture<ReplaceSourceResponse>	replaceSourcesAsync(List<Source> source)	(asynchronously) Replace all allowed sources.
CompletableFuture<ReplaceSourceResponse>	replaceSourcesAsync(List<Source> source, RequestOptions requestOptions)	(asynchronously) Replace all allowed sources.
AddApiKeyResponse	restoreApiKey(String key)	Restore a deleted API key, along with its associated permissions.
AddApiKeyResponse	restoreApiKey(String key, RequestOptions requestOptions)	Restore a deleted API key, along with its associated permissions.
CompletableFuture<AddApiKeyResponse>	restoreApiKeyAsync(String key)	(asynchronously) Restore a deleted API key, along with its associated permissions.
CompletableFuture<AddApiKeyResponse>	restoreApiKeyAsync(String key, RequestOptions requestOptions)	(asynchronously) Restore a deleted API key, along with its associated permissions.
SaveObjectResponse	saveObject(String indexName, Object body)	Add a record (object) to an index or replace it.
SaveObjectResponse	saveObject(String indexName, Object body, RequestOptions requestOptions)	Add a record (object) to an index or replace it.
CompletableFuture<SaveObjectResponse>	saveObjectAsync(String indexName, Object body)	(asynchronously) Add a record (object) to an index or replace it.
CompletableFuture<SaveObjectResponse>	saveObjectAsync(String indexName, Object body, RequestOptions requestOptions)	(asynchronously) Add a record (object) to an index or replace it.
UpdatedRuleResponse	saveRule(String indexName, String objectID, Rule rule)	To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).
UpdatedRuleResponse	saveRule(String indexName, String objectID, Rule rule, RequestOptions requestOptions)	To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).
UpdatedRuleResponse	saveRule(String indexName, String objectID, Rule rule, Boolean forwardToReplicas)	To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).
UpdatedRuleResponse	saveRule(String indexName, String objectID, Rule rule, Boolean forwardToReplicas, RequestOptions requestOptions)	To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).
CompletableFuture<UpdatedRuleResponse>	saveRuleAsync(String indexName, String objectID, Rule rule)	(asynchronously) To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).
CompletableFuture<UpdatedRuleResponse>	saveRuleAsync(String indexName, String objectID, Rule rule, RequestOptions requestOptions)	(asynchronously) To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).
CompletableFuture<UpdatedRuleResponse>	saveRuleAsync(String indexName, String objectID, Rule rule, Boolean forwardToReplicas)	(asynchronously) To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).
CompletableFuture<UpdatedRuleResponse>	saveRuleAsync(String indexName, String objectID, Rule rule, Boolean forwardToReplicas, RequestOptions requestOptions)	(asynchronously) To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).
UpdatedAtResponse	saveRules(String indexName, List<Rule> rules)	Create or update multiple rules.
UpdatedAtResponse	saveRules(String indexName, List<Rule> rules, RequestOptions requestOptions)	Create or update multiple rules.
UpdatedAtResponse	saveRules(String indexName, List<Rule> rules, Boolean forwardToReplicas, Boolean clearExistingRules)	Create or update multiple rules.
UpdatedAtResponse	saveRules(String indexName, List<Rule> rules, Boolean forwardToReplicas, Boolean clearExistingRules, RequestOptions requestOptions)	Create or update multiple rules.
CompletableFuture<UpdatedAtResponse>	saveRulesAsync(String indexName, List<Rule> rules)	(asynchronously) Create or update multiple rules.
CompletableFuture<UpdatedAtResponse>	saveRulesAsync(String indexName, List<Rule> rules, RequestOptions requestOptions)	(asynchronously) Create or update multiple rules.
CompletableFuture<UpdatedAtResponse>	saveRulesAsync(String indexName, List<Rule> rules, Boolean forwardToReplicas, Boolean clearExistingRules)	(asynchronously) Create or update multiple rules.
CompletableFuture<UpdatedAtResponse>	saveRulesAsync(String indexName, List<Rule> rules, Boolean forwardToReplicas, Boolean clearExistingRules, RequestOptions requestOptions)	(asynchronously) Create or update multiple rules.
SaveSynonymResponse	saveSynonym(String indexName, String objectID, SynonymHit synonymHit)	Add a [synonym](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms) to an index or replace it.
SaveSynonymResponse	saveSynonym(String indexName, String objectID, SynonymHit synonymHit, RequestOptions requestOptions)	Add a [synonym](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms) to an index or replace it.
SaveSynonymResponse	saveSynonym(String indexName, String objectID, SynonymHit synonymHit, Boolean forwardToReplicas)	Add a [synonym](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms) to an index or replace it.
SaveSynonymResponse	saveSynonym(String indexName, String objectID, SynonymHit synonymHit, Boolean forwardToReplicas, RequestOptions requestOptions)	Add a [synonym](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms) to an index or replace it.
CompletableFuture<SaveSynonymResponse>	saveSynonymAsync(String indexName, String objectID, SynonymHit synonymHit)	(asynchronously) Add a [synonym](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms) to an index or replace it.
CompletableFuture<SaveSynonymResponse>	saveSynonymAsync(String indexName, String objectID, SynonymHit synonymHit, RequestOptions requestOptions)	(asynchronously) Add a [synonym](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms) to an index or replace it.
CompletableFuture<SaveSynonymResponse>	saveSynonymAsync(String indexName, String objectID, SynonymHit synonymHit, Boolean forwardToReplicas)	(asynchronously) Add a [synonym](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms) to an index or replace it.
CompletableFuture<SaveSynonymResponse>	saveSynonymAsync(String indexName, String objectID, SynonymHit synonymHit, Boolean forwardToReplicas, RequestOptions requestOptions)	(asynchronously) Add a [synonym](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms) to an index or replace it.
UpdatedAtResponse	saveSynonyms(String indexName, List<SynonymHit> synonymHit)	Create or update multiple synonyms.
UpdatedAtResponse	saveSynonyms(String indexName, List<SynonymHit> synonymHit, RequestOptions requestOptions)	Create or update multiple synonyms.
UpdatedAtResponse	saveSynonyms(String indexName, List<SynonymHit> synonymHit, Boolean forwardToReplicas, Boolean replaceExistingSynonyms)	Create or update multiple synonyms.
UpdatedAtResponse	saveSynonyms(String indexName, List<SynonymHit> synonymHit, Boolean forwardToReplicas, Boolean replaceExistingSynonyms, RequestOptions requestOptions)	Create or update multiple synonyms.
CompletableFuture<UpdatedAtResponse>	saveSynonymsAsync(String indexName, List<SynonymHit> synonymHit)	(asynchronously) Create or update multiple synonyms.
CompletableFuture<UpdatedAtResponse>	saveSynonymsAsync(String indexName, List<SynonymHit> synonymHit, RequestOptions requestOptions)	(asynchronously) Create or update multiple synonyms.
CompletableFuture<UpdatedAtResponse>	saveSynonymsAsync(String indexName, List<SynonymHit> synonymHit, Boolean forwardToReplicas, Boolean replaceExistingSynonyms)	(asynchronously) Create or update multiple synonyms.
CompletableFuture<UpdatedAtResponse>	saveSynonymsAsync(String indexName, List<SynonymHit> synonymHit, Boolean forwardToReplicas, Boolean replaceExistingSynonyms, RequestOptions requestOptions)	(asynchronously) Create or update multiple synonyms.
SearchResponses	search(SearchMethodParams searchMethodParams)	Send multiple search queries to one or more indices.
SearchResponses	search(SearchMethodParams searchMethodParams, RequestOptions requestOptions)	Send multiple search queries to one or more indices.
CompletableFuture<SearchResponses>	searchAsync(SearchMethodParams searchMethodParams)	(asynchronously) Send multiple search queries to one or more indices.
CompletableFuture<SearchResponses>	searchAsync(SearchMethodParams searchMethodParams, RequestOptions requestOptions)	(asynchronously) Send multiple search queries to one or more indices.
UpdatedAtResponse	searchDictionaryEntries(DictionaryType dictionaryName, SearchDictionaryEntriesParams searchDictionaryEntriesParams)	Search for standard and [custom](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/) entries in the [stop words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plurals](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), or [segmentation (compounds)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) dictionaries.
UpdatedAtResponse	searchDictionaryEntries(DictionaryType dictionaryName, SearchDictionaryEntriesParams searchDictionaryEntriesParams, RequestOptions requestOptions)	Search for standard and [custom](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/) entries in the [stop words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plurals](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), or [segmentation (compounds)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) dictionaries.
CompletableFuture<UpdatedAtResponse>	searchDictionaryEntriesAsync(DictionaryType dictionaryName, SearchDictionaryEntriesParams searchDictionaryEntriesParams)	(asynchronously) Search for standard and [custom](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/) entries in the [stop words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plurals](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), or [segmentation (compounds)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) dictionaries.
CompletableFuture<UpdatedAtResponse>	searchDictionaryEntriesAsync(DictionaryType dictionaryName, SearchDictionaryEntriesParams searchDictionaryEntriesParams, RequestOptions requestOptions)	(asynchronously) Search for standard and [custom](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/) entries in the [stop words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plurals](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), or [segmentation (compounds)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) dictionaries.
SearchForFacetValuesResponse	searchForFacetValues(String indexName, String facetName)	[Search for a facet's values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values), optionally restricting the returned values to those contained in records matching other search criteria.
SearchForFacetValuesResponse	searchForFacetValues(String indexName, String facetName, RequestOptions requestOptions)	[Search for a facet's values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values), optionally restricting the returned values to those contained in records matching other search criteria.
SearchForFacetValuesResponse	searchForFacetValues(String indexName, String facetName, SearchForFacetValuesRequest searchForFacetValuesRequest)	[Search for a facet's values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values), optionally restricting the returned values to those contained in records matching other search criteria.
SearchForFacetValuesResponse	searchForFacetValues(String indexName, String facetName, SearchForFacetValuesRequest searchForFacetValuesRequest, RequestOptions requestOptions)	[Search for a facet's values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values), optionally restricting the returned values to those contained in records matching other search criteria.
CompletableFuture<SearchForFacetValuesResponse>	searchForFacetValuesAsync(String indexName, String facetName)	(asynchronously) [Search for a facet's values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values), optionally restricting the returned values to those contained in records matching other search criteria.
CompletableFuture<SearchForFacetValuesResponse>	searchForFacetValuesAsync(String indexName, String facetName, RequestOptions requestOptions)	(asynchronously) [Search for a facet's values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values), optionally restricting the returned values to those contained in records matching other search criteria.
CompletableFuture<SearchForFacetValuesResponse>	searchForFacetValuesAsync(String indexName, String facetName, SearchForFacetValuesRequest searchForFacetValuesRequest)	(asynchronously) [Search for a facet's values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values), optionally restricting the returned values to those contained in records matching other search criteria.
CompletableFuture<SearchForFacetValuesResponse>	searchForFacetValuesAsync(String indexName, String facetName, SearchForFacetValuesRequest searchForFacetValuesRequest, RequestOptions requestOptions)	(asynchronously) [Search for a facet's values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values), optionally restricting the returned values to those contained in records matching other search criteria.
SearchRulesResponse	searchRules(String indexName)	Search for rules in your index.
SearchRulesResponse	searchRules(String indexName, RequestOptions requestOptions)	Search for rules in your index.
SearchRulesResponse	searchRules(String indexName, SearchRulesParams searchRulesParams)	Search for rules in your index.
SearchRulesResponse	searchRules(String indexName, SearchRulesParams searchRulesParams, RequestOptions requestOptions)	Search for rules in your index.
CompletableFuture<SearchRulesResponse>	searchRulesAsync(String indexName)	(asynchronously) Search for rules in your index.
CompletableFuture<SearchRulesResponse>	searchRulesAsync(String indexName, RequestOptions requestOptions)	(asynchronously) Search for rules in your index.
CompletableFuture<SearchRulesResponse>	searchRulesAsync(String indexName, SearchRulesParams searchRulesParams)	(asynchronously) Search for rules in your index.
CompletableFuture<SearchRulesResponse>	searchRulesAsync(String indexName, SearchRulesParams searchRulesParams, RequestOptions requestOptions)	(asynchronously) Search for rules in your index.
<T> SearchResponse<T>	searchSingleIndex(String indexName, SearchParams searchParams, Class<T> innerType)	Return records that match the query.
<T> SearchResponse<T>	searchSingleIndex(String indexName, SearchParams searchParams, Class<T> innerType, RequestOptions requestOptions)	Return records that match the query.
<T> SearchResponse<T>	searchSingleIndex(String indexName, Class<T> innerType)	Return records that match the query.
<T> SearchResponse<T>	searchSingleIndex(String indexName, Class<T> innerType, RequestOptions requestOptions)	Return records that match the query.
<T> CompletableFuture<SearchResponse<T>>	searchSingleIndexAsync(String indexName, SearchParams searchParams, Class<T> innerType)	(asynchronously) Return records that match the query.
<T> CompletableFuture<SearchResponse<T>>	searchSingleIndexAsync(String indexName, SearchParams searchParams, Class<T> innerType, RequestOptions requestOptions)	(asynchronously) Return records that match the query.
<T> CompletableFuture<SearchResponse<T>>	searchSingleIndexAsync(String indexName, Class<T> innerType)	(asynchronously) Return records that match the query.
<T> CompletableFuture<SearchResponse<T>>	searchSingleIndexAsync(String indexName, Class<T> innerType, RequestOptions requestOptions)	(asynchronously) Return records that match the query.
SearchSynonymsResponse	searchSynonyms(String indexName)	Search for synonyms in your index.
SearchSynonymsResponse	searchSynonyms(String indexName, RequestOptions requestOptions)	Search for synonyms in your index.
SearchSynonymsResponse	searchSynonyms(String indexName, SynonymType type, Integer page, Integer hitsPerPage, SearchSynonymsParams searchSynonymsParams)	Search for synonyms in your index.
SearchSynonymsResponse	searchSynonyms(String indexName, SynonymType type, Integer page, Integer hitsPerPage, SearchSynonymsParams searchSynonymsParams, RequestOptions requestOptions)	Search for synonyms in your index.
CompletableFuture<SearchSynonymsResponse>	searchSynonymsAsync(String indexName)	(asynchronously) Search for synonyms in your index.
CompletableFuture<SearchSynonymsResponse>	searchSynonymsAsync(String indexName, RequestOptions requestOptions)	(asynchronously) Search for synonyms in your index.
CompletableFuture<SearchSynonymsResponse>	searchSynonymsAsync(String indexName, SynonymType type, Integer page, Integer hitsPerPage, SearchSynonymsParams searchSynonymsParams)	(asynchronously) Search for synonyms in your index.
CompletableFuture<SearchSynonymsResponse>	searchSynonymsAsync(String indexName, SynonymType type, Integer page, Integer hitsPerPage, SearchSynonymsParams searchSynonymsParams, RequestOptions requestOptions)	(asynchronously) Search for synonyms in your index.
SearchUserIdsResponse	searchUserIds(SearchUserIdsParams searchUserIdsParams)	Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time.
SearchUserIdsResponse	searchUserIds(SearchUserIdsParams searchUserIdsParams, RequestOptions requestOptions)	Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time.
CompletableFuture<SearchUserIdsResponse>	searchUserIdsAsync(SearchUserIdsParams searchUserIdsParams)	(asynchronously) Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time.
CompletableFuture<SearchUserIdsResponse>	searchUserIdsAsync(SearchUserIdsParams searchUserIdsParams, RequestOptions requestOptions)	(asynchronously) Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time.
UpdatedAtResponse	setDictionarySettings(DictionarySettingsParams dictionarySettingsParams)	Set stop word settings for a specific language.
UpdatedAtResponse	setDictionarySettings(DictionarySettingsParams dictionarySettingsParams, RequestOptions requestOptions)	Set stop word settings for a specific language.
CompletableFuture<UpdatedAtResponse>	setDictionarySettingsAsync(DictionarySettingsParams dictionarySettingsParams)	(asynchronously) Set stop word settings for a specific language.
CompletableFuture<UpdatedAtResponse>	setDictionarySettingsAsync(DictionarySettingsParams dictionarySettingsParams, RequestOptions requestOptions)	(asynchronously) Set stop word settings for a specific language.
UpdatedAtResponse	setSettings(String indexName, IndexSettings indexSettings)	Update the specified [index settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/).
UpdatedAtResponse	setSettings(String indexName, IndexSettings indexSettings, RequestOptions requestOptions)	Update the specified [index settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/).
UpdatedAtResponse	setSettings(String indexName, IndexSettings indexSettings, Boolean forwardToReplicas)	Update the specified [index settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/).
UpdatedAtResponse	setSettings(String indexName, IndexSettings indexSettings, Boolean forwardToReplicas, RequestOptions requestOptions)	Update the specified [index settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/).
CompletableFuture<UpdatedAtResponse>	setSettingsAsync(String indexName, IndexSettings indexSettings)	(asynchronously) Update the specified [index settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/).
CompletableFuture<UpdatedAtResponse>	setSettingsAsync(String indexName, IndexSettings indexSettings, RequestOptions requestOptions)	(asynchronously) Update the specified [index settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/).
CompletableFuture<UpdatedAtResponse>	setSettingsAsync(String indexName, IndexSettings indexSettings, Boolean forwardToReplicas)	(asynchronously) Update the specified [index settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/).
CompletableFuture<UpdatedAtResponse>	setSettingsAsync(String indexName, IndexSettings indexSettings, Boolean forwardToReplicas, RequestOptions requestOptions)	(asynchronously) Update the specified [index settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/).
UpdateApiKeyResponse	updateApiKey(String key, ApiKey apiKey)	Replace the permissions of an existing API key.
UpdateApiKeyResponse	updateApiKey(String key, ApiKey apiKey, RequestOptions requestOptions)	Replace the permissions of an existing API key.
CompletableFuture<UpdateApiKeyResponse>	updateApiKeyAsync(String key, ApiKey apiKey)	(asynchronously) Replace the permissions of an existing API key.
CompletableFuture<UpdateApiKeyResponse>	updateApiKeyAsync(String key, ApiKey apiKey, RequestOptions requestOptions)	(asynchronously) Replace the permissions of an existing API key.
GetApiKeyResponse	waitForApiKey(ApiKeyOperation operation, String key)	Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
GetApiKeyResponse	waitForApiKey(ApiKeyOperation operation, String key, int maxRetries, IntUnaryOperator timeout)	Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
GetApiKeyResponse	waitForApiKey(ApiKeyOperation operation, String key, int maxRetries, IntUnaryOperator timeout, RequestOptions requestOptions)	Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
GetApiKeyResponse	waitForApiKey(ApiKeyOperation operation, String key, RequestOptions requestOptions)	Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
GetApiKeyResponse	waitForApiKey(ApiKeyOperation operation, String key, ApiKey apiKey)	Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
GetApiKeyResponse	waitForApiKey(ApiKeyOperation operation, String key, ApiKey apiKey, int maxRetries, IntUnaryOperator timeout)	Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
GetApiKeyResponse	waitForApiKey(ApiKeyOperation operation, String key, ApiKey apiKey, int maxRetries, IntUnaryOperator timeout, RequestOptions requestOptions)	Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
GetApiKeyResponse	waitForApiKey(ApiKeyOperation operation, String key, ApiKey apiKey, RequestOptions requestOptions)	Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
void	waitForTask(String indexName, Long taskID)	Helper: Wait for a task to complete with `indexName` and `taskID`.
void	waitForTask(String indexName, Long taskID, int maxRetries, IntUnaryOperator timeout)	Helper: Wait for a task to complete with `indexName` and `taskID`.
void	waitForTask(String indexName, Long taskID, int maxRetries, IntUnaryOperator timeout, RequestOptions requestOptions)	Helper: Wait for a task to complete with `indexName` and `taskID`.
void	waitForTask(String indexName, Long taskID, RequestOptions requestOptions)	Helper: Wait for a task to complete with `indexName` and `taskID`.

Methods inherited from class com.algolia.ApiClient

close, executeAsync, executeAsync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SearchClient

public SearchClient(String appId,
 String apiKey)

SearchClient

public SearchClient(String appId,
 String apiKey,
 ClientOptions options)

Method Details

addApiKey

public AddApiKeyResponse addApiKey(@Nonnull
 ApiKey apiKey,
 RequestOptions requestOptions)
                            throws AlgoliaRuntimeException

Add a new API key with specific permissions and restrictions. The request must be authenticated with the admin API key. The response returns an API key string.

Parameters:

apiKey - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

addApiKey

public AddApiKeyResponse addApiKey(@Nonnull
 ApiKey apiKey)
                            throws AlgoliaRuntimeException

Add a new API key with specific permissions and restrictions. The request must be authenticated with the admin API key. The response returns an API key string.

Parameters:

apiKey - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

addApiKeyAsync

public CompletableFuture<AddApiKeyResponse> addApiKeyAsync(@Nonnull
 ApiKey apiKey,
 RequestOptions requestOptions)
                                                    throws AlgoliaRuntimeException

(asynchronously) Add a new API key with specific permissions and restrictions. The request must be authenticated with the admin API key. The response returns an API key string.

Parameters:

apiKey - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

addApiKeyAsync

public CompletableFuture<AddApiKeyResponse> addApiKeyAsync(@Nonnull
 ApiKey apiKey)
                                                    throws AlgoliaRuntimeException

(asynchronously) Add a new API key with specific permissions and restrictions. The request must be authenticated with the admin API key. The response returns an API key string.

Parameters:

apiKey - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

addOrUpdateObject

public UpdatedAtWithObjectIdResponse addOrUpdateObject(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Object body,
 RequestOptions requestOptions)
                                                throws AlgoliaRuntimeException

If you use an existing `objectID`, the existing record will be replaced with the new one. To update only some attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add multiple records to your index in a single API request, use the [`batch` operation](#tag/Records/operation/batch).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique record (object) identifier. (required)

body - Algolia record. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

addOrUpdateObject

public UpdatedAtWithObjectIdResponse addOrUpdateObject(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Object body)
                                                throws AlgoliaRuntimeException

If you use an existing `objectID`, the existing record will be replaced with the new one. To update only some attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add multiple records to your index in a single API request, use the [`batch` operation](#tag/Records/operation/batch).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique record (object) identifier. (required)

body - Algolia record. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

addOrUpdateObjectAsync

public CompletableFuture<UpdatedAtWithObjectIdResponse> addOrUpdateObjectAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Object body,
 RequestOptions requestOptions)
                                                                        throws AlgoliaRuntimeException

(asynchronously) If you use an existing `objectID`, the existing record will be replaced with the new one. To update only some attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add multiple records to your index in a single API request, use the [`batch` operation](#tag/Records/operation/batch).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique record (object) identifier. (required)

body - Algolia record. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

addOrUpdateObjectAsync

public CompletableFuture<UpdatedAtWithObjectIdResponse> addOrUpdateObjectAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Object body)
                                                                        throws AlgoliaRuntimeException

(asynchronously) If you use an existing `objectID`, the existing record will be replaced with the new one. To update only some attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add multiple records to your index in a single API request, use the [`batch` operation](#tag/Records/operation/batch).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique record (object) identifier. (required)

body - Algolia record. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

appendSource

public CreatedAtResponse appendSource(@Nonnull
 Source source,
 RequestOptions requestOptions)
                               throws AlgoliaRuntimeException

Add a source to the list of allowed sources.

Parameters:

source - Source to add. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

appendSource

public CreatedAtResponse appendSource(@Nonnull
 Source source)
                               throws AlgoliaRuntimeException

Add a source to the list of allowed sources.

Parameters:

source - Source to add. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

appendSourceAsync

public CompletableFuture<CreatedAtResponse> appendSourceAsync(@Nonnull
 Source source,
 RequestOptions requestOptions)
                                                       throws AlgoliaRuntimeException

(asynchronously) Add a source to the list of allowed sources.

Parameters:

source - Source to add. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

appendSourceAsync

public CompletableFuture<CreatedAtResponse> appendSourceAsync(@Nonnull
 Source source)
                                                       throws AlgoliaRuntimeException

(asynchronously) Add a source to the list of allowed sources.

Parameters:

source - Source to add. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

assignUserId

public CreatedAtResponse assignUserId(@Nonnull
 String xAlgoliaUserID,
 @Nonnull
 AssignUserIdParams assignUserIdParams,
 RequestOptions requestOptions)
                               throws AlgoliaRuntimeException

Assign or move a user ID to a cluster. The time it takes to move a user is proportional to the amount of data linked to the user ID.

Parameters:

xAlgoliaUserID - userID to assign. (required)

assignUserIdParams - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

assignUserId

public CreatedAtResponse assignUserId(@Nonnull
 String xAlgoliaUserID,
 @Nonnull
 AssignUserIdParams assignUserIdParams)
                               throws AlgoliaRuntimeException

Assign or move a user ID to a cluster. The time it takes to move a user is proportional to the amount of data linked to the user ID.

Parameters:

xAlgoliaUserID - userID to assign. (required)

assignUserIdParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

assignUserIdAsync

public CompletableFuture<CreatedAtResponse> assignUserIdAsync(@Nonnull
 String xAlgoliaUserID,
 @Nonnull
 AssignUserIdParams assignUserIdParams,
 RequestOptions requestOptions)
                                                       throws AlgoliaRuntimeException

(asynchronously) Assign or move a user ID to a cluster. The time it takes to move a user is proportional to the amount of data linked to the user ID.

Parameters:

xAlgoliaUserID - userID to assign. (required)

assignUserIdParams - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

assignUserIdAsync

public CompletableFuture<CreatedAtResponse> assignUserIdAsync(@Nonnull
 String xAlgoliaUserID,
 @Nonnull
 AssignUserIdParams assignUserIdParams)
                                                       throws AlgoliaRuntimeException

(asynchronously) Assign or move a user ID to a cluster. The time it takes to move a user is proportional to the amount of data linked to the user ID.

Parameters:

xAlgoliaUserID - userID to assign. (required)

assignUserIdParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batch

public BatchResponse batch(@Nonnull
 String indexName,
 @Nonnull
 BatchWriteParams batchWriteParams,
 RequestOptions requestOptions)
                    throws AlgoliaRuntimeException

To reduce the time spent on network round trips, you can perform several write actions in a single API call. Actions are applied in the order they are specified. The supported `action`s are equivalent to the individual operations of the same name.

Parameters:

indexName - Index on which to perform the request. (required)

batchWriteParams - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batch

public BatchResponse batch(@Nonnull
 String indexName,
 @Nonnull
 BatchWriteParams batchWriteParams)
                    throws AlgoliaRuntimeException

To reduce the time spent on network round trips, you can perform several write actions in a single API call. Actions are applied in the order they are specified. The supported `action`s are equivalent to the individual operations of the same name.

Parameters:

indexName - Index on which to perform the request. (required)

batchWriteParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchAsync

public CompletableFuture<BatchResponse> batchAsync(@Nonnull
 String indexName,
 @Nonnull
 BatchWriteParams batchWriteParams,
 RequestOptions requestOptions)
                                            throws AlgoliaRuntimeException

(asynchronously) To reduce the time spent on network round trips, you can perform several write actions in a single API call. Actions are applied in the order they are specified. The supported `action`s are equivalent to the individual operations of the same name.

Parameters:

indexName - Index on which to perform the request. (required)

batchWriteParams - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchAsync

public CompletableFuture<BatchResponse> batchAsync(@Nonnull
 String indexName,
 @Nonnull
 BatchWriteParams batchWriteParams)
                                            throws AlgoliaRuntimeException

(asynchronously) To reduce the time spent on network round trips, you can perform several write actions in a single API call. Actions are applied in the order they are specified. The supported `action`s are equivalent to the individual operations of the same name.

Parameters:

indexName - Index on which to perform the request. (required)

batchWriteParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchAssignUserIds

public CreatedAtResponse batchAssignUserIds(@Nonnull
 String xAlgoliaUserID,
 @Nonnull
 BatchAssignUserIdsParams batchAssignUserIdsParams,
 RequestOptions requestOptions)
                                     throws AlgoliaRuntimeException

Assign multiple user IDs to a cluster. **You can't _move_ users with this operation.**.

Parameters:

xAlgoliaUserID - userID to assign. (required)

batchAssignUserIdsParams - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchAssignUserIds

public CreatedAtResponse batchAssignUserIds(@Nonnull
 String xAlgoliaUserID,
 @Nonnull
 BatchAssignUserIdsParams batchAssignUserIdsParams)
                                     throws AlgoliaRuntimeException

Assign multiple user IDs to a cluster. **You can't _move_ users with this operation.**.

Parameters:

xAlgoliaUserID - userID to assign. (required)

batchAssignUserIdsParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchAssignUserIdsAsync

public CompletableFuture<CreatedAtResponse> batchAssignUserIdsAsync(@Nonnull
 String xAlgoliaUserID,
 @Nonnull
 BatchAssignUserIdsParams batchAssignUserIdsParams,
 RequestOptions requestOptions)
                                                             throws AlgoliaRuntimeException

(asynchronously) Assign multiple user IDs to a cluster. **You can't _move_ users with this operation.**.

Parameters:

xAlgoliaUserID - userID to assign. (required)

batchAssignUserIdsParams - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchAssignUserIdsAsync

public CompletableFuture<CreatedAtResponse> batchAssignUserIdsAsync(@Nonnull
 String xAlgoliaUserID,
 @Nonnull
 BatchAssignUserIdsParams batchAssignUserIdsParams)
                                                             throws AlgoliaRuntimeException

(asynchronously) Assign multiple user IDs to a cluster. **You can't _move_ users with this operation.**.

Parameters:

xAlgoliaUserID - userID to assign. (required)

batchAssignUserIdsParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchDictionaryEntries

public UpdatedAtResponse batchDictionaryEntries(@Nonnull
 DictionaryType dictionaryName,
 @Nonnull
 BatchDictionaryEntriesParams batchDictionaryEntriesParams,
 RequestOptions requestOptions)
                                         throws AlgoliaRuntimeException

Add or remove a batch of dictionary entries.

Parameters:

dictionaryName - Dictionary to search in. (required)

batchDictionaryEntriesParams - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchDictionaryEntries

public UpdatedAtResponse batchDictionaryEntries(@Nonnull
 DictionaryType dictionaryName,
 @Nonnull
 BatchDictionaryEntriesParams batchDictionaryEntriesParams)
                                         throws AlgoliaRuntimeException

Add or remove a batch of dictionary entries.

Parameters:

dictionaryName - Dictionary to search in. (required)

batchDictionaryEntriesParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchDictionaryEntriesAsync

public CompletableFuture<UpdatedAtResponse> batchDictionaryEntriesAsync(@Nonnull
 DictionaryType dictionaryName,
 @Nonnull
 BatchDictionaryEntriesParams batchDictionaryEntriesParams,
 RequestOptions requestOptions)
                                                                 throws AlgoliaRuntimeException

(asynchronously) Add or remove a batch of dictionary entries.

Parameters:

dictionaryName - Dictionary to search in. (required)

batchDictionaryEntriesParams - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchDictionaryEntriesAsync

public CompletableFuture<UpdatedAtResponse> batchDictionaryEntriesAsync(@Nonnull
 DictionaryType dictionaryName,
 @Nonnull
 BatchDictionaryEntriesParams batchDictionaryEntriesParams)
                                                                 throws AlgoliaRuntimeException

(asynchronously) Add or remove a batch of dictionary entries.

Parameters:

dictionaryName - Dictionary to search in. (required)

batchDictionaryEntriesParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

browse

public <T> BrowseResponse<T> browse(@Nonnull
 String indexName,
 BrowseParams browseParams,
 Class<T> innerType,
 RequestOptions requestOptions)
                             throws AlgoliaRuntimeException

Retrieve up to 1,000 records per call. Supports full-text search and filters. For better performance, it doesn't support: - The `distinct` query parameter - Sorting by typos, proximity, words, or geographical distance.

Parameters:

indexName - Index on which to perform the request. (required)

browseParams - (optional)

innerType - The class held by the index, could be your custom class or Object.

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

browse

public <T> BrowseResponse<T> browse(@Nonnull
 String indexName,
 BrowseParams browseParams,
 Class<T> innerType)
                             throws AlgoliaRuntimeException

Retrieve up to 1,000 records per call. Supports full-text search and filters. For better performance, it doesn't support: - The `distinct` query parameter - Sorting by typos, proximity, words, or geographical distance.

Parameters:

indexName - Index on which to perform the request. (required)

browseParams - (optional)

innerType - The class held by the index, could be your custom class or Object.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

browse

public <T> BrowseResponse<T> browse(@Nonnull
 String indexName,
 Class<T> innerType,
 RequestOptions requestOptions)
                             throws AlgoliaRuntimeException

Retrieve up to 1,000 records per call. Supports full-text search and filters. For better performance, it doesn't support: - The `distinct` query parameter - Sorting by typos, proximity, words, or geographical distance.

Parameters:

indexName - Index on which to perform the request. (required)

innerType - The class held by the index, could be your custom class or Object.

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

browse

public <T> BrowseResponse<T> browse(@Nonnull
 String indexName,
 Class<T> innerType)
                             throws AlgoliaRuntimeException

Retrieve up to 1,000 records per call. Supports full-text search and filters. For better performance, it doesn't support: - The `distinct` query parameter - Sorting by typos, proximity, words, or geographical distance.

Parameters:

indexName - Index on which to perform the request. (required)

innerType - The class held by the index, could be your custom class or Object.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

browseAsync

public <T> CompletableFuture<BrowseResponse<T>> browseAsync(@Nonnull
 String indexName,
 BrowseParams browseParams,
 Class<T> innerType,
 RequestOptions requestOptions)
                                                     throws AlgoliaRuntimeException

(asynchronously) Retrieve up to 1,000 records per call. Supports full-text search and filters. For better performance, it doesn't support: - The `distinct` query parameter - Sorting by typos, proximity, words, or geographical distance.

Parameters:

indexName - Index on which to perform the request. (required)

browseParams - (optional)

innerType - The class held by the index, could be your custom class or Object.

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

browseAsync

public <T> CompletableFuture<BrowseResponse<T>> browseAsync(@Nonnull
 String indexName,
 BrowseParams browseParams,
 Class<T> innerType)
                                                     throws AlgoliaRuntimeException

(asynchronously) Retrieve up to 1,000 records per call. Supports full-text search and filters. For better performance, it doesn't support: - The `distinct` query parameter - Sorting by typos, proximity, words, or geographical distance.

Parameters:

indexName - Index on which to perform the request. (required)

browseParams - (optional)

innerType - The class held by the index, could be your custom class or Object.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

browseAsync

public <T> CompletableFuture<BrowseResponse<T>> browseAsync(@Nonnull
 String indexName,
 Class<T> innerType,
 RequestOptions requestOptions)
                                                     throws AlgoliaRuntimeException

(asynchronously) Retrieve up to 1,000 records per call. Supports full-text search and filters. For better performance, it doesn't support: - The `distinct` query parameter - Sorting by typos, proximity, words, or geographical distance.

Parameters:

indexName - Index on which to perform the request. (required)

innerType - The class held by the index, could be your custom class or Object.

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

browseAsync

public <T> CompletableFuture<BrowseResponse<T>> browseAsync(@Nonnull
 String indexName,
 Class<T> innerType)
                                                     throws AlgoliaRuntimeException

(asynchronously) Retrieve up to 1,000 records per call. Supports full-text search and filters. For better performance, it doesn't support: - The `distinct` query parameter - Sorting by typos, proximity, words, or geographical distance.

Parameters:

indexName - Index on which to perform the request. (required)

innerType - The class held by the index, could be your custom class or Object.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearAllSynonyms

public UpdatedAtResponse clearAllSynonyms(@Nonnull
 String indexName,
 Boolean forwardToReplicas,
 RequestOptions requestOptions)
                                   throws AlgoliaRuntimeException

Delete all synonyms in the index.

Parameters:

indexName - Index on which to perform the request. (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearAllSynonyms

public UpdatedAtResponse clearAllSynonyms(@Nonnull
 String indexName,
 Boolean forwardToReplicas)
                                   throws AlgoliaRuntimeException

Delete all synonyms in the index.

Parameters:

indexName - Index on which to perform the request. (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearAllSynonyms

public UpdatedAtResponse clearAllSynonyms(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                                   throws AlgoliaRuntimeException

Delete all synonyms in the index.

Parameters:

indexName - Index on which to perform the request. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearAllSynonyms

public UpdatedAtResponse clearAllSynonyms(@Nonnull
 String indexName)
                                   throws AlgoliaRuntimeException

Delete all synonyms in the index.

Parameters:

indexName - Index on which to perform the request. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearAllSynonymsAsync

public CompletableFuture<UpdatedAtResponse> clearAllSynonymsAsync(@Nonnull
 String indexName,
 Boolean forwardToReplicas,
 RequestOptions requestOptions)
                                                           throws AlgoliaRuntimeException

(asynchronously) Delete all synonyms in the index.

Parameters:

indexName - Index on which to perform the request. (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearAllSynonymsAsync

public CompletableFuture<UpdatedAtResponse> clearAllSynonymsAsync(@Nonnull
 String indexName,
 Boolean forwardToReplicas)
                                                           throws AlgoliaRuntimeException

(asynchronously) Delete all synonyms in the index.

Parameters:

indexName - Index on which to perform the request. (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearAllSynonymsAsync

public CompletableFuture<UpdatedAtResponse> clearAllSynonymsAsync(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                                                           throws AlgoliaRuntimeException

(asynchronously) Delete all synonyms in the index.

Parameters:

indexName - Index on which to perform the request. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearAllSynonymsAsync

public CompletableFuture<UpdatedAtResponse> clearAllSynonymsAsync(@Nonnull
 String indexName)
                                                           throws AlgoliaRuntimeException

(asynchronously) Delete all synonyms in the index.

Parameters:

indexName - Index on which to perform the request. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearObjects

public UpdatedAtResponse clearObjects(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                               throws AlgoliaRuntimeException

Delete the records but leave settings and index-specific API keys untouched.

Parameters:

indexName - Index on which to perform the request. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearObjects

public UpdatedAtResponse clearObjects(@Nonnull
 String indexName)
                               throws AlgoliaRuntimeException

Delete the records but leave settings and index-specific API keys untouched.

Parameters:

indexName - Index on which to perform the request. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearObjectsAsync

public CompletableFuture<UpdatedAtResponse> clearObjectsAsync(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                                                       throws AlgoliaRuntimeException

(asynchronously) Delete the records but leave settings and index-specific API keys untouched.

Parameters:

indexName - Index on which to perform the request. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearObjectsAsync

public CompletableFuture<UpdatedAtResponse> clearObjectsAsync(@Nonnull
 String indexName)
                                                       throws AlgoliaRuntimeException

(asynchronously) Delete the records but leave settings and index-specific API keys untouched.

Parameters:

indexName - Index on which to perform the request. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearRules

public UpdatedAtResponse clearRules(@Nonnull
 String indexName,
 Boolean forwardToReplicas,
 RequestOptions requestOptions)
                             throws AlgoliaRuntimeException

Delete all rules in the index.

Parameters:

indexName - Index on which to perform the request. (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearRules

public UpdatedAtResponse clearRules(@Nonnull
 String indexName,
 Boolean forwardToReplicas)
                             throws AlgoliaRuntimeException

Delete all rules in the index.

Parameters:

indexName - Index on which to perform the request. (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearRules

public UpdatedAtResponse clearRules(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                             throws AlgoliaRuntimeException

Delete all rules in the index.

Parameters:

indexName - Index on which to perform the request. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearRules

public UpdatedAtResponse clearRules(@Nonnull
 String indexName)
                             throws AlgoliaRuntimeException

Delete all rules in the index.

Parameters:

indexName - Index on which to perform the request. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearRulesAsync

public CompletableFuture<UpdatedAtResponse> clearRulesAsync(@Nonnull
 String indexName,
 Boolean forwardToReplicas,
 RequestOptions requestOptions)
                                                     throws AlgoliaRuntimeException

(asynchronously) Delete all rules in the index.

Parameters:

indexName - Index on which to perform the request. (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearRulesAsync

public CompletableFuture<UpdatedAtResponse> clearRulesAsync(@Nonnull
 String indexName,
 Boolean forwardToReplicas)
                                                     throws AlgoliaRuntimeException

(asynchronously) Delete all rules in the index.

Parameters:

indexName - Index on which to perform the request. (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearRulesAsync

public CompletableFuture<UpdatedAtResponse> clearRulesAsync(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                                                     throws AlgoliaRuntimeException

(asynchronously) Delete all rules in the index.

Parameters:

indexName - Index on which to perform the request. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearRulesAsync

public CompletableFuture<UpdatedAtResponse> clearRulesAsync(@Nonnull
 String indexName)
                                                     throws AlgoliaRuntimeException

(asynchronously) Delete all rules in the index.

Parameters:

indexName - Index on which to perform the request. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

del

public Object del(@Nonnull
 String path,
 Map<String,Object> parameters,
 RequestOptions requestOptions)
           throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

del

public Object del(@Nonnull
 String path,
 Map<String,Object> parameters)
           throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

del

public Object del(@Nonnull
 String path,
 RequestOptions requestOptions)
           throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

del

public Object del(@Nonnull
 String path)
           throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

delAsync

public CompletableFuture<Object> delAsync(@Nonnull
 String path,
 Map<String,Object> parameters,
 RequestOptions requestOptions)
                                   throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

delAsync

public CompletableFuture<Object> delAsync(@Nonnull
 String path,
 Map<String,Object> parameters)
                                   throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

delAsync

public CompletableFuture<Object> delAsync(@Nonnull
 String path,
 RequestOptions requestOptions)
                                   throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

delAsync

public CompletableFuture<Object> delAsync(@Nonnull
 String path)
                                   throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteApiKey

public DeleteApiKeyResponse deleteApiKey(@Nonnull
 String key,
 RequestOptions requestOptions)
                                  throws AlgoliaRuntimeException

Delete an existing API key. The request must be authenticated with the admin API key.

Parameters:

key - API key. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteApiKey

public DeleteApiKeyResponse deleteApiKey(@Nonnull
 String key)
                                  throws AlgoliaRuntimeException

Delete an existing API key. The request must be authenticated with the admin API key.

Parameters:

key - API key. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteApiKeyAsync

public CompletableFuture<DeleteApiKeyResponse> deleteApiKeyAsync(@Nonnull
 String key,
 RequestOptions requestOptions)
                                                          throws AlgoliaRuntimeException

(asynchronously) Delete an existing API key. The request must be authenticated with the admin API key.

Parameters:

key - API key. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteApiKeyAsync

public CompletableFuture<DeleteApiKeyResponse> deleteApiKeyAsync(@Nonnull
 String key)
                                                          throws AlgoliaRuntimeException

(asynchronously) Delete an existing API key. The request must be authenticated with the admin API key.

Parameters:

key - API key. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteBy

public DeletedAtResponse deleteBy(@Nonnull
 String indexName,
 @Nonnull
 DeleteByParams deleteByParams,
 RequestOptions requestOptions)
                           throws AlgoliaRuntimeException

This operation doesn't support all the query options, only its filters (numeric, facet, or tag) and geo queries. It doesn't accept empty filters or queries.

Parameters:

indexName - Index on which to perform the request. (required)

deleteByParams - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteBy

public DeletedAtResponse deleteBy(@Nonnull
 String indexName,
 @Nonnull
 DeleteByParams deleteByParams)
                           throws AlgoliaRuntimeException

This operation doesn't support all the query options, only its filters (numeric, facet, or tag) and geo queries. It doesn't accept empty filters or queries.

Parameters:

indexName - Index on which to perform the request. (required)

deleteByParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteByAsync

public CompletableFuture<DeletedAtResponse> deleteByAsync(@Nonnull
 String indexName,
 @Nonnull
 DeleteByParams deleteByParams,
 RequestOptions requestOptions)
                                                   throws AlgoliaRuntimeException

(asynchronously) This operation doesn't support all the query options, only its filters (numeric, facet, or tag) and geo queries. It doesn't accept empty filters or queries.

Parameters:

indexName - Index on which to perform the request. (required)

deleteByParams - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteByAsync

public CompletableFuture<DeletedAtResponse> deleteByAsync(@Nonnull
 String indexName,
 @Nonnull
 DeleteByParams deleteByParams)
                                                   throws AlgoliaRuntimeException

(asynchronously) This operation doesn't support all the query options, only its filters (numeric, facet, or tag) and geo queries. It doesn't accept empty filters or queries.

Parameters:

indexName - Index on which to perform the request. (required)

deleteByParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteIndex

public DeletedAtResponse deleteIndex(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                              throws AlgoliaRuntimeException

Delete an existing index.

Parameters:

indexName - Index on which to perform the request. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteIndex

public DeletedAtResponse deleteIndex(@Nonnull
 String indexName)
                              throws AlgoliaRuntimeException

Delete an existing index.

Parameters:

indexName - Index on which to perform the request. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteIndexAsync

public CompletableFuture<DeletedAtResponse> deleteIndexAsync(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                                                      throws AlgoliaRuntimeException

(asynchronously) Delete an existing index.

Parameters:

indexName - Index on which to perform the request. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteIndexAsync

public CompletableFuture<DeletedAtResponse> deleteIndexAsync(@Nonnull
 String indexName)
                                                      throws AlgoliaRuntimeException

(asynchronously) Delete an existing index.

Parameters:

indexName - Index on which to perform the request. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteObject

public DeletedAtResponse deleteObject(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 RequestOptions requestOptions)
                               throws AlgoliaRuntimeException

To delete a set of records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy) instead.

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique record (object) identifier. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteObject

public DeletedAtResponse deleteObject(@Nonnull
 String indexName,
 @Nonnull
 String objectID)
                               throws AlgoliaRuntimeException

To delete a set of records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy) instead.

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique record (object) identifier. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteObjectAsync

public CompletableFuture<DeletedAtResponse> deleteObjectAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 RequestOptions requestOptions)
                                                       throws AlgoliaRuntimeException

(asynchronously) To delete a set of records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy) instead.

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique record (object) identifier. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteObjectAsync

public CompletableFuture<DeletedAtResponse> deleteObjectAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID)
                                                       throws AlgoliaRuntimeException

(asynchronously) To delete a set of records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy) instead.

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique record (object) identifier. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteRule

public UpdatedAtResponse deleteRule(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 Boolean forwardToReplicas,
 RequestOptions requestOptions)
                             throws AlgoliaRuntimeException

Delete a rule by its `objectID`. To find the `objectID` for rules, use the [`search` operation](#tag/Rules/operation/searchRules).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a rule object. (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteRule

public UpdatedAtResponse deleteRule(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 Boolean forwardToReplicas)
                             throws AlgoliaRuntimeException

Delete a rule by its `objectID`. To find the `objectID` for rules, use the [`search` operation](#tag/Rules/operation/searchRules).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a rule object. (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteRule

public UpdatedAtResponse deleteRule(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 RequestOptions requestOptions)
                             throws AlgoliaRuntimeException

Delete a rule by its `objectID`. To find the `objectID` for rules, use the [`search` operation](#tag/Rules/operation/searchRules).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a rule object. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteRule

public UpdatedAtResponse deleteRule(@Nonnull
 String indexName,
 @Nonnull
 String objectID)
                             throws AlgoliaRuntimeException

Delete a rule by its `objectID`. To find the `objectID` for rules, use the [`search` operation](#tag/Rules/operation/searchRules).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a rule object. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteRuleAsync

public CompletableFuture<UpdatedAtResponse> deleteRuleAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 Boolean forwardToReplicas,
 RequestOptions requestOptions)
                                                     throws AlgoliaRuntimeException

(asynchronously) Delete a rule by its `objectID`. To find the `objectID` for rules, use the [`search` operation](#tag/Rules/operation/searchRules).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a rule object. (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteRuleAsync

public CompletableFuture<UpdatedAtResponse> deleteRuleAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 Boolean forwardToReplicas)
                                                     throws AlgoliaRuntimeException

(asynchronously) Delete a rule by its `objectID`. To find the `objectID` for rules, use the [`search` operation](#tag/Rules/operation/searchRules).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a rule object. (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteRuleAsync

public CompletableFuture<UpdatedAtResponse> deleteRuleAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 RequestOptions requestOptions)
                                                     throws AlgoliaRuntimeException

(asynchronously) Delete a rule by its `objectID`. To find the `objectID` for rules, use the [`search` operation](#tag/Rules/operation/searchRules).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a rule object. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteRuleAsync

public CompletableFuture<UpdatedAtResponse> deleteRuleAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID)
                                                     throws AlgoliaRuntimeException

(asynchronously) Delete a rule by its `objectID`. To find the `objectID` for rules, use the [`search` operation](#tag/Rules/operation/searchRules).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a rule object. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteSource

public DeleteSourceResponse deleteSource(@Nonnull
 String source,
 RequestOptions requestOptions)
                                  throws AlgoliaRuntimeException

Remove a source from the list of allowed sources.

Parameters:

source - IP address range of the source. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteSource

public DeleteSourceResponse deleteSource(@Nonnull
 String source)
                                  throws AlgoliaRuntimeException

Remove a source from the list of allowed sources.

Parameters:

source - IP address range of the source. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteSourceAsync

public CompletableFuture<DeleteSourceResponse> deleteSourceAsync(@Nonnull
 String source,
 RequestOptions requestOptions)
                                                          throws AlgoliaRuntimeException

(asynchronously) Remove a source from the list of allowed sources.

Parameters:

source - IP address range of the source. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteSourceAsync

public CompletableFuture<DeleteSourceResponse> deleteSourceAsync(@Nonnull
 String source)
                                                          throws AlgoliaRuntimeException

(asynchronously) Remove a source from the list of allowed sources.

Parameters:

source - IP address range of the source. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteSynonym

public DeletedAtResponse deleteSynonym(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 Boolean forwardToReplicas,
 RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

Delete a synonym by its `objectID`. To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a synonym object. (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteSynonym

public DeletedAtResponse deleteSynonym(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 Boolean forwardToReplicas)
                                throws AlgoliaRuntimeException

Delete a synonym by its `objectID`. To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a synonym object. (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteSynonym

public DeletedAtResponse deleteSynonym(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

Delete a synonym by its `objectID`. To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a synonym object. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteSynonym

public DeletedAtResponse deleteSynonym(@Nonnull
 String indexName,
 @Nonnull
 String objectID)
                                throws AlgoliaRuntimeException

Delete a synonym by its `objectID`. To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a synonym object. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteSynonymAsync

public CompletableFuture<DeletedAtResponse> deleteSynonymAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 Boolean forwardToReplicas,
 RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

(asynchronously) Delete a synonym by its `objectID`. To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a synonym object. (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteSynonymAsync

public CompletableFuture<DeletedAtResponse> deleteSynonymAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 Boolean forwardToReplicas)
                                                        throws AlgoliaRuntimeException

(asynchronously) Delete a synonym by its `objectID`. To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a synonym object. (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteSynonymAsync

public CompletableFuture<DeletedAtResponse> deleteSynonymAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

(asynchronously) Delete a synonym by its `objectID`. To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a synonym object. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteSynonymAsync

public CompletableFuture<DeletedAtResponse> deleteSynonymAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID)
                                                        throws AlgoliaRuntimeException

(asynchronously) Delete a synonym by its `objectID`. To find the object IDs of your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a synonym object. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

get

public Object get(@Nonnull
 String path,
 Map<String,Object> parameters,
 RequestOptions requestOptions)
           throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

get

public Object get(@Nonnull
 String path,
 Map<String,Object> parameters)
           throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

get

public Object get(@Nonnull
 String path,
 RequestOptions requestOptions)
           throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

get

public Object get(@Nonnull
 String path)
           throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAsync

public CompletableFuture<Object> getAsync(@Nonnull
 String path,
 Map<String,Object> parameters,
 RequestOptions requestOptions)
                                   throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAsync

public CompletableFuture<Object> getAsync(@Nonnull
 String path,
 Map<String,Object> parameters)
                                   throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAsync

public CompletableFuture<Object> getAsync(@Nonnull
 String path,
 RequestOptions requestOptions)
                                   throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getAsync

public CompletableFuture<Object> getAsync(@Nonnull
 String path)
                                   throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getApiKey

public GetApiKeyResponse getApiKey(@Nonnull
 String key,
 RequestOptions requestOptions)
                            throws AlgoliaRuntimeException

Get the permissions and restrictions of a specific API key. When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key.

Parameters:

key - API key. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getApiKey

public GetApiKeyResponse getApiKey(@Nonnull
 String key)
                            throws AlgoliaRuntimeException

Get the permissions and restrictions of a specific API key. When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key.

Parameters:

key - API key. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getApiKeyAsync

public CompletableFuture<GetApiKeyResponse> getApiKeyAsync(@Nonnull
 String key,
 RequestOptions requestOptions)
                                                    throws AlgoliaRuntimeException

(asynchronously) Get the permissions and restrictions of a specific API key. When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key.

Parameters:

key - API key. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getApiKeyAsync

public CompletableFuture<GetApiKeyResponse> getApiKeyAsync(@Nonnull
 String key)
                                                    throws AlgoliaRuntimeException

(asynchronously) Get the permissions and restrictions of a specific API key. When authenticating with the admin API key, you can request information for any of your application's keys. When authenticating with other API keys, you can only retrieve information for that key.

Parameters:

key - API key. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getDictionaryLanguages

public Map<String,Languages> getDictionaryLanguages(RequestOptions requestOptions)
                                             throws AlgoliaRuntimeException

Lists Algolia's [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) and any customizations applied to each language's [stop word](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plural](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), and [segmentation (compound)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) features.

Parameters:

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getDictionaryLanguages

public Map<String,Languages> getDictionaryLanguages()
                                             throws AlgoliaRuntimeException

Lists Algolia's [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) and any customizations applied to each language's [stop word](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plural](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), and [segmentation (compound)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) features.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getDictionaryLanguagesAsync

public CompletableFuture<Map<String,Languages>> getDictionaryLanguagesAsync(RequestOptions requestOptions)
                                                                     throws AlgoliaRuntimeException

(asynchronously) Lists Algolia's [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) and any customizations applied to each language's [stop word](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plural](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), and [segmentation (compound)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) features.

Parameters:

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getDictionaryLanguagesAsync

public CompletableFuture<Map<String,Languages>> getDictionaryLanguagesAsync()
                                                                     throws AlgoliaRuntimeException

(asynchronously) Lists Algolia's [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) and any customizations applied to each language's [stop word](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plural](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), and [segmentation (compound)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) features.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getDictionarySettings

public GetDictionarySettingsResponse getDictionarySettings(RequestOptions requestOptions)
                                                    throws AlgoliaRuntimeException

Get the languages for which [stop words are turned off](#tag/Dictionaries/operation/setDictionarySettings).

Parameters:

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getDictionarySettings

public GetDictionarySettingsResponse getDictionarySettings()
                                                    throws AlgoliaRuntimeException

Get the languages for which [stop words are turned off](#tag/Dictionaries/operation/setDictionarySettings).

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getDictionarySettingsAsync

public CompletableFuture<GetDictionarySettingsResponse> getDictionarySettingsAsync(RequestOptions requestOptions)
                                                                            throws AlgoliaRuntimeException

(asynchronously) Get the languages for which [stop words are turned off](#tag/Dictionaries/operation/setDictionarySettings).

Parameters:

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getDictionarySettingsAsync

public CompletableFuture<GetDictionarySettingsResponse> getDictionarySettingsAsync()
                                                                            throws AlgoliaRuntimeException

(asynchronously) Get the languages for which [stop words are turned off](#tag/Dictionaries/operation/setDictionarySettings).

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getLogs

public GetLogsResponse getLogs(Integer offset,
 Integer length,
 String indexName,
 LogType type,
 RequestOptions requestOptions)
                        throws AlgoliaRuntimeException

The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). Logs are held for the last seven days. There's also a logging limit of 1,000 API calls per server. This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself. > **Note**: To fetch the logs for a Distributed Search Network (DSN) cluster, target the [DSN's endpoint](https://www.algolia.com/doc/guides/scaling/distributed-search-network-dsn/#accessing-dsn-servers).

Parameters:

offset - First log entry to retrieve. Sorted by decreasing date with 0 being the most recent. (optional, default to 0)

length - Maximum number of entries to retrieve. (optional, default to 10)

indexName - Index for which log entries should be retrieved. When omitted, log entries are retrieved for all indices. (optional)

type - Type of log entries to retrieve. When omitted, all log entries are retrieved. (optional, default to all)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getLogs

public GetLogsResponse getLogs(Integer offset,
 Integer length,
 String indexName,
 LogType type)
                        throws AlgoliaRuntimeException

The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). Logs are held for the last seven days. There's also a logging limit of 1,000 API calls per server. This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself. > **Note**: To fetch the logs for a Distributed Search Network (DSN) cluster, target the [DSN's endpoint](https://www.algolia.com/doc/guides/scaling/distributed-search-network-dsn/#accessing-dsn-servers).

Parameters:

offset - First log entry to retrieve. Sorted by decreasing date with 0 being the most recent. (optional, default to 0)

length - Maximum number of entries to retrieve. (optional, default to 10)

indexName - Index for which log entries should be retrieved. When omitted, log entries are retrieved for all indices. (optional)

type - Type of log entries to retrieve. When omitted, all log entries are retrieved. (optional, default to all)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getLogs

public GetLogsResponse getLogs(RequestOptions requestOptions)
                        throws AlgoliaRuntimeException

The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). Logs are held for the last seven days. There's also a logging limit of 1,000 API calls per server. This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself. > **Note**: To fetch the logs for a Distributed Search Network (DSN) cluster, target the [DSN's endpoint](https://www.algolia.com/doc/guides/scaling/distributed-search-network-dsn/#accessing-dsn-servers).

Parameters:

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getLogs

public GetLogsResponse getLogs()
                        throws AlgoliaRuntimeException

The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). Logs are held for the last seven days. There's also a logging limit of 1,000 API calls per server. This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself. > **Note**: To fetch the logs for a Distributed Search Network (DSN) cluster, target the [DSN's endpoint](https://www.algolia.com/doc/guides/scaling/distributed-search-network-dsn/#accessing-dsn-servers).

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getLogsAsync

public CompletableFuture<GetLogsResponse> getLogsAsync(Integer offset,
 Integer length,
 String indexName,
 LogType type,
 RequestOptions requestOptions)
                                                throws AlgoliaRuntimeException

(asynchronously) The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). Logs are held for the last seven days. There's also a logging limit of 1,000 API calls per server. This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself. > **Note**: To fetch the logs for a Distributed Search Network (DSN) cluster, target the [DSN's endpoint](https://www.algolia.com/doc/guides/scaling/distributed-search-network-dsn/#accessing-dsn-servers).

Parameters:

offset - First log entry to retrieve. Sorted by decreasing date with 0 being the most recent. (optional, default to 0)

length - Maximum number of entries to retrieve. (optional, default to 10)

indexName - Index for which log entries should be retrieved. When omitted, log entries are retrieved for all indices. (optional)

type - Type of log entries to retrieve. When omitted, all log entries are retrieved. (optional, default to all)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getLogsAsync

public CompletableFuture<GetLogsResponse> getLogsAsync(Integer offset,
 Integer length,
 String indexName,
 LogType type)
                                                throws AlgoliaRuntimeException

(asynchronously) The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). Logs are held for the last seven days. There's also a logging limit of 1,000 API calls per server. This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself. > **Note**: To fetch the logs for a Distributed Search Network (DSN) cluster, target the [DSN's endpoint](https://www.algolia.com/doc/guides/scaling/distributed-search-network-dsn/#accessing-dsn-servers).

Parameters:

offset - First log entry to retrieve. Sorted by decreasing date with 0 being the most recent. (optional, default to 0)

length - Maximum number of entries to retrieve. (optional, default to 10)

indexName - Index for which log entries should be retrieved. When omitted, log entries are retrieved for all indices. (optional)

type - Type of log entries to retrieve. When omitted, all log entries are retrieved. (optional, default to all)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getLogsAsync

public CompletableFuture<GetLogsResponse> getLogsAsync(RequestOptions requestOptions)
                                                throws AlgoliaRuntimeException

(asynchronously) The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). Logs are held for the last seven days. There's also a logging limit of 1,000 API calls per server. This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself. > **Note**: To fetch the logs for a Distributed Search Network (DSN) cluster, target the [DSN's endpoint](https://www.algolia.com/doc/guides/scaling/distributed-search-network-dsn/#accessing-dsn-servers).

Parameters:

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getLogsAsync

public CompletableFuture<GetLogsResponse> getLogsAsync()
                                                throws AlgoliaRuntimeException

(asynchronously) The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). Logs are held for the last seven days. There's also a logging limit of 1,000 API calls per server. This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself. > **Note**: To fetch the logs for a Distributed Search Network (DSN) cluster, target the [DSN's endpoint](https://www.algolia.com/doc/guides/scaling/distributed-search-network-dsn/#accessing-dsn-servers).

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getObject

public Map<String,String> getObject(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 List<String> attributesToRetrieve,
 RequestOptions requestOptions)
                             throws AlgoliaRuntimeException

To get more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique record (object) identifier. (required)

attributesToRetrieve - Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved, even when not specified. [`unretrievableAttributes`](https://www.algolia.com/doc/api-reference/api-parameters/unretrievableAttributes/) won't be retrieved unless the request is authenticated with the admin API key. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getObject

public Map<String,String> getObject(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 List<String> attributesToRetrieve)
                             throws AlgoliaRuntimeException

To get more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique record (object) identifier. (required)

attributesToRetrieve - Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved, even when not specified. [`unretrievableAttributes`](https://www.algolia.com/doc/api-reference/api-parameters/unretrievableAttributes/) won't be retrieved unless the request is authenticated with the admin API key. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getObject

public Map<String,String> getObject(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 RequestOptions requestOptions)
                             throws AlgoliaRuntimeException

To get more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique record (object) identifier. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getObject

public Map<String,String> getObject(@Nonnull
 String indexName,
 @Nonnull
 String objectID)
                             throws AlgoliaRuntimeException

To get more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique record (object) identifier. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getObjectAsync

public CompletableFuture<Map<String,String>> getObjectAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 List<String> attributesToRetrieve,
 RequestOptions requestOptions)
                                                     throws AlgoliaRuntimeException

(asynchronously) To get more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique record (object) identifier. (required)

attributesToRetrieve - Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved, even when not specified. [`unretrievableAttributes`](https://www.algolia.com/doc/api-reference/api-parameters/unretrievableAttributes/) won't be retrieved unless the request is authenticated with the admin API key. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getObjectAsync

public CompletableFuture<Map<String,String>> getObjectAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 List<String> attributesToRetrieve)
                                                     throws AlgoliaRuntimeException

(asynchronously) To get more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique record (object) identifier. (required)

attributesToRetrieve - Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved, even when not specified. [`unretrievableAttributes`](https://www.algolia.com/doc/api-reference/api-parameters/unretrievableAttributes/) won't be retrieved unless the request is authenticated with the admin API key. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getObjectAsync

public CompletableFuture<Map<String,String>> getObjectAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 RequestOptions requestOptions)
                                                     throws AlgoliaRuntimeException

(asynchronously) To get more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique record (object) identifier. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getObjectAsync

public CompletableFuture<Map<String,String>> getObjectAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID)
                                                     throws AlgoliaRuntimeException

(asynchronously) To get more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique record (object) identifier. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getObjects

public <T> GetObjectsResponse<T> getObjects(@Nonnull
 GetObjectsParams getObjectsParams,
 Class<T> innerType,
 RequestOptions requestOptions)
                                     throws AlgoliaRuntimeException

Retrieve one or more records, potentially from different indices, in a single API operation. Results will be received in the same order as the requests.

Parameters:

getObjectsParams - Request object. (required)

innerType - The class held by the index, could be your custom class or Object.

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getObjects

public <T> GetObjectsResponse<T> getObjects(@Nonnull
 GetObjectsParams getObjectsParams,
 Class<T> innerType)
                                     throws AlgoliaRuntimeException

Retrieve one or more records, potentially from different indices, in a single API operation. Results will be received in the same order as the requests.

Parameters:

getObjectsParams - Request object. (required)

innerType - The class held by the index, could be your custom class or Object.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getObjectsAsync

public <T> CompletableFuture<GetObjectsResponse<T>> getObjectsAsync(@Nonnull
 GetObjectsParams getObjectsParams,
 Class<T> innerType,
 RequestOptions requestOptions)
                                                             throws AlgoliaRuntimeException

(asynchronously) Retrieve one or more records, potentially from different indices, in a single API operation. Results will be received in the same order as the requests.

Parameters:

getObjectsParams - Request object. (required)

innerType - The class held by the index, could be your custom class or Object.

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getObjectsAsync

public <T> CompletableFuture<GetObjectsResponse<T>> getObjectsAsync(@Nonnull
 GetObjectsParams getObjectsParams,
 Class<T> innerType)
                                                             throws AlgoliaRuntimeException

(asynchronously) Retrieve one or more records, potentially from different indices, in a single API operation. Results will be received in the same order as the requests.

Parameters:

getObjectsParams - Request object. (required)

innerType - The class held by the index, could be your custom class or Object.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRule

public Rule getRule(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 RequestOptions requestOptions)
             throws AlgoliaRuntimeException

Get a rule by its `objectID`. To find the `objectID` for rules, use the [`search` operation](#tag/Rules/operation/searchRules).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a rule object. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRule

public Rule getRule(@Nonnull
 String indexName,
 @Nonnull
 String objectID)
             throws AlgoliaRuntimeException

Get a rule by its `objectID`. To find the `objectID` for rules, use the [`search` operation](#tag/Rules/operation/searchRules).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a rule object. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRuleAsync

public CompletableFuture<Rule> getRuleAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 RequestOptions requestOptions)
                                     throws AlgoliaRuntimeException

(asynchronously) Get a rule by its `objectID`. To find the `objectID` for rules, use the [`search` operation](#tag/Rules/operation/searchRules).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a rule object. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRuleAsync

public CompletableFuture<Rule> getRuleAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID)
                                     throws AlgoliaRuntimeException

(asynchronously) Get a rule by its `objectID`. To find the `objectID` for rules, use the [`search` operation](#tag/Rules/operation/searchRules).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a rule object. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSettings

public IndexSettings getSettings(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                          throws AlgoliaRuntimeException

Return an object containing an index's [configuration settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/).

Parameters:

indexName - Index on which to perform the request. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSettings

public IndexSettings getSettings(@Nonnull
 String indexName)
                          throws AlgoliaRuntimeException

Return an object containing an index's [configuration settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/).

Parameters:

indexName - Index on which to perform the request. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSettingsAsync

public CompletableFuture<IndexSettings> getSettingsAsync(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                                                  throws AlgoliaRuntimeException

(asynchronously) Return an object containing an index's [configuration settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/).

Parameters:

indexName - Index on which to perform the request. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSettingsAsync

public CompletableFuture<IndexSettings> getSettingsAsync(@Nonnull
 String indexName)
                                                  throws AlgoliaRuntimeException

(asynchronously) Return an object containing an index's [configuration settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/).

Parameters:

indexName - Index on which to perform the request. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSources

public List<Source> getSources(RequestOptions requestOptions)
                        throws AlgoliaRuntimeException

Get all allowed sources (IP addresses).

Parameters:

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSources

public List<Source> getSources()
                        throws AlgoliaRuntimeException

Get all allowed sources (IP addresses).

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSourcesAsync

public CompletableFuture<List<Source>> getSourcesAsync(RequestOptions requestOptions)
                                                throws AlgoliaRuntimeException

(asynchronously) Get all allowed sources (IP addresses).

Parameters:

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSourcesAsync

public CompletableFuture<List<Source>> getSourcesAsync()
                                                throws AlgoliaRuntimeException

(asynchronously) Get all allowed sources (IP addresses).

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSynonym

public SynonymHit getSynonym(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 RequestOptions requestOptions)
                      throws AlgoliaRuntimeException

Get a syonym by its `objectID`. To find the object IDs for your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a synonym object. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSynonym

public SynonymHit getSynonym(@Nonnull
 String indexName,
 @Nonnull
 String objectID)
                      throws AlgoliaRuntimeException

Get a syonym by its `objectID`. To find the object IDs for your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a synonym object. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSynonymAsync

public CompletableFuture<SynonymHit> getSynonymAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 RequestOptions requestOptions)
                                              throws AlgoliaRuntimeException

(asynchronously) Get a syonym by its `objectID`. To find the object IDs for your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a synonym object. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSynonymAsync

public CompletableFuture<SynonymHit> getSynonymAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID)
                                              throws AlgoliaRuntimeException

(asynchronously) Get a syonym by its `objectID`. To find the object IDs for your synonyms, use the [`search` operation](#tag/Synonyms/operation/searchSynonyms).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a synonym object. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTask

public GetTaskResponse getTask(@Nonnull
 String indexName,
 @Nonnull
 Long taskID,
 RequestOptions requestOptions)
                        throws AlgoliaRuntimeException

Some operations, such as copying an index, will respond with a `taskID` value. Use this value here to check the status of that task.

Parameters:

indexName - Index on which to perform the request. (required)

taskID - Unique task identifier. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTask

public GetTaskResponse getTask(@Nonnull
 String indexName,
 @Nonnull
 Long taskID)
                        throws AlgoliaRuntimeException

Some operations, such as copying an index, will respond with a `taskID` value. Use this value here to check the status of that task.

Parameters:

indexName - Index on which to perform the request. (required)

taskID - Unique task identifier. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTaskAsync

public CompletableFuture<GetTaskResponse> getTaskAsync(@Nonnull
 String indexName,
 @Nonnull
 Long taskID,
 RequestOptions requestOptions)
                                                throws AlgoliaRuntimeException

(asynchronously) Some operations, such as copying an index, will respond with a `taskID` value. Use this value here to check the status of that task.

Parameters:

indexName - Index on which to perform the request. (required)

taskID - Unique task identifier. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTaskAsync

public CompletableFuture<GetTaskResponse> getTaskAsync(@Nonnull
 String indexName,
 @Nonnull
 Long taskID)
                                                throws AlgoliaRuntimeException

(asynchronously) Some operations, such as copying an index, will respond with a `taskID` value. Use this value here to check the status of that task.

Parameters:

indexName - Index on which to perform the request. (required)

taskID - Unique task identifier. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopUserIds

public GetTopUserIdsResponse getTopUserIds(RequestOptions requestOptions)
                                    throws AlgoliaRuntimeException

Get the IDs of the 10 users with the highest number of records per cluster. Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time.

Parameters:

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopUserIds

public GetTopUserIdsResponse getTopUserIds()
                                    throws AlgoliaRuntimeException

Get the IDs of the 10 users with the highest number of records per cluster. Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopUserIdsAsync

public CompletableFuture<GetTopUserIdsResponse> getTopUserIdsAsync(RequestOptions requestOptions)
                                                            throws AlgoliaRuntimeException

(asynchronously) Get the IDs of the 10 users with the highest number of records per cluster. Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time.

Parameters:

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopUserIdsAsync

public CompletableFuture<GetTopUserIdsResponse> getTopUserIdsAsync()
                                                            throws AlgoliaRuntimeException

(asynchronously) Get the IDs of the 10 users with the highest number of records per cluster. Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getUserId

public UserId getUserId(@Nonnull
 String userID,
 RequestOptions requestOptions)
                 throws AlgoliaRuntimeException

Returns the userID data stored in the mapping. Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time.

Parameters:

userID - userID to assign. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getUserId

public UserId getUserId(@Nonnull
 String userID)
                 throws AlgoliaRuntimeException

Returns the userID data stored in the mapping. Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time.

Parameters:

userID - userID to assign. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getUserIdAsync

public CompletableFuture<UserId> getUserIdAsync(@Nonnull
 String userID,
 RequestOptions requestOptions)
                                         throws AlgoliaRuntimeException

(asynchronously) Returns the userID data stored in the mapping. Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time.

Parameters:

userID - userID to assign. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getUserIdAsync

public CompletableFuture<UserId> getUserIdAsync(@Nonnull
 String userID)
                                         throws AlgoliaRuntimeException

(asynchronously) Returns the userID data stored in the mapping. Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time.

Parameters:

userID - userID to assign. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

hasPendingMappings

public HasPendingMappingsResponse hasPendingMappings(Boolean getClusters,
 RequestOptions requestOptions)
                                              throws AlgoliaRuntimeException

To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.

Parameters:

getClusters - Indicates whether to include the cluster's pending mapping state in the response. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

hasPendingMappings

public HasPendingMappingsResponse hasPendingMappings(Boolean getClusters)
                                              throws AlgoliaRuntimeException

To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.

Parameters:

getClusters - Indicates whether to include the cluster's pending mapping state in the response. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

hasPendingMappings

public HasPendingMappingsResponse hasPendingMappings(RequestOptions requestOptions)
                                              throws AlgoliaRuntimeException

To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.

Parameters:

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

hasPendingMappings

public HasPendingMappingsResponse hasPendingMappings()
                                              throws AlgoliaRuntimeException

To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

hasPendingMappingsAsync

public CompletableFuture<HasPendingMappingsResponse> hasPendingMappingsAsync(Boolean getClusters,
 RequestOptions requestOptions)
                                                                      throws AlgoliaRuntimeException

(asynchronously) To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.

Parameters:

getClusters - Indicates whether to include the cluster's pending mapping state in the response. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

hasPendingMappingsAsync

public CompletableFuture<HasPendingMappingsResponse> hasPendingMappingsAsync(Boolean getClusters)
                                                                      throws AlgoliaRuntimeException

(asynchronously) To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.

Parameters:

getClusters - Indicates whether to include the cluster's pending mapping state in the response. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

hasPendingMappingsAsync

public CompletableFuture<HasPendingMappingsResponse> hasPendingMappingsAsync(RequestOptions requestOptions)
                                                                      throws AlgoliaRuntimeException

(asynchronously) To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.

Parameters:

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

hasPendingMappingsAsync

public CompletableFuture<HasPendingMappingsResponse> hasPendingMappingsAsync()
                                                                      throws AlgoliaRuntimeException

(asynchronously) To determine when the time-consuming process of creating a large batch of users or migrating users from one cluster to another is complete, this operation retrieves the status of the process.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listApiKeys

public ListApiKeysResponse listApiKeys(RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

List all API keys associated with your Algolia application, including their permissions and restrictions.

Parameters:

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listApiKeys

public ListApiKeysResponse listApiKeys()
                                throws AlgoliaRuntimeException

List all API keys associated with your Algolia application, including their permissions and restrictions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listApiKeysAsync

public CompletableFuture<ListApiKeysResponse> listApiKeysAsync(RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

(asynchronously) List all API keys associated with your Algolia application, including their permissions and restrictions.

Parameters:

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listApiKeysAsync

public CompletableFuture<ListApiKeysResponse> listApiKeysAsync()
                                                        throws AlgoliaRuntimeException

(asynchronously) List all API keys associated with your Algolia application, including their permissions and restrictions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listClusters

public ListClustersResponse listClusters(RequestOptions requestOptions)
                                  throws AlgoliaRuntimeException

List the available clusters in a multi-cluster setup.

Parameters:

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listClusters

public ListClustersResponse listClusters()
                                  throws AlgoliaRuntimeException

List the available clusters in a multi-cluster setup.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listClustersAsync

public CompletableFuture<ListClustersResponse> listClustersAsync(RequestOptions requestOptions)
                                                          throws AlgoliaRuntimeException

(asynchronously) List the available clusters in a multi-cluster setup.

Parameters:

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listClustersAsync

public CompletableFuture<ListClustersResponse> listClustersAsync()
                                                          throws AlgoliaRuntimeException

(asynchronously) List the available clusters in a multi-cluster setup.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listIndices

public ListIndicesResponse listIndices(Integer page,
 Integer hitsPerPage,
 RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

List indices in an Algolia application.

Parameters:

page - Returns the requested page number. The page size is determined by the `hitsPerPage` parameter. You can see the number of available pages in the `nbPages` response attribute. When `page` is null, the API response is not paginated. (optional)

hitsPerPage - Maximum number of hits per page. (optional, default to 100)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listIndices

public ListIndicesResponse listIndices(Integer page,
 Integer hitsPerPage)
                                throws AlgoliaRuntimeException

List indices in an Algolia application.

Parameters:

page - Returns the requested page number. The page size is determined by the `hitsPerPage` parameter. You can see the number of available pages in the `nbPages` response attribute. When `page` is null, the API response is not paginated. (optional)

hitsPerPage - Maximum number of hits per page. (optional, default to 100)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listIndices

public ListIndicesResponse listIndices(RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

List indices in an Algolia application.

Parameters:

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listIndices

public ListIndicesResponse listIndices()
                                throws AlgoliaRuntimeException

List indices in an Algolia application.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listIndicesAsync

public CompletableFuture<ListIndicesResponse> listIndicesAsync(Integer page,
 Integer hitsPerPage,
 RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

(asynchronously) List indices in an Algolia application.

Parameters:

page - Returns the requested page number. The page size is determined by the `hitsPerPage` parameter. You can see the number of available pages in the `nbPages` response attribute. When `page` is null, the API response is not paginated. (optional)

hitsPerPage - Maximum number of hits per page. (optional, default to 100)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listIndicesAsync

public CompletableFuture<ListIndicesResponse> listIndicesAsync(Integer page,
 Integer hitsPerPage)
                                                        throws AlgoliaRuntimeException

(asynchronously) List indices in an Algolia application.

Parameters:

page - Returns the requested page number. The page size is determined by the `hitsPerPage` parameter. You can see the number of available pages in the `nbPages` response attribute. When `page` is null, the API response is not paginated. (optional)

hitsPerPage - Maximum number of hits per page. (optional, default to 100)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listIndicesAsync

public CompletableFuture<ListIndicesResponse> listIndicesAsync(RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

(asynchronously) List indices in an Algolia application.

Parameters:

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listIndicesAsync

public CompletableFuture<ListIndicesResponse> listIndicesAsync()
                                                        throws AlgoliaRuntimeException

(asynchronously) List indices in an Algolia application.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listUserIds

public ListUserIdsResponse listUserIds(Integer page,
 Integer hitsPerPage,
 RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

List the userIDs assigned to a multi-cluster application. Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time.

Parameters:

page - Returns the requested page number. The page size is determined by the `hitsPerPage` parameter. You can see the number of available pages in the `nbPages` response attribute. When `page` is null, the API response is not paginated. (optional)

hitsPerPage - Maximum number of hits per page. (optional, default to 100)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listUserIds

public ListUserIdsResponse listUserIds(Integer page,
 Integer hitsPerPage)
                                throws AlgoliaRuntimeException

List the userIDs assigned to a multi-cluster application. Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time.

Parameters:

page - Returns the requested page number. The page size is determined by the `hitsPerPage` parameter. You can see the number of available pages in the `nbPages` response attribute. When `page` is null, the API response is not paginated. (optional)

hitsPerPage - Maximum number of hits per page. (optional, default to 100)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listUserIds

public ListUserIdsResponse listUserIds(RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

List the userIDs assigned to a multi-cluster application. Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time.

Parameters:

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listUserIds

public ListUserIdsResponse listUserIds()
                                throws AlgoliaRuntimeException

List the userIDs assigned to a multi-cluster application. Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listUserIdsAsync

public CompletableFuture<ListUserIdsResponse> listUserIdsAsync(Integer page,
 Integer hitsPerPage,
 RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

(asynchronously) List the userIDs assigned to a multi-cluster application. Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time.

Parameters:

page - Returns the requested page number. The page size is determined by the `hitsPerPage` parameter. You can see the number of available pages in the `nbPages` response attribute. When `page` is null, the API response is not paginated. (optional)

hitsPerPage - Maximum number of hits per page. (optional, default to 100)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listUserIdsAsync

public CompletableFuture<ListUserIdsResponse> listUserIdsAsync(Integer page,
 Integer hitsPerPage)
                                                        throws AlgoliaRuntimeException

(asynchronously) List the userIDs assigned to a multi-cluster application. Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time.

Parameters:

page - Returns the requested page number. The page size is determined by the `hitsPerPage` parameter. You can see the number of available pages in the `nbPages` response attribute. When `page` is null, the API response is not paginated. (optional)

hitsPerPage - Maximum number of hits per page. (optional, default to 100)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listUserIdsAsync

public CompletableFuture<ListUserIdsResponse> listUserIdsAsync(RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

(asynchronously) List the userIDs assigned to a multi-cluster application. Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time.

Parameters:

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listUserIdsAsync

public CompletableFuture<ListUserIdsResponse> listUserIdsAsync()
                                                        throws AlgoliaRuntimeException

(asynchronously) List the userIDs assigned to a multi-cluster application. Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

multipleBatch

public MultipleBatchResponse multipleBatch(@Nonnull
 BatchParams batchParams,
 RequestOptions requestOptions)
                                    throws AlgoliaRuntimeException

To reduce the time spent on network round trips, you can perform several write actions in a single request. It's a multi-index version of the [`batch` operation](#tag/Records/operation/batch). Actions are applied in the order they are specified. The supported actions are equivalent to the individual operations of the same name.

Parameters:

batchParams - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

multipleBatch

public MultipleBatchResponse multipleBatch(@Nonnull
 BatchParams batchParams)
                                    throws AlgoliaRuntimeException

To reduce the time spent on network round trips, you can perform several write actions in a single request. It's a multi-index version of the [`batch` operation](#tag/Records/operation/batch). Actions are applied in the order they are specified. The supported actions are equivalent to the individual operations of the same name.

Parameters:

batchParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

multipleBatchAsync

public CompletableFuture<MultipleBatchResponse> multipleBatchAsync(@Nonnull
 BatchParams batchParams,
 RequestOptions requestOptions)
                                                            throws AlgoliaRuntimeException

(asynchronously) To reduce the time spent on network round trips, you can perform several write actions in a single request. It's a multi-index version of the [`batch` operation](#tag/Records/operation/batch). Actions are applied in the order they are specified. The supported actions are equivalent to the individual operations of the same name.

Parameters:

batchParams - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

multipleBatchAsync

public CompletableFuture<MultipleBatchResponse> multipleBatchAsync(@Nonnull
 BatchParams batchParams)
                                                            throws AlgoliaRuntimeException

(asynchronously) To reduce the time spent on network round trips, you can perform several write actions in a single request. It's a multi-index version of the [`batch` operation](#tag/Records/operation/batch). Actions are applied in the order they are specified. The supported actions are equivalent to the individual operations of the same name.

Parameters:

batchParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

operationIndex

public UpdatedAtResponse operationIndex(@Nonnull
 String indexName,
 @Nonnull
 OperationIndexParams operationIndexParams,
 RequestOptions requestOptions)
                                 throws AlgoliaRuntimeException

This `operation`, _copy_ or _move_, will copy or move a source index's (`IndexName`) records, settings, synonyms, and rules to a `destination` index. If the destination index exists, it will be replaced, except for index-specific API keys and analytics data. If the destination index doesn't exist, it will be created. The choice between moving or copying an index depends on your needs. Choose: - **Move** to rename an index. - **Copy** to create a new index with the same records and configuration as an existing one. > **Note**: When considering copying or moving, be aware of the [rate limitations](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits) on these processes and the [impact on your analytics data](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/concepts/indices-analytics/).

Parameters:

indexName - Index on which to perform the request. (required)

operationIndexParams - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

operationIndex

public UpdatedAtResponse operationIndex(@Nonnull
 String indexName,
 @Nonnull
 OperationIndexParams operationIndexParams)
                                 throws AlgoliaRuntimeException

This `operation`, _copy_ or _move_, will copy or move a source index's (`IndexName`) records, settings, synonyms, and rules to a `destination` index. If the destination index exists, it will be replaced, except for index-specific API keys and analytics data. If the destination index doesn't exist, it will be created. The choice between moving or copying an index depends on your needs. Choose: - **Move** to rename an index. - **Copy** to create a new index with the same records and configuration as an existing one. > **Note**: When considering copying or moving, be aware of the [rate limitations](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits) on these processes and the [impact on your analytics data](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/concepts/indices-analytics/).

Parameters:

indexName - Index on which to perform the request. (required)

operationIndexParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

operationIndexAsync

public CompletableFuture<UpdatedAtResponse> operationIndexAsync(@Nonnull
 String indexName,
 @Nonnull
 OperationIndexParams operationIndexParams,
 RequestOptions requestOptions)
                                                         throws AlgoliaRuntimeException

(asynchronously) This `operation`, _copy_ or _move_, will copy or move a source index's (`IndexName`) records, settings, synonyms, and rules to a `destination` index. If the destination index exists, it will be replaced, except for index-specific API keys and analytics data. If the destination index doesn't exist, it will be created. The choice between moving or copying an index depends on your needs. Choose: - **Move** to rename an index. - **Copy** to create a new index with the same records and configuration as an existing one. > **Note**: When considering copying or moving, be aware of the [rate limitations](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits) on these processes and the [impact on your analytics data](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/concepts/indices-analytics/).

Parameters:

indexName - Index on which to perform the request. (required)

operationIndexParams - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

operationIndexAsync

public CompletableFuture<UpdatedAtResponse> operationIndexAsync(@Nonnull
 String indexName,
 @Nonnull
 OperationIndexParams operationIndexParams)
                                                         throws AlgoliaRuntimeException

(asynchronously) This `operation`, _copy_ or _move_, will copy or move a source index's (`IndexName`) records, settings, synonyms, and rules to a `destination` index. If the destination index exists, it will be replaced, except for index-specific API keys and analytics data. If the destination index doesn't exist, it will be created. The choice between moving or copying an index depends on your needs. Choose: - **Move** to rename an index. - **Copy** to create a new index with the same records and configuration as an existing one. > **Note**: When considering copying or moving, be aware of the [rate limitations](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits) on these processes and the [impact on your analytics data](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/concepts/indices-analytics/).

Parameters:

indexName - Index on which to perform the request. (required)

operationIndexParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

partialUpdateObject

public UpdatedAtWithObjectIdResponse partialUpdateObject(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Map<String,AttributeToUpdate> attributesToUpdate,
 Boolean createIfNotExists,
 RequestOptions requestOptions)
                                                  throws AlgoliaRuntimeException

Add new attributes or update current ones in an existing record. You can use any first-level attribute but not nested attributes. If you specify a [nested attribute](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/creating-and-using-nested-attributes/), the engine treats it as a replacement for its first-level ancestor.

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique record (object) identifier. (required)

attributesToUpdate - Object with attributes to update. (required)

createIfNotExists - Indicates whether to create a new record if it doesn't exist yet. (optional, default to true)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

partialUpdateObject

public UpdatedAtWithObjectIdResponse partialUpdateObject(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Map<String,AttributeToUpdate> attributesToUpdate,
 Boolean createIfNotExists)
                                                  throws AlgoliaRuntimeException

Add new attributes or update current ones in an existing record. You can use any first-level attribute but not nested attributes. If you specify a [nested attribute](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/creating-and-using-nested-attributes/), the engine treats it as a replacement for its first-level ancestor.

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique record (object) identifier. (required)

attributesToUpdate - Object with attributes to update. (required)

createIfNotExists - Indicates whether to create a new record if it doesn't exist yet. (optional, default to true)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

partialUpdateObject

public UpdatedAtWithObjectIdResponse partialUpdateObject(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Map<String,AttributeToUpdate> attributesToUpdate,
 RequestOptions requestOptions)
                                                  throws AlgoliaRuntimeException

Add new attributes or update current ones in an existing record. You can use any first-level attribute but not nested attributes. If you specify a [nested attribute](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/creating-and-using-nested-attributes/), the engine treats it as a replacement for its first-level ancestor.

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique record (object) identifier. (required)

attributesToUpdate - Object with attributes to update. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

partialUpdateObject

public UpdatedAtWithObjectIdResponse partialUpdateObject(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Map<String,AttributeToUpdate> attributesToUpdate)
                                                  throws AlgoliaRuntimeException

Add new attributes or update current ones in an existing record. You can use any first-level attribute but not nested attributes. If you specify a [nested attribute](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/creating-and-using-nested-attributes/), the engine treats it as a replacement for its first-level ancestor.

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique record (object) identifier. (required)

attributesToUpdate - Object with attributes to update. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

partialUpdateObjectAsync

public CompletableFuture<UpdatedAtWithObjectIdResponse> partialUpdateObjectAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Map<String,AttributeToUpdate> attributesToUpdate,
 Boolean createIfNotExists,
 RequestOptions requestOptions)
                                                                          throws AlgoliaRuntimeException

(asynchronously) Add new attributes or update current ones in an existing record. You can use any first-level attribute but not nested attributes. If you specify a [nested attribute](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/creating-and-using-nested-attributes/), the engine treats it as a replacement for its first-level ancestor.

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique record (object) identifier. (required)

attributesToUpdate - Object with attributes to update. (required)

createIfNotExists - Indicates whether to create a new record if it doesn't exist yet. (optional, default to true)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

partialUpdateObjectAsync

public CompletableFuture<UpdatedAtWithObjectIdResponse> partialUpdateObjectAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Map<String,AttributeToUpdate> attributesToUpdate,
 Boolean createIfNotExists)
                                                                          throws AlgoliaRuntimeException

(asynchronously) Add new attributes or update current ones in an existing record. You can use any first-level attribute but not nested attributes. If you specify a [nested attribute](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/creating-and-using-nested-attributes/), the engine treats it as a replacement for its first-level ancestor.

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique record (object) identifier. (required)

attributesToUpdate - Object with attributes to update. (required)

createIfNotExists - Indicates whether to create a new record if it doesn't exist yet. (optional, default to true)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

partialUpdateObjectAsync

public CompletableFuture<UpdatedAtWithObjectIdResponse> partialUpdateObjectAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Map<String,AttributeToUpdate> attributesToUpdate,
 RequestOptions requestOptions)
                                                                          throws AlgoliaRuntimeException

(asynchronously) Add new attributes or update current ones in an existing record. You can use any first-level attribute but not nested attributes. If you specify a [nested attribute](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/creating-and-using-nested-attributes/), the engine treats it as a replacement for its first-level ancestor.

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique record (object) identifier. (required)

attributesToUpdate - Object with attributes to update. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

partialUpdateObjectAsync

public CompletableFuture<UpdatedAtWithObjectIdResponse> partialUpdateObjectAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Map<String,AttributeToUpdate> attributesToUpdate)
                                                                          throws AlgoliaRuntimeException

(asynchronously) Add new attributes or update current ones in an existing record. You can use any first-level attribute but not nested attributes. If you specify a [nested attribute](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/creating-and-using-nested-attributes/), the engine treats it as a replacement for its first-level ancestor.

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique record (object) identifier. (required)

attributesToUpdate - Object with attributes to update. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

post

public Object post(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body,
 RequestOptions requestOptions)
            throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

body - Parameters to send with the custom request. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

post

public Object post(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body)
            throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

body - Parameters to send with the custom request. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

post

public Object post(@Nonnull
 String path,
 RequestOptions requestOptions)
            throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

post

public Object post(@Nonnull
 String path)
            throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

postAsync

public CompletableFuture<Object> postAsync(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body,
 RequestOptions requestOptions)
                                    throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

body - Parameters to send with the custom request. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

postAsync

public CompletableFuture<Object> postAsync(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body)
                                    throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

body - Parameters to send with the custom request. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

postAsync

public CompletableFuture<Object> postAsync(@Nonnull
 String path,
 RequestOptions requestOptions)
                                    throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

postAsync

public CompletableFuture<Object> postAsync(@Nonnull
 String path)
                                    throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

put

public Object put(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body,
 RequestOptions requestOptions)
           throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

body - Parameters to send with the custom request. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

put

public Object put(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body)
           throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

body - Parameters to send with the custom request. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

put

public Object put(@Nonnull
 String path,
 RequestOptions requestOptions)
           throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

put

public Object put(@Nonnull
 String path)
           throws AlgoliaRuntimeException

This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

putAsync

public CompletableFuture<Object> putAsync(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body,
 RequestOptions requestOptions)
                                   throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

body - Parameters to send with the custom request. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

putAsync

public CompletableFuture<Object> putAsync(@Nonnull
 String path,
 Map<String,Object> parameters,
 Object body)
                                   throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

parameters - Query parameters to apply to the current query. (optional)

body - Parameters to send with the custom request. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

putAsync

public CompletableFuture<Object> putAsync(@Nonnull
 String path,
 RequestOptions requestOptions)
                                   throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

putAsync

public CompletableFuture<Object> putAsync(@Nonnull
 String path)
                                   throws AlgoliaRuntimeException

(asynchronously) This method allow you to send requests to the Algolia REST API.

Parameters:

path - Path of the endpoint, anything after \"/1\" must be specified. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

removeUserId

public RemoveUserIdResponse removeUserId(@Nonnull
 String userID,
 RequestOptions requestOptions)
                                  throws AlgoliaRuntimeException

Remove a userID and its associated data from the multi-clusters.

Parameters:

userID - userID to assign. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

removeUserId

public RemoveUserIdResponse removeUserId(@Nonnull
 String userID)
                                  throws AlgoliaRuntimeException

Remove a userID and its associated data from the multi-clusters.

Parameters:

userID - userID to assign. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

removeUserIdAsync

public CompletableFuture<RemoveUserIdResponse> removeUserIdAsync(@Nonnull
 String userID,
 RequestOptions requestOptions)
                                                          throws AlgoliaRuntimeException

(asynchronously) Remove a userID and its associated data from the multi-clusters.

Parameters:

userID - userID to assign. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

removeUserIdAsync

public CompletableFuture<RemoveUserIdResponse> removeUserIdAsync(@Nonnull
 String userID)
                                                          throws AlgoliaRuntimeException

(asynchronously) Remove a userID and its associated data from the multi-clusters.

Parameters:

userID - userID to assign. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

replaceSources

public ReplaceSourceResponse replaceSources(@Nonnull
 List<Source> source,
 RequestOptions requestOptions)
                                     throws AlgoliaRuntimeException

Replace all allowed sources.

Parameters:

source - Allowed sources. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

replaceSources

public ReplaceSourceResponse replaceSources(@Nonnull
 List<Source> source)
                                     throws AlgoliaRuntimeException

Replace all allowed sources.

Parameters:

source - Allowed sources. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

replaceSourcesAsync

public CompletableFuture<ReplaceSourceResponse> replaceSourcesAsync(@Nonnull
 List<Source> source,
 RequestOptions requestOptions)
                                                             throws AlgoliaRuntimeException

(asynchronously) Replace all allowed sources.

Parameters:

source - Allowed sources. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

replaceSourcesAsync

public CompletableFuture<ReplaceSourceResponse> replaceSourcesAsync(@Nonnull
 List<Source> source)
                                                             throws AlgoliaRuntimeException

(asynchronously) Replace all allowed sources.

Parameters:

source - Allowed sources. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

restoreApiKey

public AddApiKeyResponse restoreApiKey(@Nonnull
 String key,
 RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

Restore a deleted API key, along with its associated permissions. The request must be authenticated with the admin API key.

Parameters:

key - API key. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

restoreApiKey

public AddApiKeyResponse restoreApiKey(@Nonnull
 String key)
                                throws AlgoliaRuntimeException

Restore a deleted API key, along with its associated permissions. The request must be authenticated with the admin API key.

Parameters:

key - API key. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

restoreApiKeyAsync

public CompletableFuture<AddApiKeyResponse> restoreApiKeyAsync(@Nonnull
 String key,
 RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

(asynchronously) Restore a deleted API key, along with its associated permissions. The request must be authenticated with the admin API key.

Parameters:

key - API key. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

restoreApiKeyAsync

public CompletableFuture<AddApiKeyResponse> restoreApiKeyAsync(@Nonnull
 String key)
                                                        throws AlgoliaRuntimeException

(asynchronously) Restore a deleted API key, along with its associated permissions. The request must be authenticated with the admin API key.

Parameters:

key - API key. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveObject

public SaveObjectResponse saveObject(@Nonnull
 String indexName,
 @Nonnull
 Object body,
 RequestOptions requestOptions)
                              throws AlgoliaRuntimeException

Add a record (object) to an index or replace it. If the record doesn't contain an `objectID`, Algolia automatically adds it. If you use an existing `objectID`, the existing record is replaced with the new one. To add multiple records to your index in a single API request, use the [`batch` operation](#tag/Records/operation/batch).

Parameters:

indexName - Index on which to perform the request. (required)

body - The Algolia record. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveObject

public SaveObjectResponse saveObject(@Nonnull
 String indexName,
 @Nonnull
 Object body)
                              throws AlgoliaRuntimeException

Add a record (object) to an index or replace it. If the record doesn't contain an `objectID`, Algolia automatically adds it. If you use an existing `objectID`, the existing record is replaced with the new one. To add multiple records to your index in a single API request, use the [`batch` operation](#tag/Records/operation/batch).

Parameters:

indexName - Index on which to perform the request. (required)

body - The Algolia record. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveObjectAsync

public CompletableFuture<SaveObjectResponse> saveObjectAsync(@Nonnull
 String indexName,
 @Nonnull
 Object body,
 RequestOptions requestOptions)
                                                      throws AlgoliaRuntimeException

(asynchronously) Add a record (object) to an index or replace it. If the record doesn't contain an `objectID`, Algolia automatically adds it. If you use an existing `objectID`, the existing record is replaced with the new one. To add multiple records to your index in a single API request, use the [`batch` operation](#tag/Records/operation/batch).

Parameters:

indexName - Index on which to perform the request. (required)

body - The Algolia record. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveObjectAsync

public CompletableFuture<SaveObjectResponse> saveObjectAsync(@Nonnull
 String indexName,
 @Nonnull
 Object body)
                                                      throws AlgoliaRuntimeException

(asynchronously) Add a record (object) to an index or replace it. If the record doesn't contain an `objectID`, Algolia automatically adds it. If you use an existing `objectID`, the existing record is replaced with the new one. To add multiple records to your index in a single API request, use the [`batch` operation](#tag/Records/operation/batch).

Parameters:

indexName - Index on which to perform the request. (required)

body - The Algolia record. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRule

public UpdatedRuleResponse saveRule(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Rule rule,
 Boolean forwardToReplicas,
 RequestOptions requestOptions)
                             throws AlgoliaRuntimeException

To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a rule object. (required)

rule - (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRule

public UpdatedRuleResponse saveRule(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Rule rule,
 Boolean forwardToReplicas)
                             throws AlgoliaRuntimeException

To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a rule object. (required)

rule - (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRule

public UpdatedRuleResponse saveRule(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Rule rule,
 RequestOptions requestOptions)
                             throws AlgoliaRuntimeException

To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a rule object. (required)

rule - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRule

public UpdatedRuleResponse saveRule(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Rule rule)
                             throws AlgoliaRuntimeException

To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a rule object. (required)

rule - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRuleAsync

public CompletableFuture<UpdatedRuleResponse> saveRuleAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Rule rule,
 Boolean forwardToReplicas,
 RequestOptions requestOptions)
                                                     throws AlgoliaRuntimeException

(asynchronously) To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a rule object. (required)

rule - (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRuleAsync

public CompletableFuture<UpdatedRuleResponse> saveRuleAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Rule rule,
 Boolean forwardToReplicas)
                                                     throws AlgoliaRuntimeException

(asynchronously) To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a rule object. (required)

rule - (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRuleAsync

public CompletableFuture<UpdatedRuleResponse> saveRuleAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Rule rule,
 RequestOptions requestOptions)
                                                     throws AlgoliaRuntimeException

(asynchronously) To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a rule object. (required)

rule - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRuleAsync

public CompletableFuture<UpdatedRuleResponse> saveRuleAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Rule rule)
                                                     throws AlgoliaRuntimeException

(asynchronously) To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a rule object. (required)

rule - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRules

public UpdatedAtResponse saveRules(@Nonnull
 String indexName,
 @Nonnull
 List<Rule> rules,
 Boolean forwardToReplicas,
 Boolean clearExistingRules,
 RequestOptions requestOptions)
                            throws AlgoliaRuntimeException

Create or update multiple rules.

Parameters:

indexName - Index on which to perform the request. (required)

rules - (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

clearExistingRules - Indicates whether existing rules should be deleted before adding this batch. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRules

public UpdatedAtResponse saveRules(@Nonnull
 String indexName,
 @Nonnull
 List<Rule> rules,
 Boolean forwardToReplicas,
 Boolean clearExistingRules)
                            throws AlgoliaRuntimeException

Create or update multiple rules.

Parameters:

indexName - Index on which to perform the request. (required)

rules - (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

clearExistingRules - Indicates whether existing rules should be deleted before adding this batch. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRules

public UpdatedAtResponse saveRules(@Nonnull
 String indexName,
 @Nonnull
 List<Rule> rules,
 RequestOptions requestOptions)
                            throws AlgoliaRuntimeException

Create or update multiple rules.

Parameters:

indexName - Index on which to perform the request. (required)

rules - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRules

public UpdatedAtResponse saveRules(@Nonnull
 String indexName,
 @Nonnull
 List<Rule> rules)
                            throws AlgoliaRuntimeException

Create or update multiple rules.

Parameters:

indexName - Index on which to perform the request. (required)

rules - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRulesAsync

public CompletableFuture<UpdatedAtResponse> saveRulesAsync(@Nonnull
 String indexName,
 @Nonnull
 List<Rule> rules,
 Boolean forwardToReplicas,
 Boolean clearExistingRules,
 RequestOptions requestOptions)
                                                    throws AlgoliaRuntimeException

(asynchronously) Create or update multiple rules.

Parameters:

indexName - Index on which to perform the request. (required)

rules - (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

clearExistingRules - Indicates whether existing rules should be deleted before adding this batch. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRulesAsync

public CompletableFuture<UpdatedAtResponse> saveRulesAsync(@Nonnull
 String indexName,
 @Nonnull
 List<Rule> rules,
 Boolean forwardToReplicas,
 Boolean clearExistingRules)
                                                    throws AlgoliaRuntimeException

(asynchronously) Create or update multiple rules.

Parameters:

indexName - Index on which to perform the request. (required)

rules - (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

clearExistingRules - Indicates whether existing rules should be deleted before adding this batch. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRulesAsync

public CompletableFuture<UpdatedAtResponse> saveRulesAsync(@Nonnull
 String indexName,
 @Nonnull
 List<Rule> rules,
 RequestOptions requestOptions)
                                                    throws AlgoliaRuntimeException

(asynchronously) Create or update multiple rules.

Parameters:

indexName - Index on which to perform the request. (required)

rules - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRulesAsync

public CompletableFuture<UpdatedAtResponse> saveRulesAsync(@Nonnull
 String indexName,
 @Nonnull
 List<Rule> rules)
                                                    throws AlgoliaRuntimeException

(asynchronously) Create or update multiple rules.

Parameters:

indexName - Index on which to perform the request. (required)

rules - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonym

public SaveSynonymResponse saveSynonym(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 SynonymHit synonymHit,
 Boolean forwardToReplicas,
 RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

Add a [synonym](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms) to an index or replace it. If the synonym `objectID` doesn't exist, Algolia adds a new one. If you use an existing synonym `objectID`, the existing synonym is replaced with the new one. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a synonym object. (required)

synonymHit - (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonym

public SaveSynonymResponse saveSynonym(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 SynonymHit synonymHit,
 Boolean forwardToReplicas)
                                throws AlgoliaRuntimeException

Add a [synonym](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms) to an index or replace it. If the synonym `objectID` doesn't exist, Algolia adds a new one. If you use an existing synonym `objectID`, the existing synonym is replaced with the new one. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a synonym object. (required)

synonymHit - (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonym

public SaveSynonymResponse saveSynonym(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 SynonymHit synonymHit,
 RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

Add a [synonym](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms) to an index or replace it. If the synonym `objectID` doesn't exist, Algolia adds a new one. If you use an existing synonym `objectID`, the existing synonym is replaced with the new one. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a synonym object. (required)

synonymHit - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonym

public SaveSynonymResponse saveSynonym(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 SynonymHit synonymHit)
                                throws AlgoliaRuntimeException

Add a [synonym](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms) to an index or replace it. If the synonym `objectID` doesn't exist, Algolia adds a new one. If you use an existing synonym `objectID`, the existing synonym is replaced with the new one. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a synonym object. (required)

synonymHit - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonymAsync

public CompletableFuture<SaveSynonymResponse> saveSynonymAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 SynonymHit synonymHit,
 Boolean forwardToReplicas,
 RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

(asynchronously) Add a [synonym](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms) to an index or replace it. If the synonym `objectID` doesn't exist, Algolia adds a new one. If you use an existing synonym `objectID`, the existing synonym is replaced with the new one. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a synonym object. (required)

synonymHit - (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonymAsync

public CompletableFuture<SaveSynonymResponse> saveSynonymAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 SynonymHit synonymHit,
 Boolean forwardToReplicas)
                                                        throws AlgoliaRuntimeException

(asynchronously) Add a [synonym](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms) to an index or replace it. If the synonym `objectID` doesn't exist, Algolia adds a new one. If you use an existing synonym `objectID`, the existing synonym is replaced with the new one. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a synonym object. (required)

synonymHit - (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonymAsync

public CompletableFuture<SaveSynonymResponse> saveSynonymAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 SynonymHit synonymHit,
 RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

(asynchronously) Add a [synonym](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms) to an index or replace it. If the synonym `objectID` doesn't exist, Algolia adds a new one. If you use an existing synonym `objectID`, the existing synonym is replaced with the new one. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a synonym object. (required)

synonymHit - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonymAsync

public CompletableFuture<SaveSynonymResponse> saveSynonymAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 SynonymHit synonymHit)
                                                        throws AlgoliaRuntimeException

(asynchronously) Add a [synonym](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms) to an index or replace it. If the synonym `objectID` doesn't exist, Algolia adds a new one. If you use an existing synonym `objectID`, the existing synonym is replaced with the new one. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms).

Parameters:

indexName - Index on which to perform the request. (required)

objectID - Unique identifier of a synonym object. (required)

synonymHit - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonyms

public UpdatedAtResponse saveSynonyms(@Nonnull
 String indexName,
 @Nonnull
 List<SynonymHit> synonymHit,
 Boolean forwardToReplicas,
 Boolean replaceExistingSynonyms,
 RequestOptions requestOptions)
                               throws AlgoliaRuntimeException

Create or update multiple synonyms.

Parameters:

indexName - Index on which to perform the request. (required)

synonymHit - (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

replaceExistingSynonyms - Indicates whether to replace all synonyms in the index with the ones sent with this request. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonyms

public UpdatedAtResponse saveSynonyms(@Nonnull
 String indexName,
 @Nonnull
 List<SynonymHit> synonymHit,
 Boolean forwardToReplicas,
 Boolean replaceExistingSynonyms)
                               throws AlgoliaRuntimeException

Create or update multiple synonyms.

Parameters:

indexName - Index on which to perform the request. (required)

synonymHit - (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

replaceExistingSynonyms - Indicates whether to replace all synonyms in the index with the ones sent with this request. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonyms

public UpdatedAtResponse saveSynonyms(@Nonnull
 String indexName,
 @Nonnull
 List<SynonymHit> synonymHit,
 RequestOptions requestOptions)
                               throws AlgoliaRuntimeException

Create or update multiple synonyms.

Parameters:

indexName - Index on which to perform the request. (required)

synonymHit - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonyms

public UpdatedAtResponse saveSynonyms(@Nonnull
 String indexName,
 @Nonnull
 List<SynonymHit> synonymHit)
                               throws AlgoliaRuntimeException

Create or update multiple synonyms.

Parameters:

indexName - Index on which to perform the request. (required)

synonymHit - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonymsAsync

public CompletableFuture<UpdatedAtResponse> saveSynonymsAsync(@Nonnull
 String indexName,
 @Nonnull
 List<SynonymHit> synonymHit,
 Boolean forwardToReplicas,
 Boolean replaceExistingSynonyms,
 RequestOptions requestOptions)
                                                       throws AlgoliaRuntimeException

(asynchronously) Create or update multiple synonyms.

Parameters:

indexName - Index on which to perform the request. (required)

synonymHit - (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

replaceExistingSynonyms - Indicates whether to replace all synonyms in the index with the ones sent with this request. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonymsAsync

public CompletableFuture<UpdatedAtResponse> saveSynonymsAsync(@Nonnull
 String indexName,
 @Nonnull
 List<SynonymHit> synonymHit,
 Boolean forwardToReplicas,
 Boolean replaceExistingSynonyms)
                                                       throws AlgoliaRuntimeException

(asynchronously) Create or update multiple synonyms.

Parameters:

indexName - Index on which to perform the request. (required)

synonymHit - (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

replaceExistingSynonyms - Indicates whether to replace all synonyms in the index with the ones sent with this request. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonymsAsync

public CompletableFuture<UpdatedAtResponse> saveSynonymsAsync(@Nonnull
 String indexName,
 @Nonnull
 List<SynonymHit> synonymHit,
 RequestOptions requestOptions)
                                                       throws AlgoliaRuntimeException

(asynchronously) Create or update multiple synonyms.

Parameters:

indexName - Index on which to perform the request. (required)

synonymHit - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonymsAsync

public CompletableFuture<UpdatedAtResponse> saveSynonymsAsync(@Nonnull
 String indexName,
 @Nonnull
 List<SynonymHit> synonymHit)
                                                       throws AlgoliaRuntimeException

(asynchronously) Create or update multiple synonyms.

Parameters:

indexName - Index on which to perform the request. (required)

synonymHit - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

search

public SearchResponses search(@Nonnull
 SearchMethodParams searchMethodParams,
 RequestOptions requestOptions)
                       throws AlgoliaRuntimeException

Send multiple search queries to one or more indices.

Parameters:

searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

search

public SearchResponses search(@Nonnull
 SearchMethodParams searchMethodParams)
                       throws AlgoliaRuntimeException

Send multiple search queries to one or more indices.

Parameters:

searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchAsync

public CompletableFuture<SearchResponses> searchAsync(@Nonnull
 SearchMethodParams searchMethodParams,
 RequestOptions requestOptions)
                                               throws AlgoliaRuntimeException

(asynchronously) Send multiple search queries to one or more indices.

Parameters:

searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchAsync

public CompletableFuture<SearchResponses> searchAsync(@Nonnull
 SearchMethodParams searchMethodParams)
                                               throws AlgoliaRuntimeException

(asynchronously) Send multiple search queries to one or more indices.

Parameters:

searchMethodParams - Query requests and strategies. Results will be received in the same order as the queries. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchDictionaryEntries

public UpdatedAtResponse searchDictionaryEntries(@Nonnull
 DictionaryType dictionaryName,
 @Nonnull
 SearchDictionaryEntriesParams searchDictionaryEntriesParams,
 RequestOptions requestOptions)
                                          throws AlgoliaRuntimeException

Search for standard and [custom](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/) entries in the [stop words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plurals](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), or [segmentation (compounds)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) dictionaries.

Parameters:

dictionaryName - Dictionary to search in. (required)

searchDictionaryEntriesParams - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchDictionaryEntries

public UpdatedAtResponse searchDictionaryEntries(@Nonnull
 DictionaryType dictionaryName,
 @Nonnull
 SearchDictionaryEntriesParams searchDictionaryEntriesParams)
                                          throws AlgoliaRuntimeException

Search for standard and [custom](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/) entries in the [stop words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plurals](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), or [segmentation (compounds)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) dictionaries.

Parameters:

dictionaryName - Dictionary to search in. (required)

searchDictionaryEntriesParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchDictionaryEntriesAsync

public CompletableFuture<UpdatedAtResponse> searchDictionaryEntriesAsync(@Nonnull
 DictionaryType dictionaryName,
 @Nonnull
 SearchDictionaryEntriesParams searchDictionaryEntriesParams,
 RequestOptions requestOptions)
                                                                  throws AlgoliaRuntimeException

(asynchronously) Search for standard and [custom](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/) entries in the [stop words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plurals](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), or [segmentation (compounds)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) dictionaries.

Parameters:

dictionaryName - Dictionary to search in. (required)

searchDictionaryEntriesParams - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchDictionaryEntriesAsync

public CompletableFuture<UpdatedAtResponse> searchDictionaryEntriesAsync(@Nonnull
 DictionaryType dictionaryName,
 @Nonnull
 SearchDictionaryEntriesParams searchDictionaryEntriesParams)
                                                                  throws AlgoliaRuntimeException

(asynchronously) Search for standard and [custom](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/) entries in the [stop words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-stop-words/), [plurals](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/), or [segmentation (compounds)](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) dictionaries.

Parameters:

dictionaryName - Dictionary to search in. (required)

searchDictionaryEntriesParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchForFacetValues

public SearchForFacetValuesResponse searchForFacetValues(@Nonnull
 String indexName,
 @Nonnull
 String facetName,
 SearchForFacetValuesRequest searchForFacetValuesRequest,
 RequestOptions requestOptions)
                                                  throws AlgoliaRuntimeException

[Search for a facet's values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values), optionally restricting the returned values to those contained in records matching other search criteria. > **Note**: Pagination isn't supported (`page` and `hitsPerPage` are ignored). By default, the engine returns a maximum of 10 values but you can adjust this with `maxFacetHits`.

Parameters:

indexName - Index on which to perform the request. (required)

facetName - Facet name. (required)

searchForFacetValuesRequest - (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchForFacetValues

public SearchForFacetValuesResponse searchForFacetValues(@Nonnull
 String indexName,
 @Nonnull
 String facetName,
 SearchForFacetValuesRequest searchForFacetValuesRequest)
                                                  throws AlgoliaRuntimeException

[Search for a facet's values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values), optionally restricting the returned values to those contained in records matching other search criteria. > **Note**: Pagination isn't supported (`page` and `hitsPerPage` are ignored). By default, the engine returns a maximum of 10 values but you can adjust this with `maxFacetHits`.

Parameters:

indexName - Index on which to perform the request. (required)

facetName - Facet name. (required)

searchForFacetValuesRequest - (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchForFacetValues

public SearchForFacetValuesResponse searchForFacetValues(@Nonnull
 String indexName,
 @Nonnull
 String facetName,
 RequestOptions requestOptions)
                                                  throws AlgoliaRuntimeException

[Search for a facet's values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values), optionally restricting the returned values to those contained in records matching other search criteria. > **Note**: Pagination isn't supported (`page` and `hitsPerPage` are ignored). By default, the engine returns a maximum of 10 values but you can adjust this with `maxFacetHits`.

Parameters:

indexName - Index on which to perform the request. (required)

facetName - Facet name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchForFacetValues

public SearchForFacetValuesResponse searchForFacetValues(@Nonnull
 String indexName,
 @Nonnull
 String facetName)
                                                  throws AlgoliaRuntimeException

[Search for a facet's values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values), optionally restricting the returned values to those contained in records matching other search criteria. > **Note**: Pagination isn't supported (`page` and `hitsPerPage` are ignored). By default, the engine returns a maximum of 10 values but you can adjust this with `maxFacetHits`.

Parameters:

indexName - Index on which to perform the request. (required)

facetName - Facet name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchForFacetValuesAsync

public CompletableFuture<SearchForFacetValuesResponse> searchForFacetValuesAsync(@Nonnull
 String indexName,
 @Nonnull
 String facetName,
 SearchForFacetValuesRequest searchForFacetValuesRequest,
 RequestOptions requestOptions)
                                                                          throws AlgoliaRuntimeException

(asynchronously) [Search for a facet's values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values), optionally restricting the returned values to those contained in records matching other search criteria. > **Note**: Pagination isn't supported (`page` and `hitsPerPage` are ignored). By default, the engine returns a maximum of 10 values but you can adjust this with `maxFacetHits`.

Parameters:

indexName - Index on which to perform the request. (required)

facetName - Facet name. (required)

searchForFacetValuesRequest - (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchForFacetValuesAsync

public CompletableFuture<SearchForFacetValuesResponse> searchForFacetValuesAsync(@Nonnull
 String indexName,
 @Nonnull
 String facetName,
 SearchForFacetValuesRequest searchForFacetValuesRequest)
                                                                          throws AlgoliaRuntimeException

(asynchronously) [Search for a facet's values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values), optionally restricting the returned values to those contained in records matching other search criteria. > **Note**: Pagination isn't supported (`page` and `hitsPerPage` are ignored). By default, the engine returns a maximum of 10 values but you can adjust this with `maxFacetHits`.

Parameters:

indexName - Index on which to perform the request. (required)

facetName - Facet name. (required)

searchForFacetValuesRequest - (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchForFacetValuesAsync

public CompletableFuture<SearchForFacetValuesResponse> searchForFacetValuesAsync(@Nonnull
 String indexName,
 @Nonnull
 String facetName,
 RequestOptions requestOptions)
                                                                          throws AlgoliaRuntimeException

(asynchronously) [Search for a facet's values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values), optionally restricting the returned values to those contained in records matching other search criteria. > **Note**: Pagination isn't supported (`page` and `hitsPerPage` are ignored). By default, the engine returns a maximum of 10 values but you can adjust this with `maxFacetHits`.

Parameters:

indexName - Index on which to perform the request. (required)

facetName - Facet name. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchForFacetValuesAsync

public CompletableFuture<SearchForFacetValuesResponse> searchForFacetValuesAsync(@Nonnull
 String indexName,
 @Nonnull
 String facetName)
                                                                          throws AlgoliaRuntimeException

(asynchronously) [Search for a facet's values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values), optionally restricting the returned values to those contained in records matching other search criteria. > **Note**: Pagination isn't supported (`page` and `hitsPerPage` are ignored). By default, the engine returns a maximum of 10 values but you can adjust this with `maxFacetHits`.

Parameters:

indexName - Index on which to perform the request. (required)

facetName - Facet name. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchRules

public SearchRulesResponse searchRules(@Nonnull
 String indexName,
 SearchRulesParams searchRulesParams,
 RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

Search for rules in your index. You can control the search with parameters. To list all rules, send an empty request body.

Parameters:

indexName - Index on which to perform the request. (required)

searchRulesParams - (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchRules

public SearchRulesResponse searchRules(@Nonnull
 String indexName,
 SearchRulesParams searchRulesParams)
                                throws AlgoliaRuntimeException

Search for rules in your index. You can control the search with parameters. To list all rules, send an empty request body.

Parameters:

indexName - Index on which to perform the request. (required)

searchRulesParams - (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchRules

public SearchRulesResponse searchRules(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

Search for rules in your index. You can control the search with parameters. To list all rules, send an empty request body.

Parameters:

indexName - Index on which to perform the request. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchRules

public SearchRulesResponse searchRules(@Nonnull
 String indexName)
                                throws AlgoliaRuntimeException

Search for rules in your index. You can control the search with parameters. To list all rules, send an empty request body.

Parameters:

indexName - Index on which to perform the request. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchRulesAsync

public CompletableFuture<SearchRulesResponse> searchRulesAsync(@Nonnull
 String indexName,
 SearchRulesParams searchRulesParams,
 RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

(asynchronously) Search for rules in your index. You can control the search with parameters. To list all rules, send an empty request body.

Parameters:

indexName - Index on which to perform the request. (required)

searchRulesParams - (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchRulesAsync

public CompletableFuture<SearchRulesResponse> searchRulesAsync(@Nonnull
 String indexName,
 SearchRulesParams searchRulesParams)
                                                        throws AlgoliaRuntimeException

(asynchronously) Search for rules in your index. You can control the search with parameters. To list all rules, send an empty request body.

Parameters:

indexName - Index on which to perform the request. (required)

searchRulesParams - (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchRulesAsync

public CompletableFuture<SearchRulesResponse> searchRulesAsync(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

(asynchronously) Search for rules in your index. You can control the search with parameters. To list all rules, send an empty request body.

Parameters:

indexName - Index on which to perform the request. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchRulesAsync

public CompletableFuture<SearchRulesResponse> searchRulesAsync(@Nonnull
 String indexName)
                                                        throws AlgoliaRuntimeException

(asynchronously) Search for rules in your index. You can control the search with parameters. To list all rules, send an empty request body.

Parameters:

indexName - Index on which to perform the request. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSingleIndex

public <T> SearchResponse<T> searchSingleIndex(@Nonnull
 String indexName,
 SearchParams searchParams,
 Class<T> innerType,
 RequestOptions requestOptions)
                                        throws AlgoliaRuntimeException

Return records that match the query.

Parameters:

indexName - Index on which to perform the request. (required)

searchParams - (optional)

innerType - The class held by the index, could be your custom class or Object.

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSingleIndex

public <T> SearchResponse<T> searchSingleIndex(@Nonnull
 String indexName,
 SearchParams searchParams,
 Class<T> innerType)
                                        throws AlgoliaRuntimeException

Return records that match the query.

Parameters:

indexName - Index on which to perform the request. (required)

searchParams - (optional)

innerType - The class held by the index, could be your custom class or Object.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSingleIndex

public <T> SearchResponse<T> searchSingleIndex(@Nonnull
 String indexName,
 Class<T> innerType,
 RequestOptions requestOptions)
                                        throws AlgoliaRuntimeException

Return records that match the query.

Parameters:

indexName - Index on which to perform the request. (required)

innerType - The class held by the index, could be your custom class or Object.

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSingleIndex

public <T> SearchResponse<T> searchSingleIndex(@Nonnull
 String indexName,
 Class<T> innerType)
                                        throws AlgoliaRuntimeException

Return records that match the query.

Parameters:

indexName - Index on which to perform the request. (required)

innerType - The class held by the index, could be your custom class or Object.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSingleIndexAsync

public <T> CompletableFuture<SearchResponse<T>> searchSingleIndexAsync(@Nonnull
 String indexName,
 SearchParams searchParams,
 Class<T> innerType,
 RequestOptions requestOptions)
                                                                throws AlgoliaRuntimeException

(asynchronously) Return records that match the query.

Parameters:

indexName - Index on which to perform the request. (required)

searchParams - (optional)

innerType - The class held by the index, could be your custom class or Object.

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSingleIndexAsync

public <T> CompletableFuture<SearchResponse<T>> searchSingleIndexAsync(@Nonnull
 String indexName,
 SearchParams searchParams,
 Class<T> innerType)
                                                                throws AlgoliaRuntimeException

(asynchronously) Return records that match the query.

Parameters:

indexName - Index on which to perform the request. (required)

searchParams - (optional)

innerType - The class held by the index, could be your custom class or Object.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSingleIndexAsync

public <T> CompletableFuture<SearchResponse<T>> searchSingleIndexAsync(@Nonnull
 String indexName,
 Class<T> innerType,
 RequestOptions requestOptions)
                                                                throws AlgoliaRuntimeException

(asynchronously) Return records that match the query.

Parameters:

indexName - Index on which to perform the request. (required)

innerType - The class held by the index, could be your custom class or Object.

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSingleIndexAsync

public <T> CompletableFuture<SearchResponse<T>> searchSingleIndexAsync(@Nonnull
 String indexName,
 Class<T> innerType)
                                                                throws AlgoliaRuntimeException

(asynchronously) Return records that match the query.

Parameters:

indexName - Index on which to perform the request. (required)

innerType - The class held by the index, could be your custom class or Object.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSynonyms

public SearchSynonymsResponse searchSynonyms(@Nonnull
 String indexName,
 SynonymType type,
 Integer page,
 Integer hitsPerPage,
 SearchSynonymsParams searchSynonymsParams,
 RequestOptions requestOptions)
                                      throws AlgoliaRuntimeException

Search for synonyms in your index. You can control and filter the search with parameters. To get all synonyms, send an empty request body.

Parameters:

indexName - Index on which to perform the request. (required)

type - Search for specific [types of synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms). (optional)

page - Returns the requested page number (the first page is 0). Page size is set by `hitsPerPage`. When null, there's no pagination. (optional, default to 0)

hitsPerPage - Maximum number of hits per page. (optional, default to 100)

searchSynonymsParams - Body of the `searchSynonyms` operation. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSynonyms

public SearchSynonymsResponse searchSynonyms(@Nonnull
 String indexName,
 SynonymType type,
 Integer page,
 Integer hitsPerPage,
 SearchSynonymsParams searchSynonymsParams)
                                      throws AlgoliaRuntimeException

Search for synonyms in your index. You can control and filter the search with parameters. To get all synonyms, send an empty request body.

Parameters:

indexName - Index on which to perform the request. (required)

type - Search for specific [types of synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms). (optional)

page - Returns the requested page number (the first page is 0). Page size is set by `hitsPerPage`. When null, there's no pagination. (optional, default to 0)

hitsPerPage - Maximum number of hits per page. (optional, default to 100)

searchSynonymsParams - Body of the `searchSynonyms` operation. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSynonyms

public SearchSynonymsResponse searchSynonyms(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                                      throws AlgoliaRuntimeException

Search for synonyms in your index. You can control and filter the search with parameters. To get all synonyms, send an empty request body.

Parameters:

indexName - Index on which to perform the request. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSynonyms

public SearchSynonymsResponse searchSynonyms(@Nonnull
 String indexName)
                                      throws AlgoliaRuntimeException

Search for synonyms in your index. You can control and filter the search with parameters. To get all synonyms, send an empty request body.

Parameters:

indexName - Index on which to perform the request. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSynonymsAsync

public CompletableFuture<SearchSynonymsResponse> searchSynonymsAsync(@Nonnull
 String indexName,
 SynonymType type,
 Integer page,
 Integer hitsPerPage,
 SearchSynonymsParams searchSynonymsParams,
 RequestOptions requestOptions)
                                                              throws AlgoliaRuntimeException

(asynchronously) Search for synonyms in your index. You can control and filter the search with parameters. To get all synonyms, send an empty request body.

Parameters:

indexName - Index on which to perform the request. (required)

type - Search for specific [types of synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms). (optional)

page - Returns the requested page number (the first page is 0). Page size is set by `hitsPerPage`. When null, there's no pagination. (optional, default to 0)

hitsPerPage - Maximum number of hits per page. (optional, default to 100)

searchSynonymsParams - Body of the `searchSynonyms` operation. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSynonymsAsync

public CompletableFuture<SearchSynonymsResponse> searchSynonymsAsync(@Nonnull
 String indexName,
 SynonymType type,
 Integer page,
 Integer hitsPerPage,
 SearchSynonymsParams searchSynonymsParams)
                                                              throws AlgoliaRuntimeException

(asynchronously) Search for synonyms in your index. You can control and filter the search with parameters. To get all synonyms, send an empty request body.

Parameters:

indexName - Index on which to perform the request. (required)

type - Search for specific [types of synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#the-different-types-of-synonyms). (optional)

page - Returns the requested page number (the first page is 0). Page size is set by `hitsPerPage`. When null, there's no pagination. (optional, default to 0)

hitsPerPage - Maximum number of hits per page. (optional, default to 100)

searchSynonymsParams - Body of the `searchSynonyms` operation. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSynonymsAsync

public CompletableFuture<SearchSynonymsResponse> searchSynonymsAsync(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                                                              throws AlgoliaRuntimeException

(asynchronously) Search for synonyms in your index. You can control and filter the search with parameters. To get all synonyms, send an empty request body.

Parameters:

indexName - Index on which to perform the request. (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSynonymsAsync

public CompletableFuture<SearchSynonymsResponse> searchSynonymsAsync(@Nonnull
 String indexName)
                                                              throws AlgoliaRuntimeException

(asynchronously) Search for synonyms in your index. You can control and filter the search with parameters. To get all synonyms, send an empty request body.

Parameters:

indexName - Index on which to perform the request. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchUserIds

public SearchUserIdsResponse searchUserIds(@Nonnull
 SearchUserIdsParams searchUserIdsParams,
 RequestOptions requestOptions)
                                    throws AlgoliaRuntimeException

Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time. To ensure rapid updates, the user IDs index isn't built at the same time as the mapping. Instead, it's built every 12 hours, at the same time as the update of user ID usage. For example, if you add or move a user ID, the search will show an old value until the next time the mapping is rebuilt (every 12 hours).

Parameters:

searchUserIdsParams - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchUserIds

public SearchUserIdsResponse searchUserIds(@Nonnull
 SearchUserIdsParams searchUserIdsParams)
                                    throws AlgoliaRuntimeException

Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time. To ensure rapid updates, the user IDs index isn't built at the same time as the mapping. Instead, it's built every 12 hours, at the same time as the update of user ID usage. For example, if you add or move a user ID, the search will show an old value until the next time the mapping is rebuilt (every 12 hours).

Parameters:

searchUserIdsParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchUserIdsAsync

public CompletableFuture<SearchUserIdsResponse> searchUserIdsAsync(@Nonnull
 SearchUserIdsParams searchUserIdsParams,
 RequestOptions requestOptions)
                                                            throws AlgoliaRuntimeException

(asynchronously) Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time. To ensure rapid updates, the user IDs index isn't built at the same time as the mapping. Instead, it's built every 12 hours, at the same time as the update of user ID usage. For example, if you add or move a user ID, the search will show an old value until the next time the mapping is rebuilt (every 12 hours).

Parameters:

searchUserIdsParams - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchUserIdsAsync

public CompletableFuture<SearchUserIdsResponse> searchUserIdsAsync(@Nonnull
 SearchUserIdsParams searchUserIdsParams)
                                                            throws AlgoliaRuntimeException

(asynchronously) Since it can take up to a few seconds to get the data from the different clusters, the response isn't real-time. To ensure rapid updates, the user IDs index isn't built at the same time as the mapping. Instead, it's built every 12 hours, at the same time as the update of user ID usage. For example, if you add or move a user ID, the search will show an old value until the next time the mapping is rebuilt (every 12 hours).

Parameters:

searchUserIdsParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setDictionarySettings

public UpdatedAtResponse setDictionarySettings(@Nonnull
 DictionarySettingsParams dictionarySettingsParams,
 RequestOptions requestOptions)
                                        throws AlgoliaRuntimeException

Set stop word settings for a specific language.

Parameters:

dictionarySettingsParams - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setDictionarySettings

public UpdatedAtResponse setDictionarySettings(@Nonnull
 DictionarySettingsParams dictionarySettingsParams)
                                        throws AlgoliaRuntimeException

Set stop word settings for a specific language.

Parameters:

dictionarySettingsParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setDictionarySettingsAsync

public CompletableFuture<UpdatedAtResponse> setDictionarySettingsAsync(@Nonnull
 DictionarySettingsParams dictionarySettingsParams,
 RequestOptions requestOptions)
                                                                throws AlgoliaRuntimeException

(asynchronously) Set stop word settings for a specific language.

Parameters:

dictionarySettingsParams - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setDictionarySettingsAsync

public CompletableFuture<UpdatedAtResponse> setDictionarySettingsAsync(@Nonnull
 DictionarySettingsParams dictionarySettingsParams)
                                                                throws AlgoliaRuntimeException

(asynchronously) Set stop word settings for a specific language.

Parameters:

dictionarySettingsParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setSettings

public UpdatedAtResponse setSettings(@Nonnull
 String indexName,
 @Nonnull
 IndexSettings indexSettings,
 Boolean forwardToReplicas,
 RequestOptions requestOptions)
                              throws AlgoliaRuntimeException

Update the specified [index settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/). Specifying null for a setting resets it to its default value.

Parameters:

indexName - Index on which to perform the request. (required)

indexSettings - (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setSettings

public UpdatedAtResponse setSettings(@Nonnull
 String indexName,
 @Nonnull
 IndexSettings indexSettings,
 Boolean forwardToReplicas)
                              throws AlgoliaRuntimeException

Update the specified [index settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/). Specifying null for a setting resets it to its default value.

Parameters:

indexName - Index on which to perform the request. (required)

indexSettings - (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setSettings

public UpdatedAtResponse setSettings(@Nonnull
 String indexName,
 @Nonnull
 IndexSettings indexSettings,
 RequestOptions requestOptions)
                              throws AlgoliaRuntimeException

Update the specified [index settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/). Specifying null for a setting resets it to its default value.

Parameters:

indexName - Index on which to perform the request. (required)

indexSettings - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setSettings

public UpdatedAtResponse setSettings(@Nonnull
 String indexName,
 @Nonnull
 IndexSettings indexSettings)
                              throws AlgoliaRuntimeException

Update the specified [index settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/). Specifying null for a setting resets it to its default value.

Parameters:

indexName - Index on which to perform the request. (required)

indexSettings - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setSettingsAsync

public CompletableFuture<UpdatedAtResponse> setSettingsAsync(@Nonnull
 String indexName,
 @Nonnull
 IndexSettings indexSettings,
 Boolean forwardToReplicas,
 RequestOptions requestOptions)
                                                      throws AlgoliaRuntimeException

(asynchronously) Update the specified [index settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/). Specifying null for a setting resets it to its default value.

Parameters:

indexName - Index on which to perform the request. (required)

indexSettings - (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setSettingsAsync

public CompletableFuture<UpdatedAtResponse> setSettingsAsync(@Nonnull
 String indexName,
 @Nonnull
 IndexSettings indexSettings,
 Boolean forwardToReplicas)
                                                      throws AlgoliaRuntimeException

(asynchronously) Update the specified [index settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/). Specifying null for a setting resets it to its default value.

Parameters:

indexName - Index on which to perform the request. (required)

indexSettings - (required)

forwardToReplicas - Indicates whether changed index settings are forwarded to the replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setSettingsAsync

public CompletableFuture<UpdatedAtResponse> setSettingsAsync(@Nonnull
 String indexName,
 @Nonnull
 IndexSettings indexSettings,
 RequestOptions requestOptions)
                                                      throws AlgoliaRuntimeException

(asynchronously) Update the specified [index settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/). Specifying null for a setting resets it to its default value.

Parameters:

indexName - Index on which to perform the request. (required)

indexSettings - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setSettingsAsync

public CompletableFuture<UpdatedAtResponse> setSettingsAsync(@Nonnull
 String indexName,
 @Nonnull
 IndexSettings indexSettings)
                                                      throws AlgoliaRuntimeException

(asynchronously) Update the specified [index settings](https://www.algolia.com/doc/api-reference/settings-api-parameters/). Specifying null for a setting resets it to its default value.

Parameters:

indexName - Index on which to perform the request. (required)

indexSettings - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

updateApiKey

public UpdateApiKeyResponse updateApiKey(@Nonnull
 String key,
 @Nonnull
 ApiKey apiKey,
 RequestOptions requestOptions)
                                  throws AlgoliaRuntimeException

Replace the permissions of an existing API key. Any unspecified parameter resets that permission to its default value. The request must be authenticated with the admin API key.

Parameters:

key - API key. (required)

apiKey - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

updateApiKey

public UpdateApiKeyResponse updateApiKey(@Nonnull
 String key,
 @Nonnull
 ApiKey apiKey)
                                  throws AlgoliaRuntimeException

Replace the permissions of an existing API key. Any unspecified parameter resets that permission to its default value. The request must be authenticated with the admin API key.

Parameters:

key - API key. (required)

apiKey - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

updateApiKeyAsync

public CompletableFuture<UpdateApiKeyResponse> updateApiKeyAsync(@Nonnull
 String key,
 @Nonnull
 ApiKey apiKey,
 RequestOptions requestOptions)
                                                          throws AlgoliaRuntimeException

(asynchronously) Replace the permissions of an existing API key. Any unspecified parameter resets that permission to its default value. The request must be authenticated with the admin API key.

Parameters:

key - API key. (required)

apiKey - (required)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

updateApiKeyAsync

public CompletableFuture<UpdateApiKeyResponse> updateApiKeyAsync(@Nonnull
 String key,
 @Nonnull
 ApiKey apiKey)
                                                          throws AlgoliaRuntimeException

(asynchronously) Replace the permissions of an existing API key. Any unspecified parameter resets that permission to its default value. The request must be authenticated with the admin API key.

Parameters:

key - API key. (required)

apiKey - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

waitForTask

public void waitForTask(String indexName,
 Long taskID,
 int maxRetries,
 IntUnaryOperator timeout,
 RequestOptions requestOptions)

Helper: Wait for a task to complete with `indexName` and `taskID`.

Parameters:

indexName - The `indexName` where the operation was performed.

taskID - The `taskID` returned in the method response.

maxRetries - The maximum number of retry. 50 by default. (optional)

timeout - The function to decide how long to wait between retries. min(retries * 200, 5000) by default. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. (optional)

waitForTask

public void waitForTask(String indexName,
 Long taskID,
 RequestOptions requestOptions)

Helper: Wait for a task to complete with `indexName` and `taskID`.

Parameters:

indexName - The `indexName` where the operation was performed.

taskID - The `taskID` returned in the method response.

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. (optional)

waitForTask

public void waitForTask(String indexName,
 Long taskID,
 int maxRetries,
 IntUnaryOperator timeout)

Helper: Wait for a task to complete with `indexName` and `taskID`.

Parameters:

indexName - The `indexName` where the operation was performed.

taskID - The `taskID` returned in the method response.

maxRetries - The maximum number of retry. 50 by default. (optional)

timeout - The function to decide how long to wait between retries. min(retries * 200, 5000) by default. (optional)

waitForTask

public void waitForTask(String indexName,
 Long taskID)

Helper: Wait for a task to complete with `indexName` and `taskID`.

Parameters:

indexName - The `indexName` where the operation was performed.

taskID - The `taskID` returned in the method response.

waitForApiKey

public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation,
 String key,
 ApiKey apiKey,
 int maxRetries,
 IntUnaryOperator timeout,
 RequestOptions requestOptions)

Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.

Parameters:

operation - The `operation` that was done on a `key`.

key - The `key` that has been added, deleted or updated.

apiKey - Necessary to know if an `update` operation has been processed, compare fields of the response with it.

maxRetries - The maximum number of retry. 50 by default. (optional)

timeout - The function to decide how long to wait between retries. min(retries * 200, 5000) by default. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. (optional)

waitForApiKey

public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation,
 String key,
 int maxRetries,
 IntUnaryOperator timeout,
 RequestOptions requestOptions)

Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.

Parameters:

operation - The `operation` that was done on a `key`. (ADD or DELETE only)

key - The `key` that has been added, deleted or updated.

maxRetries - The maximum number of retry. 50 by default. (optional)

timeout - The function to decide how long to wait between retries. min(retries * 200, 5000) by default. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. (optional)

waitForApiKey

public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation,
 String key,
 ApiKey apiKey,
 RequestOptions requestOptions)

Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.

Parameters:

operation - The `operation` that was done on a `key`.

key - The `key` that has been added, deleted or updated.

apiKey - Necessary to know if an `update` operation has been processed, compare fields of the response with it.

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. (optional)

waitForApiKey

public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation,
 String key,
 RequestOptions requestOptions)

Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.

Parameters:

operation - The `operation` that was done on a `key`. (ADD or DELETE only)

key - The `key` that has been added, deleted or updated.

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. (optional)

waitForApiKey

public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation,
 String key,
 ApiKey apiKey,
 int maxRetries,
 IntUnaryOperator timeout)

Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.

Parameters:

operation - The `operation` that was done on a `key`.

key - The `key` that has been added, deleted or updated.

apiKey - Necessary to know if an `update` operation has been processed, compare fields of the response with it.

maxRetries - The maximum number of retry. 50 by default. (optional)

timeout - The function to decide how long to wait between retries. min(retries * 200, 5000) by default. (optional)

waitForApiKey

public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation,
 String key,
 int maxRetries,
 IntUnaryOperator timeout)

Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.

Parameters:

operation - The `operation` that was done on a `key`. (ADD or DELETE only)

key - The `key` that has been added, deleted or updated.

maxRetries - The maximum number of retry. 50 by default. (optional)

timeout - The function to decide how long to wait between retries. min(retries * 200, 5000) by default. (optional)

waitForApiKey

public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation,
 String key,
 ApiKey apiKey)

Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.

Parameters:

operation - The `operation` that was done on a `key`.

key - The `key` that has been added, deleted or updated.

apiKey - Necessary to know if an `update` operation has been processed, compare fields of the response with it.

waitForApiKey

public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation,
 String key)

Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.

Parameters:

operation - The `operation` that was done on a `key`. (ADD or DELETE only)

key - The `key` that has been added, deleted or updated.

browseObjects

public <T> Iterable<T> browseObjects(String indexName,
 BrowseParamsObject params,
 Class<T> innerType,
 RequestOptions requestOptions)

Helper: Returns an iterator on top of the `browse` method.

Parameters:

indexName - The index in which to perform the request.

params - The `browse` parameters.

innerType - The class held by the index, could be your custom class or Object.

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. (optional)

browseObjects

public <T> Iterable<T> browseObjects(String indexName,
 BrowseParamsObject params,
 Class<T> innerType)

Helper: Returns an iterator on top of the `browse` method.

Parameters:

indexName - The index in which to perform the request.

params - The `browse` parameters.

innerType - The class held by the index, could be your custom class or Object.

browseSynonyms

public Iterable<SynonymHit> browseSynonyms(String indexName,
 SynonymType type,
 SearchSynonymsParams params,
 RequestOptions requestOptions)

Helper: Returns an iterator on top of the `searchSynonyms` method.

Parameters:

indexName - The index in which to perform the request.

type - The synonym type. (optional)

params - The `searchSynonyms` parameters. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. (optional)

browseSynonyms

public Iterable<SynonymHit> browseSynonyms(String indexName,
 SynonymType type,
 SearchSynonymsParams params)

Helper: Returns an iterator on top of the `searchSynonyms` method.

Parameters:

indexName - The index in which to perform the request.

type - The synonym type. (optional)

params - The `searchSynonyms` parameters .(optional)

browseSynonyms

public Iterable<SynonymHit> browseSynonyms(String indexName)

Helper: Returns an iterator on top of the `searchSynonyms` method.

Parameters:

indexName - The index in which to perform the request.

browseRules

public Iterable<Rule> browseRules(String indexName,
 SearchRulesParams params,
 RequestOptions requestOptions)

Helper: Returns an iterator on top of the `searchRules` method.

Parameters:

indexName - The index in which to perform the request.

params - The `searchRules` parameters. (optional)

requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions. (optional)

browseRules

public Iterable<Rule> browseRules(String indexName,
 SearchRulesParams params)

Helper: Returns an iterator on top of the `searchRules` method.

Parameters:

indexName - The index in which to perform the request.

params - The `searchRules` parameters. (optional)

browseRules

public Iterable<Rule> browseRules(String indexName)

Helper: Returns an iterator on top of the `searchRules` method.

Parameters:

indexName - The index in which to perform the request.