public interface SyncRules<T> extends SyncBaseIndex<T>
| Modifier and Type | Method and 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
|
getApiClientgetKlass, getNamedefault Task saveRule(@Nonnull String queryRuleID, @Nonnull Rule content) throws AlgoliaException
queryRuleID - the id of the queryRulecontent - the queryRuleAlgoliaExceptiondefault Task saveRule(@Nonnull String queryRuleID, @Nonnull Rule content, @Nonnull RequestOptions requestOptions) throws AlgoliaException
queryRuleID - the id of the queryRulecontent - the queryRulerequestOptions - Options to pass to this requestAlgoliaExceptiondefault Task saveRule(@Nonnull String queryRuleID, @Nonnull Rule content, boolean forwardToReplicas) throws AlgoliaException
queryRuleID - the id of the queryRulecontent - the queryRuleforwardToReplicas - should this request be forwarded to replicasAlgoliaExceptiondefault Task saveRule(@Nonnull String queryRuleID, @Nonnull Rule content, boolean forwardToReplicas, @Nonnull RequestOptions requestOptions) throws AlgoliaException
queryRuleID - the id of the queryRulecontent - the queryRuleforwardToReplicas - should this request be forwarded to replicasrequestOptions - Options to pass to this requestAlgoliaExceptiondefault Optional<Rule> getRule(@Nonnull String ruleId) throws AlgoliaException
ruleId - the id of the query ruleAlgoliaExceptiondefault Optional<Rule> getRule(@Nonnull String ruleId, @Nonnull RequestOptions requestOptions) throws AlgoliaException
ruleId - the id of the query rulerequestOptions - Options to pass to this requestAlgoliaExceptiondefault Task deleteRule(@Nonnull String ruleId) throws AlgoliaException
ruleId - the id of the queryRuleAlgoliaExceptiondefault Task deleteRule(@Nonnull String ruleId, @Nonnull RequestOptions requestOptions) throws AlgoliaException
ruleId - the id of the queryRulerequestOptions - Options to pass to this requestAlgoliaExceptiondefault Task deleteRule(@Nonnull String ruleId, boolean forwardToReplicas, @Nonnull RequestOptions requestOptions) throws AlgoliaException
ruleId - the id of the query ruleforwardToReplicas - should this request be forwarded to replicasrequestOptions - Options to pass to this requestAlgoliaExceptiondefault Task clearRules() throws AlgoliaException
AlgoliaExceptiondefault Task clearRules(@Nonnull RequestOptions requestOptions) throws AlgoliaException
requestOptions - Options to pass to this requestAlgoliaExceptiondefault Task clearRules(boolean forwardToReplicas) throws AlgoliaException
AlgoliaExceptiondefault Task clearRules(boolean forwardToReplicas, @Nonnull RequestOptions requestOptions) throws AlgoliaException
forwardToReplicas - should this request be forwarded to replicasrequestOptions - Options to pass to this requestAlgoliaExceptiondefault SearchRuleResult searchRules(@Nonnull RuleQuery query) throws AlgoliaException
query - the queryAlgoliaExceptiondefault SearchRuleResult searchRules(@Nonnull RuleQuery query, @Nonnull RequestOptions requestOptions) throws AlgoliaException
query - the queryrequestOptions - Options to pass to this requestAlgoliaExceptiondefault Task batchRules(@Nonnull List<Rule> rules, boolean forwardToReplicas, boolean clearExistingRules) throws AlgoliaException
rules - List of query RulesforwardToReplicas - Forward the operation to the slave indicesclearExistingRules - Replace the existing query Rules with this batchAlgoliaExceptiondefault Task batchRules(@Nonnull List<Rule> rules, boolean forwardToReplicas, boolean clearExistingRules, @Nonnull RequestOptions requestOptions) throws AlgoliaException
rules - List of query RulesforwardToReplicas - Forward the operation to the slave indicesclearExistingRules - Replace the existing query Rules with this batchrequestOptions - Options to pass to this requestAlgoliaExceptiondefault Task batchRules(@Nonnull List<Rule> rules, boolean forwardToReplicas) throws AlgoliaException
rules - List of RulesforwardToReplicas - Forward the operation to the slave indicesAlgoliaExceptiondefault Task batchRules(@Nonnull List<Rule> rules, boolean forwardToReplicas, @Nonnull RequestOptions requestOptions) throws AlgoliaException
rules - List of RulesforwardToReplicas - Forward the operation to the slave indicesrequestOptions - Options to pass to this requestAlgoliaExceptiondefault Task batchRules(@Nonnull List<Rule> rules) throws AlgoliaException
rules - List of RulesAlgoliaExceptiondefault Task batchRules(@Nonnull List<Rule> rules, @Nonnull RequestOptions requestOptions) throws AlgoliaException
rules - List of RulesrequestOptions - Options to pass to this requestAlgoliaExceptionCopyright © 2018. All rights reserved.