Package com.algolia.search

Interface SyncRules<T>

All Superinterfaces:

AbstractIndex<T>, Serializable, SyncBaseIndex<T>

All Known Implementing Classes:

Index

public interface SyncRules<T>
extends SyncBaseIndex<T>

Method Summary

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

Methods inherited from interface com.algolia.search.AbstractIndex

getKlass, getName

Methods inherited from interface com.algolia.search.SyncBaseIndex

getApiClient

Method Detail

saveRule

default Task saveRule(@Nonnull
                      String queryRuleID,
                      @Nonnull
                      Rule content)
               throws AlgoliaException

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

Parameters:

queryRuleID - the id of the queryRule

content - the queryRule

Returns:

the associated task

Throws:

AlgoliaException

saveRule

default Task saveRule(@Nonnull
                      String queryRuleID,
                      @Nonnull
                      Rule content,
                      @Nonnull
                      RequestOptions requestOptions)
               throws AlgoliaException

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

Parameters:

queryRuleID - the id of the queryRule

content - the queryRule

requestOptions - Options to pass to this request

Returns:

the associated task

Throws:

AlgoliaException

saveRule

default Task saveRule(@Nonnull
                      String queryRuleID,
                      @Nonnull
                      Rule content,
                      boolean forwardToReplicas)
               throws AlgoliaException

Saves/updates a queryRule without replacing

Parameters:

queryRuleID - the id of the queryRule

content - the queryRule

forwardToReplicas - should this request be forwarded to replicas

Returns:

the associated task

Throws:

AlgoliaException

saveRule

default Task saveRule(@Nonnull
                      String queryRuleID,
                      @Nonnull
                      Rule content,
                      boolean forwardToReplicas,
                      @Nonnull
                      RequestOptions requestOptions)
               throws AlgoliaException

Saves/updates a queryRule without replacing

Parameters:

queryRuleID - the id of the queryRule

content - the queryRule

forwardToReplicas - should this request be forwarded to replicas

requestOptions - Options to pass to this request

Returns:

the associated task

Throws:

AlgoliaException

getRule

default Optional<Rule> getRule(@Nonnull
                               String ruleId)
                        throws AlgoliaException

Get a rule by Id

Parameters:

ruleId - the id of the query rule

Returns:

the associated task

Throws:

AlgoliaException

getRule

default Optional<Rule> getRule(@Nonnull
                               String ruleId,
                               @Nonnull
                               RequestOptions requestOptions)
                        throws AlgoliaException

Get a rule by Id

Parameters:

ruleId - the id of the query rule

requestOptions - Options to pass to this request

Returns:

the associated task

Throws:

AlgoliaException

deleteRule

default Task deleteRule(@Nonnull
                        String ruleId)
                 throws AlgoliaException

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

Parameters:

ruleId - the id of the queryRule

Returns:

the associated task

Throws:

AlgoliaException

deleteRule

default Task deleteRule(@Nonnull
                        String ruleId,
                        @Nonnull
                        RequestOptions requestOptions)
                 throws AlgoliaException

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

Parameters:

ruleId - the id of the queryRule

requestOptions - Options to pass to this request

Returns:

the associated task

Throws:

AlgoliaException

deleteRule

default Task deleteRule(@Nonnull
                        String ruleId,
                        boolean forwardToReplicas,
                        @Nonnull
                        RequestOptions requestOptions)
                 throws AlgoliaException

Deletes a query rule

Parameters:

ruleId - the id of the query rule

forwardToReplicas - should this request be forwarded to replicas

requestOptions - Options to pass to this request

Returns:

the associated task

Throws:

AlgoliaException

clearRules

default Task clearRules()
                 throws AlgoliaException

Clear all query Rules and NOT forwarding it to the replicas

Returns:

the associated task

Throws:

AlgoliaException

clearRules

default Task clearRules(@Nonnull
                        RequestOptions requestOptions)
                 throws AlgoliaException

Clear all query Rules and NOT forwarding it to the replicas

Parameters:

requestOptions - Options to pass to this request

Returns:

the associated task

Throws:

AlgoliaException

clearRules

default Task clearRules(boolean forwardToReplicas)
                 throws AlgoliaException

Clears all Rules

Returns:

the associated task

Throws:

AlgoliaException

clearRules

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

Clears all Rules

Parameters:

forwardToReplicas - should this request be forwarded to replicas

requestOptions - Options to pass to this request

Returns:

the associated task

Throws:

AlgoliaException

searchRules

default SearchRuleResult searchRules(@Nonnull
                                     RuleQuery query)
                              throws AlgoliaException

Search for Rules

Parameters:

query - the query

Returns:

the results of the query

Throws:

AlgoliaException

searchRules

default SearchRuleResult searchRules(@Nonnull
                                     RuleQuery query,
                                     @Nonnull
                                     RequestOptions requestOptions)
                              throws AlgoliaException

Search for Rules

Parameters:

query - the query

requestOptions - Options to pass to this request

Returns:

the results of the query

Throws:

AlgoliaException

batchRules

default Task batchRules(@Nonnull
                        List<Rule> rules,
                        boolean forwardToReplicas,
                        boolean clearExistingRules)
                 throws AlgoliaException

Add or replace a list of query Rules

Parameters:

rules - List of query Rules

forwardToReplicas - Forward the operation to the slave indices

clearExistingRules - Replace the existing query Rules with this batch

Returns:

the associated task

Throws:

AlgoliaException

batchRules

default Task batchRules(@Nonnull
                        List<Rule> rules,
                        boolean forwardToReplicas,
                        boolean clearExistingRules,
                        @Nonnull
                        RequestOptions requestOptions)
                 throws AlgoliaException

Add or replace a list of query Rules

Parameters:

rules - List of query Rules

forwardToReplicas - Forward the operation to the slave indices

clearExistingRules - Replace the existing query Rules with this batch

requestOptions - Options to pass to this request

Returns:

the associated task

Throws:

AlgoliaException

batchRules

default Task batchRules(@Nonnull
                        List<Rule> rules,
                        boolean forwardToReplicas)
                 throws AlgoliaException

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

Throws:

AlgoliaException

batchRules

default Task batchRules(@Nonnull
                        List<Rule> rules,
                        boolean forwardToReplicas,
                        @Nonnull
                        RequestOptions requestOptions)
                 throws AlgoliaException

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

Throws:

AlgoliaException

batchRules

default Task batchRules(@Nonnull
                        List<Rule> rules)
                 throws AlgoliaException

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

Parameters:

rules - List of Rules

Returns:

the associated task

Throws:

AlgoliaException

batchRules

default Task batchRules(@Nonnull
                        List<Rule> rules,
                        @Nonnull
                        RequestOptions requestOptions)
                 throws AlgoliaException

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

Throws:

AlgoliaException