Package com.algolia.api

Class SearchClient

java.lang.Object

com.algolia.ApiClient

com.algolia.api.SearchClient

public class SearchClient
extends ApiClient

Field Summary

Fields inherited from class com.algolia.ApiClient

json

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<Object>	search(SearchMethodParams searchMethodParams)	Send multiple search queries to one or more indices.
SearchResponses<Object>	search(SearchMethodParams searchMethodParams, RequestOptions requestOptions)	Send multiple search queries to one or more indices.
<T> SearchResponses<T>	search(SearchMethodParams searchMethodParams, Class<T> innerType)	Send multiple search queries to one or more indices.
<T> SearchResponses<T>	search(SearchMethodParams searchMethodParams, Class<T> innerType, RequestOptions requestOptions)	Send multiple search queries to one or more indices.
CompletableFuture<SearchResponses<Object>>	searchAsync(SearchMethodParams searchMethodParams)	(asynchronously) Send multiple search queries to one or more indices.
CompletableFuture<SearchResponses<Object>>	searchAsync(SearchMethodParams searchMethodParams, RequestOptions requestOptions)	(asynchronously) Send multiple search queries to one or more indices.
<T> CompletableFuture<SearchResponses<T>>	searchAsync(SearchMethodParams searchMethodParams, Class<T> innerType)	(asynchronously) Send multiple search queries to one or more indices.
<T> CompletableFuture<SearchResponses<T>>	searchAsync(SearchMethodParams searchMethodParams, Class<T> innerType, 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, 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.
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.
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, 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.
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.
SearchRulesResponse	searchRules(String indexName)	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.
SearchRulesResponse	searchRules(String indexName, 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, 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.
CompletableFuture<SearchRulesResponse>	searchRulesAsync(String indexName, 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, 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.
SearchSynonymsResponse	searchSynonyms(String indexName, 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, 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.
CompletableFuture<SearchSynonymsResponse>	searchSynonymsAsync(String indexName, 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, 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`.
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`.
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

addAlgoliaAgent, addDefaultHeader, buildCall, buildRequest, buildUrl, escapeString, executeAsync, executeAsync, executeAsync, getConnectTimeout, getReadTimeout, getWriteTimeout, isDebugging, parameterToString, processHeaderParams, removeAlgoliaAgent, serialize, setConnectTimeout, setHosts, setLogLevel, setReadTimeout, setWriteTimeout

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(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.

Returns:

AddApiKeyResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

addApiKey

public AddApiKeyResponse addApiKey(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)

Returns:

AddApiKeyResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

addApiKeyAsync

public CompletableFuture<AddApiKeyResponse> addApiKeyAsync(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.

Returns:

CompletableFuture The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

addApiKeyAsync

public CompletableFuture<AddApiKeyResponse> addApiKeyAsync(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)

Returns:

CompletableFuture The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

addOrUpdateObject

public UpdatedAtWithObjectIdResponse addOrUpdateObject(String indexName,
 String objectID,
 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.

Returns:

UpdatedAtWithObjectIdResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

addOrUpdateObject

public UpdatedAtWithObjectIdResponse addOrUpdateObject(String indexName,
 String objectID,
 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)

Returns:

UpdatedAtWithObjectIdResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

addOrUpdateObjectAsync

public CompletableFuture<UpdatedAtWithObjectIdResponse> addOrUpdateObjectAsync(String indexName,
 String objectID,
 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.

Returns:

CompletableFuture The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

addOrUpdateObjectAsync

public CompletableFuture<UpdatedAtWithObjectIdResponse> addOrUpdateObjectAsync(String indexName,
 String objectID,
 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)

Returns:

CompletableFuture The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

appendSource

public CreatedAtResponse appendSource(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.

Returns:

CreatedAtResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

appendSource

public CreatedAtResponse appendSource(Source source)
                               throws AlgoliaRuntimeException

Add a source to the list of allowed sources.

Parameters:

source - Source to add. (required)

Returns:

CreatedAtResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

appendSourceAsync

public CompletableFuture<CreatedAtResponse> appendSourceAsync(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.

Returns:

CompletableFuture The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

appendSourceAsync

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

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

Parameters:

source - Source to add. (required)

Returns:

CompletableFuture The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

assignUserId

public CreatedAtResponse assignUserId(String xAlgoliaUserID,
 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.

Returns:

CreatedAtResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

assignUserId

public CreatedAtResponse assignUserId(String xAlgoliaUserID,
 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)

Returns:

CreatedAtResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

assignUserIdAsync

public CompletableFuture<CreatedAtResponse> assignUserIdAsync(String xAlgoliaUserID,
 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.

Returns:

CompletableFuture The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

assignUserIdAsync

public CompletableFuture<CreatedAtResponse> assignUserIdAsync(String xAlgoliaUserID,
 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)

Returns:

CompletableFuture The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batch

public BatchResponse batch(String indexName,
 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.

Returns:

BatchResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batch

public BatchResponse batch(String indexName,
 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)

Returns:

BatchResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchAsync

public CompletableFuture<BatchResponse> batchAsync(String indexName,
 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.

Returns:

CompletableFuture The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchAsync

public CompletableFuture<BatchResponse> batchAsync(String indexName,
 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)

Returns:

CompletableFuture The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchAssignUserIds

public CreatedAtResponse batchAssignUserIds(String xAlgoliaUserID,
 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.

Returns:

CreatedAtResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchAssignUserIds

public CreatedAtResponse batchAssignUserIds(String xAlgoliaUserID,
 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)

Returns:

CreatedAtResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchAssignUserIdsAsync

public CompletableFuture<CreatedAtResponse> batchAssignUserIdsAsync(String xAlgoliaUserID,
 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.

Returns:

CompletableFuture The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchAssignUserIdsAsync

public CompletableFuture<CreatedAtResponse> batchAssignUserIdsAsync(String xAlgoliaUserID,
 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)

Returns:

CompletableFuture The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchDictionaryEntries

public UpdatedAtResponse batchDictionaryEntries(DictionaryType dictionaryName,
 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.

Returns:

UpdatedAtResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchDictionaryEntries

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

Add or remove a batch of dictionary entries.

Parameters:

dictionaryName - Dictionary to search in. (required)

batchDictionaryEntriesParams - (required)

Returns:

UpdatedAtResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchDictionaryEntriesAsync

public CompletableFuture<UpdatedAtResponse> batchDictionaryEntriesAsync(DictionaryType dictionaryName,
 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.

Returns:

CompletableFuture The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchDictionaryEntriesAsync

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

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

Parameters:

dictionaryName - Dictionary to search in. (required)

batchDictionaryEntriesParams - (required)

Returns:

CompletableFuture The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

browse

public <T> BrowseResponse<T> browse(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.

Returns:

BrowseResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

browse

public <T> BrowseResponse<T> browse(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.

Returns:

BrowseResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

browse

public <T> BrowseResponse<T> browse(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.

Returns:

BrowseResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

browse

public <T> BrowseResponse<T> browse(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.

Returns:

BrowseResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

browseAsync

public <T> CompletableFuture<BrowseResponse<T>> browseAsync(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.

Returns:

CompletableFuture<BrowseResponse> The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

browseAsync

public <T> CompletableFuture<BrowseResponse<T>> browseAsync(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.

Returns:

CompletableFuture<BrowseResponse> The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

browseAsync

public <T> CompletableFuture<BrowseResponse<T>> browseAsync(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.

Returns:

CompletableFuture<BrowseResponse> The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

browseAsync

public <T> CompletableFuture<BrowseResponse<T>> browseAsync(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.

Returns:

CompletableFuture<BrowseResponse> The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearAllSynonyms

public UpdatedAtResponse clearAllSynonyms(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.

Returns:

UpdatedAtResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearAllSynonyms

public UpdatedAtResponse clearAllSynonyms(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)

Returns:

UpdatedAtResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearAllSynonyms

public UpdatedAtResponse clearAllSynonyms(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.

Returns:

UpdatedAtResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearAllSynonyms

public UpdatedAtResponse clearAllSynonyms(String indexName)
                                   throws AlgoliaRuntimeException

Delete all synonyms in the index.

Parameters:

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

Returns:

UpdatedAtResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearAllSynonymsAsync

public CompletableFuture<UpdatedAtResponse> clearAllSynonymsAsync(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.

Returns:

CompletableFuture The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearAllSynonymsAsync

public CompletableFuture<UpdatedAtResponse> clearAllSynonymsAsync(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)

Returns:

CompletableFuture The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearAllSynonymsAsync

public CompletableFuture<UpdatedAtResponse> clearAllSynonymsAsync(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.

Returns:

CompletableFuture The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearAllSynonymsAsync

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

(asynchronously) Delete all synonyms in the index.

Parameters:

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

Returns:

CompletableFuture The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearObjects

public UpdatedAtResponse clearObjects(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.

Returns:

UpdatedAtResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearObjects

public UpdatedAtResponse clearObjects(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)

Returns:

UpdatedAtResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearObjectsAsync

public CompletableFuture<UpdatedAtResponse> clearObjectsAsync(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.

Returns:

CompletableFuture The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearObjectsAsync

public CompletableFuture<UpdatedAtResponse> clearObjectsAsync(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)

Returns:

CompletableFuture The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearRules

public UpdatedAtResponse clearRules(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.

Returns:

UpdatedAtResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearRules

public UpdatedAtResponse clearRules(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)

Returns:

UpdatedAtResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearRules

public UpdatedAtResponse clearRules(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.

Returns:

UpdatedAtResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearRules

public UpdatedAtResponse clearRules(String indexName)
                             throws AlgoliaRuntimeException

Delete all rules in the index.

Parameters:

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

Returns:

UpdatedAtResponse

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearRulesAsync

public CompletableFuture<UpdatedAtResponse> clearRulesAsync(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.

Returns:

CompletableFuture The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearRulesAsync

public CompletableFuture<UpdatedAtResponse> clearRulesAsync(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)

Returns:

CompletableFuture The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearRulesAsync

public CompletableFuture<UpdatedAtResponse> clearRulesAsync(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.

Returns:

CompletableFuture The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearRulesAsync

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

(asynchronously) Delete all rules in the index.

Parameters:

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

Returns:

CompletableFuture The awaitable future

Throws:

AlgoliaRuntimeException - If it fails to process the API call

del

public Object del(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.

Returns:

Object

Throws:

AlgoliaRuntimeException - If it fails to process the API call

del

public Object del(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)

Returns:

Object

Throws:

AlgoliaRuntimeException - If it fails to process the API call

del

public Object del(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.

Returns:

Object

Throws:

AlgoliaRuntimeException - If it fails to process the API call

del

public Object del(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)

Returns:

Object

Throws:

AlgoliaRuntimeException - If it fails to process the API call

delAsync

public CompletableFuture<Object> delAsync(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.

Returns:

CompletableFuture