Package com.algolia.api

Class SearchClient

java.lang.Object

com.algolia.ApiClient

com.algolia.api.SearchClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class SearchClient
extends ApiClient

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
AddApiKeyResponse	addApiKey(ApiKey apiKey)	Creates a new API key with specific permissions and restrictions.
AddApiKeyResponse	addApiKey(ApiKey apiKey, RequestOptions requestOptions)	Creates a new API key with specific permissions and restrictions.
CompletableFuture<AddApiKeyResponse>	addApiKeyAsync(ApiKey apiKey)	(asynchronously) Creates a new API key with specific permissions and restrictions.
CompletableFuture<AddApiKeyResponse>	addApiKeyAsync(ApiKey apiKey, RequestOptions requestOptions)	(asynchronously) Creates a new API key with specific permissions and restrictions.
UpdatedAtWithObjectIdResponse	addOrUpdateObject(String indexName, String objectID, Object body)	If a record with the specified object ID exists, the existing record is replaced.
UpdatedAtWithObjectIdResponse	addOrUpdateObject(String indexName, String objectID, Object body, RequestOptions requestOptions)	If a record with the specified object ID exists, the existing record is replaced.
CompletableFuture<UpdatedAtWithObjectIdResponse>	addOrUpdateObjectAsync(String indexName, String objectID, Object body)	(asynchronously) If a record with the specified object ID exists, the existing record is replaced.
CompletableFuture<UpdatedAtWithObjectIdResponse>	addOrUpdateObjectAsync(String indexName, String objectID, Object body, RequestOptions requestOptions)	(asynchronously) If a record with the specified object ID exists, the existing record is replaced.
CreatedAtResponse	appendSource(Source source)	Adds a source to the list of allowed sources.
CreatedAtResponse	appendSource(Source source, RequestOptions requestOptions)	Adds a source to the list of allowed sources.
CompletableFuture<CreatedAtResponse>	appendSourceAsync(Source source)	(asynchronously) Adds a source to the list of allowed sources.
CompletableFuture<CreatedAtResponse>	appendSourceAsync(Source source, RequestOptions requestOptions)	(asynchronously) Adds a source to the list of allowed sources.
CreatedAtResponse	assignUserId(String xAlgoliaUserID, AssignUserIdParams assignUserIdParams)	Assigns or moves a user ID to a cluster.
CreatedAtResponse	assignUserId(String xAlgoliaUserID, AssignUserIdParams assignUserIdParams, RequestOptions requestOptions)	Assigns or moves a user ID to a cluster.
CompletableFuture<CreatedAtResponse>	assignUserIdAsync(String xAlgoliaUserID, AssignUserIdParams assignUserIdParams)	(asynchronously) Assigns or moves a user ID to a cluster.
CompletableFuture<CreatedAtResponse>	assignUserIdAsync(String xAlgoliaUserID, AssignUserIdParams assignUserIdParams, RequestOptions requestOptions)	(asynchronously) Assigns or moves a user ID to a cluster.
BatchResponse	batch(String indexName, BatchWriteParams batchWriteParams)	Adds, updates, or deletes records in one index with a single API request.
BatchResponse	batch(String indexName, BatchWriteParams batchWriteParams, RequestOptions requestOptions)	Adds, updates, or deletes records in one index with a single API request.
CreatedAtResponse	batchAssignUserIds(String xAlgoliaUserID, BatchAssignUserIdsParams batchAssignUserIdsParams)	Assigns multiple user IDs to a cluster.
CreatedAtResponse	batchAssignUserIds(String xAlgoliaUserID, BatchAssignUserIdsParams batchAssignUserIdsParams, RequestOptions requestOptions)	Assigns multiple user IDs to a cluster.
CompletableFuture<CreatedAtResponse>	batchAssignUserIdsAsync(String xAlgoliaUserID, BatchAssignUserIdsParams batchAssignUserIdsParams)	(asynchronously) Assigns multiple user IDs to a cluster.
CompletableFuture<CreatedAtResponse>	batchAssignUserIdsAsync(String xAlgoliaUserID, BatchAssignUserIdsParams batchAssignUserIdsParams, RequestOptions requestOptions)	(asynchronously) Assigns multiple user IDs to a cluster.
CompletableFuture<BatchResponse>	batchAsync(String indexName, BatchWriteParams batchWriteParams)	(asynchronously) Adds, updates, or deletes records in one index with a single API request.
CompletableFuture<BatchResponse>	batchAsync(String indexName, BatchWriteParams batchWriteParams, RequestOptions requestOptions)	(asynchronously) Adds, updates, or deletes records in one index with a single API request.
UpdatedAtResponse	batchDictionaryEntries(DictionaryType dictionaryName, BatchDictionaryEntriesParams batchDictionaryEntriesParams)	Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.
UpdatedAtResponse	batchDictionaryEntries(DictionaryType dictionaryName, BatchDictionaryEntriesParams batchDictionaryEntriesParams, RequestOptions requestOptions)	Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.
CompletableFuture<UpdatedAtResponse>	batchDictionaryEntriesAsync(DictionaryType dictionaryName, BatchDictionaryEntriesParams batchDictionaryEntriesParams)	(asynchronously) Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.
CompletableFuture<UpdatedAtResponse>	batchDictionaryEntriesAsync(DictionaryType dictionaryName, BatchDictionaryEntriesParams batchDictionaryEntriesParams, RequestOptions requestOptions)	(asynchronously) Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.
<T> BrowseResponse<T>	browse(String indexName, BrowseParams browseParams, Class<T> innerType)	Retrieves records from an index, up to 1,000 per request.
<T> BrowseResponse<T>	browse(String indexName, BrowseParams browseParams, Class<T> innerType, RequestOptions requestOptions)	Retrieves records from an index, up to 1,000 per request.
<T> BrowseResponse<T>	browse(String indexName, Class<T> innerType)	Retrieves records from an index, up to 1,000 per request.
<T> BrowseResponse<T>	browse(String indexName, Class<T> innerType, RequestOptions requestOptions)	Retrieves records from an index, up to 1,000 per request.
<T> CompletableFuture<BrowseResponse<T>>	browseAsync(String indexName, BrowseParams browseParams, Class<T> innerType)	(asynchronously) Retrieves records from an index, up to 1,000 per request.
<T> CompletableFuture<BrowseResponse<T>>	browseAsync(String indexName, BrowseParams browseParams, Class<T> innerType, RequestOptions requestOptions)	(asynchronously) Retrieves records from an index, up to 1,000 per request.
<T> CompletableFuture<BrowseResponse<T>>	browseAsync(String indexName, Class<T> innerType)	(asynchronously) Retrieves records from an index, up to 1,000 per request.
<T> CompletableFuture<BrowseResponse<T>>	browseAsync(String indexName, Class<T> innerType, RequestOptions requestOptions)	(asynchronously) Retrieves records from an index, up to 1,000 per request.
<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, SearchSynonymsParams params)	Helper: Returns an iterator on top of the `searchSynonyms` method.
Iterable<SynonymHit>	browseSynonyms(String indexName, SearchSynonymsParams params, RequestOptions requestOptions)	Helper: Returns an iterator on top of the `searchSynonyms` method.
UpdatedAtResponse	clearObjects(String indexName)	Deletes only the records from an index while keeping settings, synonyms, and rules.
UpdatedAtResponse	clearObjects(String indexName, RequestOptions requestOptions)	Deletes only the records from an index while keeping settings, synonyms, and rules.
CompletableFuture<UpdatedAtResponse>	clearObjectsAsync(String indexName)	(asynchronously) Deletes only the records from an index while keeping settings, synonyms, and rules.
CompletableFuture<UpdatedAtResponse>	clearObjectsAsync(String indexName, RequestOptions requestOptions)	(asynchronously) Deletes only the records from an index while keeping settings, synonyms, and rules.
UpdatedAtResponse	clearRules(String indexName)	Deletes all rules from the index.
UpdatedAtResponse	clearRules(String indexName, RequestOptions requestOptions)	Deletes all rules from the index.
UpdatedAtResponse	clearRules(String indexName, Boolean forwardToReplicas)	Deletes all rules from the index.
UpdatedAtResponse	clearRules(String indexName, Boolean forwardToReplicas, RequestOptions requestOptions)	Deletes all rules from the index.
CompletableFuture<UpdatedAtResponse>	clearRulesAsync(String indexName)	(asynchronously) Deletes all rules from the index.
CompletableFuture<UpdatedAtResponse>	clearRulesAsync(String indexName, RequestOptions requestOptions)	(asynchronously) Deletes all rules from the index.
CompletableFuture<UpdatedAtResponse>	clearRulesAsync(String indexName, Boolean forwardToReplicas)	(asynchronously) Deletes all rules from the index.
CompletableFuture<UpdatedAtResponse>	clearRulesAsync(String indexName, Boolean forwardToReplicas, RequestOptions requestOptions)	(asynchronously) Deletes all rules from the index.
UpdatedAtResponse	clearSynonyms(String indexName)	Deletes all synonyms from the index.
UpdatedAtResponse	clearSynonyms(String indexName, RequestOptions requestOptions)	Deletes all synonyms from the index.
UpdatedAtResponse	clearSynonyms(String indexName, Boolean forwardToReplicas)	Deletes all synonyms from the index.
UpdatedAtResponse	clearSynonyms(String indexName, Boolean forwardToReplicas, RequestOptions requestOptions)	Deletes all synonyms from the index.
CompletableFuture<UpdatedAtResponse>	clearSynonymsAsync(String indexName)	(asynchronously) Deletes all synonyms from the index.
CompletableFuture<UpdatedAtResponse>	clearSynonymsAsync(String indexName, RequestOptions requestOptions)	(asynchronously) Deletes all synonyms from the index.
CompletableFuture<UpdatedAtResponse>	clearSynonymsAsync(String indexName, Boolean forwardToReplicas)	(asynchronously) Deletes all synonyms from the index.
CompletableFuture<UpdatedAtResponse>	clearSynonymsAsync(String indexName, Boolean forwardToReplicas, RequestOptions requestOptions)	(asynchronously) Deletes all synonyms from the index.
Object	customDelete(String path)	This method allow you to send requests to the Algolia REST API.
Object	customDelete(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	customDelete(String path, Map<String,Object> parameters)	This method allow you to send requests to the Algolia REST API.
Object	customDelete(String path, Map<String,Object> parameters, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customDeleteAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customDeleteAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customDeleteAsync(String path, Map<String,Object> parameters)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customDeleteAsync(String path, Map<String,Object> parameters, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
Object	customGet(String path)	This method allow you to send requests to the Algolia REST API.
Object	customGet(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	customGet(String path, Map<String,Object> parameters)	This method allow you to send requests to the Algolia REST API.
Object	customGet(String path, Map<String,Object> parameters, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customGetAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customGetAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customGetAsync(String path, Map<String,Object> parameters)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customGetAsync(String path, Map<String,Object> parameters, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
Object	customPost(String path)	This method allow you to send requests to the Algolia REST API.
Object	customPost(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	customPost(String path, Map<String,Object> parameters, Object body)	This method allow you to send requests to the Algolia REST API.
Object	customPost(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPostAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPostAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPostAsync(String path, Map<String,Object> parameters, Object body)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPostAsync(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
Object	customPut(String path)	This method allow you to send requests to the Algolia REST API.
Object	customPut(String path, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
Object	customPut(String path, Map<String,Object> parameters, Object body)	This method allow you to send requests to the Algolia REST API.
Object	customPut(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPutAsync(String path)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPutAsync(String path, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPutAsync(String path, Map<String,Object> parameters, Object body)	(asynchronously) This method allow you to send requests to the Algolia REST API.
CompletableFuture<Object>	customPutAsync(String path, Map<String,Object> parameters, Object body, RequestOptions requestOptions)	(asynchronously) This method allow you to send requests to the Algolia REST API.
DeleteApiKeyResponse	deleteApiKey(String key)	Deletes the API key.
DeleteApiKeyResponse	deleteApiKey(String key, RequestOptions requestOptions)	Deletes the API key.
CompletableFuture<DeleteApiKeyResponse>	deleteApiKeyAsync(String key)	(asynchronously) Deletes the API key.
CompletableFuture<DeleteApiKeyResponse>	deleteApiKeyAsync(String key, RequestOptions requestOptions)	(asynchronously) Deletes the API key.
DeletedAtResponse	deleteBy(String indexName, DeleteByParams deleteByParams)	This operation doesn't accept empty queries or filters.
DeletedAtResponse	deleteBy(String indexName, DeleteByParams deleteByParams, RequestOptions requestOptions)	This operation doesn't accept empty queries or filters.
CompletableFuture<DeletedAtResponse>	deleteByAsync(String indexName, DeleteByParams deleteByParams)	(asynchronously) This operation doesn't accept empty queries or filters.
CompletableFuture<DeletedAtResponse>	deleteByAsync(String indexName, DeleteByParams deleteByParams, RequestOptions requestOptions)	(asynchronously) This operation doesn't accept empty queries or filters.
DeletedAtResponse	deleteIndex(String indexName)	Deletes an index and all its settings.
DeletedAtResponse	deleteIndex(String indexName, RequestOptions requestOptions)	Deletes an index and all its settings.
CompletableFuture<DeletedAtResponse>	deleteIndexAsync(String indexName)	(asynchronously) Deletes an index and all its settings.
CompletableFuture<DeletedAtResponse>	deleteIndexAsync(String indexName, RequestOptions requestOptions)	(asynchronously) Deletes an index and all its settings.
DeletedAtResponse	deleteObject(String indexName, String objectID)	Deletes a record by its object ID.
DeletedAtResponse	deleteObject(String indexName, String objectID, RequestOptions requestOptions)	Deletes a record by its object ID.
CompletableFuture<DeletedAtResponse>	deleteObjectAsync(String indexName, String objectID)	(asynchronously) Deletes a record by its object ID.
CompletableFuture<DeletedAtResponse>	deleteObjectAsync(String indexName, String objectID, RequestOptions requestOptions)	(asynchronously) Deletes a record by its object ID.
UpdatedAtResponse	deleteRule(String indexName, String objectID)	Deletes a rule by its ID.
UpdatedAtResponse	deleteRule(String indexName, String objectID, RequestOptions requestOptions)	Deletes a rule by its ID.
UpdatedAtResponse	deleteRule(String indexName, String objectID, Boolean forwardToReplicas)	Deletes a rule by its ID.
UpdatedAtResponse	deleteRule(String indexName, String objectID, Boolean forwardToReplicas, RequestOptions requestOptions)	Deletes a rule by its ID.
CompletableFuture<UpdatedAtResponse>	deleteRuleAsync(String indexName, String objectID)	(asynchronously) Deletes a rule by its ID.
CompletableFuture<UpdatedAtResponse>	deleteRuleAsync(String indexName, String objectID, RequestOptions requestOptions)	(asynchronously) Deletes a rule by its ID.
CompletableFuture<UpdatedAtResponse>	deleteRuleAsync(String indexName, String objectID, Boolean forwardToReplicas)	(asynchronously) Deletes a rule by its ID.
CompletableFuture<UpdatedAtResponse>	deleteRuleAsync(String indexName, String objectID, Boolean forwardToReplicas, RequestOptions requestOptions)	(asynchronously) Deletes a rule by its ID.
DeleteSourceResponse	deleteSource(String source)	Deletes a source from the list of allowed sources.
DeleteSourceResponse	deleteSource(String source, RequestOptions requestOptions)	Deletes a source from the list of allowed sources.
CompletableFuture<DeleteSourceResponse>	deleteSourceAsync(String source)	(asynchronously) Deletes a source from the list of allowed sources.
CompletableFuture<DeleteSourceResponse>	deleteSourceAsync(String source, RequestOptions requestOptions)	(asynchronously) Deletes a source from the list of allowed sources.
DeletedAtResponse	deleteSynonym(String indexName, String objectID)	Deletes a synonym by its ID.
DeletedAtResponse	deleteSynonym(String indexName, String objectID, RequestOptions requestOptions)	Deletes a synonym by its ID.
DeletedAtResponse	deleteSynonym(String indexName, String objectID, Boolean forwardToReplicas)	Deletes a synonym by its ID.
DeletedAtResponse	deleteSynonym(String indexName, String objectID, Boolean forwardToReplicas, RequestOptions requestOptions)	Deletes a synonym by its ID.
CompletableFuture<DeletedAtResponse>	deleteSynonymAsync(String indexName, String objectID)	(asynchronously) Deletes a synonym by its ID.
CompletableFuture<DeletedAtResponse>	deleteSynonymAsync(String indexName, String objectID, RequestOptions requestOptions)	(asynchronously) Deletes a synonym by its ID.
CompletableFuture<DeletedAtResponse>	deleteSynonymAsync(String indexName, String objectID, Boolean forwardToReplicas)	(asynchronously) Deletes a synonym by its ID.
CompletableFuture<DeletedAtResponse>	deleteSynonymAsync(String indexName, String objectID, Boolean forwardToReplicas, RequestOptions requestOptions)	(asynchronously) Deletes a synonym by its ID.
GetApiKeyResponse	getApiKey(String key)	Gets the permissions and restrictions of an API key.
GetApiKeyResponse	getApiKey(String key, RequestOptions requestOptions)	Gets the permissions and restrictions of an API key.
CompletableFuture<GetApiKeyResponse>	getApiKeyAsync(String key)	(asynchronously) Gets the permissions and restrictions of an API key.
CompletableFuture<GetApiKeyResponse>	getApiKeyAsync(String key, RequestOptions requestOptions)	(asynchronously) Gets the permissions and restrictions of an API key.
Map<String,Languages>	getDictionaryLanguages()	Lists supported languages with their supported dictionary types and number of custom entries.
Map<String,Languages>	getDictionaryLanguages(RequestOptions requestOptions)	Lists supported languages with their supported dictionary types and number of custom entries.
CompletableFuture<Map<String,Languages>>	getDictionaryLanguagesAsync()	(asynchronously) Lists supported languages with their supported dictionary types and number of custom entries.
CompletableFuture<Map<String,Languages>>	getDictionaryLanguagesAsync(RequestOptions requestOptions)	(asynchronously) Lists supported languages with their supported dictionary types and number of custom entries.
GetDictionarySettingsResponse	getDictionarySettings()	Retrieves the languages for which standard dictionary entries are turned off.
GetDictionarySettingsResponse	getDictionarySettings(RequestOptions requestOptions)	Retrieves the languages for which standard dictionary entries are turned off.
CompletableFuture<GetDictionarySettingsResponse>	getDictionarySettingsAsync()	(asynchronously) Retrieves the languages for which standard dictionary entries are turned off.
CompletableFuture<GetDictionarySettingsResponse>	getDictionarySettingsAsync(RequestOptions requestOptions)	(asynchronously) Retrieves the languages for which standard dictionary entries are turned off.
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)	Retrieves one record by its object ID.
Map<String,String>	getObject(String indexName, String objectID, RequestOptions requestOptions)	Retrieves one record by its object ID.
Map<String,String>	getObject(String indexName, String objectID, List<String> attributesToRetrieve)	Retrieves one record by its object ID.
Map<String,String>	getObject(String indexName, String objectID, List<String> attributesToRetrieve, RequestOptions requestOptions)	Retrieves one record by its object ID.
CompletableFuture<Map<String,String>>	getObjectAsync(String indexName, String objectID)	(asynchronously) Retrieves one record by its object ID.
CompletableFuture<Map<String,String>>	getObjectAsync(String indexName, String objectID, RequestOptions requestOptions)	(asynchronously) Retrieves one record by its object ID.
CompletableFuture<Map<String,String>>	getObjectAsync(String indexName, String objectID, List<String> attributesToRetrieve)	(asynchronously) Retrieves one record by its object ID.
CompletableFuture<Map<String,String>>	getObjectAsync(String indexName, String objectID, List<String> attributesToRetrieve, RequestOptions requestOptions)	(asynchronously) Retrieves one record by its object ID.
<T> GetObjectsResponse<T>	getObjects(GetObjectsParams getObjectsParams, Class<T> innerType)	Retrieves one or more records, potentially from different indices.
<T> GetObjectsResponse<T>	getObjects(GetObjectsParams getObjectsParams, Class<T> innerType, RequestOptions requestOptions)	Retrieves one or more records, potentially from different indices.
<T> CompletableFuture<GetObjectsResponse<T>>	getObjectsAsync(GetObjectsParams getObjectsParams, Class<T> innerType)	(asynchronously) Retrieves one or more records, potentially from different indices.
<T> CompletableFuture<GetObjectsResponse<T>>	getObjectsAsync(GetObjectsParams getObjectsParams, Class<T> innerType, RequestOptions requestOptions)	(asynchronously) Retrieves one or more records, potentially from different indices.
Rule	getRule(String indexName, String objectID)	Retrieves a rule by its ID.
Rule	getRule(String indexName, String objectID, RequestOptions requestOptions)	Retrieves a rule by its ID.
CompletableFuture<Rule>	getRuleAsync(String indexName, String objectID)	(asynchronously) Retrieves a rule by its ID.
CompletableFuture<Rule>	getRuleAsync(String indexName, String objectID, RequestOptions requestOptions)	(asynchronously) Retrieves a rule by its ID.
IndexSettings	getSettings(String indexName)	Retrieves an object with non-null index settings.
IndexSettings	getSettings(String indexName, RequestOptions requestOptions)	Retrieves an object with non-null index settings.
CompletableFuture<IndexSettings>	getSettingsAsync(String indexName)	(asynchronously) Retrieves an object with non-null index settings.
CompletableFuture<IndexSettings>	getSettingsAsync(String indexName, RequestOptions requestOptions)	(asynchronously) Retrieves an object with non-null index settings.
List<Source>	getSources()	Retrieves all allowed IP addresses with access to your application.
List<Source>	getSources(RequestOptions requestOptions)	Retrieves all allowed IP addresses with access to your application.
CompletableFuture<List<Source>>	getSourcesAsync()	(asynchronously) Retrieves all allowed IP addresses with access to your application.
CompletableFuture<List<Source>>	getSourcesAsync(RequestOptions requestOptions)	(asynchronously) Retrieves all allowed IP addresses with access to your application.
SynonymHit	getSynonym(String indexName, String objectID)	Retrieves a syonym by its ID.
SynonymHit	getSynonym(String indexName, String objectID, RequestOptions requestOptions)	Retrieves a syonym by its ID.
CompletableFuture<SynonymHit>	getSynonymAsync(String indexName, String objectID)	(asynchronously) Retrieves a syonym by its ID.
CompletableFuture<SynonymHit>	getSynonymAsync(String indexName, String objectID, RequestOptions requestOptions)	(asynchronously) Retrieves a syonym by its ID.
GetTaskResponse	getTask(String indexName, Long taskID)	Checks the status of a given task.
GetTaskResponse	getTask(String indexName, Long taskID, RequestOptions requestOptions)	Checks the status of a given task.
CompletableFuture<GetTaskResponse>	getTaskAsync(String indexName, Long taskID)	(asynchronously) Checks the status of a given task.
CompletableFuture<GetTaskResponse>	getTaskAsync(String indexName, Long taskID, RequestOptions requestOptions)	(asynchronously) Checks the status of a given task.
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 user ID data stored in the mapping.
UserId	getUserId(String userID, RequestOptions requestOptions)	Returns the user ID data stored in the mapping.
CompletableFuture<UserId>	getUserIdAsync(String userID)	(asynchronously) Returns the user ID data stored in the mapping.
CompletableFuture<UserId>	getUserIdAsync(String userID, RequestOptions requestOptions)	(asynchronously) Returns the user ID 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()	Lists all API keys associated with your Algolia application, including their permissions and restrictions.
ListApiKeysResponse	listApiKeys(RequestOptions requestOptions)	Lists all API keys associated with your Algolia application, including their permissions and restrictions.
CompletableFuture<ListApiKeysResponse>	listApiKeysAsync()	(asynchronously) Lists all API keys associated with your Algolia application, including their permissions and restrictions.
CompletableFuture<ListApiKeysResponse>	listApiKeysAsync(RequestOptions requestOptions)	(asynchronously) Lists all API keys associated with your Algolia application, including their permissions and restrictions.
ListClustersResponse	listClusters()	Lists the available clusters in a multi-cluster setup.
ListClustersResponse	listClusters(RequestOptions requestOptions)	Lists the available clusters in a multi-cluster setup.
CompletableFuture<ListClustersResponse>	listClustersAsync()	(asynchronously) Lists the available clusters in a multi-cluster setup.
CompletableFuture<ListClustersResponse>	listClustersAsync(RequestOptions requestOptions)	(asynchronously) Lists the available clusters in a multi-cluster setup.
ListIndicesResponse	listIndices()	Lists all indices in the current Algolia application.
ListIndicesResponse	listIndices(RequestOptions requestOptions)	Lists all indices in the current Algolia application.
ListIndicesResponse	listIndices(Integer page, Integer hitsPerPage)	Lists all indices in the current Algolia application.
ListIndicesResponse	listIndices(Integer page, Integer hitsPerPage, RequestOptions requestOptions)	Lists all indices in the current Algolia application.
CompletableFuture<ListIndicesResponse>	listIndicesAsync()	(asynchronously) Lists all indices in the current Algolia application.
CompletableFuture<ListIndicesResponse>	listIndicesAsync(RequestOptions requestOptions)	(asynchronously) Lists all indices in the current Algolia application.
CompletableFuture<ListIndicesResponse>	listIndicesAsync(Integer page, Integer hitsPerPage)	(asynchronously) Lists all indices in the current Algolia application.
CompletableFuture<ListIndicesResponse>	listIndicesAsync(Integer page, Integer hitsPerPage, RequestOptions requestOptions)	(asynchronously) Lists all indices in the current Algolia application.
ListUserIdsResponse	listUserIds()	Lists the userIDs assigned to a multi-cluster application.
ListUserIdsResponse	listUserIds(RequestOptions requestOptions)	Lists the userIDs assigned to a multi-cluster application.
ListUserIdsResponse	listUserIds(Integer page, Integer hitsPerPage)	Lists the userIDs assigned to a multi-cluster application.
ListUserIdsResponse	listUserIds(Integer page, Integer hitsPerPage, RequestOptions requestOptions)	Lists the userIDs assigned to a multi-cluster application.
CompletableFuture<ListUserIdsResponse>	listUserIdsAsync()	(asynchronously) Lists the userIDs assigned to a multi-cluster application.
CompletableFuture<ListUserIdsResponse>	listUserIdsAsync(RequestOptions requestOptions)	(asynchronously) Lists the userIDs assigned to a multi-cluster application.
CompletableFuture<ListUserIdsResponse>	listUserIdsAsync(Integer page, Integer hitsPerPage)	(asynchronously) Lists the userIDs assigned to a multi-cluster application.
CompletableFuture<ListUserIdsResponse>	listUserIdsAsync(Integer page, Integer hitsPerPage, RequestOptions requestOptions)	(asynchronously) Lists the userIDs assigned to a multi-cluster application.
MultipleBatchResponse	multipleBatch(BatchParams batchParams)	Adds, updates, or deletes records in multiple indices with a single API request.
MultipleBatchResponse	multipleBatch(BatchParams batchParams, RequestOptions requestOptions)	Adds, updates, or deletes records in multiple indices with a single API request.
CompletableFuture<MultipleBatchResponse>	multipleBatchAsync(BatchParams batchParams)	(asynchronously) Adds, updates, or deletes records in multiple indices with a single API request.
CompletableFuture<MultipleBatchResponse>	multipleBatchAsync(BatchParams batchParams, RequestOptions requestOptions)	(asynchronously) Adds, updates, or deletes records in multiple indices with a single API request.
UpdatedAtResponse	operationIndex(String indexName, OperationIndexParams operationIndexParams)	Copies or moves (renames) an index within the same Algolia application.
UpdatedAtResponse	operationIndex(String indexName, OperationIndexParams operationIndexParams, RequestOptions requestOptions)	Copies or moves (renames) an index within the same Algolia application.
CompletableFuture<UpdatedAtResponse>	operationIndexAsync(String indexName, OperationIndexParams operationIndexParams)	(asynchronously) Copies or moves (renames) an index within the same Algolia application.
CompletableFuture<UpdatedAtResponse>	operationIndexAsync(String indexName, OperationIndexParams operationIndexParams, RequestOptions requestOptions)	(asynchronously) Copies or moves (renames) an index within the same Algolia application.
UpdatedAtWithObjectIdResponse	partialUpdateObject(String indexName, String objectID, Map<String,AttributeToUpdate> attributesToUpdate)	Adds new attributes to a record, or update existing ones.
UpdatedAtWithObjectIdResponse	partialUpdateObject(String indexName, String objectID, Map<String,AttributeToUpdate> attributesToUpdate, RequestOptions requestOptions)	Adds new attributes to a record, or update existing ones.
UpdatedAtWithObjectIdResponse	partialUpdateObject(String indexName, String objectID, Map<String,AttributeToUpdate> attributesToUpdate, Boolean createIfNotExists)	Adds new attributes to a record, or update existing ones.
UpdatedAtWithObjectIdResponse	partialUpdateObject(String indexName, String objectID, Map<String,AttributeToUpdate> attributesToUpdate, Boolean createIfNotExists, RequestOptions requestOptions)	Adds new attributes to a record, or update existing ones.
CompletableFuture<UpdatedAtWithObjectIdResponse>	partialUpdateObjectAsync(String indexName, String objectID, Map<String,AttributeToUpdate> attributesToUpdate)	(asynchronously) Adds new attributes to a record, or update existing ones.
CompletableFuture<UpdatedAtWithObjectIdResponse>	partialUpdateObjectAsync(String indexName, String objectID, Map<String,AttributeToUpdate> attributesToUpdate, RequestOptions requestOptions)	(asynchronously) Adds new attributes to a record, or update existing ones.
CompletableFuture<UpdatedAtWithObjectIdResponse>	partialUpdateObjectAsync(String indexName, String objectID, Map<String,AttributeToUpdate> attributesToUpdate, Boolean createIfNotExists)	(asynchronously) Adds new attributes to a record, or update existing ones.
CompletableFuture<UpdatedAtWithObjectIdResponse>	partialUpdateObjectAsync(String indexName, String objectID, Map<String,AttributeToUpdate> attributesToUpdate, Boolean createIfNotExists, RequestOptions requestOptions)	(asynchronously) Adds new attributes to a record, or update existing ones.
RemoveUserIdResponse	removeUserId(String userID)	Deletes a user ID and its associated data from the clusters.
RemoveUserIdResponse	removeUserId(String userID, RequestOptions requestOptions)	Deletes a user ID and its associated data from the clusters.
CompletableFuture<RemoveUserIdResponse>	removeUserIdAsync(String userID)	(asynchronously) Deletes a user ID and its associated data from the clusters.
CompletableFuture<RemoveUserIdResponse>	removeUserIdAsync(String userID, RequestOptions requestOptions)	(asynchronously) Deletes a user ID and its associated data from the clusters.
ReplaceSourceResponse	replaceSources(List<Source> source)	Replaces the list of allowed sources.
ReplaceSourceResponse	replaceSources(List<Source> source, RequestOptions requestOptions)	Replaces the list of allowed sources.
CompletableFuture<ReplaceSourceResponse>	replaceSourcesAsync(List<Source> source)	(asynchronously) Replaces the list of allowed sources.
CompletableFuture<ReplaceSourceResponse>	replaceSourcesAsync(List<Source> source, RequestOptions requestOptions)	(asynchronously) Replaces the list of allowed sources.
AddApiKeyResponse	restoreApiKey(String key)	Restores a deleted API key.
AddApiKeyResponse	restoreApiKey(String key, RequestOptions requestOptions)	Restores a deleted API key.
CompletableFuture<AddApiKeyResponse>	restoreApiKeyAsync(String key)	(asynchronously) Restores a deleted API key.
CompletableFuture<AddApiKeyResponse>	restoreApiKeyAsync(String key, RequestOptions requestOptions)	(asynchronously) Restores a deleted API key.
SaveObjectResponse	saveObject(String indexName, Object body)	Adds a record to an index or replace it.
SaveObjectResponse	saveObject(String indexName, Object body, RequestOptions requestOptions)	Adds a record to an index or replace it.
CompletableFuture<SaveObjectResponse>	saveObjectAsync(String indexName, Object body)	(asynchronously) Adds a record to an index or replace it.
CompletableFuture<SaveObjectResponse>	saveObjectAsync(String indexName, Object body, RequestOptions requestOptions)	(asynchronously) Adds a record to an index or replace it.
UpdatedRuleResponse	saveRule(String indexName, String objectID, Rule rule)	If a rule with the specified object ID doesn't exist, it's created.
UpdatedRuleResponse	saveRule(String indexName, String objectID, Rule rule, RequestOptions requestOptions)	If a rule with the specified object ID doesn't exist, it's created.
UpdatedRuleResponse	saveRule(String indexName, String objectID, Rule rule, Boolean forwardToReplicas)	If a rule with the specified object ID doesn't exist, it's created.
UpdatedRuleResponse	saveRule(String indexName, String objectID, Rule rule, Boolean forwardToReplicas, RequestOptions requestOptions)	If a rule with the specified object ID doesn't exist, it's created.
CompletableFuture<UpdatedRuleResponse>	saveRuleAsync(String indexName, String objectID, Rule rule)	(asynchronously) If a rule with the specified object ID doesn't exist, it's created.
CompletableFuture<UpdatedRuleResponse>	saveRuleAsync(String indexName, String objectID, Rule rule, RequestOptions requestOptions)	(asynchronously) If a rule with the specified object ID doesn't exist, it's created.
CompletableFuture<UpdatedRuleResponse>	saveRuleAsync(String indexName, String objectID, Rule rule, Boolean forwardToReplicas)	(asynchronously) If a rule with the specified object ID doesn't exist, it's created.
CompletableFuture<UpdatedRuleResponse>	saveRuleAsync(String indexName, String objectID, Rule rule, Boolean forwardToReplicas, RequestOptions requestOptions)	(asynchronously) If a rule with the specified object ID doesn't exist, it's created.
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)	If a synonym with the specified object ID doesn't exist, Algolia adds a new one.
SaveSynonymResponse	saveSynonym(String indexName, String objectID, SynonymHit synonymHit, RequestOptions requestOptions)	If a synonym with the specified object ID doesn't exist, Algolia adds a new one.
SaveSynonymResponse	saveSynonym(String indexName, String objectID, SynonymHit synonymHit, Boolean forwardToReplicas)	If a synonym with the specified object ID doesn't exist, Algolia adds a new one.
SaveSynonymResponse	saveSynonym(String indexName, String objectID, SynonymHit synonymHit, Boolean forwardToReplicas, RequestOptions requestOptions)	If a synonym with the specified object ID doesn't exist, Algolia adds a new one.
CompletableFuture<SaveSynonymResponse>	saveSynonymAsync(String indexName, String objectID, SynonymHit synonymHit)	(asynchronously) If a synonym with the specified object ID doesn't exist, Algolia adds a new one.
CompletableFuture<SaveSynonymResponse>	saveSynonymAsync(String indexName, String objectID, SynonymHit synonymHit, RequestOptions requestOptions)	(asynchronously) If a synonym with the specified object ID doesn't exist, Algolia adds a new one.
CompletableFuture<SaveSynonymResponse>	saveSynonymAsync(String indexName, String objectID, SynonymHit synonymHit, Boolean forwardToReplicas)	(asynchronously) If a synonym with the specified object ID doesn't exist, Algolia adds a new one.
CompletableFuture<SaveSynonymResponse>	saveSynonymAsync(String indexName, String objectID, SynonymHit synonymHit, Boolean forwardToReplicas, RequestOptions requestOptions)	(asynchronously) If a synonym with the specified object ID doesn't exist, Algolia adds a new one.
UpdatedAtResponse	saveSynonyms(String indexName, List<SynonymHit> synonymHit)	If a synonym with the `objectID` doesn't exist, Algolia adds a new one.
UpdatedAtResponse	saveSynonyms(String indexName, List<SynonymHit> synonymHit, RequestOptions requestOptions)	If a synonym with the `objectID` doesn't exist, Algolia adds a new one.
UpdatedAtResponse	saveSynonyms(String indexName, List<SynonymHit> synonymHit, Boolean forwardToReplicas, Boolean replaceExistingSynonyms)	If a synonym with the `objectID` doesn't exist, Algolia adds a new one.
UpdatedAtResponse	saveSynonyms(String indexName, List<SynonymHit> synonymHit, Boolean forwardToReplicas, Boolean replaceExistingSynonyms, RequestOptions requestOptions)	If a synonym with the `objectID` doesn't exist, Algolia adds a new one.
CompletableFuture<UpdatedAtResponse>	saveSynonymsAsync(String indexName, List<SynonymHit> synonymHit)	(asynchronously) If a synonym with the `objectID` doesn't exist, Algolia adds a new one.
CompletableFuture<UpdatedAtResponse>	saveSynonymsAsync(String indexName, List<SynonymHit> synonymHit, RequestOptions requestOptions)	(asynchronously) If a synonym with the `objectID` doesn't exist, Algolia adds a new one.
CompletableFuture<UpdatedAtResponse>	saveSynonymsAsync(String indexName, List<SynonymHit> synonymHit, Boolean forwardToReplicas, Boolean replaceExistingSynonyms)	(asynchronously) If a synonym with the `objectID` doesn't exist, Algolia adds a new one.
CompletableFuture<UpdatedAtResponse>	saveSynonymsAsync(String indexName, List<SynonymHit> synonymHit, Boolean forwardToReplicas, Boolean replaceExistingSynonyms, RequestOptions requestOptions)	(asynchronously) If a synonym with the `objectID` doesn't exist, Algolia adds a new one.
<T> SearchResponses<T>	search(SearchMethodParams searchMethodParams, Class<T> innerType)	Sends multiple search request to one or more indices.
<T> SearchResponses<T>	search(SearchMethodParams searchMethodParams, Class<T> innerType, RequestOptions requestOptions)	Sends multiple search request to one or more indices.
<T> CompletableFuture<SearchResponses<T>>	searchAsync(SearchMethodParams searchMethodParams, Class<T> innerType)	(asynchronously) Sends multiple search request to one or more indices.
<T> CompletableFuture<SearchResponses<T>>	searchAsync(SearchMethodParams searchMethodParams, Class<T> innerType, RequestOptions requestOptions)	(asynchronously) Sends multiple search request to one or more indices.
SearchDictionaryEntriesResponse	searchDictionaryEntries(DictionaryType dictionaryName, SearchDictionaryEntriesParams searchDictionaryEntriesParams)	Searches for standard and custom dictionary entries.
SearchDictionaryEntriesResponse	searchDictionaryEntries(DictionaryType dictionaryName, SearchDictionaryEntriesParams searchDictionaryEntriesParams, RequestOptions requestOptions)	Searches for standard and custom dictionary entries.
CompletableFuture<SearchDictionaryEntriesResponse>	searchDictionaryEntriesAsync(DictionaryType dictionaryName, SearchDictionaryEntriesParams searchDictionaryEntriesParams)	(asynchronously) Searches for standard and custom dictionary entries.
CompletableFuture<SearchDictionaryEntriesResponse>	searchDictionaryEntriesAsync(DictionaryType dictionaryName, SearchDictionaryEntriesParams searchDictionaryEntriesParams, RequestOptions requestOptions)	(asynchronously) Searches for standard and custom dictionary entries.
List<SearchForFacetValuesResponse>	searchForFacets(List<SearchForFacets> requests)	Executes a synchronous search for the provided search requests, with certainty that we will only request Algolia facets.
List<SearchForFacetValuesResponse>	searchForFacets(List<SearchForFacets> requests, SearchStrategy strategy)	Executes a synchronous search for the provided search requests, with certainty that we will only request Algolia facets.
List<SearchForFacetValuesResponse>	searchForFacets(List<SearchForFacets> requests, SearchStrategy strategy, RequestOptions requestOptions)	Executes a synchronous search for the provided search requests, with certainty that we will only request Algolia facets.
CompletableFuture<List<SearchForFacetValuesResponse>>	searchForFacetsAsync(List<SearchForFacets> requests)	Executes an asynchronous search for the provided search requests, with certainty that we will only request Algolia facets.
CompletableFuture<List<SearchForFacetValuesResponse>>	searchForFacetsAsync(List<SearchForFacets> requests, SearchStrategy strategy)	Executes an asynchronous search for the provided search requests, with certainty that we will only request Algolia facets.
CompletableFuture<List<SearchForFacetValuesResponse>>	searchForFacetsAsync(List<SearchForFacets> requests, SearchStrategy strategy, RequestOptions requestOptions)	Executes an asynchronous search for the provided search requests, with certainty that we will only request Algolia facets.
SearchForFacetValuesResponse	searchForFacetValues(String indexName, String facetName)	Searches for values of a specified facet attribute.
SearchForFacetValuesResponse	searchForFacetValues(String indexName, String facetName, RequestOptions requestOptions)	Searches for values of a specified facet attribute.
SearchForFacetValuesResponse	searchForFacetValues(String indexName, String facetName, SearchForFacetValuesRequest searchForFacetValuesRequest)	Searches for values of a specified facet attribute.
SearchForFacetValuesResponse	searchForFacetValues(String indexName, String facetName, SearchForFacetValuesRequest searchForFacetValuesRequest, RequestOptions requestOptions)	Searches for values of a specified facet attribute.
CompletableFuture<SearchForFacetValuesResponse>	searchForFacetValuesAsync(String indexName, String facetName)	(asynchronously) Searches for values of a specified facet attribute.
CompletableFuture<SearchForFacetValuesResponse>	searchForFacetValuesAsync(String indexName, String facetName, RequestOptions requestOptions)	(asynchronously) Searches for values of a specified facet attribute.
CompletableFuture<SearchForFacetValuesResponse>	searchForFacetValuesAsync(String indexName, String facetName, SearchForFacetValuesRequest searchForFacetValuesRequest)	(asynchronously) Searches for values of a specified facet attribute.
CompletableFuture<SearchForFacetValuesResponse>	searchForFacetValuesAsync(String indexName, String facetName, SearchForFacetValuesRequest searchForFacetValuesRequest, RequestOptions requestOptions)	(asynchronously) Searches for values of a specified facet attribute.
<T> List<SearchResponse<T>>	searchForHits(List<SearchForHits> requests, SearchStrategy strategy, Class<T> innerType)	Executes a synchronous search for the provided search requests, with certainty that we will only request Algolia records (hits).
<T> List<SearchResponse<T>>	searchForHits(List<SearchForHits> requests, SearchStrategy strategy, Class<T> innerType, RequestOptions requestOptions)	Executes a synchronous search for the provided search requests, with certainty that we will only request Algolia records (hits).
<T> List<SearchResponse<T>>	searchForHits(List<SearchForHits> requests, Class<T> innerType)	Executes a synchronous search for the provided search requests, with certainty that we will only request Algolia records (hits).
<T> CompletableFuture<List<SearchResponse<T>>>	searchForHitsAsync(List<SearchForHits> requests, SearchStrategy strategy, Class<T> innerType)	Executes an asynchronous search for the provided search requests, with certainty that we will only request Algolia records (hits).
<T> CompletableFuture<List<SearchResponse<T>>>	searchForHitsAsync(List<SearchForHits> requests, SearchStrategy strategy, Class<T> innerType, RequestOptions requestOptions)	Executes an asynchronous search for the provided search requests, with certainty that we will only request Algolia records (hits).
<T> CompletableFuture<List<SearchResponse<T>>>	searchForHitsAsync(List<SearchForHits> requests, Class<T> innerType)	Executes an asynchronous search for the provided search requests, with certainty that we will only request Algolia records (hits).
SearchRulesResponse	searchRules(String indexName)	Searches for rules in your index.
SearchRulesResponse	searchRules(String indexName, RequestOptions requestOptions)	Searches for rules in your index.
SearchRulesResponse	searchRules(String indexName, SearchRulesParams searchRulesParams)	Searches for rules in your index.
SearchRulesResponse	searchRules(String indexName, SearchRulesParams searchRulesParams, RequestOptions requestOptions)	Searches for rules in your index.
CompletableFuture<SearchRulesResponse>	searchRulesAsync(String indexName)	(asynchronously) Searches for rules in your index.
CompletableFuture<SearchRulesResponse>	searchRulesAsync(String indexName, RequestOptions requestOptions)	(asynchronously) Searches for rules in your index.
CompletableFuture<SearchRulesResponse>	searchRulesAsync(String indexName, SearchRulesParams searchRulesParams)	(asynchronously) Searches for rules in your index.
CompletableFuture<SearchRulesResponse>	searchRulesAsync(String indexName, SearchRulesParams searchRulesParams, RequestOptions requestOptions)	(asynchronously) Searches for rules in your index.
<T> SearchResponse<T>	searchSingleIndex(String indexName, SearchParams searchParams, Class<T> innerType)	Searches a single index and return matching search results (_hits_).
<T> SearchResponse<T>	searchSingleIndex(String indexName, SearchParams searchParams, Class<T> innerType, RequestOptions requestOptions)	Searches a single index and return matching search results (_hits_).
<T> SearchResponse<T>	searchSingleIndex(String indexName, Class<T> innerType)	Searches a single index and return matching search results (_hits_).
<T> SearchResponse<T>	searchSingleIndex(String indexName, Class<T> innerType, RequestOptions requestOptions)	Searches a single index and return matching search results (_hits_).
<T> CompletableFuture<SearchResponse<T>>	searchSingleIndexAsync(String indexName, SearchParams searchParams, Class<T> innerType)	(asynchronously) Searches a single index and return matching search results (_hits_).
<T> CompletableFuture<SearchResponse<T>>	searchSingleIndexAsync(String indexName, SearchParams searchParams, Class<T> innerType, RequestOptions requestOptions)	(asynchronously) Searches a single index and return matching search results (_hits_).
<T> CompletableFuture<SearchResponse<T>>	searchSingleIndexAsync(String indexName, Class<T> innerType)	(asynchronously) Searches a single index and return matching search results (_hits_).
<T> CompletableFuture<SearchResponse<T>>	searchSingleIndexAsync(String indexName, Class<T> innerType, RequestOptions requestOptions)	(asynchronously) Searches a single index and return matching search results (_hits_).
SearchSynonymsResponse	searchSynonyms(String indexName)	Searches for synonyms in your index.
SearchSynonymsResponse	searchSynonyms(String indexName, RequestOptions requestOptions)	Searches for synonyms in your index.
SearchSynonymsResponse	searchSynonyms(String indexName, SearchSynonymsParams searchSynonymsParams)	Searches for synonyms in your index.
SearchSynonymsResponse	searchSynonyms(String indexName, SearchSynonymsParams searchSynonymsParams, RequestOptions requestOptions)	Searches for synonyms in your index.
CompletableFuture<SearchSynonymsResponse>	searchSynonymsAsync(String indexName)	(asynchronously) Searches for synonyms in your index.
CompletableFuture<SearchSynonymsResponse>	searchSynonymsAsync(String indexName, RequestOptions requestOptions)	(asynchronously) Searches for synonyms in your index.
CompletableFuture<SearchSynonymsResponse>	searchSynonymsAsync(String indexName, SearchSynonymsParams searchSynonymsParams)	(asynchronously) Searches for synonyms in your index.
CompletableFuture<SearchSynonymsResponse>	searchSynonymsAsync(String indexName, SearchSynonymsParams searchSynonymsParams, RequestOptions requestOptions)	(asynchronously) Searches for synonyms in your index.
SearchUserIdsResponse	searchUserIds(SearchUserIdsParams searchUserIdsParams)	Since it can take 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 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 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 a few seconds to get the data from the different clusters, the response isn't real-time.
UpdatedAtResponse	setDictionarySettings(DictionarySettingsParams dictionarySettingsParams)	Turns standard stop word dictionary entries on or off for a given language.
UpdatedAtResponse	setDictionarySettings(DictionarySettingsParams dictionarySettingsParams, RequestOptions requestOptions)	Turns standard stop word dictionary entries on or off for a given language.
CompletableFuture<UpdatedAtResponse>	setDictionarySettingsAsync(DictionarySettingsParams dictionarySettingsParams)	(asynchronously) Turns standard stop word dictionary entries on or off for a given language.
CompletableFuture<UpdatedAtResponse>	setDictionarySettingsAsync(DictionarySettingsParams dictionarySettingsParams, RequestOptions requestOptions)	(asynchronously) Turns standard stop word dictionary entries on or off for a given language.
UpdatedAtResponse	setSettings(String indexName, IndexSettings indexSettings)	Update the specified index settings.
UpdatedAtResponse	setSettings(String indexName, IndexSettings indexSettings, RequestOptions requestOptions)	Update the specified index settings.
UpdatedAtResponse	setSettings(String indexName, IndexSettings indexSettings, Boolean forwardToReplicas)	Update the specified index settings.
UpdatedAtResponse	setSettings(String indexName, IndexSettings indexSettings, Boolean forwardToReplicas, RequestOptions requestOptions)	Update the specified index settings.
CompletableFuture<UpdatedAtResponse>	setSettingsAsync(String indexName, IndexSettings indexSettings)	(asynchronously) Update the specified index settings.
CompletableFuture<UpdatedAtResponse>	setSettingsAsync(String indexName, IndexSettings indexSettings, RequestOptions requestOptions)	(asynchronously) Update the specified index settings.
CompletableFuture<UpdatedAtResponse>	setSettingsAsync(String indexName, IndexSettings indexSettings, Boolean forwardToReplicas)	(asynchronously) Update the specified index settings.
CompletableFuture<UpdatedAtResponse>	setSettingsAsync(String indexName, IndexSettings indexSettings, Boolean forwardToReplicas, RequestOptions requestOptions)	(asynchronously) Update the specified index settings.
UpdateApiKeyResponse	updateApiKey(String key, ApiKey apiKey)	Replaces the permissions of an existing API key.
UpdateApiKeyResponse	updateApiKey(String key, ApiKey apiKey, RequestOptions requestOptions)	Replaces the permissions of an existing API key.
CompletableFuture<UpdateApiKeyResponse>	updateApiKeyAsync(String key, ApiKey apiKey)	(asynchronously) Replaces the permissions of an existing API key.
CompletableFuture<UpdateApiKeyResponse>	updateApiKeyAsync(String key, ApiKey apiKey, RequestOptions requestOptions)	(asynchronously) Replaces the permissions of an existing API key.
GetApiKeyResponse	waitForApiKey(ApiKeyOperation operation, String key)	Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
GetApiKeyResponse	waitForApiKey(ApiKeyOperation operation, String key, int maxRetries, IntUnaryOperator timeout)	Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
GetApiKeyResponse	waitForApiKey(ApiKeyOperation operation, String key, int maxRetries, IntUnaryOperator timeout, RequestOptions requestOptions)	Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
GetApiKeyResponse	waitForApiKey(ApiKeyOperation operation, String key, RequestOptions requestOptions)	Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
GetApiKeyResponse	waitForApiKey(ApiKeyOperation operation, String key, ApiKey apiKey)	Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
GetApiKeyResponse	waitForApiKey(ApiKeyOperation operation, String key, ApiKey apiKey, int maxRetries, IntUnaryOperator timeout)	Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
GetApiKeyResponse	waitForApiKey(ApiKeyOperation operation, String key, ApiKey apiKey, int maxRetries, IntUnaryOperator timeout, RequestOptions requestOptions)	Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
GetApiKeyResponse	waitForApiKey(ApiKeyOperation operation, String key, ApiKey apiKey, RequestOptions requestOptions)	Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
void	waitForTask(String indexName, Long taskID)	Helper: Wait for a task to complete with `indexName` and `taskID`.
void	waitForTask(String indexName, Long taskID, int maxRetries, IntUnaryOperator timeout)	Helper: Wait for a task to complete with `indexName` and `taskID`.
void	waitForTask(String indexName, Long taskID, int maxRetries, IntUnaryOperator timeout, RequestOptions requestOptions)	Helper: Wait for a task to complete with `indexName` and `taskID`.
void	waitForTask(String indexName, Long taskID, RequestOptions requestOptions)	Helper: Wait for a task to complete with `indexName` and `taskID`.

Methods inherited from class com.algolia.ApiClient

close, executeAsync, executeAsync

Methods inherited from class java.lang.Object

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

Constructor Details

SearchClient

public SearchClient(String appId,
 String apiKey)

SearchClient

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

Method Details

addApiKey

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

Creates a new API key with specific permissions and restrictions.

Parameters:

apiKey - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

addApiKey

public AddApiKeyResponse addApiKey(@Nonnull
 ApiKey apiKey)
                            throws AlgoliaRuntimeException

Creates a new API key with specific permissions and restrictions.

Parameters:

apiKey - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

addApiKeyAsync

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

(asynchronously) Creates a new API key with specific permissions and restrictions.

Parameters:

apiKey - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

addApiKeyAsync

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

(asynchronously) Creates a new API key with specific permissions and restrictions.

Parameters:

apiKey - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

addOrUpdateObject

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

If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index. To update _some_ attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

objectID - Unique record identifier. (required)

body - The record, a schemaless object with attributes that are useful in the context of search and discovery. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

addOrUpdateObject

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

If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index. To update _some_ attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

objectID - Unique record identifier. (required)

body - The record, a schemaless object with attributes that are useful in the context of search and discovery. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

addOrUpdateObjectAsync

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

(asynchronously) If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index. To update _some_ attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

objectID - Unique record identifier. (required)

body - The record, a schemaless object with attributes that are useful in the context of search and discovery. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

addOrUpdateObjectAsync

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

(asynchronously) If a record with the specified object ID exists, the existing record is replaced. Otherwise, a new record is added to the index. To update _some_ attributes of an existing record, use the [`partial` operation](#tag/Records/operation/partialUpdateObject) instead. To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

objectID - Unique record identifier. (required)

body - The record, a schemaless object with attributes that are useful in the context of search and discovery. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

appendSource

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

Adds a source to the list of allowed sources.

Parameters:

source - Source to add. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

appendSource

public CreatedAtResponse appendSource(@Nonnull
 Source source)
                               throws AlgoliaRuntimeException

Adds a source to the list of allowed sources.

Parameters:

source - Source to add. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

appendSourceAsync

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

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

Parameters:

source - Source to add. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

appendSourceAsync

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

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

Parameters:

source - Source to add. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

assignUserId

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

Assigns or moves 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 - User ID to assign. (required)

assignUserIdParams - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

assignUserId

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

Assigns or moves 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 - User ID to assign. (required)

assignUserIdParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

assignUserIdAsync

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

(asynchronously) Assigns or moves 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 - User ID to assign. (required)

assignUserIdParams - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

assignUserIdAsync

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

(asynchronously) Assigns or moves 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 - User ID to assign. (required)

assignUserIdParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batch

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

Adds, updates, or deletes records in one index with a single API request. Batching index updates reduces latency and increases data integrity. - Actions are applied in the order they're specified. - Actions are equivalent to the individual API requests of the same name.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

batchWriteParams - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batch

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

Adds, updates, or deletes records in one index with a single API request. Batching index updates reduces latency and increases data integrity. - Actions are applied in the order they're specified. - Actions are equivalent to the individual API requests of the same name.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

batchWriteParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchAsync

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

(asynchronously) Adds, updates, or deletes records in one index with a single API request. Batching index updates reduces latency and increases data integrity. - Actions are applied in the order they're specified. - Actions are equivalent to the individual API requests of the same name.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

batchWriteParams - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchAsync

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

(asynchronously) Adds, updates, or deletes records in one index with a single API request. Batching index updates reduces latency and increases data integrity. - Actions are applied in the order they're specified. - Actions are equivalent to the individual API requests of the same name.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

batchWriteParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchAssignUserIds

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

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

Parameters:

xAlgoliaUserID - User ID to assign. (required)

batchAssignUserIdsParams - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchAssignUserIds

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

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

Parameters:

xAlgoliaUserID - User ID to assign. (required)

batchAssignUserIdsParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchAssignUserIdsAsync

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

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

Parameters:

xAlgoliaUserID - User ID to assign. (required)

batchAssignUserIdsParams - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchAssignUserIdsAsync

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

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

Parameters:

xAlgoliaUserID - User ID to assign. (required)

batchAssignUserIdsParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchDictionaryEntries

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

Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.

Parameters:

dictionaryName - Dictionary type in which to search. (required)

batchDictionaryEntriesParams - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchDictionaryEntries

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

Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.

Parameters:

dictionaryName - Dictionary type in which to search. (required)

batchDictionaryEntriesParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchDictionaryEntriesAsync

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

(asynchronously) Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.

Parameters:

dictionaryName - Dictionary type in which to search. (required)

batchDictionaryEntriesParams - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

batchDictionaryEntriesAsync

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

(asynchronously) Adds or deletes multiple entries from your plurals, segmentation, or stop word dictionaries.

Parameters:

dictionaryName - Dictionary type in which to search. (required)

batchDictionaryEntriesParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

browse

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

Retrieves records from an index, up to 1,000 per request. While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices. - The Analytics API doesn't collect data when using `browse`. - Records are ranked by attributes and custom ranking. - Deduplication (`distinct`) is turned off. - There's no ranking for: typo-tolerance, number of matched words, proximity, geo distance.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

browseParams - (optional)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

browse

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

Retrieves records from an index, up to 1,000 per request. While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices. - The Analytics API doesn't collect data when using `browse`. - Records are ranked by attributes and custom ranking. - Deduplication (`distinct`) is turned off. - There's no ranking for: typo-tolerance, number of matched words, proximity, geo distance.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

browseParams - (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

browse

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

Retrieves records from an index, up to 1,000 per request. While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices. - The Analytics API doesn't collect data when using `browse`. - Records are ranked by attributes and custom ranking. - Deduplication (`distinct`) is turned off. - There's no ranking for: typo-tolerance, number of matched words, proximity, geo distance.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

browse

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

Retrieves records from an index, up to 1,000 per request. While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices. - The Analytics API doesn't collect data when using `browse`. - Records are ranked by attributes and custom ranking. - Deduplication (`distinct`) is turned off. - There's no ranking for: typo-tolerance, number of matched words, proximity, geo distance.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

browseAsync

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

(asynchronously) Retrieves records from an index, up to 1,000 per request. While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices. - The Analytics API doesn't collect data when using `browse`. - Records are ranked by attributes and custom ranking. - Deduplication (`distinct`) is turned off. - There's no ranking for: typo-tolerance, number of matched words, proximity, geo distance.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

browseParams - (optional)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

browseAsync

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

(asynchronously) Retrieves records from an index, up to 1,000 per request. While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices. - The Analytics API doesn't collect data when using `browse`. - Records are ranked by attributes and custom ranking. - Deduplication (`distinct`) is turned off. - There's no ranking for: typo-tolerance, number of matched words, proximity, geo distance.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

browseParams - (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

browseAsync

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

(asynchronously) Retrieves records from an index, up to 1,000 per request. While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices. - The Analytics API doesn't collect data when using `browse`. - Records are ranked by attributes and custom ranking. - Deduplication (`distinct`) is turned off. - There's no ranking for: typo-tolerance, number of matched words, proximity, geo distance.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

browseAsync

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

(asynchronously) Retrieves records from an index, up to 1,000 per request. While searching retrieves _hits_ (records augmented with attributes for highlighting and ranking details), browsing _just_ returns matching records. This can be useful if you want to export your indices. - The Analytics API doesn't collect data when using `browse`. - Records are ranked by attributes and custom ranking. - Deduplication (`distinct`) is turned off. - There's no ranking for: typo-tolerance, number of matched words, proximity, geo distance.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearObjects

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

Deletes only the records from an index while keeping settings, synonyms, and rules.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearObjects

public UpdatedAtResponse clearObjects(@Nonnull
 String indexName)
                               throws AlgoliaRuntimeException

Deletes only the records from an index while keeping settings, synonyms, and rules.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearObjectsAsync

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

(asynchronously) Deletes only the records from an index while keeping settings, synonyms, and rules.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearObjectsAsync

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

(asynchronously) Deletes only the records from an index while keeping settings, synonyms, and rules.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearRules

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

Deletes all rules from the index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearRules

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

Deletes all rules from the index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearRules

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

Deletes all rules from the index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearRules

public UpdatedAtResponse clearRules(@Nonnull
 String indexName)
                             throws AlgoliaRuntimeException

Deletes all rules from the index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearRulesAsync

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

(asynchronously) Deletes all rules from the index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearRulesAsync

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

(asynchronously) Deletes all rules from the index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearRulesAsync

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

(asynchronously) Deletes all rules from the index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearRulesAsync

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

(asynchronously) Deletes all rules from the index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearSynonyms

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

Deletes all synonyms from the index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearSynonyms

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

Deletes all synonyms from the index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearSynonyms

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

Deletes all synonyms from the index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearSynonyms

public UpdatedAtResponse clearSynonyms(@Nonnull
 String indexName)
                                throws AlgoliaRuntimeException

Deletes all synonyms from the index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearSynonymsAsync

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

(asynchronously) Deletes all synonyms from the index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearSynonymsAsync

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

(asynchronously) Deletes all synonyms from the index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearSynonymsAsync

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

(asynchronously) Deletes all synonyms from the index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

clearSynonymsAsync

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

(asynchronously) Deletes all synonyms from the index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDelete

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

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

Parameters:

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

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDelete

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

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

Parameters:

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDelete

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

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

Parameters:

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDelete

public Object customDelete(@Nonnull
 String path)
                    throws AlgoliaRuntimeException

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

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDeleteAsync

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

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

Parameters:

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

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDeleteAsync

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

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

Parameters:

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDeleteAsync

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

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

Parameters:

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customDeleteAsync

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

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

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGet

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

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

Parameters:

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

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGet

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

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

Parameters:

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGet

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

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

Parameters:

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGet

public Object customGet(@Nonnull
 String path)
                 throws AlgoliaRuntimeException

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

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGetAsync

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

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

Parameters:

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

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGetAsync

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

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

Parameters:

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGetAsync

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

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

Parameters:

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customGetAsync

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

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

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPost

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

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

Parameters:

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

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

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPost

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

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

Parameters:

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

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPost

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

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

Parameters:

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPost

public Object customPost(@Nonnull
 String path)
                  throws AlgoliaRuntimeException

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

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPostAsync

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

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

Parameters:

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

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

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPostAsync

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

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

Parameters:

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

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPostAsync

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

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

Parameters:

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPostAsync

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

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

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPut

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

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

Parameters:

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

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

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPut

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

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

Parameters:

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

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPut

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

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

Parameters:

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPut

public Object customPut(@Nonnull
 String path)
                 throws AlgoliaRuntimeException

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

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPutAsync

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

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

Parameters:

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

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

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPutAsync

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

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

Parameters:

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

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPutAsync

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

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

Parameters:

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

customPutAsync

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

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

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteApiKey

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

Deletes the API key.

Parameters:

key - API key. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteApiKey

public DeleteApiKeyResponse deleteApiKey(@Nonnull
 String key)
                                  throws AlgoliaRuntimeException

Deletes the API key.

Parameters:

key - API key. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteApiKeyAsync

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

(asynchronously) Deletes the API key.

Parameters:

key - API key. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteApiKeyAsync

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

(asynchronously) Deletes the API key.

Parameters:

key - API key. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteBy

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

This operation doesn't accept empty queries or filters. It's more efficient to get a list of object IDs with the [`browse` operation](#tag/Search/operation/browse), and then delete the records using the [`batch` operation](tag/Records/operation/batch).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

deleteByParams - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteBy

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

This operation doesn't accept empty queries or filters. It's more efficient to get a list of object IDs with the [`browse` operation](#tag/Search/operation/browse), and then delete the records using the [`batch` operation](tag/Records/operation/batch).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

deleteByParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteByAsync

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

(asynchronously) This operation doesn't accept empty queries or filters. It's more efficient to get a list of object IDs with the [`browse` operation](#tag/Search/operation/browse), and then delete the records using the [`batch` operation](tag/Records/operation/batch).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

deleteByParams - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteByAsync

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

(asynchronously) This operation doesn't accept empty queries or filters. It's more efficient to get a list of object IDs with the [`browse` operation](#tag/Search/operation/browse), and then delete the records using the [`batch` operation](tag/Records/operation/batch).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

deleteByParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteIndex

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

Deletes an index and all its settings. - Deleting an index doesn't delete its analytics data. - If you try to delete a non-existing index, the operation is ignored without warning. - If the index you want to delete has replica indices, the replicas become independent indices. - If the index you want to delete is a replica index, you must first unlink it from its primary index before you can delete it. For more information, see [Delete replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas/).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteIndex

public DeletedAtResponse deleteIndex(@Nonnull
 String indexName)
                              throws AlgoliaRuntimeException

Deletes an index and all its settings. - Deleting an index doesn't delete its analytics data. - If you try to delete a non-existing index, the operation is ignored without warning. - If the index you want to delete has replica indices, the replicas become independent indices. - If the index you want to delete is a replica index, you must first unlink it from its primary index before you can delete it. For more information, see [Delete replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas/).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteIndexAsync

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

(asynchronously) Deletes an index and all its settings. - Deleting an index doesn't delete its analytics data. - If you try to delete a non-existing index, the operation is ignored without warning. - If the index you want to delete has replica indices, the replicas become independent indices. - If the index you want to delete is a replica index, you must first unlink it from its primary index before you can delete it. For more information, see [Delete replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas/).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteIndexAsync

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

(asynchronously) Deletes an index and all its settings. - Deleting an index doesn't delete its analytics data. - If you try to delete a non-existing index, the operation is ignored without warning. - If the index you want to delete has replica indices, the replicas become independent indices. - If the index you want to delete is a replica index, you must first unlink it from its primary index before you can delete it. For more information, see [Delete replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/deleting-replicas/).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteObject

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

Deletes a record by its object ID. To delete more than one record, use the [`batch` operation](#tag/Records/operation/batch). To delete records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

objectID - Unique record identifier. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteObject

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

Deletes a record by its object ID. To delete more than one record, use the [`batch` operation](#tag/Records/operation/batch). To delete records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

objectID - Unique record identifier. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteObjectAsync

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

(asynchronously) Deletes a record by its object ID. To delete more than one record, use the [`batch` operation](#tag/Records/operation/batch). To delete records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

objectID - Unique record identifier. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteObjectAsync

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

(asynchronously) Deletes a record by its object ID. To delete more than one record, use the [`batch` operation](#tag/Records/operation/batch). To delete records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

objectID - Unique record identifier. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteRule

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

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

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

forwardToReplicas - Whether changes are applied to replica indices. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteRule

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

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

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

forwardToReplicas - Whether changes are applied to replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteRule

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

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

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteRule

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

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

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteRuleAsync

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

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

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

forwardToReplicas - Whether changes are applied to replica indices. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteRuleAsync

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

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

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

forwardToReplicas - Whether changes are applied to replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteRuleAsync

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

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

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteRuleAsync

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

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

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteSource

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

Deletes a source from the list of allowed sources.

Parameters:

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteSource

public DeleteSourceResponse deleteSource(@Nonnull
 String source)
                                  throws AlgoliaRuntimeException

Deletes a source from the list of allowed sources.

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteSourceAsync

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

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

Parameters:

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteSourceAsync

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

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

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteSynonym

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

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

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

forwardToReplicas - Whether changes are applied to replica indices. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteSynonym

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

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

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

forwardToReplicas - Whether changes are applied to replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteSynonym

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

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

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteSynonym

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

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

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteSynonymAsync

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

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

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

forwardToReplicas - Whether changes are applied to replica indices. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteSynonymAsync

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

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

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

forwardToReplicas - Whether changes are applied to replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteSynonymAsync

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

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

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

deleteSynonymAsync

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

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

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getApiKey

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

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

Parameters:

key - API key. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getApiKey

public GetApiKeyResponse getApiKey(@Nonnull
 String key)
                            throws AlgoliaRuntimeException

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

Parameters:

key - API key. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getApiKeyAsync

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

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

Parameters:

key - API key. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getApiKeyAsync

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

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

Parameters:

key - API key. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getDictionaryLanguages

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

Lists supported languages with their supported dictionary types and number of custom entries.

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getDictionaryLanguages

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

Lists supported languages with their supported dictionary types and number of custom entries.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getDictionaryLanguagesAsync

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

(asynchronously) Lists supported languages with their supported dictionary types and number of custom entries.

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getDictionaryLanguagesAsync

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

(asynchronously) Lists supported languages with their supported dictionary types and number of custom entries.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getDictionarySettings

public GetDictionarySettingsResponse getDictionarySettings(RequestOptions requestOptions)
                                                    throws AlgoliaRuntimeException

Retrieves the languages for which standard dictionary entries are turned off.

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getDictionarySettings

public GetDictionarySettingsResponse getDictionarySettings()
                                                    throws AlgoliaRuntimeException

Retrieves the languages for which standard dictionary entries are turned off.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getDictionarySettingsAsync

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

(asynchronously) Retrieves the languages for which standard dictionary entries are turned off.

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getDictionarySettingsAsync

public CompletableFuture<GetDictionarySettingsResponse> getDictionarySettingsAsync()
                                                                            throws AlgoliaRuntimeException

(asynchronously) Retrieves the languages for which standard dictionary entries are turned off.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getLogs

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

The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). - Logs are held for the last seven days. - Up to 1,000 API requests per server are logged. - This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself.

Parameters:

offset - First log entry to retrieve. The most recent entries are listed first. (optional, default to 0)

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

indexName - Index for which to retrieve log entries. By default, log entries are retrieved for all indices. (optional)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getLogs

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

The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). - Logs are held for the last seven days. - Up to 1,000 API requests per server are logged. - This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself.

Parameters:

offset - First log entry to retrieve. The most recent entries are listed first. (optional, default to 0)

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

indexName - Index for which to retrieve log entries. By default, log entries are retrieved for all indices. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getLogs

public GetLogsResponse getLogs(RequestOptions requestOptions)
                        throws AlgoliaRuntimeException

The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). - Logs are held for the last seven days. - Up to 1,000 API requests per server are logged. - This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself.

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getLogs

public GetLogsResponse getLogs()
                        throws AlgoliaRuntimeException

The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). - Logs are held for the last seven days. - Up to 1,000 API requests per server are logged. - This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getLogsAsync

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

(asynchronously) The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). - Logs are held for the last seven days. - Up to 1,000 API requests per server are logged. - This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself.

Parameters:

offset - First log entry to retrieve. The most recent entries are listed first. (optional, default to 0)

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

indexName - Index for which to retrieve log entries. By default, log entries are retrieved for all indices. (optional)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getLogsAsync

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

(asynchronously) The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). - Logs are held for the last seven days. - Up to 1,000 API requests per server are logged. - This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself.

Parameters:

offset - First log entry to retrieve. The most recent entries are listed first. (optional, default to 0)

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

indexName - Index for which to retrieve log entries. By default, log entries are retrieved for all indices. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getLogsAsync

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

(asynchronously) The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). - Logs are held for the last seven days. - Up to 1,000 API requests per server are logged. - This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself.

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getLogsAsync

public CompletableFuture<GetLogsResponse> getLogsAsync()
                                                throws AlgoliaRuntimeException

(asynchronously) The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl). - Logs are held for the last seven days. - Up to 1,000 API requests per server are logged. - This request counts towards your [operations quota](https://support.algolia.com/hc/en-us/articles/4406981829777-How-does-Algolia-count-records-and-operations-) but doesn't appear in the logs itself.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getObject

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

Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

objectID - Unique record identifier. (required)

attributesToRetrieve - Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved. Attributes included in `unretrievableAttributes` won't be retrieved unless the request is authenticated with the admin API key. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getObject

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

Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

objectID - Unique record identifier. (required)

attributesToRetrieve - Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved. Attributes included in `unretrievableAttributes` won't be retrieved unless the request is authenticated with the admin API key. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getObject

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

Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

objectID - Unique record identifier. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getObject

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

Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

objectID - Unique record identifier. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getObjectAsync

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

(asynchronously) Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

objectID - Unique record identifier. (required)

attributesToRetrieve - Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved. Attributes included in `unretrievableAttributes` won't be retrieved unless the request is authenticated with the admin API key. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getObjectAsync

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

(asynchronously) Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

objectID - Unique record identifier. (required)

attributesToRetrieve - Attributes to include with the records in the response. This is useful to reduce the size of the API response. By default, all retrievable attributes are returned. `objectID` is always retrieved. Attributes included in `unretrievableAttributes` won't be retrieved unless the request is authenticated with the admin API key. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getObjectAsync

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

(asynchronously) Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

objectID - Unique record identifier. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getObjectAsync

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

(asynchronously) Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](#tag/Records/operation/getObjects).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

objectID - Unique record identifier. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getObjects

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

Retrieves one or more records, potentially from different indices. Records are returned in the same order as the requests.

Parameters:

getObjectsParams - Request object. (required)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getObjects

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

Retrieves one or more records, potentially from different indices. Records are returned in the same order as the requests.

Parameters:

getObjectsParams - Request object. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getObjectsAsync

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

(asynchronously) Retrieves one or more records, potentially from different indices. Records are returned in the same order as the requests.

Parameters:

getObjectsParams - Request object. (required)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getObjectsAsync

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

(asynchronously) Retrieves one or more records, potentially from different indices. Records are returned in the same order as the requests.

Parameters:

getObjectsParams - Request object. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRule

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

Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](#tag/Rules/operation/searchRules).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRule

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

Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](#tag/Rules/operation/searchRules).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRuleAsync

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

(asynchronously) Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](#tag/Rules/operation/searchRules).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getRuleAsync

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

(asynchronously) Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](#tag/Rules/operation/searchRules).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSettings

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

Retrieves an object with non-null index settings.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSettings

public IndexSettings getSettings(@Nonnull
 String indexName)
                          throws AlgoliaRuntimeException

Retrieves an object with non-null index settings.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSettingsAsync

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

(asynchronously) Retrieves an object with non-null index settings.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSettingsAsync

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

(asynchronously) Retrieves an object with non-null index settings.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSources

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

Retrieves all allowed IP addresses with access to your application.

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSources

public List<Source> getSources()
                        throws AlgoliaRuntimeException

Retrieves all allowed IP addresses with access to your application.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSourcesAsync

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

(asynchronously) Retrieves all allowed IP addresses with access to your application.

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSourcesAsync

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

(asynchronously) Retrieves all allowed IP addresses with access to your application.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSynonym

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

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

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSynonym

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

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

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSynonymAsync

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

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

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getSynonymAsync

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

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

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTask

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

Checks the status of a given task. Indexing tasks are asynchronous. When you add, update, or delete records or indices, a task is created on a queue and completed depending on the load on the server. The indexing tasks' responses include a task ID that you can use to check the status.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

taskID - Unique task identifier. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTask

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

Checks the status of a given task. Indexing tasks are asynchronous. When you add, update, or delete records or indices, a task is created on a queue and completed depending on the load on the server. The indexing tasks' responses include a task ID that you can use to check the status.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

taskID - Unique task identifier. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTaskAsync

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

(asynchronously) Checks the status of a given task. Indexing tasks are asynchronous. When you add, update, or delete records or indices, a task is created on a queue and completed depending on the load on the server. The indexing tasks' responses include a task ID that you can use to check the status.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

taskID - Unique task identifier. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTaskAsync

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

(asynchronously) Checks the status of a given task. Indexing tasks are asynchronous. When you add, update, or delete records or indices, a task is created on a queue and completed depending on the load on the server. The indexing tasks' responses include a task ID that you can use to check the status.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

taskID - Unique task identifier. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopUserIds

public GetTopUserIdsResponse getTopUserIds(RequestOptions requestOptions)
                                    throws AlgoliaRuntimeException

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

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopUserIds

public GetTopUserIdsResponse getTopUserIds()
                                    throws AlgoliaRuntimeException

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopUserIdsAsync

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

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

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getTopUserIdsAsync

public CompletableFuture<GetTopUserIdsResponse> getTopUserIdsAsync()
                                                            throws AlgoliaRuntimeException

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getUserId

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

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

Parameters:

userID - User ID to assign. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getUserId

public UserId getUserId(@Nonnull
 String userID)
                 throws AlgoliaRuntimeException

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

Parameters:

userID - User ID to assign. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getUserIdAsync

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

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

Parameters:

userID - User ID to assign. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

getUserIdAsync

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

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

Parameters:

userID - User ID to assign. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

hasPendingMappings

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

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

Parameters:

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

hasPendingMappings

public HasPendingMappingsResponse hasPendingMappings(Boolean getClusters)
                                              throws AlgoliaRuntimeException

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

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

hasPendingMappings

public HasPendingMappingsResponse hasPendingMappings(RequestOptions requestOptions)
                                              throws AlgoliaRuntimeException

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

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

hasPendingMappings

public HasPendingMappingsResponse hasPendingMappings()
                                              throws AlgoliaRuntimeException

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

hasPendingMappingsAsync

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

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

Parameters:

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

hasPendingMappingsAsync

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

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

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

hasPendingMappingsAsync

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

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

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

hasPendingMappingsAsync

public CompletableFuture<HasPendingMappingsResponse> hasPendingMappingsAsync()
                                                                      throws AlgoliaRuntimeException

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listApiKeys

public ListApiKeysResponse listApiKeys(RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

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

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listApiKeys

public ListApiKeysResponse listApiKeys()
                                throws AlgoliaRuntimeException

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listApiKeysAsync

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

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

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listApiKeysAsync

public CompletableFuture<ListApiKeysResponse> listApiKeysAsync()
                                                        throws AlgoliaRuntimeException

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listClusters

public ListClustersResponse listClusters(RequestOptions requestOptions)
                                  throws AlgoliaRuntimeException

Lists the available clusters in a multi-cluster setup.

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listClusters

public ListClustersResponse listClusters()
                                  throws AlgoliaRuntimeException

Lists the available clusters in a multi-cluster setup.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listClustersAsync

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

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

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listClustersAsync

public CompletableFuture<ListClustersResponse> listClustersAsync()
                                                          throws AlgoliaRuntimeException

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listIndices

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

Lists all indices in the current Algolia application. The request follows any index restrictions of the API key you use to make the request.

Parameters:

page - Requested page of the API response. If `null`, the API response is not paginated. (optional)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listIndices

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

Lists all indices in the current Algolia application. The request follows any index restrictions of the API key you use to make the request.

Parameters:

page - Requested page of the API response. If `null`, the API response is not paginated. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listIndices

public ListIndicesResponse listIndices(RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

Lists all indices in the current Algolia application. The request follows any index restrictions of the API key you use to make the request.

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listIndices

public ListIndicesResponse listIndices()
                                throws AlgoliaRuntimeException

Lists all indices in the current Algolia application. The request follows any index restrictions of the API key you use to make the request.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listIndicesAsync

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

(asynchronously) Lists all indices in the current Algolia application. The request follows any index restrictions of the API key you use to make the request.

Parameters:

page - Requested page of the API response. If `null`, the API response is not paginated. (optional)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listIndicesAsync

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

(asynchronously) Lists all indices in the current Algolia application. The request follows any index restrictions of the API key you use to make the request.

Parameters:

page - Requested page of the API response. If `null`, the API response is not paginated. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listIndicesAsync

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

(asynchronously) Lists all indices in the current Algolia application. The request follows any index restrictions of the API key you use to make the request.

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listIndicesAsync

public CompletableFuture<ListIndicesResponse> listIndicesAsync()
                                                        throws AlgoliaRuntimeException

(asynchronously) Lists all indices in the current Algolia application. The request follows any index restrictions of the API key you use to make the request.

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listUserIds

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

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

Parameters:

page - Requested page of the API response. If `null`, the API response is not paginated. (optional)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listUserIds

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

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

Parameters:

page - Requested page of the API response. If `null`, the API response is not paginated. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listUserIds

public ListUserIdsResponse listUserIds(RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

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

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listUserIds

public ListUserIdsResponse listUserIds()
                                throws AlgoliaRuntimeException

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listUserIdsAsync

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

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

Parameters:

page - Requested page of the API response. If `null`, the API response is not paginated. (optional)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listUserIdsAsync

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

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

Parameters:

page - Requested page of the API response. If `null`, the API response is not paginated. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listUserIdsAsync

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

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

Parameters:

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

listUserIdsAsync

public CompletableFuture<ListUserIdsResponse> listUserIdsAsync()
                                                        throws AlgoliaRuntimeException

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

multipleBatch

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

Adds, updates, or deletes records in multiple indices with a single API request. - Actions are applied in the order they are specified. - Actions are equivalent to the individual API requests of the same name.

Parameters:

batchParams - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

multipleBatch

public MultipleBatchResponse multipleBatch(@Nonnull
 BatchParams batchParams)
                                    throws AlgoliaRuntimeException

Adds, updates, or deletes records in multiple indices with a single API request. - Actions are applied in the order they are specified. - Actions are equivalent to the individual API requests of the same name.

Parameters:

batchParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

multipleBatchAsync

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

(asynchronously) Adds, updates, or deletes records in multiple indices with a single API request. - Actions are applied in the order they are specified. - Actions are equivalent to the individual API requests of the same name.

Parameters:

batchParams - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

multipleBatchAsync

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

(asynchronously) Adds, updates, or deletes records in multiple indices with a single API request. - Actions are applied in the order they are specified. - Actions are equivalent to the individual API requests of the same name.

Parameters:

batchParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

operationIndex

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

Copies or moves (renames) an index within the same Algolia application. - Existing destination indices are overwritten, except for index-specific API keys and analytics data. - If the destination index doesn't exist yet, it'll be created. **Copy** - Copying a source index that doesn't exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can't copy the `enableReRanking`, `mode`, and `replicas` settings. - You can't copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/) **Move** - Moving a source index that doesn't exist is ignored without returning an error. - When moving an index, the analytics data keep their original name and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices/).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

operationIndexParams - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

operationIndex

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

Copies or moves (renames) an index within the same Algolia application. - Existing destination indices are overwritten, except for index-specific API keys and analytics data. - If the destination index doesn't exist yet, it'll be created. **Copy** - Copying a source index that doesn't exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can't copy the `enableReRanking`, `mode`, and `replicas` settings. - You can't copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/) **Move** - Moving a source index that doesn't exist is ignored without returning an error. - When moving an index, the analytics data keep their original name and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices/).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

operationIndexParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

operationIndexAsync

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

(asynchronously) Copies or moves (renames) an index within the same Algolia application. - Existing destination indices are overwritten, except for index-specific API keys and analytics data. - If the destination index doesn't exist yet, it'll be created. **Copy** - Copying a source index that doesn't exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can't copy the `enableReRanking`, `mode`, and `replicas` settings. - You can't copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/) **Move** - Moving a source index that doesn't exist is ignored without returning an error. - When moving an index, the analytics data keep their original name and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices/).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

operationIndexParams - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

operationIndexAsync

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

(asynchronously) Copies or moves (renames) an index within the same Algolia application. - Existing destination indices are overwritten, except for index-specific API keys and analytics data. - If the destination index doesn't exist yet, it'll be created. **Copy** - Copying a source index that doesn't exist creates a new index with 0 records and default settings. - The API keys of the source index are merged with the existing keys in the destination index. - You can't copy the `enableReRanking`, `mode`, and `replicas` settings. - You can't copy to a destination index that already has replicas. - Be aware of the [size limits](https://www.algolia.com/doc/guides/scaling/algolia-service-limits/#application-record-and-index-limits). - Related guide: [Copy indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/copy-indices/) **Move** - Moving a source index that doesn't exist is ignored without returning an error. - When moving an index, the analytics data keep their original name and a new set of analytics data is started for the new name. To access the original analytics in the dashboard, create an index with the original name. - If the destination index has replicas, moving will overwrite the existing index and copy the data to the replica indices. - Related guide: [Move indices](https://www.algolia.com/doc/guides/sending-and-managing-data/manage-indices-and-apps/manage-indices/how-to/move-indices/).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

operationIndexParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

partialUpdateObject

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

Adds new attributes to a record, or update existing ones. - If a record with the specified object ID doesn't exist, a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn't exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes. If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

objectID - Unique record identifier. (required)

attributesToUpdate - Attributes with their values. (required)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

partialUpdateObject

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

Adds new attributes to a record, or update existing ones. - If a record with the specified object ID doesn't exist, a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn't exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes. If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

objectID - Unique record identifier. (required)

attributesToUpdate - Attributes with their values. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

partialUpdateObject

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

Adds new attributes to a record, or update existing ones. - If a record with the specified object ID doesn't exist, a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn't exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes. If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

objectID - Unique record identifier. (required)

attributesToUpdate - Attributes with their values. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

partialUpdateObject

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

Adds new attributes to a record, or update existing ones. - If a record with the specified object ID doesn't exist, a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn't exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes. If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

objectID - Unique record identifier. (required)

attributesToUpdate - Attributes with their values. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

partialUpdateObjectAsync

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

(asynchronously) Adds new attributes to a record, or update existing ones. - If a record with the specified object ID doesn't exist, a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn't exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes. If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

objectID - Unique record identifier. (required)

attributesToUpdate - Attributes with their values. (required)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

partialUpdateObjectAsync

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

(asynchronously) Adds new attributes to a record, or update existing ones. - If a record with the specified object ID doesn't exist, a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn't exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes. If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

objectID - Unique record identifier. (required)

attributesToUpdate - Attributes with their values. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

partialUpdateObjectAsync

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

(asynchronously) Adds new attributes to a record, or update existing ones. - If a record with the specified object ID doesn't exist, a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn't exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes. If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

objectID - Unique record identifier. (required)

attributesToUpdate - Attributes with their values. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

partialUpdateObjectAsync

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

(asynchronously) Adds new attributes to a record, or update existing ones. - If a record with the specified object ID doesn't exist, a new record is added to the index **if** `createIfNotExists` is true. - If the index doesn't exist yet, this method creates a new index. - You can use any first-level attribute but not nested attributes. If you specify a nested attribute, the engine treats it as a replacement for its first-level ancestor.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

objectID - Unique record identifier. (required)

attributesToUpdate - Attributes with their values. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

removeUserId

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

Deletes a user ID and its associated data from the clusters.

Parameters:

userID - User ID to assign. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

removeUserId

public RemoveUserIdResponse removeUserId(@Nonnull
 String userID)
                                  throws AlgoliaRuntimeException

Deletes a user ID and its associated data from the clusters.

Parameters:

userID - User ID to assign. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

removeUserIdAsync

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

(asynchronously) Deletes a user ID and its associated data from the clusters.

Parameters:

userID - User ID to assign. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

removeUserIdAsync

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

(asynchronously) Deletes a user ID and its associated data from the clusters.

Parameters:

userID - User ID to assign. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

replaceSources

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

Replaces the list of allowed sources.

Parameters:

source - Allowed sources. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

replaceSources

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

Replaces the list of allowed sources.

Parameters:

source - Allowed sources. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

replaceSourcesAsync

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

(asynchronously) Replaces the list of allowed sources.

Parameters:

source - Allowed sources. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

replaceSourcesAsync

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

(asynchronously) Replaces the list of allowed sources.

Parameters:

source - Allowed sources. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

restoreApiKey

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

Restores a deleted API key. Restoring resets the `validity` attribute to `0`. Algolia stores up to 1,000 API keys per application. If you create more, the oldest API keys are deleted and can't be restored.

Parameters:

key - API key. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

restoreApiKey

public AddApiKeyResponse restoreApiKey(@Nonnull
 String key)
                                throws AlgoliaRuntimeException

Restores a deleted API key. Restoring resets the `validity` attribute to `0`. Algolia stores up to 1,000 API keys per application. If you create more, the oldest API keys are deleted and can't be restored.

Parameters:

key - API key. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

restoreApiKeyAsync

public CompletableFuture<AddApiKeyResponse> restoreApiKeyAsync(@Nonnull
 String key,
 RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

(asynchronously) Restores a deleted API key. Restoring resets the `validity` attribute to `0`. Algolia stores up to 1,000 API keys per application. If you create more, the oldest API keys are deleted and can't be restored.

Parameters:

key - API key. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

restoreApiKeyAsync

public CompletableFuture<AddApiKeyResponse> restoreApiKeyAsync(@Nonnull
 String key)
                                                        throws AlgoliaRuntimeException

(asynchronously) Restores a deleted API key. Restoring resets the `validity` attribute to `0`. Algolia stores up to 1,000 API keys per application. If you create more, the oldest API keys are deleted and can't be restored.

Parameters:

key - API key. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveObject

public SaveObjectResponse saveObject(@Nonnull
 String indexName,
 @Nonnull
 Object body,
 RequestOptions requestOptions)
                              throws AlgoliaRuntimeException

Adds a record to an index or replace it. - If the record doesn't have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn't exist, a new record is added to your index. - If you add a record to an index that doesn't exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partial). To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

body - The record, a schemaless object with attributes that are useful in the context of search and discovery. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveObject

public SaveObjectResponse saveObject(@Nonnull
 String indexName,
 @Nonnull
 Object body)
                              throws AlgoliaRuntimeException

Adds a record to an index or replace it. - If the record doesn't have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn't exist, a new record is added to your index. - If you add a record to an index that doesn't exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partial). To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

body - The record, a schemaless object with attributes that are useful in the context of search and discovery. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveObjectAsync

public CompletableFuture<SaveObjectResponse> saveObjectAsync(@Nonnull
 String indexName,
 @Nonnull
 Object body,
 RequestOptions requestOptions)
                                                      throws AlgoliaRuntimeException

(asynchronously) Adds a record to an index or replace it. - If the record doesn't have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn't exist, a new record is added to your index. - If you add a record to an index that doesn't exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partial). To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

body - The record, a schemaless object with attributes that are useful in the context of search and discovery. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveObjectAsync

public CompletableFuture<SaveObjectResponse> saveObjectAsync(@Nonnull
 String indexName,
 @Nonnull
 Object body)
                                                      throws AlgoliaRuntimeException

(asynchronously) Adds a record to an index or replace it. - If the record doesn't have an object ID, a new record with an auto-generated object ID is added to your index. - If a record with the specified object ID exists, the existing record is replaced. - If a record with the specified object ID doesn't exist, a new record is added to your index. - If you add a record to an index that doesn't exist yet, a new index is created. To update _some_ attributes of a record, use the [`partial` operation](#tag/Records/operation/partial). To add, update, or replace multiple records, use the [`batch` operation](#tag/Records/operation/batch).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

body - The record, a schemaless object with attributes that are useful in the context of search and discovery. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRule

public UpdatedRuleResponse saveRule(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Rule rule,
 Boolean forwardToReplicas,
 RequestOptions requestOptions)
                             throws AlgoliaRuntimeException

If a rule with the specified object ID doesn't exist, it's created. Otherwise, the existing rule is replaced. To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

rule - (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRule

public UpdatedRuleResponse saveRule(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Rule rule,
 Boolean forwardToReplicas)
                             throws AlgoliaRuntimeException

If a rule with the specified object ID doesn't exist, it's created. Otherwise, the existing rule is replaced. To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

rule - (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRule

public UpdatedRuleResponse saveRule(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Rule rule,
 RequestOptions requestOptions)
                             throws AlgoliaRuntimeException

If a rule with the specified object ID doesn't exist, it's created. Otherwise, the existing rule is replaced. To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

rule - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRule

public UpdatedRuleResponse saveRule(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Rule rule)
                             throws AlgoliaRuntimeException

If a rule with the specified object ID doesn't exist, it's created. Otherwise, the existing rule is replaced. To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

rule - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRuleAsync

public CompletableFuture<UpdatedRuleResponse> saveRuleAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Rule rule,
 Boolean forwardToReplicas,
 RequestOptions requestOptions)
                                                     throws AlgoliaRuntimeException

(asynchronously) If a rule with the specified object ID doesn't exist, it's created. Otherwise, the existing rule is replaced. To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

rule - (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRuleAsync

public CompletableFuture<UpdatedRuleResponse> saveRuleAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Rule rule,
 Boolean forwardToReplicas)
                                                     throws AlgoliaRuntimeException

(asynchronously) If a rule with the specified object ID doesn't exist, it's created. Otherwise, the existing rule is replaced. To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

rule - (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRuleAsync

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

(asynchronously) If a rule with the specified object ID doesn't exist, it's created. Otherwise, the existing rule is replaced. To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

rule - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRuleAsync

public CompletableFuture<UpdatedRuleResponse> saveRuleAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 Rule rule)
                                                     throws AlgoliaRuntimeException

(asynchronously) If a rule with the specified object ID doesn't exist, it's created. Otherwise, the existing rule is replaced. To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

rule - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRules

public UpdatedAtResponse saveRules(@Nonnull
 String indexName,
 @Nonnull
 List<Rule> rules,
 Boolean forwardToReplicas,
 Boolean clearExistingRules,
 RequestOptions requestOptions)
                            throws AlgoliaRuntimeException

Create or update multiple rules. If a rule with the specified object ID doesn't exist, Algolia creates a new one. Otherwise, existing rules are replaced.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

rules - (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

clearExistingRules - Whether existing rules should be deleted before adding this batch. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRules

public UpdatedAtResponse saveRules(@Nonnull
 String indexName,
 @Nonnull
 List<Rule> rules,
 Boolean forwardToReplicas,
 Boolean clearExistingRules)
                            throws AlgoliaRuntimeException

Create or update multiple rules. If a rule with the specified object ID doesn't exist, Algolia creates a new one. Otherwise, existing rules are replaced.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

rules - (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

clearExistingRules - Whether existing rules should be deleted before adding this batch. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRules

public UpdatedAtResponse saveRules(@Nonnull
 String indexName,
 @Nonnull
 List<Rule> rules,
 RequestOptions requestOptions)
                            throws AlgoliaRuntimeException

Create or update multiple rules. If a rule with the specified object ID doesn't exist, Algolia creates a new one. Otherwise, existing rules are replaced.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

rules - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRules

public UpdatedAtResponse saveRules(@Nonnull
 String indexName,
 @Nonnull
 List<Rule> rules)
                            throws AlgoliaRuntimeException

Create or update multiple rules. If a rule with the specified object ID doesn't exist, Algolia creates a new one. Otherwise, existing rules are replaced.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

rules - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRulesAsync

public CompletableFuture<UpdatedAtResponse> saveRulesAsync(@Nonnull
 String indexName,
 @Nonnull
 List<Rule> rules,
 Boolean forwardToReplicas,
 Boolean clearExistingRules,
 RequestOptions requestOptions)
                                                    throws AlgoliaRuntimeException

(asynchronously) Create or update multiple rules. If a rule with the specified object ID doesn't exist, Algolia creates a new one. Otherwise, existing rules are replaced.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

rules - (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

clearExistingRules - Whether existing rules should be deleted before adding this batch. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRulesAsync

public CompletableFuture<UpdatedAtResponse> saveRulesAsync(@Nonnull
 String indexName,
 @Nonnull
 List<Rule> rules,
 Boolean forwardToReplicas,
 Boolean clearExistingRules)
                                                    throws AlgoliaRuntimeException

(asynchronously) Create or update multiple rules. If a rule with the specified object ID doesn't exist, Algolia creates a new one. Otherwise, existing rules are replaced.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

rules - (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

clearExistingRules - Whether existing rules should be deleted before adding this batch. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRulesAsync

public CompletableFuture<UpdatedAtResponse> saveRulesAsync(@Nonnull
 String indexName,
 @Nonnull
 List<Rule> rules,
 RequestOptions requestOptions)
                                                    throws AlgoliaRuntimeException

(asynchronously) Create or update multiple rules. If a rule with the specified object ID doesn't exist, Algolia creates a new one. Otherwise, existing rules are replaced.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

rules - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveRulesAsync

public CompletableFuture<UpdatedAtResponse> saveRulesAsync(@Nonnull
 String indexName,
 @Nonnull
 List<Rule> rules)
                                                    throws AlgoliaRuntimeException

(asynchronously) Create or update multiple rules. If a rule with the specified object ID doesn't exist, Algolia creates a new one. Otherwise, existing rules are replaced.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

rules - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonym

public SaveSynonymResponse saveSynonym(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 SynonymHit synonymHit,
 Boolean forwardToReplicas,
 RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

If a synonym with the specified object ID doesn't exist, Algolia adds a new one. Otherwise, the existing synonym is replaced. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

synonymHit - (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonym

public SaveSynonymResponse saveSynonym(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 SynonymHit synonymHit,
 Boolean forwardToReplicas)
                                throws AlgoliaRuntimeException

If a synonym with the specified object ID doesn't exist, Algolia adds a new one. Otherwise, the existing synonym is replaced. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

synonymHit - (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonym

public SaveSynonymResponse saveSynonym(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 SynonymHit synonymHit,
 RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

If a synonym with the specified object ID doesn't exist, Algolia adds a new one. Otherwise, the existing synonym is replaced. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

synonymHit - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonym

public SaveSynonymResponse saveSynonym(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 SynonymHit synonymHit)
                                throws AlgoliaRuntimeException

If a synonym with the specified object ID doesn't exist, Algolia adds a new one. Otherwise, the existing synonym is replaced. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

synonymHit - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonymAsync

public CompletableFuture<SaveSynonymResponse> saveSynonymAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 SynonymHit synonymHit,
 Boolean forwardToReplicas,
 RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

(asynchronously) If a synonym with the specified object ID doesn't exist, Algolia adds a new one. Otherwise, the existing synonym is replaced. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

synonymHit - (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonymAsync

public CompletableFuture<SaveSynonymResponse> saveSynonymAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 SynonymHit synonymHit,
 Boolean forwardToReplicas)
                                                        throws AlgoliaRuntimeException

(asynchronously) If a synonym with the specified object ID doesn't exist, Algolia adds a new one. Otherwise, the existing synonym is replaced. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

synonymHit - (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonymAsync

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

(asynchronously) If a synonym with the specified object ID doesn't exist, Algolia adds a new one. Otherwise, the existing synonym is replaced. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

synonymHit - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonymAsync

public CompletableFuture<SaveSynonymResponse> saveSynonymAsync(@Nonnull
 String indexName,
 @Nonnull
 String objectID,
 @Nonnull
 SynonymHit synonymHit)
                                                        throws AlgoliaRuntimeException

(asynchronously) If a synonym with the specified object ID doesn't exist, Algolia adds a new one. Otherwise, the existing synonym is replaced. To add multiple synonyms in a single API request, use the [`batch` operation](#tag/Synonyms/operation/saveSynonyms).

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

synonymHit - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonyms

public UpdatedAtResponse saveSynonyms(@Nonnull
 String indexName,
 @Nonnull
 List<SynonymHit> synonymHit,
 Boolean forwardToReplicas,
 Boolean replaceExistingSynonyms,
 RequestOptions requestOptions)
                               throws AlgoliaRuntimeException

If a synonym with the `objectID` doesn't exist, Algolia adds a new one. Otherwise, existing synonyms are replaced.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

synonymHit - (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

replaceExistingSynonyms - Whether to replace all synonyms in the index with the ones sent with this request. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonyms

public UpdatedAtResponse saveSynonyms(@Nonnull
 String indexName,
 @Nonnull
 List<SynonymHit> synonymHit,
 Boolean forwardToReplicas,
 Boolean replaceExistingSynonyms)
                               throws AlgoliaRuntimeException

If a synonym with the `objectID` doesn't exist, Algolia adds a new one. Otherwise, existing synonyms are replaced.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

synonymHit - (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

replaceExistingSynonyms - Whether to replace all synonyms in the index with the ones sent with this request. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonyms

public UpdatedAtResponse saveSynonyms(@Nonnull
 String indexName,
 @Nonnull
 List<SynonymHit> synonymHit,
 RequestOptions requestOptions)
                               throws AlgoliaRuntimeException

If a synonym with the `objectID` doesn't exist, Algolia adds a new one. Otherwise, existing synonyms are replaced.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

synonymHit - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonyms

public UpdatedAtResponse saveSynonyms(@Nonnull
 String indexName,
 @Nonnull
 List<SynonymHit> synonymHit)
                               throws AlgoliaRuntimeException

If a synonym with the `objectID` doesn't exist, Algolia adds a new one. Otherwise, existing synonyms are replaced.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

synonymHit - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonymsAsync

public CompletableFuture<UpdatedAtResponse> saveSynonymsAsync(@Nonnull
 String indexName,
 @Nonnull
 List<SynonymHit> synonymHit,
 Boolean forwardToReplicas,
 Boolean replaceExistingSynonyms,
 RequestOptions requestOptions)
                                                       throws AlgoliaRuntimeException

(asynchronously) If a synonym with the `objectID` doesn't exist, Algolia adds a new one. Otherwise, existing synonyms are replaced.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

synonymHit - (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

replaceExistingSynonyms - Whether to replace all synonyms in the index with the ones sent with this request. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonymsAsync

public CompletableFuture<UpdatedAtResponse> saveSynonymsAsync(@Nonnull
 String indexName,
 @Nonnull
 List<SynonymHit> synonymHit,
 Boolean forwardToReplicas,
 Boolean replaceExistingSynonyms)
                                                       throws AlgoliaRuntimeException

(asynchronously) If a synonym with the `objectID` doesn't exist, Algolia adds a new one. Otherwise, existing synonyms are replaced.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

synonymHit - (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

replaceExistingSynonyms - Whether to replace all synonyms in the index with the ones sent with this request. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonymsAsync

public CompletableFuture<UpdatedAtResponse> saveSynonymsAsync(@Nonnull
 String indexName,
 @Nonnull
 List<SynonymHit> synonymHit,
 RequestOptions requestOptions)
                                                       throws AlgoliaRuntimeException

(asynchronously) If a synonym with the `objectID` doesn't exist, Algolia adds a new one. Otherwise, existing synonyms are replaced.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

synonymHit - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

saveSynonymsAsync

public CompletableFuture<UpdatedAtResponse> saveSynonymsAsync(@Nonnull
 String indexName,
 @Nonnull
 List<SynonymHit> synonymHit)
                                                       throws AlgoliaRuntimeException

(asynchronously) If a synonym with the `objectID` doesn't exist, Algolia adds a new one. Otherwise, existing synonyms are replaced.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

synonymHit - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

search

public <T> SearchResponses<T> search(@Nonnull
 SearchMethodParams searchMethodParams,
 Class<T> innerType,
 RequestOptions requestOptions)
                              throws AlgoliaRuntimeException

Sends multiple search request to one or more indices. This can be useful in these cases: - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.

Parameters:

searchMethodParams - Muli-search request body. Results are returned in the same order as the requests. (required)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

search

public <T> SearchResponses<T> search(@Nonnull
 SearchMethodParams searchMethodParams,
 Class<T> innerType)
                              throws AlgoliaRuntimeException

Sends multiple search request to one or more indices. This can be useful in these cases: - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.

Parameters:

searchMethodParams - Muli-search request body. Results are returned in the same order as the requests. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchAsync

public <T> CompletableFuture<SearchResponses<T>> searchAsync(@Nonnull
 SearchMethodParams searchMethodParams,
 Class<T> innerType,
 RequestOptions requestOptions)
                                                      throws AlgoliaRuntimeException

(asynchronously) Sends multiple search request to one or more indices. This can be useful in these cases: - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.

Parameters:

searchMethodParams - Muli-search request body. Results are returned in the same order as the requests. (required)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchAsync

public <T> CompletableFuture<SearchResponses<T>> searchAsync(@Nonnull
 SearchMethodParams searchMethodParams,
 Class<T> innerType)
                                                      throws AlgoliaRuntimeException

(asynchronously) Sends multiple search request to one or more indices. This can be useful in these cases: - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.

Parameters:

searchMethodParams - Muli-search request body. Results are returned in the same order as the requests. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchDictionaryEntries

public SearchDictionaryEntriesResponse searchDictionaryEntries(@Nonnull
 DictionaryType dictionaryName,
 @Nonnull
 SearchDictionaryEntriesParams searchDictionaryEntriesParams,
 RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

Searches for standard and custom dictionary entries.

Parameters:

dictionaryName - Dictionary type in which to search. (required)

searchDictionaryEntriesParams - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchDictionaryEntries

public SearchDictionaryEntriesResponse searchDictionaryEntries(@Nonnull
 DictionaryType dictionaryName,
 @Nonnull
 SearchDictionaryEntriesParams searchDictionaryEntriesParams)
                                                        throws AlgoliaRuntimeException

Searches for standard and custom dictionary entries.

Parameters:

dictionaryName - Dictionary type in which to search. (required)

searchDictionaryEntriesParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchDictionaryEntriesAsync

public CompletableFuture<SearchDictionaryEntriesResponse> searchDictionaryEntriesAsync(@Nonnull
 DictionaryType dictionaryName,
 @Nonnull
 SearchDictionaryEntriesParams searchDictionaryEntriesParams,
 RequestOptions requestOptions)
                                                                                throws AlgoliaRuntimeException

(asynchronously) Searches for standard and custom dictionary entries.

Parameters:

dictionaryName - Dictionary type in which to search. (required)

searchDictionaryEntriesParams - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchDictionaryEntriesAsync

public CompletableFuture<SearchDictionaryEntriesResponse> searchDictionaryEntriesAsync(@Nonnull
 DictionaryType dictionaryName,
 @Nonnull
 SearchDictionaryEntriesParams searchDictionaryEntriesParams)
                                                                                throws AlgoliaRuntimeException

(asynchronously) Searches for standard and custom dictionary entries.

Parameters:

dictionaryName - Dictionary type in which to search. (required)

searchDictionaryEntriesParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchForFacetValues

public SearchForFacetValuesResponse searchForFacetValues(@Nonnull
 String indexName,
 @Nonnull
 String facetName,
 SearchForFacetValuesRequest searchForFacetValuesRequest,
 RequestOptions requestOptions)
                                                  throws AlgoliaRuntimeException

Searches for values of a specified facet attribute. - By default, facet values are sorted by decreasing count. You can adjust this with the `sortFacetValueBy` parameter. - Searching for facet values doesn't work if you have **more than 65 searchable facets and searchable attributes combined**.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

facetName - Facet attribute in which to search for values. This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier. (required)

searchForFacetValuesRequest - (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchForFacetValues

public SearchForFacetValuesResponse searchForFacetValues(@Nonnull
 String indexName,
 @Nonnull
 String facetName,
 SearchForFacetValuesRequest searchForFacetValuesRequest)
                                                  throws AlgoliaRuntimeException

Searches for values of a specified facet attribute. - By default, facet values are sorted by decreasing count. You can adjust this with the `sortFacetValueBy` parameter. - Searching for facet values doesn't work if you have **more than 65 searchable facets and searchable attributes combined**.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

facetName - Facet attribute in which to search for values. This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier. (required)

searchForFacetValuesRequest - (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchForFacetValues

public SearchForFacetValuesResponse searchForFacetValues(@Nonnull
 String indexName,
 @Nonnull
 String facetName,
 RequestOptions requestOptions)
                                                  throws AlgoliaRuntimeException

Searches for values of a specified facet attribute. - By default, facet values are sorted by decreasing count. You can adjust this with the `sortFacetValueBy` parameter. - Searching for facet values doesn't work if you have **more than 65 searchable facets and searchable attributes combined**.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

facetName - Facet attribute in which to search for values. This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchForFacetValues

public SearchForFacetValuesResponse searchForFacetValues(@Nonnull
 String indexName,
 @Nonnull
 String facetName)
                                                  throws AlgoliaRuntimeException

Searches for values of a specified facet attribute. - By default, facet values are sorted by decreasing count. You can adjust this with the `sortFacetValueBy` parameter. - Searching for facet values doesn't work if you have **more than 65 searchable facets and searchable attributes combined**.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

facetName - Facet attribute in which to search for values. This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchForFacetValuesAsync

public CompletableFuture<SearchForFacetValuesResponse> searchForFacetValuesAsync(@Nonnull
 String indexName,
 @Nonnull
 String facetName,
 SearchForFacetValuesRequest searchForFacetValuesRequest,
 RequestOptions requestOptions)
                                                                          throws AlgoliaRuntimeException

(asynchronously) Searches for values of a specified facet attribute. - By default, facet values are sorted by decreasing count. You can adjust this with the `sortFacetValueBy` parameter. - Searching for facet values doesn't work if you have **more than 65 searchable facets and searchable attributes combined**.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

facetName - Facet attribute in which to search for values. This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier. (required)

searchForFacetValuesRequest - (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchForFacetValuesAsync

public CompletableFuture<SearchForFacetValuesResponse> searchForFacetValuesAsync(@Nonnull
 String indexName,
 @Nonnull
 String facetName,
 SearchForFacetValuesRequest searchForFacetValuesRequest)
                                                                          throws AlgoliaRuntimeException

(asynchronously) Searches for values of a specified facet attribute. - By default, facet values are sorted by decreasing count. You can adjust this with the `sortFacetValueBy` parameter. - Searching for facet values doesn't work if you have **more than 65 searchable facets and searchable attributes combined**.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

facetName - Facet attribute in which to search for values. This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier. (required)

searchForFacetValuesRequest - (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchForFacetValuesAsync

public CompletableFuture<SearchForFacetValuesResponse> searchForFacetValuesAsync(@Nonnull
 String indexName,
 @Nonnull
 String facetName,
 RequestOptions requestOptions)
                                                                          throws AlgoliaRuntimeException

(asynchronously) Searches for values of a specified facet attribute. - By default, facet values are sorted by decreasing count. You can adjust this with the `sortFacetValueBy` parameter. - Searching for facet values doesn't work if you have **more than 65 searchable facets and searchable attributes combined**.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

facetName - Facet attribute in which to search for values. This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchForFacetValuesAsync

public CompletableFuture<SearchForFacetValuesResponse> searchForFacetValuesAsync(@Nonnull
 String indexName,
 @Nonnull
 String facetName)
                                                                          throws AlgoliaRuntimeException

(asynchronously) Searches for values of a specified facet attribute. - By default, facet values are sorted by decreasing count. You can adjust this with the `sortFacetValueBy` parameter. - Searching for facet values doesn't work if you have **more than 65 searchable facets and searchable attributes combined**.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

facetName - Facet attribute in which to search for values. This attribute must be included in the `attributesForFaceting` index setting with the `searchable()` modifier. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchRules

public SearchRulesResponse searchRules(@Nonnull
 String indexName,
 SearchRulesParams searchRulesParams,
 RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

Searches for rules in your index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

searchRulesParams - (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchRules

public SearchRulesResponse searchRules(@Nonnull
 String indexName,
 SearchRulesParams searchRulesParams)
                                throws AlgoliaRuntimeException

Searches for rules in your index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

searchRulesParams - (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchRules

public SearchRulesResponse searchRules(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                                throws AlgoliaRuntimeException

Searches for rules in your index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchRules

public SearchRulesResponse searchRules(@Nonnull
 String indexName)
                                throws AlgoliaRuntimeException

Searches for rules in your index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchRulesAsync

public CompletableFuture<SearchRulesResponse> searchRulesAsync(@Nonnull
 String indexName,
 SearchRulesParams searchRulesParams,
 RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

(asynchronously) Searches for rules in your index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

searchRulesParams - (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchRulesAsync

public CompletableFuture<SearchRulesResponse> searchRulesAsync(@Nonnull
 String indexName,
 SearchRulesParams searchRulesParams)
                                                        throws AlgoliaRuntimeException

(asynchronously) Searches for rules in your index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

searchRulesParams - (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchRulesAsync

public CompletableFuture<SearchRulesResponse> searchRulesAsync(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                                                        throws AlgoliaRuntimeException

(asynchronously) Searches for rules in your index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchRulesAsync

public CompletableFuture<SearchRulesResponse> searchRulesAsync(@Nonnull
 String indexName)
                                                        throws AlgoliaRuntimeException

(asynchronously) Searches for rules in your index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSingleIndex

public <T> SearchResponse<T> searchSingleIndex(@Nonnull
 String indexName,
 SearchParams searchParams,
 Class<T> innerType,
 RequestOptions requestOptions)
                                        throws AlgoliaRuntimeException

Searches a single index and return matching search results (_hits_). This method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

searchParams - (optional)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSingleIndex

public <T> SearchResponse<T> searchSingleIndex(@Nonnull
 String indexName,
 SearchParams searchParams,
 Class<T> innerType)
                                        throws AlgoliaRuntimeException

Searches a single index and return matching search results (_hits_). This method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

searchParams - (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSingleIndex

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

Searches a single index and return matching search results (_hits_). This method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSingleIndex

public <T> SearchResponse<T> searchSingleIndex(@Nonnull
 String indexName,
 Class<T> innerType)
                                        throws AlgoliaRuntimeException

Searches a single index and return matching search results (_hits_). This method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSingleIndexAsync

public <T> CompletableFuture<SearchResponse<T>> searchSingleIndexAsync(@Nonnull
 String indexName,
 SearchParams searchParams,
 Class<T> innerType,
 RequestOptions requestOptions)
                                                                throws AlgoliaRuntimeException

(asynchronously) Searches a single index and return matching search results (_hits_). This method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

searchParams - (optional)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSingleIndexAsync

public <T> CompletableFuture<SearchResponse<T>> searchSingleIndexAsync(@Nonnull
 String indexName,
 SearchParams searchParams,
 Class<T> innerType)
                                                                throws AlgoliaRuntimeException

(asynchronously) Searches a single index and return matching search results (_hits_). This method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

searchParams - (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSingleIndexAsync

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

(asynchronously) Searches a single index and return matching search results (_hits_). This method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSingleIndexAsync

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

(asynchronously) Searches a single index and return matching search results (_hits_). This method lets you retrieve up to 1,000 hits. If you need more, use the [`browse` operation](#tag/Search/operation/browse) or increase the `paginatedLimitedTo` index setting.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSynonyms

public SearchSynonymsResponse searchSynonyms(@Nonnull
 String indexName,
 SearchSynonymsParams searchSynonymsParams,
 RequestOptions requestOptions)
                                      throws AlgoliaRuntimeException

Searches for synonyms in your index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

searchSynonymsParams - Body of the `searchSynonyms` operation. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSynonyms

public SearchSynonymsResponse searchSynonyms(@Nonnull
 String indexName,
 SearchSynonymsParams searchSynonymsParams)
                                      throws AlgoliaRuntimeException

Searches for synonyms in your index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

searchSynonymsParams - Body of the `searchSynonyms` operation. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSynonyms

public SearchSynonymsResponse searchSynonyms(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                                      throws AlgoliaRuntimeException

Searches for synonyms in your index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSynonyms

public SearchSynonymsResponse searchSynonyms(@Nonnull
 String indexName)
                                      throws AlgoliaRuntimeException

Searches for synonyms in your index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSynonymsAsync

public CompletableFuture<SearchSynonymsResponse> searchSynonymsAsync(@Nonnull
 String indexName,
 SearchSynonymsParams searchSynonymsParams,
 RequestOptions requestOptions)
                                                              throws AlgoliaRuntimeException

(asynchronously) Searches for synonyms in your index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

searchSynonymsParams - Body of the `searchSynonyms` operation. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSynonymsAsync

public CompletableFuture<SearchSynonymsResponse> searchSynonymsAsync(@Nonnull
 String indexName,
 SearchSynonymsParams searchSynonymsParams)
                                                              throws AlgoliaRuntimeException

(asynchronously) Searches for synonyms in your index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

searchSynonymsParams - Body of the `searchSynonyms` operation. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSynonymsAsync

public CompletableFuture<SearchSynonymsResponse> searchSynonymsAsync(@Nonnull
 String indexName,
 RequestOptions requestOptions)
                                                              throws AlgoliaRuntimeException

(asynchronously) Searches for synonyms in your index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchSynonymsAsync

public CompletableFuture<SearchSynonymsResponse> searchSynonymsAsync(@Nonnull
 String indexName)
                                                              throws AlgoliaRuntimeException

(asynchronously) Searches for synonyms in your index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchUserIds

public SearchUserIdsResponse searchUserIds(@Nonnull
 SearchUserIdsParams searchUserIdsParams,
 RequestOptions requestOptions)
                                    throws AlgoliaRuntimeException

Since it can take a few seconds to get the data from the different clusters, the response isn't real-time. To ensure rapid updates, the user IDs index isn't built at the same time as the mapping. Instead, it's built every 12 hours, at the same time as the update of user ID usage. For example, if you add or move a user ID, the search will show an old value until the next time the mapping is rebuilt (every 12 hours).

Parameters:

searchUserIdsParams - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchUserIds

public SearchUserIdsResponse searchUserIds(@Nonnull
 SearchUserIdsParams searchUserIdsParams)
                                    throws AlgoliaRuntimeException

Since it can take a few seconds to get the data from the different clusters, the response isn't real-time. To ensure rapid updates, the user IDs index isn't built at the same time as the mapping. Instead, it's built every 12 hours, at the same time as the update of user ID usage. For example, if you add or move a user ID, the search will show an old value until the next time the mapping is rebuilt (every 12 hours).

Parameters:

searchUserIdsParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchUserIdsAsync

public CompletableFuture<SearchUserIdsResponse> searchUserIdsAsync(@Nonnull
 SearchUserIdsParams searchUserIdsParams,
 RequestOptions requestOptions)
                                                            throws AlgoliaRuntimeException

(asynchronously) Since it can take a few seconds to get the data from the different clusters, the response isn't real-time. To ensure rapid updates, the user IDs index isn't built at the same time as the mapping. Instead, it's built every 12 hours, at the same time as the update of user ID usage. For example, if you add or move a user ID, the search will show an old value until the next time the mapping is rebuilt (every 12 hours).

Parameters:

searchUserIdsParams - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

searchUserIdsAsync

public CompletableFuture<SearchUserIdsResponse> searchUserIdsAsync(@Nonnull
 SearchUserIdsParams searchUserIdsParams)
                                                            throws AlgoliaRuntimeException

(asynchronously) Since it can take a few seconds to get the data from the different clusters, the response isn't real-time. To ensure rapid updates, the user IDs index isn't built at the same time as the mapping. Instead, it's built every 12 hours, at the same time as the update of user ID usage. For example, if you add or move a user ID, the search will show an old value until the next time the mapping is rebuilt (every 12 hours).

Parameters:

searchUserIdsParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setDictionarySettings

public UpdatedAtResponse setDictionarySettings(@Nonnull
 DictionarySettingsParams dictionarySettingsParams,
 RequestOptions requestOptions)
                                        throws AlgoliaRuntimeException

Turns standard stop word dictionary entries on or off for a given language.

Parameters:

dictionarySettingsParams - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setDictionarySettings

public UpdatedAtResponse setDictionarySettings(@Nonnull
 DictionarySettingsParams dictionarySettingsParams)
                                        throws AlgoliaRuntimeException

Turns standard stop word dictionary entries on or off for a given language.

Parameters:

dictionarySettingsParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setDictionarySettingsAsync

public CompletableFuture<UpdatedAtResponse> setDictionarySettingsAsync(@Nonnull
 DictionarySettingsParams dictionarySettingsParams,
 RequestOptions requestOptions)
                                                                throws AlgoliaRuntimeException

(asynchronously) Turns standard stop word dictionary entries on or off for a given language.

Parameters:

dictionarySettingsParams - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setDictionarySettingsAsync

public CompletableFuture<UpdatedAtResponse> setDictionarySettingsAsync(@Nonnull
 DictionarySettingsParams dictionarySettingsParams)
                                                                throws AlgoliaRuntimeException

(asynchronously) Turns standard stop word dictionary entries on or off for a given language.

Parameters:

dictionarySettingsParams - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setSettings

public UpdatedAtResponse setSettings(@Nonnull
 String indexName,
 @Nonnull
 IndexSettings indexSettings,
 Boolean forwardToReplicas,
 RequestOptions requestOptions)
                              throws AlgoliaRuntimeException

Update the specified index settings. Index settings that you don't specify are left unchanged. Specify `null` to reset a setting to its default value. For best performance, update the index settings before you add new records to your index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

indexSettings - (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setSettings

public UpdatedAtResponse setSettings(@Nonnull
 String indexName,
 @Nonnull
 IndexSettings indexSettings,
 Boolean forwardToReplicas)
                              throws AlgoliaRuntimeException

Update the specified index settings. Index settings that you don't specify are left unchanged. Specify `null` to reset a setting to its default value. For best performance, update the index settings before you add new records to your index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

indexSettings - (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setSettings

public UpdatedAtResponse setSettings(@Nonnull
 String indexName,
 @Nonnull
 IndexSettings indexSettings,
 RequestOptions requestOptions)
                              throws AlgoliaRuntimeException

Update the specified index settings. Index settings that you don't specify are left unchanged. Specify `null` to reset a setting to its default value. For best performance, update the index settings before you add new records to your index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

indexSettings - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setSettings

public UpdatedAtResponse setSettings(@Nonnull
 String indexName,
 @Nonnull
 IndexSettings indexSettings)
                              throws AlgoliaRuntimeException

Update the specified index settings. Index settings that you don't specify are left unchanged. Specify `null` to reset a setting to its default value. For best performance, update the index settings before you add new records to your index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

indexSettings - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setSettingsAsync

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

(asynchronously) Update the specified index settings. Index settings that you don't specify are left unchanged. Specify `null` to reset a setting to its default value. For best performance, update the index settings before you add new records to your index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

indexSettings - (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setSettingsAsync

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

(asynchronously) Update the specified index settings. Index settings that you don't specify are left unchanged. Specify `null` to reset a setting to its default value. For best performance, update the index settings before you add new records to your index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

indexSettings - (required)

forwardToReplicas - Whether changes are applied to replica indices. (optional)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setSettingsAsync

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

(asynchronously) Update the specified index settings. Index settings that you don't specify are left unchanged. Specify `null` to reset a setting to its default value. For best performance, update the index settings before you add new records to your index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

indexSettings - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

setSettingsAsync

public CompletableFuture<UpdatedAtResponse> setSettingsAsync(@Nonnull
 String indexName,
 @Nonnull
 IndexSettings indexSettings)
                                                      throws AlgoliaRuntimeException

(asynchronously) Update the specified index settings. Index settings that you don't specify are left unchanged. Specify `null` to reset a setting to its default value. For best performance, update the index settings before you add new records to your index.

Parameters:

indexName - Name of the index on which to perform the operation. (required)

indexSettings - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

updateApiKey

public UpdateApiKeyResponse updateApiKey(@Nonnull
 String key,
 @Nonnull
 ApiKey apiKey,
 RequestOptions requestOptions)
                                  throws AlgoliaRuntimeException

Replaces the permissions of an existing API key. Any unspecified attribute resets that attribute to its default value.

Parameters:

key - API key. (required)

apiKey - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

updateApiKey

public UpdateApiKeyResponse updateApiKey(@Nonnull
 String key,
 @Nonnull
 ApiKey apiKey)
                                  throws AlgoliaRuntimeException

Replaces the permissions of an existing API key. Any unspecified attribute resets that attribute to its default value.

Parameters:

key - API key. (required)

apiKey - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

updateApiKeyAsync

public CompletableFuture<UpdateApiKeyResponse> updateApiKeyAsync(@Nonnull
 String key,
 @Nonnull
 ApiKey apiKey,
 RequestOptions requestOptions)
                                                          throws AlgoliaRuntimeException

(asynchronously) Replaces the permissions of an existing API key. Any unspecified attribute resets that attribute to its default value.

Parameters:

key - API key. (required)

apiKey - (required)

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

Throws:

AlgoliaRuntimeException - If it fails to process the API call

updateApiKeyAsync

public CompletableFuture<UpdateApiKeyResponse> updateApiKeyAsync(@Nonnull
 String key,
 @Nonnull
 ApiKey apiKey)
                                                          throws AlgoliaRuntimeException

(asynchronously) Replaces the permissions of an existing API key. Any unspecified attribute resets that attribute to its default value.

Parameters:

key - API key. (required)

apiKey - (required)

Throws:

AlgoliaRuntimeException - If it fails to process the API call

waitForTask

public void waitForTask(String indexName,
 Long taskID,
 int maxRetries,
 IntUnaryOperator timeout,
 RequestOptions requestOptions)

Helper: Wait for a task to complete with `indexName` and `taskID`.

Parameters:

indexName - The `indexName` where the operation was performed.

taskID - The `taskID` returned in the method response.

maxRetries - The maximum number of retry. 50 by default. (optional)

timeout - The function to decide how long to wait between retries. min(retries * 200, 5000) by default. (optional)

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

waitForTask

public void waitForTask(String indexName,
 Long taskID,
 RequestOptions requestOptions)

Helper: Wait for a task to complete with `indexName` and `taskID`.

Parameters:

indexName - The `indexName` where the operation was performed.

taskID - The `taskID` returned in the method response.

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

waitForTask

public void waitForTask(String indexName,
 Long taskID,
 int maxRetries,
 IntUnaryOperator timeout)

Helper: Wait for a task to complete with `indexName` and `taskID`.

Parameters:

indexName - The `indexName` where the operation was performed.

taskID - The `taskID` returned in the method response.

maxRetries - The maximum number of retry. 50 by default. (optional)

timeout - The function to decide how long to wait between retries. min(retries * 200, 5000) by default. (optional)

waitForTask

public void waitForTask(String indexName,
 Long taskID)

Helper: Wait for a task to complete with `indexName` and `taskID`.

Parameters:

indexName - The `indexName` where the operation was performed.

taskID - The `taskID` returned in the method response.

waitForApiKey

public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation,
 String key,
 ApiKey apiKey,
 int maxRetries,
 IntUnaryOperator timeout,
 RequestOptions requestOptions)

Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.

Parameters:

operation - The `operation` that was done on a `key`.

key - The `key` that has been added, deleted or updated.

apiKey - Necessary to know if an `update` operation has been processed, compare fields of the response with it.

maxRetries - The maximum number of retry. 50 by default. (optional)

timeout - The function to decide how long to wait between retries. min(retries * 200, 5000) by default. (optional)

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

waitForApiKey

public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation,
 String key,
 int maxRetries,
 IntUnaryOperator timeout,
 RequestOptions requestOptions)

Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.

Parameters:

operation - The `operation` that was done on a `key`. (ADD or DELETE only)

key - The `key` that has been added, deleted or updated.

maxRetries - The maximum number of retry. 50 by default. (optional)

timeout - The function to decide how long to wait between retries. min(retries * 200, 5000) by default. (optional)

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

waitForApiKey

public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation,
 String key,
 ApiKey apiKey,
 RequestOptions requestOptions)

Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.

Parameters:

operation - The `operation` that was done on a `key`.

key - The `key` that has been added, deleted or updated.

apiKey - Necessary to know if an `update` operation has been processed, compare fields of the response with it.

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

waitForApiKey

public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation,
 String key,
 RequestOptions requestOptions)

Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.

Parameters:

operation - The `operation` that was done on a `key`. (ADD or DELETE only)

key - The `key` that has been added, deleted or updated.

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

waitForApiKey

public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation,
 String key,
 ApiKey apiKey,
 int maxRetries,
 IntUnaryOperator timeout)

Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.

Parameters:

operation - The `operation` that was done on a `key`.

key - The `key` that has been added, deleted or updated.

apiKey - Necessary to know if an `update` operation has been processed, compare fields of the response with it.

maxRetries - The maximum number of retry. 50 by default. (optional)

timeout - The function to decide how long to wait between retries. min(retries * 200, 5000) by default. (optional)

waitForApiKey

public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation,
 String key,
 int maxRetries,
 IntUnaryOperator timeout)

Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.

Parameters:

operation - The `operation` that was done on a `key`. (ADD or DELETE only)

key - The `key` that has been added, deleted or updated.

maxRetries - The maximum number of retry. 50 by default. (optional)

timeout - The function to decide how long to wait between retries. min(retries * 200, 5000) by default. (optional)

waitForApiKey

public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation,
 String key,
 ApiKey apiKey)

Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.

Parameters:

operation - The `operation` that was done on a `key`.

key - The `key` that has been added, deleted or updated.

apiKey - Necessary to know if an `update` operation has been processed, compare fields of the response with it.

waitForApiKey

public GetApiKeyResponse waitForApiKey(ApiKeyOperation operation,
 String key)

Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.

Parameters:

operation - The `operation` that was done on a `key`. (ADD or DELETE only)

key - The `key` that has been added, deleted or updated.

browseObjects

public <T> Iterable<T> browseObjects(String indexName,
 BrowseParamsObject params,
 Class<T> innerType,
 RequestOptions requestOptions)

Helper: Returns an iterator on top of the `browse` method.

Parameters:

indexName - The index in which to perform the request.

params - The `browse` parameters.

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

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

browseObjects

public <T> Iterable<T> browseObjects(String indexName,
 BrowseParamsObject params,
 Class<T> innerType)

Helper: Returns an iterator on top of the `browse` method.

Parameters:

indexName - The index in which to perform the request.

params - The `browse` parameters.

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

browseSynonyms

public Iterable<SynonymHit> browseSynonyms(String indexName,
 SearchSynonymsParams params,
 RequestOptions requestOptions)

Helper: Returns an iterator on top of the `searchSynonyms` method.

Parameters:

indexName - The index in which to perform the request.

params - The `searchSynonyms` parameters. (optional)

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

browseSynonyms

public Iterable<SynonymHit> browseSynonyms(String indexName,
 SearchSynonymsParams params)

Helper: Returns an iterator on top of the `searchSynonyms` method.

Parameters:

indexName - The index in which to perform the request.

params - The `searchSynonyms` parameters .(optional)

browseSynonyms

public Iterable<SynonymHit> browseSynonyms(String indexName)

Helper: Returns an iterator on top of the `searchSynonyms` method.

Parameters:

indexName - The index in which to perform the request.

browseRules

public Iterable<Rule> browseRules(String indexName,
 SearchRulesParams params,
 RequestOptions requestOptions)

Helper: Returns an iterator on top of the `searchRules` method.

Parameters:

indexName - The index in which to perform the request.

params - The `searchRules` parameters. (optional)

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

browseRules

public Iterable<Rule> browseRules(String indexName,
 SearchRulesParams params)

Helper: Returns an iterator on top of the `searchRules` method.

Parameters:

indexName - The index in which to perform the request.

params - The `searchRules` parameters. (optional)

browseRules

public Iterable<Rule> browseRules(String indexName)

Helper: Returns an iterator on top of the `searchRules` method.

Parameters:

indexName - The index in which to perform the request.

searchForHits

public <T> List<SearchResponse<T>> searchForHits(@Nonnull
 List<SearchForHits> requests,
 Class<T> innerType)

Executes a synchronous search for the provided search requests, with certainty that we will only request Algolia records (hits). Results will be received in the same order as the queries.

Parameters:

requests - A list of search requests to be executed.

searchForHits

public <T> List<SearchResponse<T>> searchForHits(@Nonnull
 List<SearchForHits> requests,
 SearchStrategy strategy,
 Class<T> innerType)

Executes a synchronous search for the provided search requests, with certainty that we will only request Algolia records (hits). Results will be received in the same order as the queries.

Parameters:

requests - A list of search requests to be executed.

strategy - The search strategy to be employed during the search.

searchForHits

public <T> List<SearchResponse<T>> searchForHits(@Nonnull
 List<SearchForHits> requests,
 SearchStrategy strategy,
 Class<T> innerType,
 RequestOptions requestOptions)

Executes a synchronous search for the provided search requests, with certainty that we will only request Algolia records (hits). Results will be received in the same order as the queries.

Parameters:

requests - A list of search requests to be executed.

strategy - The search strategy to be employed during the search.

requestOptions - Additional options for the search request.

searchForHitsAsync

public <T>
CompletableFuture<List<SearchResponse<T>>> searchForHitsAsync(@Nonnull
 List<SearchForHits> requests,
 Class<T> innerType)

Executes an asynchronous search for the provided search requests, with certainty that we will only request Algolia records (hits). Results will be received in the same order as the queries.

Parameters:

requests - A list of search requests to be executed.

searchForHitsAsync

public <T>
CompletableFuture<List<SearchResponse<T>>> searchForHitsAsync(@Nonnull
 List<SearchForHits> requests,
 SearchStrategy strategy,
 Class<T> innerType)

Executes an asynchronous search for the provided search requests, with certainty that we will only request Algolia records (hits). Results will be received in the same order as the queries.

Parameters:

requests - A list of search requests to be executed.

strategy - The search strategy to be employed during the search.

searchForHitsAsync

public <T>
CompletableFuture<List<SearchResponse<T>>> searchForHitsAsync(@Nonnull
 List<SearchForHits> requests,
 SearchStrategy strategy,
 Class<T> innerType,
 RequestOptions requestOptions)

Executes an asynchronous search for the provided search requests, with certainty that we will only request Algolia records (hits). Results will be received in the same order as the queries.

Parameters:

requests - A list of search requests to be executed.

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

strategy - The search strategy to be employed during the search.

requestOptions - Additional options for the search request.

searchForFacets

public List<SearchForFacetValuesResponse> searchForFacets(@Nonnull
 List<SearchForFacets> requests)

Executes a synchronous search for the provided search requests, with certainty that we will only request Algolia facets. Results will be received in the same order as the queries.

Parameters:

requests - A list of search requests to be executed.

searchForFacets

public List<SearchForFacetValuesResponse> searchForFacets(@Nonnull
 List<SearchForFacets> requests,
 SearchStrategy strategy)

Executes a synchronous search for the provided search requests, with certainty that we will only request Algolia facets. Results will be received in the same order as the queries.

Parameters:

requests - A list of search requests to be executed.

strategy - The search strategy to be employed during the search.

searchForFacets

public List<SearchForFacetValuesResponse> searchForFacets(@Nonnull
 List<SearchForFacets> requests,
 SearchStrategy strategy,
 RequestOptions requestOptions)

Executes a synchronous search for the provided search requests, with certainty that we will only request Algolia facets. Results will be received in the same order as the queries.

Parameters:

requests - A list of search requests to be executed.

strategy - The search strategy to be employed during the search.

requestOptions - Additional options for the search request.

searchForFacetsAsync

public CompletableFuture<List<SearchForFacetValuesResponse>> searchForFacetsAsync(@Nonnull
 List<SearchForFacets> requests)

Executes an asynchronous search for the provided search requests, with certainty that we will only request Algolia facets. Results will be received in the same order as the queries.

Parameters:

requests - A list of search requests to be executed.

searchForFacetsAsync

public CompletableFuture<List<SearchForFacetValuesResponse>> searchForFacetsAsync(@Nonnull
 List<SearchForFacets> requests,
 SearchStrategy strategy)

Executes an asynchronous search for the provided search requests, with certainty that we will only request Algolia facets. Results will be received in the same order as the queries.

Parameters:

requests - A list of search requests to be executed.

strategy - The search strategy to be employed during the search.

searchForFacetsAsync

public CompletableFuture<List<SearchForFacetValuesResponse>> searchForFacetsAsync(@Nonnull
 List<SearchForFacets> requests,
 SearchStrategy strategy,
 RequestOptions requestOptions)

Executes an asynchronous search for the provided search requests, with certainty that we will only request Algolia facets. Results will be received in the same order as the queries.

Parameters:

requests - A list of search requests to be executed.

strategy - The search strategy to be employed during the search.

requestOptions - Additional options for the search request.