Package com.algolia.search

Interface SearchIndexSynonyms<T>

Type Parameters:

T -

All Superinterfaces:

SearchIndexBase<T>

All Known Implementing Classes:

SearchIndex

public interface SearchIndexSynonyms<T>
extends SearchIndexBase<T>

This interface holds all endpoints for Synonyms.

Method Summary

Modifier and Type	Method	Description
default SynonymsIterable	browseSynonyms()	Retrieve an index’s complete list of synonyms The list includes all synonyms - whether created on the dashboard or pushed by the API.
default SynonymsIterable	browseSynonyms(int hitsPerPage)	Retrieve an index’s complete list of synonyms The list includes all synonyms - whether created on the dashboard or pushed by the API.
default SynonymsIterable	browseSynonyms(int hitsPerPage, RequestOptions requestOptions)	Retrieve an index’s complete list of synonyms The list includes all synonyms - whether created on the dashboard or pushed by the API.
default ClearSynonymsResponse	clearSynonyms()	Remove all synonyms from an index.
default ClearSynonymsResponse	clearSynonyms(RequestOptions requestOptions)	Remove all synonyms from an index.
default ClearSynonymsResponse	clearSynonyms(Boolean forwardToReplicas)	Remove all synonyms from an index.
default CompletableFuture<ClearSynonymsResponse>	clearSynonymsAsync()	Remove all synonyms from an index.
default CompletableFuture<ClearSynonymsResponse>	clearSynonymsAsync(RequestOptions requestOptions)	Remove all synonyms from an index.
default CompletableFuture<ClearSynonymsResponse>	clearSynonymsAsync(Boolean forwardToReplicas)	Remove all synonyms from an index.
default DeleteResponse	deleteSynonym(String objectID)	Remove a single synonym from an index using its object id.
default DeleteResponse	deleteSynonym(String objectID, RequestOptions requestOptions)	Remove a single synonym from an index using its object id.
default DeleteResponse	deleteSynonym(String objectID, Boolean forwardToReplicas)	Remove a single synonym from an index using its object id.
default CompletableFuture<DeleteResponse>	deleteSynonymAsync(String objectID)	Remove a single synonym from an index using its object id.
default CompletableFuture<DeleteResponse>	deleteSynonymAsync(String objectID, RequestOptions requestOptions)	Remove a single synonym from an index using its object id.
default CompletableFuture<DeleteResponse>	deleteSynonymAsync(String objectID, Boolean forwardToReplicas)	Remove a single synonym from an index using its object id.
default Synonym	getSynonym(String objectID)	Get a single synonym using its object id.
default Synonym	getSynonym(String objectID, RequestOptions requestOptions)	Get a single synonym using its object id.
default CompletableFuture<Synonym>	getSynonymAsync(String objectID)	Get a single synonym using its object id.
default CompletableFuture<Synonym>	getSynonymAsync(String objectID, RequestOptions requestOptions)	Get a single synonym using its object id.
default SaveSynonymResponse	replaceAllSynonyms(Iterable<Synonym> synonyms)	Push a new set of synonyms and erase all previous ones.
default SaveSynonymResponse	replaceAllSynonyms(Iterable<Synonym> synonyms, RequestOptions requestOptions)	Push a new set of synonyms and erase all previous ones.
default SaveSynonymResponse	replaceAllSynonyms(Iterable<Synonym> synonyms, Boolean forwardToReplicas)	Push a new set of synonyms and erase all previous ones.
default CompletableFuture<SaveSynonymResponse>	replaceAllSynonymsAsync(Iterable<Synonym> synonyms)	Push a new set of synonyms and erase all previous ones.
default CompletableFuture<SaveSynonymResponse>	replaceAllSynonymsAsync(Iterable<Synonym> synonyms, RequestOptions requestOptions)	Push a new set of synonyms and erase all previous ones.
default CompletableFuture<SaveSynonymResponse>	replaceAllSynonymsAsync(Iterable<Synonym> synonyms, Boolean forwardToReplicas)	Push a new set of synonyms and erase all previous ones.
default SaveSynonymResponse	saveSynonym(Synonym synonym)	Create or update a single rule.
default SaveSynonymResponse	saveSynonym(Synonym synonym, RequestOptions requestOptions)	Create or update a single synonym on an index.
default SaveSynonymResponse	saveSynonym(Synonym synonym, Boolean forwardToReplicas)	Create or update a single rule.
default SaveSynonymResponse	saveSynonym(Synonym synonym, Boolean forwardToReplicas, RequestOptions requestOptions)	Create or update a single rule.
default CompletableFuture<SaveSynonymResponse>	saveSynonymAsync(Synonym synonym)	Create or update a single rule.
default CompletableFuture<SaveSynonymResponse>	saveSynonymAsync(Synonym synonym, RequestOptions requestOptions)	Create or update a single synonym on an index.
default CompletableFuture<SaveSynonymResponse>	saveSynonymAsync(Synonym synonym, Boolean forwardToReplicas)	Create or update a single rule.
default CompletableFuture<SaveSynonymResponse>	saveSynonymAsync(Synonym synonym, Boolean forwardToReplicas, RequestOptions requestOptions)	Create or update a single rule.
default SaveSynonymResponse	saveSynonyms(Iterable<Synonym> synonyms)	Create or update multiple synonyms.
default SaveSynonymResponse	saveSynonyms(Iterable<Synonym> synonyms, RequestOptions requestOptions)	Create or update multiple synonyms.
default SaveSynonymResponse	saveSynonyms(Iterable<Synonym> synonyms, Boolean forwardToReplicas, Boolean clearExistingSynonyms)	Create or update multiple synonyms.
default SaveSynonymResponse	saveSynonyms(Iterable<Synonym> synonyms, Boolean forwardToReplicas, Boolean clearExistingSynonyms, RequestOptions requestOptions)	Create or update multiple synonyms.
default CompletableFuture<SaveSynonymResponse>	saveSynonymsAsync(Iterable<Synonym> synonyms)	Create or update multiple synonyms.
default CompletableFuture<SaveSynonymResponse>	saveSynonymsAsync(Iterable<Synonym> synonyms, RequestOptions requestOptions)	Create or update multiple synonyms.
default CompletableFuture<SaveSynonymResponse>	saveSynonymsAsync(Iterable<Synonym> synonyms, Boolean forwardToReplicas, Boolean clearExistingSynonyms)	Create or update multiple synonyms.
default CompletableFuture<SaveSynonymResponse>	saveSynonymsAsync(Iterable<Synonym> synonyms, Boolean forwardToReplicas, Boolean clearExistingSynonyms, RequestOptions requestOptions)	Create or update multiple synonyms.
default SearchResult<Synonym>	searchSynonyms(SynonymQuery query)	Get all synonyms that match a query.
default SearchResult<Synonym>	searchSynonyms(SynonymQuery query, RequestOptions requestOptions)	Get all synonyms that match a query.
default CompletableFuture<SearchResult<Synonym>>	searchSynonymsAsync(SynonymQuery query)	Get all synonyms that match a query.
default CompletableFuture<SearchResult<Synonym>>	searchSynonymsAsync(SynonymQuery query, RequestOptions requestOptions)	Get all synonyms that match a query.

Methods inherited from interface com.algolia.search.SearchIndexBase

getClazz, getConfig, getTransport, getUrlEncodedIndexName, waitTask, waitTask

Method Detail

searchSynonyms

default SearchResult<Synonym> searchSynonyms(SynonymQuery query)

Get all synonyms that match a query.

Parameters:

query - Synonym query

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

searchSynonyms

default SearchResult<Synonym> searchSynonyms(SynonymQuery query,
                                             RequestOptions requestOptions)

Get all synonyms that match a query.

Parameters:

query - Synonym query

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

searchSynonymsAsync

default CompletableFuture<SearchResult<Synonym>> searchSynonymsAsync(SynonymQuery query)

Get all synonyms that match a query.

Parameters:

query - Synonym query

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

searchSynonymsAsync

default CompletableFuture<SearchResult<Synonym>> searchSynonymsAsync(SynonymQuery query,
                                                                     RequestOptions requestOptions)

Get all synonyms that match a query.

Parameters:

query - Synonym query

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getSynonym

default Synonym getSynonym(@Nonnull
                           String objectID)

Get a single synonym using its object id.

Parameters:

objectID - Algolia's objectID

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getSynonym

default Synonym getSynonym(@Nonnull
                           String objectID,
                           RequestOptions requestOptions)

Get a single synonym using its object id.

Parameters:

objectID - Algolia's objectID

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getSynonymAsync

default CompletableFuture<Synonym> getSynonymAsync(@Nonnull
                                                   String objectID)

Get a single synonym using its object id.

Parameters:

objectID - Algolia's objectID

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getSynonymAsync

default CompletableFuture<Synonym> getSynonymAsync(@Nonnull
                                                   String objectID,
                                                   RequestOptions requestOptions)

Get a single synonym using its object id.

Parameters:

objectID - Algolia's objectID

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

browseSynonyms

default SynonymsIterable browseSynonyms()

Retrieve an index’s complete list of synonyms The list includes all synonyms - whether created on the dashboard or pushed by the API. The method returns an iterator.

browseSynonyms

default SynonymsIterable browseSynonyms(int hitsPerPage)

Retrieve an index’s complete list of synonyms The list includes all synonyms - whether created on the dashboard or pushed by the API. The method returns an iterator.

Parameters:

hitsPerPage - Number of hits per page to retrieve default = 1000

browseSynonyms

default SynonymsIterable browseSynonyms(int hitsPerPage,
                                        RequestOptions requestOptions)

Retrieve an index’s complete list of synonyms The list includes all synonyms - whether created on the dashboard or pushed by the API. The method returns an iterator.

Parameters:

hitsPerPage - Number of hits per page to retrieve default = 1000

requestOptions - Options to pass to this request

saveSynonym

default SaveSynonymResponse saveSynonym(@Nonnull
                                        Synonym synonym)

Create or update a single rule.

Parameters:

synonym - Algolia's synonym

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveSynonym

default SaveSynonymResponse saveSynonym(@Nonnull
                                        Synonym synonym,
                                        @Nonnull
                                        Boolean forwardToReplicas)

Create or update a single rule.

Parameters:

synonym - Algolia's synonym

forwardToReplicas - Forward the request to the replicas

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveSynonym

default SaveSynonymResponse saveSynonym(@Nonnull
                                        Synonym synonym,
                                        @Nonnull
                                        Boolean forwardToReplicas,
                                        @Nonnull
                                        RequestOptions requestOptions)

Create or update a single rule.

Parameters:

synonym - Algolia's synonym

forwardToReplicas - Forward the request to the replicas

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveSynonym

default SaveSynonymResponse saveSynonym(@Nonnull
                                        Synonym synonym,
                                        @Nonnull
                                        RequestOptions requestOptions)

Create or update a single synonym on an index.

Parameters:

synonym - Algolia's synonym

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveSynonymAsync

default CompletableFuture<SaveSynonymResponse> saveSynonymAsync(@Nonnull
                                                                Synonym synonym)

Create or update a single rule.

Parameters:

synonym - Algolia's synonym

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveSynonymAsync

default CompletableFuture<SaveSynonymResponse> saveSynonymAsync(@Nonnull
                                                                Synonym synonym,
                                                                @Nonnull
                                                                Boolean forwardToReplicas)

Create or update a single rule.

Parameters:

synonym - Algolia's synonym

forwardToReplicas - Forward the request to the replicas

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveSynonymAsync

default CompletableFuture<SaveSynonymResponse> saveSynonymAsync(@Nonnull
                                                                Synonym synonym,
                                                                @Nonnull
                                                                Boolean forwardToReplicas,
                                                                @Nonnull
                                                                RequestOptions requestOptions)

Create or update a single rule.

Parameters:

synonym - Algolia's synonym

forwardToReplicas - Forward the request to the replicas

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveSynonymAsync

default CompletableFuture<SaveSynonymResponse> saveSynonymAsync(@Nonnull
                                                                Synonym synonym,
                                                                @Nonnull
                                                                RequestOptions requestOptions)

Create or update a single synonym on an index.

Parameters:

synonym - Algolia's synonym

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveSynonyms

default SaveSynonymResponse saveSynonyms(@Nonnull
                                         Iterable<Synonym> synonyms)

Create or update multiple synonyms.

Parameters:

synonyms - List of synonyms

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveSynonyms

default SaveSynonymResponse saveSynonyms(@Nonnull
                                         Iterable<Synonym> synonyms,
                                         @Nonnull
                                         Boolean forwardToReplicas,
                                         @Nonnull
                                         Boolean clearExistingSynonyms)

Create or update multiple synonyms.

Parameters:

synonyms - List of synonyms

forwardToReplicas - Forward to the replicas the request

clearExistingSynonyms - Replace all existing synonyms

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveSynonyms

default SaveSynonymResponse saveSynonyms(@Nonnull
                                         Iterable<Synonym> synonyms,
                                         @Nonnull
                                         Boolean forwardToReplicas,
                                         @Nonnull
                                         Boolean clearExistingSynonyms,
                                         @Nonnull
                                         RequestOptions requestOptions)

Create or update multiple synonyms.

Parameters:

synonyms - List of synonyms

forwardToReplicas - Forward to the replicas the request

clearExistingSynonyms - Replace all existing synonyms

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveSynonyms

default SaveSynonymResponse saveSynonyms(@Nonnull
                                         Iterable<Synonym> synonyms,
                                         RequestOptions requestOptions)

Create or update multiple synonyms.

Parameters:

synonyms - List of synonyms

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveSynonymsAsync

default CompletableFuture<SaveSynonymResponse> saveSynonymsAsync(@Nonnull
                                                                 Iterable<Synonym> synonyms)

Create or update multiple synonyms.

Parameters:

synonyms - List of synonyms

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveSynonymsAsync

default CompletableFuture<SaveSynonymResponse> saveSynonymsAsync(@Nonnull
                                                                 Iterable<Synonym> synonyms,
                                                                 @Nonnull
                                                                 Boolean forwardToReplicas,
                                                                 @Nonnull
                                                                 Boolean clearExistingSynonyms)

Create or update multiple synonyms.

Parameters:

synonyms - List of synonyms

forwardToReplicas - Forward to the replicas the request

clearExistingSynonyms - Replace all existing synonyms

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveSynonymsAsync

default CompletableFuture<SaveSynonymResponse> saveSynonymsAsync(@Nonnull
                                                                 Iterable<Synonym> synonyms,
                                                                 @Nonnull
                                                                 Boolean forwardToReplicas,
                                                                 @Nonnull
                                                                 Boolean clearExistingSynonyms,
                                                                 @Nonnull
                                                                 RequestOptions requestOptions)

Create or update multiple synonyms.

Parameters:

synonyms - List of synonyms

forwardToReplicas - Forward to the replicas the request

clearExistingSynonyms - Replace all existing synonyms

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveSynonymsAsync

default CompletableFuture<SaveSynonymResponse> saveSynonymsAsync(@Nonnull
                                                                 Iterable<Synonym> synonyms,
                                                                 RequestOptions requestOptions)

Create or update multiple synonyms.

Parameters:

synonyms - List of synonyms

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

deleteSynonym

default DeleteResponse deleteSynonym(@Nonnull
                                     String objectID)

Remove a single synonym from an index using its object id.

Parameters:

objectID - The synonym objectID

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

deleteSynonym

default DeleteResponse deleteSynonym(@Nonnull
                                     String objectID,
                                     @Nonnull
                                     Boolean forwardToReplicas)

Remove a single synonym from an index using its object id.

Parameters:

objectID - The synonym objectID

forwardToReplicas - Forward the request to the replicas

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

deleteSynonym

default DeleteResponse deleteSynonym(@Nonnull
                                     String objectID,
                                     RequestOptions requestOptions)

Remove a single synonym from an index using its object id.

Parameters:

objectID - The synonym objectID

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

deleteSynonymAsync

default CompletableFuture<DeleteResponse> deleteSynonymAsync(@Nonnull
                                                             String objectID)

Remove a single synonym from an index using its object id.

Parameters:

objectID - The synonym objectID

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

deleteSynonymAsync

default CompletableFuture<DeleteResponse> deleteSynonymAsync(@Nonnull
                                                             String objectID,
                                                             @Nonnull
                                                             Boolean forwardToReplicas)

Remove a single synonym from an index using its object id.

Parameters:

objectID - The synonym objectID

forwardToReplicas - Forward the request to the replicas

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

deleteSynonymAsync

default CompletableFuture<DeleteResponse> deleteSynonymAsync(@Nonnull
                                                             String objectID,
                                                             RequestOptions requestOptions)

Remove a single synonym from an index using its object id.

Parameters:

objectID - The synonym objectID

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

clearSynonyms

default ClearSynonymsResponse clearSynonyms()

Remove all synonyms from an index.

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

clearSynonyms

default ClearSynonymsResponse clearSynonyms(@Nonnull
                                            Boolean forwardToReplicas)

Remove all synonyms from an index.

Parameters:

forwardToReplicas - Forward the request to the replicas

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

clearSynonyms

default ClearSynonymsResponse clearSynonyms(RequestOptions requestOptions)

Remove all synonyms from an index.

Parameters:

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

clearSynonymsAsync

default CompletableFuture<ClearSynonymsResponse> clearSynonymsAsync()

Remove all synonyms from an index.

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

clearSynonymsAsync

default CompletableFuture<ClearSynonymsResponse> clearSynonymsAsync(@Nonnull
                                                                    Boolean forwardToReplicas)

Remove all synonyms from an index.

Parameters:

forwardToReplicas - Forward the request to the replicas

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

clearSynonymsAsync

default CompletableFuture<ClearSynonymsResponse> clearSynonymsAsync(RequestOptions requestOptions)

Remove all synonyms from an index.

Parameters:

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

replaceAllSynonyms

default SaveSynonymResponse replaceAllSynonyms(@Nonnull
                                               Iterable<Synonym> synonyms)

Push a new set of synonyms and erase all previous ones. This method, like replaceAllObjects, guarantees zero downtime. All existing synonyms are deleted and replaced with the new ones, in a single, atomic operation

Parameters:

synonyms - List of synonyms

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

replaceAllSynonyms

default SaveSynonymResponse replaceAllSynonyms(@Nonnull
                                               Iterable<Synonym> synonyms,
                                               @Nonnull
                                               Boolean forwardToReplicas)

Push a new set of synonyms and erase all previous ones. This method, like replaceAllObjects, guarantees zero downtime. All existing synonyms are deleted and replaced with the new ones, in a single, atomic operation

Parameters:

synonyms - List of synonyms

forwardToReplicas - Forward to the replicas the request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

replaceAllSynonyms

default SaveSynonymResponse replaceAllSynonyms(@Nonnull
                                               Iterable<Synonym> synonyms,
                                               @Nonnull
                                               RequestOptions requestOptions)

Push a new set of synonyms and erase all previous ones. This method, like replaceAllObjects, guarantees zero downtime. All existing synonyms are deleted and replaced with the new ones, in a single, atomic operation

Parameters:

synonyms - List of synonyms

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

replaceAllSynonymsAsync

default CompletableFuture<SaveSynonymResponse> replaceAllSynonymsAsync(@Nonnull
                                                                       Iterable<Synonym> synonyms)

Push a new set of synonyms and erase all previous ones. This method, like replaceAllObjects, guarantees zero downtime. All existing synonyms are deleted and replaced with the new ones, in a single, atomic operation

Parameters:

synonyms - List of synonyms

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

replaceAllSynonymsAsync

default CompletableFuture<SaveSynonymResponse> replaceAllSynonymsAsync(@Nonnull
                                                                       Iterable<Synonym> synonyms,
                                                                       @Nonnull
                                                                       Boolean forwardToReplicas)

Push a new set of synonyms and erase all previous ones. This method, like replaceAllObjects, guarantees zero downtime. All existing synonyms are deleted and replaced with the new ones, in a single, atomic operation

Parameters:

synonyms - List of synonyms

forwardToReplicas - Forward to the replicas the request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

replaceAllSynonymsAsync

default CompletableFuture<SaveSynonymResponse> replaceAllSynonymsAsync(@Nonnull
                                                                       Iterable<Synonym> synonyms,
                                                                       @Nonnull
                                                                       RequestOptions requestOptions)

Push a new set of synonyms and erase all previous ones. This method, like replaceAllObjects, guarantees zero downtime. All existing synonyms are deleted and replaced with the new ones, in a single, atomic operation

Parameters:

synonyms - List of synonyms

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization