Package com.algolia.search

Interface SyncSynonyms<T>

All Superinterfaces:

AbstractIndex<T>, Serializable, SyncBaseIndex<T>

All Known Implementing Classes:

Index

public interface SyncSynonyms<T>
extends SyncBaseIndex<T>

Method Summary

Modifier and Type	Method	Description
default Task	batchSynonyms(List<AbstractSynonym> synonyms)	Add or Replace a list of synonyms, no forward to slaves, and no replacement
default Task	batchSynonyms(List<AbstractSynonym> synonyms, boolean forwardToReplicas)	Add or Replace a list of synonyms, no replacement
default Task	batchSynonyms(List<AbstractSynonym> synonyms, boolean forwardToReplicas, boolean replaceExistingSynonyms)	Add or Replace a list of synonyms
default Task	batchSynonyms(List<AbstractSynonym> synonyms, boolean forwardToReplicas, boolean replaceExistingSynonyms, RequestOptions requestOptions)	Add or Replace a list of synonyms
default Task	batchSynonyms(List<AbstractSynonym> synonyms, boolean forwardToReplicas, RequestOptions requestOptions)	Add or Replace a list of synonyms, no replacement
default Task	batchSynonyms(List<AbstractSynonym> synonyms, RequestOptions requestOptions)	Add or Replace a list of synonyms, no forward to slaves, and no replacement
default Task	clearSynonyms()	Clear all synonyms and NOT forwarding it to the replicas
default Task	clearSynonyms(boolean forwardToReplicas)	Clears all synonyms
default Task	clearSynonyms(boolean forwardToReplicas, RequestOptions requestOptions)	Clears all synonyms
default Task	clearSynonyms(RequestOptions requestOptions)	Clear all synonyms and NOT forwarding it to the replicas
default Task	deleteSynonym(String synonymID)	Deletes a synonym by ID and NOT forwarding it to the replicas
default Task	deleteSynonym(String synonymID, boolean forwardToReplicas)	Deletes a synonym
default Task	deleteSynonym(String synonymID, boolean forwardToReplicas, RequestOptions requestOptions)	Deletes a synonym
default Task	deleteSynonym(String synonymID, RequestOptions requestOptions)	Deletes a synonym by ID and NOT forwarding it to the replicas
default Optional<AbstractSynonym>	getSynonym(String synonymID)	Get a synonym by ID
default Optional<AbstractSynonym>	getSynonym(String synonymID, RequestOptions requestOptions)	Get a synonym by ID
default Task	saveSynonym(String synonymID, AbstractSynonym content)	Saves/updates a synonym without replacing it and NOT forwarding it to the replicas
default Task	saveSynonym(String synonymID, AbstractSynonym content, boolean forwardToReplicas)	Saves/updates a synonym without replacing
default Task	saveSynonym(String synonymID, AbstractSynonym content, boolean forwardToReplicas, RequestOptions requestOptions)	Saves/updates a synonym without replacing
default Task	saveSynonym(String synonymID, AbstractSynonym content, RequestOptions requestOptions)	Saves/updates a synonym without replacing it and NOT forwarding it to the slaves
default SearchSynonymResult	searchSynonyms(SynonymQuery query)	Search for synonyms
default SearchSynonymResult	searchSynonyms(SynonymQuery query, RequestOptions requestOptions)	Search for synonyms

Methods inherited from interface com.algolia.search.AbstractIndex

getKlass, getName

Methods inherited from interface com.algolia.search.SyncBaseIndex

getApiClient

Method Detail

saveSynonym

default Task saveSynonym(@Nonnull
                         String synonymID,
                         @Nonnull
                         AbstractSynonym content)
                  throws AlgoliaException

Saves/updates a synonym without replacing it and NOT forwarding it to the replicas

Parameters:

synonymID - the id of the synonym

content - the synonym

Returns:

the associated task

Throws:

AlgoliaException

saveSynonym

default Task saveSynonym(@Nonnull
                         String synonymID,
                         @Nonnull
                         AbstractSynonym content,
                         @Nonnull
                         RequestOptions requestOptions)
                  throws AlgoliaException

Saves/updates a synonym without replacing it and NOT forwarding it to the slaves

Parameters:

synonymID - the id of the synonym

content - the synonym

requestOptions - Options to pass to this request

Returns:

the associated task

Throws:

AlgoliaException

saveSynonym

default Task saveSynonym(@Nonnull
                         String synonymID,
                         @Nonnull
                         AbstractSynonym content,
                         boolean forwardToReplicas)
                  throws AlgoliaException

Saves/updates a synonym without replacing

Parameters:

synonymID - the id of the synonym

content - the synonym

forwardToReplicas - should this request be forwarded to replicas

Returns:

the associated task

Throws:

AlgoliaException

saveSynonym

default Task saveSynonym(@Nonnull
                         String synonymID,
                         @Nonnull
                         AbstractSynonym content,
                         boolean forwardToReplicas,
                         @Nonnull
                         RequestOptions requestOptions)
                  throws AlgoliaException

Saves/updates a synonym without replacing

Parameters:

synonymID - the id of the synonym

content - the synonym

forwardToReplicas - should this request be forwarded to slaves

requestOptions - Options to pass to this request

Returns:

the associated task

Throws:

AlgoliaException

getSynonym

default Optional<AbstractSynonym> getSynonym(@Nonnull
                                             String synonymID)
                                      throws AlgoliaException

Get a synonym by ID

Parameters:

synonymID - the id of the synonym

Returns:

the associated task

Throws:

AlgoliaException

getSynonym

default Optional<AbstractSynonym> getSynonym(@Nonnull
                                             String synonymID,
                                             @Nonnull
                                             RequestOptions requestOptions)
                                      throws AlgoliaException

Get a synonym by ID

Parameters:

synonymID - the id of the synonym

requestOptions - Options to pass to this request

Returns:

the associated task

Throws:

AlgoliaException

deleteSynonym

default Task deleteSynonym(@Nonnull
                           String synonymID)
                    throws AlgoliaException

Deletes a synonym by ID and NOT forwarding it to the replicas

Parameters:

synonymID - the id of the synonym

Returns:

the associated task

Throws:

AlgoliaException

deleteSynonym

default Task deleteSynonym(@Nonnull
                           String synonymID,
                           @Nonnull
                           RequestOptions requestOptions)
                    throws AlgoliaException

Deletes a synonym by ID and NOT forwarding it to the replicas

Parameters:

synonymID - the id of the synonym

requestOptions - Options to pass to this request

Returns:

the associated task

Throws:

AlgoliaException

deleteSynonym

default Task deleteSynonym(@Nonnull
                           String synonymID,
                           boolean forwardToReplicas)
                    throws AlgoliaException

Deletes a synonym

Parameters:

synonymID - the id of the synonym

forwardToReplicas - should this request be forwarded to replicas

Returns:

the associated task

Throws:

AlgoliaException

deleteSynonym

default Task deleteSynonym(@Nonnull
                           String synonymID,
                           boolean forwardToReplicas,
                           @Nonnull
                           RequestOptions requestOptions)
                    throws AlgoliaException

Deletes a synonym

Parameters:

synonymID - the id of the synonym

forwardToReplicas - should this request be forwarded to replicas

requestOptions - Options to pass to this request

Returns:

the associated task

Throws:

AlgoliaException

clearSynonyms

default Task clearSynonyms()
                    throws AlgoliaException

Clear all synonyms and NOT forwarding it to the replicas

Returns:

the associated task

Throws:

AlgoliaException

clearSynonyms

default Task clearSynonyms(@Nonnull
                           RequestOptions requestOptions)
                    throws AlgoliaException

Clear all synonyms and NOT forwarding it to the replicas

Parameters:

requestOptions - Options to pass to this request

Returns:

the associated task

Throws:

AlgoliaException

clearSynonyms

default Task clearSynonyms(boolean forwardToReplicas)
                    throws AlgoliaException

Clears all synonyms

Parameters:

forwardToReplicas - should this request be forwarded to replicas

Returns:

the associated task

Throws:

AlgoliaException

clearSynonyms

default Task clearSynonyms(boolean forwardToReplicas,
                           @Nonnull
                           RequestOptions requestOptions)
                    throws AlgoliaException

Clears all synonyms

Parameters:

forwardToReplicas - should this request be forwarded to replicas

requestOptions - Options to pass to this request

Returns:

the associated task

Throws:

AlgoliaException

searchSynonyms

default SearchSynonymResult searchSynonyms(@Nonnull
                                           SynonymQuery query)
                                    throws AlgoliaException

Search for synonyms

Parameters:

query - the query

Returns:

the results of the query

Throws:

AlgoliaException

searchSynonyms

default SearchSynonymResult searchSynonyms(@Nonnull
                                           SynonymQuery query,
                                           @Nonnull
                                           RequestOptions requestOptions)
                                    throws AlgoliaException

Search for synonyms

Parameters:

query - the query

requestOptions - Options to pass to this request

Returns:

the results of the query

Throws:

AlgoliaException

batchSynonyms

default Task batchSynonyms(@Nonnull
                           List<AbstractSynonym> synonyms,
                           boolean forwardToReplicas,
                           boolean replaceExistingSynonyms)
                    throws AlgoliaException

Add or Replace a list of synonyms

Parameters:

synonyms - List of synonyms

forwardToReplicas - Forward the operation to the slave indices

replaceExistingSynonyms - Replace the existing synonyms with this batch

Returns:

the associated task

Throws:

AlgoliaException

batchSynonyms

default Task batchSynonyms(@Nonnull
                           List<AbstractSynonym> synonyms,
                           boolean forwardToReplicas,
                           boolean replaceExistingSynonyms,
                           @Nonnull
                           RequestOptions requestOptions)
                    throws AlgoliaException

Add or Replace a list of synonyms

Parameters:

synonyms - List of synonyms

forwardToReplicas - Forward the operation to the slave indices

replaceExistingSynonyms - Replace the existing synonyms with this batch

requestOptions - Options to pass to this request

Returns:

the associated task

Throws:

AlgoliaException

batchSynonyms

default Task batchSynonyms(@Nonnull
                           List<AbstractSynonym> synonyms,
                           boolean forwardToReplicas)
                    throws AlgoliaException

Add or Replace a list of synonyms, no replacement

Parameters:

synonyms - List of synonyms

forwardToReplicas - Forward the operation to the slave indices

Returns:

the associated task

Throws:

AlgoliaException

batchSynonyms

default Task batchSynonyms(@Nonnull
                           List<AbstractSynonym> synonyms,
                           boolean forwardToReplicas,
                           @Nonnull
                           RequestOptions requestOptions)
                    throws AlgoliaException

Add or Replace a list of synonyms, no replacement

Parameters:

synonyms - List of synonyms

forwardToReplicas - Forward the operation to the slave indices

requestOptions - Options to pass to this request

Returns:

the associated task

Throws:

AlgoliaException

batchSynonyms

default Task batchSynonyms(@Nonnull
                           List<AbstractSynonym> synonyms)
                    throws AlgoliaException

Add or Replace a list of synonyms, no forward to slaves, and no replacement

Parameters:

synonyms - List of synonyms

Returns:

the associated task

Throws:

AlgoliaException

batchSynonyms

default Task batchSynonyms(@Nonnull
                           List<AbstractSynonym> synonyms,
                           @Nonnull
                           RequestOptions requestOptions)
                    throws AlgoliaException

Add or Replace a list of synonyms, no forward to slaves, and no replacement

Parameters:

synonyms - List of synonyms

requestOptions - Options to pass to this request

Returns:

the associated task

Throws:

AlgoliaException