com.algolia.search

Interface AsyncRules<T>

All Superinterfaces:

AbstractIndex<T>, AsyncBaseIndex<T>, Serializable

All Known Implementing Classes:

AsyncIndex

public interface AsyncRules<T>
extends AsyncBaseIndex<T>

Method Summary

Modifier and Type	Method and Description
default CompletableFuture<AsyncTask>	batchRules(List<Rule> rules) Add or Replace a list of Rules, no forward to replicas, and no replacement
default CompletableFuture<AsyncTask>	batchRules(List<Rule> rules, boolean forwardToReplicas) Add or Replace a list of Rules, no replacement
default CompletableFuture<AsyncTask>	batchRules(List<Rule> rules, boolean forwardToReplicas, boolean clearExistingRules) Add or replace a list of Rules
default CompletableFuture<AsyncTask>	batchRules(List<Rule> rules, boolean forwardToReplicas, boolean clearExistingRules, RequestOptions requestOptions) Add or replace a list of Rules
default CompletableFuture<AsyncTask>	batchRules(List<Rule> rules, boolean forwardToReplicas, RequestOptions requestOptions) Add or Replace a list of Rules, no replacement
default CompletableFuture<AsyncTask>	batchRules(List<Rule> rules, RequestOptions requestOptions) Add or Replace a list of Rules, no forward to replicas, and no replacement
default CompletableFuture<AsyncTask>	clearRules() Clear all Rules and NOT forwarding it to the replicas
default CompletableFuture<AsyncTask>	clearRules(boolean forwardToReplicas) Clears all Rules
default CompletableFuture<AsyncTask>	clearRules(boolean forwardToReplicas, RequestOptions requestOptions) Clears all Rules
default CompletableFuture<AsyncTask>	clearRules(RequestOptions requestOptions) Clear all Rules and NOT forwarding it to the replicas
default CompletableFuture<AsyncTask>	deleteRule(String ruleID) Deletes a rule by ID and NOT forwarding it to the replicas
default CompletableFuture<AsyncTask>	deleteRule(String ruleID, boolean forwardToReplicas) Deletes a rule
default CompletableFuture<AsyncTask>	deleteRule(String ruleID, boolean forwardToReplicas, RequestOptions requestOptions) Deletes a rule
default CompletableFuture<AsyncTask>	deleteRule(String ruleID, RequestOptions requestOptions) Deletes a rule by ID and NOT forwarding it to the replicas
default CompletableFuture<Optional<Rule>>	getRule(String ruleID) Get a rule by ID
default CompletableFuture<Optional<Rule>>	getRule(String ruleID, RequestOptions requestOptions) Get a rule by ID
default CompletableFuture<AsyncTask>	saveRule(String ruleID, Rule rule) Saves/updates a rule without replacing it and NOT forwarding it to the replicas
default CompletableFuture<AsyncTask>	saveRule(String ruleID, Rule rule, boolean forwardToReplicas) Saves/updates a rule
default CompletableFuture<AsyncTask>	saveRule(String ruleID, Rule rule, boolean forwardToReplicas, RequestOptions requestOptions) Saves/updates a rule
default CompletableFuture<AsyncTask>	saveRule(String ruleID, Rule rule, RequestOptions requestOptions) Saves/updates a rule without replacing it and NOT forwarding it to the replicas
default CompletableFuture<SearchRuleResult>	searchRules(RuleQuery query) Search for Rules
default CompletableFuture<SearchRuleResult>	searchRules(RuleQuery query, RequestOptions requestOptions) Search for Rules

Methods inherited from interface com.algolia.search.AsyncBaseIndex

getApiClient

Methods inherited from interface com.algolia.search.AbstractIndex

getKlass, getName

Method Detail

saveRule

default CompletableFuture<AsyncTask> saveRule(@Nonnull
                                              String ruleID,
                                              @Nonnull
                                              Rule rule)

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

Parameters:

ruleID - the id of the query rule

rule - the query rule

Returns:

the associated task

saveRule

default CompletableFuture<AsyncTask> saveRule(@Nonnull
                                              String ruleID,
                                              @Nonnull
                                              Rule rule,
                                              @Nonnull
                                              RequestOptions requestOptions)

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

Parameters:

ruleID - the id of the query rule

rule - the query rule

requestOptions - Options to pass to this request

Returns:

the associated task

saveRule

default CompletableFuture<AsyncTask> saveRule(@Nonnull
                                              String ruleID,
                                              @Nonnull
                                              Rule rule,
                                              boolean forwardToReplicas)

Saves/updates a rule

Parameters:

ruleID - the id of the query rule

rule - the query rule

forwardToReplicas - should this request be forwarded to replicas

Returns:

the associated task

saveRule

default CompletableFuture<AsyncTask> saveRule(@Nonnull
                                              String ruleID,
                                              @Nonnull
                                              Rule rule,
                                              boolean forwardToReplicas,
                                              @Nonnull
                                              RequestOptions requestOptions)

Saves/updates a rule

Parameters:

ruleID - the id of the query rule

rule - the query rule

forwardToReplicas - should this request be forwarded to replicas

requestOptions - Options to pass to this request

Returns:

the associated task

getRule

default CompletableFuture<Optional<Rule>> getRule(@Nonnull
                                                  String ruleID)

Get a rule by ID

Parameters:

ruleID - the id of the rule

Returns:

the associated task

getRule

default CompletableFuture<Optional<Rule>> getRule(@Nonnull
                                                  String ruleID,
                                                  @Nonnull
                                                  RequestOptions requestOptions)

Get a rule by ID

Parameters:

ruleID - the id of the rule

requestOptions - Options to pass to this request

Returns:

the associated task

deleteRule

default CompletableFuture<AsyncTask> deleteRule(@Nonnull
                                                String ruleID)

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

Parameters:

ruleID - the id of the query rule

Returns:

the associated task

deleteRule

default CompletableFuture<AsyncTask> deleteRule(@Nonnull
                                                String ruleID,
                                                @Nonnull
                                                RequestOptions requestOptions)

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

Parameters:

ruleID - the id of the query rule

requestOptions - Options to pass to this request

Returns:

the associated task

deleteRule

default CompletableFuture<AsyncTask> deleteRule(@Nonnull
                                                String ruleID,
                                                boolean forwardToReplicas)

Deletes a rule

Parameters:

ruleID - the id of the rule

forwardToReplicas - should this request be forwarded to replicas

Returns:

the associated task

deleteRule

default CompletableFuture<AsyncTask> deleteRule(@Nonnull
                                                String ruleID,
                                                boolean forwardToReplicas,
                                                @Nonnull
                                                RequestOptions requestOptions)

Deletes a rule

Parameters:

ruleID - the id of the rule

forwardToReplicas - should this request be forwarded to replicas

requestOptions - Options to pass to this request

Returns:

the associated task

clearRules

default CompletableFuture<AsyncTask> clearRules()

Clear all Rules and NOT forwarding it to the replicas

Returns:

the associated task

clearRules

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

Clear all Rules and NOT forwarding it to the replicas

Parameters:

requestOptions - Options to pass to this request

Returns:

the associated task

clearRules

default CompletableFuture<AsyncTask> clearRules(boolean forwardToReplicas)

Clears all Rules

Returns:

the associated task

clearRules

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

Clears all Rules

Parameters:

requestOptions - Options to pass to this request

Returns:

the associated task

searchRules

default CompletableFuture<SearchRuleResult> searchRules(@Nonnull
                                                        RuleQuery query)

Search for Rules

Parameters:

query - the query

Returns:

the results of the query

searchRules

default CompletableFuture<SearchRuleResult> searchRules(@Nonnull
                                                        RuleQuery query,
                                                        @Nonnull
                                                        RequestOptions requestOptions)

Search for Rules

Parameters:

requestOptions - Options to pass to this request

query - the query

Returns:

the results of the query

batchRules

default CompletableFuture<AsyncTask> batchRules(@Nonnull
                                                List<Rule> rules,
                                                boolean forwardToReplicas,
                                                boolean clearExistingRules)

Add or replace a list of Rules

Parameters:

rules - List of Rules

forwardToReplicas - Forward the operation to the replicas indices

clearExistingRules - Replace the existing Rules with this batch

Returns:

the associated task

batchRules

default CompletableFuture<AsyncTask> batchRules(@Nonnull
                                                List<Rule> rules,
                                                boolean forwardToReplicas,
                                                boolean clearExistingRules,
                                                @Nonnull
                                                RequestOptions requestOptions)

Add or replace a list of Rules

Parameters:

rules - List of Rules

forwardToReplicas - Forward the operation to the replicas indices

clearExistingRules - Replace the existing Rules with this batch

requestOptions - Options to pass to this request

Returns:

the associated task

batchRules

default CompletableFuture<AsyncTask> batchRules(@Nonnull
                                                List<Rule> rules,
                                                boolean forwardToReplicas)

Add or Replace a list of Rules, no replacement

Parameters:

rules - List of Rules

forwardToReplicas - Forward the operation to the slave indices

Returns:

the associated task

batchRules

default CompletableFuture<AsyncTask> batchRules(@Nonnull
                                                List<Rule> rules,
                                                boolean forwardToReplicas,
                                                @Nonnull
                                                RequestOptions requestOptions)

Add or Replace a list of Rules, no replacement

Parameters:

rules - List of Rules

forwardToReplicas - Forward the operation to the slave indices

requestOptions - Options to pass to this request

Returns:

the associated task

batchRules

default CompletableFuture<AsyncTask> batchRules(@Nonnull
                                                List<Rule> rules)

Add or Replace a list of Rules, no forward to replicas, and no replacement

Parameters:

rules - List of Rules

Returns:

the associated task

batchRules

default CompletableFuture<AsyncTask> batchRules(@Nonnull
                                                List<Rule> rules,
                                                @Nonnull
                                                RequestOptions requestOptions)

Add or Replace a list of Rules, no forward to replicas, and no replacement

Parameters:

rules - List of Rules

requestOptions - Options to pass to this request

Returns:

the associated task