Package com.algolia.search

Interface AsyncSynonyms<T>

All Superinterfaces:

AbstractIndex<T>, AsyncBaseIndex<T>, Serializable

All Known Implementing Classes:

AsyncIndex

public interface AsyncSynonyms<T>
extends AsyncBaseIndex<T>

Method Summary

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

getApiClient

Method Detail

saveSynonym

default CompletableFuture<AsyncTask> saveSynonym(@Nonnull
                                                 String synonymID,
                                                 @Nonnull
                                                 AbstractSynonym content)

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

saveSynonym

default CompletableFuture<AsyncTask> saveSynonym(@Nonnull
                                                 String synonymID,
                                                 @Nonnull
                                                 AbstractSynonym content,
                                                 @Nonnull
                                                 RequestOptions requestOptions)

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

saveSynonym

default CompletableFuture<AsyncTask> saveSynonym(@Nonnull
                                                 String synonymID,
                                                 @Nonnull
                                                 AbstractSynonym content,
                                                 boolean forwardToReplicas)

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

saveSynonym

default CompletableFuture<AsyncTask> saveSynonym(@Nonnull
                                                 String synonymID,
                                                 @Nonnull
                                                 AbstractSynonym content,
                                                 boolean forwardToReplicas,
                                                 @Nonnull
                                                 RequestOptions requestOptions)

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

getSynonym

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

Get a synonym by ID

Parameters:

synonymID - the id of the synonym

Returns:

the associated task

getSynonym

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

Get a synonym by ID

Parameters:

synonymID - the id of the synonym

requestOptions - Options to pass to this request

Returns:

the associated task

deleteSynonym

default CompletableFuture<AsyncTask> deleteSynonym(@Nonnull
                                                   String synonymID)

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

Parameters:

synonymID - the id of the synonym

Returns:

the associated task

deleteSynonym

default CompletableFuture<AsyncTask> deleteSynonym(@Nonnull
                                                   String synonymID,
                                                   @Nonnull
                                                   RequestOptions requestOptions)

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

Parameters:

synonymID - the id of the synonym

requestOptions - Options to pass to this request

Returns:

the associated task

deleteSynonym

default CompletableFuture<AsyncTask> deleteSynonym(@Nonnull
                                                   String synonymID,
                                                   boolean forwardToReplicas)

Deletes a synonym

Parameters:

synonymID - the id of the synonym

forwardToReplicas - should this request be forwarded to replicas

Returns:

the associated task

deleteSynonym

default CompletableFuture<AsyncTask> deleteSynonym(@Nonnull
                                                   String synonymID,
                                                   boolean forwardToReplicas,
                                                   @Nonnull
                                                   RequestOptions requestOptions)

Deletes a synonym

Parameters:

synonymID - the id of the synonym

forwardToReplicas - should this request be forwarded to slaves

requestOptions - Options to pass to this request

Returns:

the associated task

clearSynonyms

default CompletableFuture<AsyncTask> clearSynonyms()

Clear all synonyms and NOT forwarding it to the replicas

Returns:

the associated task

clearSynonyms

default CompletableFuture<AsyncTask> clearSynonyms(@Nonnull
                                                   RequestOptions requestOptions)

Clear all synonyms and NOT forwarding it to the slaves

Parameters:

requestOptions - Options to pass to this request

Returns:

the associated task

clearSynonyms

default CompletableFuture<AsyncTask> clearSynonyms(boolean forwardToReplicas)

Clears all synonyms

Returns:

the associated task

clearSynonyms

default CompletableFuture<AsyncTask> clearSynonyms(boolean forwardToReplicas,
                                                   @Nonnull
                                                   RequestOptions requestOptions)

Clears all synonyms

Parameters:

requestOptions - Options to pass to this request

Returns:

the associated task

searchSynonyms

default CompletableFuture<SearchSynonymResult> searchSynonyms(@Nonnull
                                                              SynonymQuery query)

Search for synonyms

Parameters:

query - the query

Returns:

the results of the query

searchSynonyms

default CompletableFuture<SearchSynonymResult> searchSynonyms(@Nonnull
                                                              SynonymQuery query,
                                                              @Nonnull
                                                              RequestOptions requestOptions)

Search for synonyms

Parameters:

query - the query

requestOptions - Options to pass to this request

Returns:

the results of the query

batchSynonyms

default CompletableFuture<AsyncTask> batchSynonyms(@Nonnull
                                                   List<AbstractSynonym> synonyms,
                                                   boolean forwardToReplicas,
                                                   boolean replaceExistingSynonyms)

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

batchSynonyms

default CompletableFuture<AsyncTask> batchSynonyms(@Nonnull
                                                   List<AbstractSynonym> synonyms,
                                                   boolean forwardToReplicas,
                                                   boolean replaceExistingSynonyms,
                                                   @Nonnull
                                                   RequestOptions requestOptions)

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

batchSynonyms

default CompletableFuture<AsyncTask> batchSynonyms(@Nonnull
                                                   List<AbstractSynonym> synonyms,
                                                   boolean forwardToReplicas)

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

batchSynonyms

default CompletableFuture<AsyncTask> batchSynonyms(@Nonnull
                                                   List<AbstractSynonym> synonyms,
                                                   boolean forwardToReplicas,
                                                   @Nonnull
                                                   RequestOptions requestOptions)

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

batchSynonyms

default CompletableFuture<AsyncTask> batchSynonyms(@Nonnull
                                                   List<AbstractSynonym> synonyms)

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

Parameters:

synonyms - List of synonyms

Returns:

the associated task

batchSynonyms

default CompletableFuture<AsyncTask> batchSynonyms(@Nonnull
                                                   List<AbstractSynonym> synonyms,
                                                   @Nonnull
                                                   RequestOptions requestOptions)

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