Uses of Class
com.algolia.search.models.synonyms.Synonym

Packages that use Synonym

Package	Description
com.algolia.search
com.algolia.search.iterators
com.algolia.search.models.synonyms

Uses of Synonym in com.algolia.search

Methods in com.algolia.search that return Synonym

Modifier and Type	Method	Description
default Synonym	SearchIndexSynonyms.getSynonym(String objectID)	Get a single synonym using its object id.
default Synonym	SearchIndexSynonyms.getSynonym(String objectID, RequestOptions requestOptions)	Get a single synonym using its object id.

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

Modifier and Type	Method	Description
default CompletableFuture<Synonym>	SearchIndexSynonyms.getSynonymAsync(String objectID)	Get a single synonym using its object id.
default CompletableFuture<Synonym>	SearchIndexSynonyms.getSynonymAsync(String objectID, RequestOptions requestOptions)	Get a single synonym using its object id.
default SearchResult<Synonym>	SearchIndexSynonyms.searchSynonyms(SynonymQuery query)	Get all synonyms that match a query.
default SearchResult<Synonym>	SearchIndexSynonyms.searchSynonyms(SynonymQuery query, RequestOptions requestOptions)	Get all synonyms that match a query.
default CompletableFuture<SearchResult<Synonym>>	SearchIndexSynonyms.searchSynonymsAsync(SynonymQuery query)	Get all synonyms that match a query.
default CompletableFuture<SearchResult<Synonym>>	SearchIndexSynonyms.searchSynonymsAsync(SynonymQuery query, RequestOptions requestOptions)	Get all synonyms that match a query.

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

Modifier and Type	Method	Description
default SaveSynonymResponse	SearchIndexSynonyms.saveSynonym(Synonym synonym)	Create or update a single rule.
default SaveSynonymResponse	SearchIndexSynonyms.saveSynonym(Synonym synonym, RequestOptions requestOptions)	Create or update a single synonym on an index.
default SaveSynonymResponse	SearchIndexSynonyms.saveSynonym(Synonym synonym, Boolean forwardToReplicas)	Create or update a single rule.
default SaveSynonymResponse	SearchIndexSynonyms.saveSynonym(Synonym synonym, Boolean forwardToReplicas, RequestOptions requestOptions)	Create or update a single rule.
default CompletableFuture<SaveSynonymResponse>	SearchIndexSynonyms.saveSynonymAsync(Synonym synonym)	Create or update a single rule.
default CompletableFuture<SaveSynonymResponse>	SearchIndexSynonyms.saveSynonymAsync(Synonym synonym, RequestOptions requestOptions)	Create or update a single synonym on an index.
default CompletableFuture<SaveSynonymResponse>	SearchIndexSynonyms.saveSynonymAsync(Synonym synonym, Boolean forwardToReplicas)	Create or update a single rule.
default CompletableFuture<SaveSynonymResponse>	SearchIndexSynonyms.saveSynonymAsync(Synonym synonym, Boolean forwardToReplicas, RequestOptions requestOptions)	Create or update a single rule.

Method parameters in com.algolia.search with type arguments of type Synonym

Modifier and Type	Method	Description
default SaveSynonymResponse	SearchIndexSynonyms.replaceAllSynonyms(Iterable<Synonym> synonyms)	Push a new set of synonyms and erase all previous ones.
default SaveSynonymResponse	SearchIndexSynonyms.replaceAllSynonyms(Iterable<Synonym> synonyms, RequestOptions requestOptions)	Push a new set of synonyms and erase all previous ones.
default SaveSynonymResponse	SearchIndexSynonyms.replaceAllSynonyms(Iterable<Synonym> synonyms, Boolean forwardToReplicas)	Push a new set of synonyms and erase all previous ones.
default CompletableFuture<SaveSynonymResponse>	SearchIndexSynonyms.replaceAllSynonymsAsync(Iterable<Synonym> synonyms)	Push a new set of synonyms and erase all previous ones.
default CompletableFuture<SaveSynonymResponse>	SearchIndexSynonyms.replaceAllSynonymsAsync(Iterable<Synonym> synonyms, RequestOptions requestOptions)	Push a new set of synonyms and erase all previous ones.
default CompletableFuture<SaveSynonymResponse>	SearchIndexSynonyms.replaceAllSynonymsAsync(Iterable<Synonym> synonyms, Boolean forwardToReplicas)	Push a new set of synonyms and erase all previous ones.
default SaveSynonymResponse	SearchIndexSynonyms.saveSynonyms(Iterable<Synonym> synonyms)	Create or update multiple synonyms.
default SaveSynonymResponse	SearchIndexSynonyms.saveSynonyms(Iterable<Synonym> synonyms, RequestOptions requestOptions)	Create or update multiple synonyms.
default SaveSynonymResponse	SearchIndexSynonyms.saveSynonyms(Iterable<Synonym> synonyms, Boolean forwardToReplicas, Boolean clearExistingSynonyms)	Create or update multiple synonyms.
default SaveSynonymResponse	SearchIndexSynonyms.saveSynonyms(Iterable<Synonym> synonyms, Boolean forwardToReplicas, Boolean clearExistingSynonyms, RequestOptions requestOptions)	Create or update multiple synonyms.
default CompletableFuture<SaveSynonymResponse>	SearchIndexSynonyms.saveSynonymsAsync(Iterable<Synonym> synonyms)	Create or update multiple synonyms.
default CompletableFuture<SaveSynonymResponse>	SearchIndexSynonyms.saveSynonymsAsync(Iterable<Synonym> synonyms, RequestOptions requestOptions)	Create or update multiple synonyms.
default CompletableFuture<SaveSynonymResponse>	SearchIndexSynonyms.saveSynonymsAsync(Iterable<Synonym> synonyms, Boolean forwardToReplicas, Boolean clearExistingSynonyms)	Create or update multiple synonyms.
default CompletableFuture<SaveSynonymResponse>	SearchIndexSynonyms.saveSynonymsAsync(Iterable<Synonym> synonyms, Boolean forwardToReplicas, Boolean clearExistingSynonyms, RequestOptions requestOptions)	Create or update multiple synonyms.

Uses of Synonym in com.algolia.search.iterators

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

Modifier and Type	Method	Description
Iterator<Synonym>	SynonymsIterable.iterator()

Uses of Synonym in com.algolia.search.models.synonyms

Methods in com.algolia.search.models.synonyms that return Synonym

Modifier and Type	Method	Description
static Synonym	Synonym.createAltCorrection1(String objectID, String word, List<String> corrections)
static Synonym	Synonym.createAltCorrection2(String objectID, String word, List<String> corrections)
static Synonym	Synonym.createOneWaySynonym(String objectID, String input, List<String> synonyms)
static Synonym	Synonym.createPlaceHolder(String objectID, String placeholder, List<String> replacements)
static Synonym	Synonym.createSynonym(String objectID, List<String> synonyms)
Synonym	Synonym.setCorrections(List<String> corrections)
Synonym	Synonym.setInput(String input)
Synonym	Synonym.setObjectID(String objectID)
Synonym	Synonym.setPlaceholder(String placeholder)
Synonym	Synonym.setReplacements(List<String> replacements)
Synonym	Synonym.setSynonyms(List<String> synonyms)
Synonym	Synonym.setType(String type)
Synonym	Synonym.setWord(String word)