Package com.algolia.search

Interface SearchIndexRules<T>

Type Parameters:

T -

All Superinterfaces:

SearchIndexBase<T>

All Known Implementing Classes:

SearchIndex

public interface SearchIndexRules<T>
extends SearchIndexBase<T>

This interface holds all endpoints for Query Rules.

Method Summary

Modifier and Type	Method	Description
default RulesIterable	browseRules()	Retrieve an index’s full list of rules using an iterator.
default RulesIterable	browseRules(int hitsPerPage)	Retrieve an index’s full list of rules using an iterator.
default RulesIterable	browseRules(int hitsPerPage, RequestOptions requestOptions)	Retrieve an index’s full list of rules using an iterator.
default DeleteResponse	clearRules()	Delete all rules in an index.
default DeleteResponse	clearRules(RequestOptions requestOptions)	Delete all rules in an index.
default DeleteResponse	clearRules(Boolean forwardToReplicas)	Delete all rules in an index.
default DeleteResponse	clearRules(Boolean forwardToReplicas, RequestOptions requestOptions)	Delete all rules in an index.
default CompletableFuture<DeleteResponse>	clearRulesAsync()	Delete all rules in an index.
default CompletableFuture<DeleteResponse>	clearRulesAsync(RequestOptions requestOptions)	Delete all rules in an index.
default CompletableFuture<DeleteResponse>	clearRulesAsync(Boolean forwardToReplicas)	Delete all rules in an index.
default CompletableFuture<DeleteResponse>	clearRulesAsync(Boolean forwardToReplicas, RequestOptions requestOptions)	Delete all rules in an index.
default DeleteResponse	deleteRule(String objectID)	Delete the rule for the given ruleId
default DeleteResponse	deleteRule(String objectID, RequestOptions requestOptions)	Delete the rule for the given ruleId
default CompletableFuture<DeleteResponse>	deleteRuleAsync(String objectID)	Delete the rule for the given ruleId
default CompletableFuture<DeleteResponse>	deleteRuleAsync(String objectID, RequestOptions requestOptions)	Delete the rule for the given ruleId
default Rule	getRule(String objectID)	Get the specified rule by its objectID
default Rule	getRule(String objectID, RequestOptions requestOptions)	Get the specified rule by its objectID
default CompletableFuture<Rule>	getRuleAsync(String objectID)	Get the specified rule by its objectID
default CompletableFuture<Rule>	getRuleAsync(String objectID, RequestOptions requestOptions)	Get the specified rule by its objectID
default SaveRuleResponse	replaceAllRules(Iterable<Rule> rules)	Push a new set of rules and erase all previous ones.
default SaveRuleResponse	replaceAllRules(Iterable<Rule> rules, RequestOptions requestOptions)	Push a new set of rules and erase all previous ones.
default SaveRuleResponse	replaceAllRules(Iterable<Rule> rules, Boolean forwardToReplicas)	Push a new set of rules and erase all previous ones.
default CompletableFuture<SaveRuleResponse>	replaceAllRulesAsync(Iterable<Rule> rules)	Push a new set of rules and erase all previous ones.
default CompletableFuture<SaveRuleResponse>	replaceAllRulesAsync(Iterable<Rule> rules, RequestOptions requestOptions)	Push a new set of rules and erase all previous ones.
default CompletableFuture<SaveRuleResponse>	replaceAllRulesAsync(Iterable<Rule> rules, Boolean forwardToReplicas)	Push a new set of rules and erase all previous ones.
default SaveRuleResponse	saveRule(Rule rule)	Create or update a single rule.
default SaveRuleResponse	saveRule(Rule rule, RequestOptions requestOptions)	Create or update a single rule.
default SaveRuleResponse	saveRule(Rule rule, Boolean forwardToReplicas)	Create or update a single rule.
default SaveRuleResponse	saveRule(Rule rule, Boolean forwardToReplicas, RequestOptions requestOptions)	Create or update a single rule.
default CompletableFuture<SaveRuleResponse>	saveRuleAsync(Rule rule)	Create or update a single rule.
default CompletableFuture<SaveRuleResponse>	saveRuleAsync(Rule rule, RequestOptions requestOptions)	Create or update a single rule.
default CompletableFuture<SaveRuleResponse>	saveRuleAsync(Rule rule, Boolean forwardToReplicas)	Create or update a single rule.
default CompletableFuture<SaveRuleResponse>	saveRuleAsync(Rule rule, Boolean forwardToReplicas, RequestOptions requestOptions)	Create or update a single rule.
default SaveRuleResponse	saveRules(Iterable<Rule> rules)	Create or update a specified set of rules, or all rules.
default SaveRuleResponse	saveRules(Iterable<Rule> rules, RequestOptions requestOptions)	Create or update a specified set of rules, or all rules.
default SaveRuleResponse	saveRules(Iterable<Rule> rules, Boolean forwardToReplicas, Boolean clearExistingRules)	Create or update a specified set of rules, or all rules.
default SaveRuleResponse	saveRules(Iterable<Rule> rules, Boolean forwardToReplicas, Boolean clearExistingRules, RequestOptions requestOptions)	Create or update a specified set of rules, or all rules.
default CompletableFuture<SaveRuleResponse>	saveRulesAsync(Iterable<Rule> rules)	Create or update a specified set of rules, or all rules.
default CompletableFuture<SaveRuleResponse>	saveRulesAsync(Iterable<Rule> rules, RequestOptions requestOptions)	Create or update a specified set of rules, or all rules.
default CompletableFuture<SaveRuleResponse>	saveRulesAsync(Iterable<Rule> rules, Boolean forwardToReplicas, Boolean clearExistingRules)	Create or update a specified set of rules, or all rules.
default CompletableFuture<SaveRuleResponse>	saveRulesAsync(Iterable<Rule> rules, Boolean forwardToReplicas, Boolean clearExistingRules, RequestOptions requestOptions)	Create or update a specified set of rules, or all rules.
default SearchResult<Rule>	searchRules(RuleQuery query)	Search for rules matching various criteria.
default SearchResult<Rule>	searchRules(RuleQuery query, RequestOptions requestOptions)	Search for rules matching various criteria.
default CompletableFuture<SearchResult<Rule>>	searchRulesAsync(RuleQuery query)	Search for rules matching various criteria.
default CompletableFuture<SearchResult<Rule>>	searchRulesAsync(RuleQuery query, RequestOptions requestOptions)	Search for rules matching various criteria.

Methods inherited from interface com.algolia.search.SearchIndexBase

getClazz, getConfig, getTransport, getUrlEncodedIndexName, waitTask, waitTask

Method Detail

getRule

default Rule getRule(@Nonnull
                     String objectID)

Get the specified rule by its objectID

Parameters:

objectID - Algolia's objectID

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getRule

default Rule getRule(@Nonnull
                     String objectID,
                     RequestOptions requestOptions)

Get the specified rule by its objectID

Parameters:

objectID - Algolia's objectID

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getRuleAsync

default CompletableFuture<Rule> getRuleAsync(@Nonnull
                                             String objectID)

Get the specified rule by its objectID

Parameters:

objectID - Algolia's objectID

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

getRuleAsync

default CompletableFuture<Rule> getRuleAsync(@Nonnull
                                             String objectID,
                                             RequestOptions requestOptions)

Get the specified rule by its objectID

Parameters:

objectID - Algolia's objectID

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

searchRules

default SearchResult<Rule> searchRules(@Nonnull
                                       RuleQuery query)

Search for rules matching various criteria.

Parameters:

query - The search rule query

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

searchRules

default SearchResult<Rule> searchRules(@Nonnull
                                       RuleQuery query,
                                       RequestOptions requestOptions)

Search for rules matching various criteria.

Parameters:

query - The search rule query

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

searchRulesAsync

default CompletableFuture<SearchResult<Rule>> searchRulesAsync(@Nonnull
                                                               RuleQuery query)

Search for rules matching various criteria.

Parameters:

query - The search rule query

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

searchRulesAsync

default CompletableFuture<SearchResult<Rule>> searchRulesAsync(@Nonnull
                                                               RuleQuery query,
                                                               RequestOptions requestOptions)

Search for rules matching various criteria.

Parameters:

query - The search rule query

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

browseRules

default RulesIterable browseRules()

Retrieve an index’s full list of rules using an iterator. The list contains the rule name, plus the complete details of its conditions and consequences. The list includes all rules, whether created on the dashboard or pushed by the API.

browseRules

default RulesIterable browseRules(int hitsPerPage)

Retrieve an index’s full list of rules using an iterator. The list contains the rule name, plus the complete details of its conditions and consequences. The list includes all rules, whether created on the dashboard or pushed by the API.

Parameters:

hitsPerPage - Number of hits per page to retrieve default = 1000

browseRules

default RulesIterable browseRules(int hitsPerPage,
                                  RequestOptions requestOptions)

Retrieve an index’s full list of rules using an iterator. The list contains the rule name, plus the complete details of its conditions and consequences. The list includes all rules, whether created on the dashboard or pushed by the API.

Parameters:

hitsPerPage - Number of hits per page to retrieve default = 1000

requestOptions - Options to pass to this request

saveRule

default SaveRuleResponse saveRule(@Nonnull
                                  Rule rule)

Create or update a single rule.

Parameters:

rule - A query rule

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveRule

default SaveRuleResponse saveRule(@Nonnull
                                  Rule rule,
                                  @Nonnull
                                  Boolean forwardToReplicas)

Create or update a single rule.

Parameters:

rule - A query rule

forwardToReplicas - Forward the request to the replicas

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveRule

default SaveRuleResponse saveRule(@Nonnull
                                  Rule rule,
                                  @Nonnull
                                  Boolean forwardToReplicas,
                                  @Nonnull
                                  RequestOptions requestOptions)

Create or update a single rule.

Parameters:

rule - A query rule

forwardToReplicas - Forward the request to the replicas

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveRule

default SaveRuleResponse saveRule(@Nonnull
                                  Rule rule,
                                  @Nonnull
                                  RequestOptions requestOptions)

Create or update a single rule.

Parameters:

rule - A query rule

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveRuleAsync

default CompletableFuture<SaveRuleResponse> saveRuleAsync(@Nonnull
                                                          Rule rule)

Create or update a single rule.

Parameters:

rule - A query rule

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveRuleAsync

default CompletableFuture<SaveRuleResponse> saveRuleAsync(@Nonnull
                                                          Rule rule,
                                                          @Nonnull
                                                          Boolean forwardToReplicas)

Create or update a single rule.

Parameters:

rule - A query rule

forwardToReplicas - Forward the request to the replicas

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveRuleAsync

default CompletableFuture<SaveRuleResponse> saveRuleAsync(@Nonnull
                                                          Rule rule,
                                                          @Nonnull
                                                          Boolean forwardToReplicas,
                                                          @Nonnull
                                                          RequestOptions requestOptions)

Create or update a single rule.

Parameters:

rule - A query rule

forwardToReplicas - Forward the request to the replicas

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveRuleAsync

default CompletableFuture<SaveRuleResponse> saveRuleAsync(@Nonnull
                                                          Rule rule,
                                                          @Nonnull
                                                          RequestOptions requestOptions)

Create or update a single rule.

Parameters:

rule - A query rule

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveRules

default SaveRuleResponse saveRules(@Nonnull
                                   Iterable<Rule> rules)

Create or update a specified set of rules, or all rules.

Parameters:

rules - List of rules

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When the class doesn't have an objectID field or a Jacksonannotation @JsonProperty(\"objectID\"")

saveRules

default SaveRuleResponse saveRules(@Nonnull
                                   Iterable<Rule> rules,
                                   @Nonnull
                                   Boolean forwardToReplicas,
                                   @Nonnull
                                   Boolean clearExistingRules)

Create or update a specified set of rules, or all rules.

Parameters:

rules - List of rules

forwardToReplicas - Forward to the replicas the request

clearExistingRules - Clear all existing rules

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveRules

default SaveRuleResponse saveRules(@Nonnull
                                   Iterable<Rule> rules,
                                   @Nonnull
                                   Boolean forwardToReplicas,
                                   @Nonnull
                                   Boolean clearExistingRules,
                                   @Nonnull
                                   RequestOptions requestOptions)

Create or update a specified set of rules, or all rules.

Parameters:

rules - List of rules

forwardToReplicas - Forward to the replicas the request

clearExistingRules - Clear all existing rules

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveRules

default SaveRuleResponse saveRules(@Nonnull
                                   Iterable<Rule> rules,
                                   RequestOptions requestOptions)

Create or update a specified set of rules, or all rules.

Parameters:

rules - List of rules

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveRulesAsync

default CompletableFuture<SaveRuleResponse> saveRulesAsync(@Nonnull
                                                           Iterable<Rule> rules)

Create or update a specified set of rules, or all rules.

Parameters:

rules - List of rules

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When the class doesn't have an objectID field or a Jacksonannotation @JsonProperty(\"objectID\"")

saveRulesAsync

default CompletableFuture<SaveRuleResponse> saveRulesAsync(@Nonnull
                                                           Iterable<Rule> rules,
                                                           @Nonnull
                                                           Boolean forwardToReplicas,
                                                           @Nonnull
                                                           Boolean clearExistingRules)

Create or update a specified set of rules, or all rules.

Parameters:

rules - List of rules

forwardToReplicas - Forward to the replicas the request

clearExistingRules - Clear all existing rules

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveRulesAsync

default CompletableFuture<SaveRuleResponse> saveRulesAsync(@Nonnull
                                                           Iterable<Rule> rules,
                                                           @Nonnull
                                                           Boolean forwardToReplicas,
                                                           @Nonnull
                                                           Boolean clearExistingRules,
                                                           @Nonnull
                                                           RequestOptions requestOptions)

Create or update a specified set of rules, or all rules.

Parameters:

rules - List of rules

forwardToReplicas - Forward to the replicas the request

clearExistingRules - Clear all existing rules

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

saveRulesAsync

default CompletableFuture<SaveRuleResponse> saveRulesAsync(@Nonnull
                                                           Iterable<Rule> rules,
                                                           RequestOptions requestOptions)

Create or update a specified set of rules, or all rules.

Parameters:

rules - List of rules

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

deleteRule

default DeleteResponse deleteRule(@Nonnull
                                  String objectID)

Delete the rule for the given ruleId

Parameters:

objectID - The rule objectID

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

deleteRule

default DeleteResponse deleteRule(@Nonnull
                                  String objectID,
                                  RequestOptions requestOptions)

Delete the rule for the given ruleId

Parameters:

objectID - The rule objectID

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

deleteRuleAsync

default CompletableFuture<DeleteResponse> deleteRuleAsync(@Nonnull
                                                          String objectID)

Delete the rule for the given ruleId

Parameters:

objectID - The rule objectID

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

deleteRuleAsync

default CompletableFuture<DeleteResponse> deleteRuleAsync(@Nonnull
                                                          String objectID,
                                                          RequestOptions requestOptions)

Delete the rule for the given ruleId

Parameters:

objectID - The rule objectID

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

replaceAllRules

default SaveRuleResponse replaceAllRules(@Nonnull
                                         Iterable<Rule> rules)

Push a new set of rules and erase all previous ones. This method, like replaceAllObjects, guarantees zero downtime. All existing rules are deleted and replaced with the new ones, in a single, atomic operation

Parameters:

rules - List of rules

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

replaceAllRules

default SaveRuleResponse replaceAllRules(@Nonnull
                                         Iterable<Rule> rules,
                                         @Nonnull
                                         Boolean forwardToReplicas)

Push a new set of rules and erase all previous ones. This method, like replaceAllObjects, guarantees zero downtime. All existing rules are deleted and replaced with the new ones, in a single, atomic operation

Parameters:

rules - List of rules

forwardToReplicas - Forward to the replicas the request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

replaceAllRules

default SaveRuleResponse replaceAllRules(@Nonnull
                                         Iterable<Rule> rules,
                                         @Nonnull
                                         RequestOptions requestOptions)

Push a new set of rules and erase all previous ones. This method, like replaceAllObjects, guarantees zero downtime. All existing rules are deleted and replaced with the new ones, in a single, atomic operation

Parameters:

rules - List of rules

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

replaceAllRulesAsync

default CompletableFuture<SaveRuleResponse> replaceAllRulesAsync(@Nonnull
                                                                 Iterable<Rule> rules)

Push a new set of rules and erase all previous ones. This method, like replaceAllObjects, guarantees zero downtime. All existing rules are deleted and replaced with the new ones, in a single, atomic operation

Parameters:

rules - List of rules

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

replaceAllRulesAsync

default CompletableFuture<SaveRuleResponse> replaceAllRulesAsync(@Nonnull
                                                                 Iterable<Rule> rules,
                                                                 @Nonnull
                                                                 Boolean forwardToReplicas)

Push a new set of rules and erase all previous ones. This method, like replaceAllObjects, guarantees zero downtime. All existing rules are deleted and replaced with the new ones, in a single, atomic operation

Parameters:

rules - List of rules

forwardToReplicas - Forward to the replicas the request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

replaceAllRulesAsync

default CompletableFuture<SaveRuleResponse> replaceAllRulesAsync(@Nonnull
                                                                 Iterable<Rule> rules,
                                                                 @Nonnull
                                                                 RequestOptions requestOptions)

Push a new set of rules and erase all previous ones. This method, like replaceAllObjects, guarantees zero downtime. All existing rules are deleted and replaced with the new ones, in a single, atomic operation

Parameters:

rules - List of rules

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

clearRules

default DeleteResponse clearRules()

Delete all rules in an index.

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

clearRules

default DeleteResponse clearRules(@Nonnull
                                  Boolean forwardToReplicas)

Delete all rules in an index.

Parameters:

forwardToReplicas - Forward the request to the replicas if so

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

clearRules

default DeleteResponse clearRules(@Nonnull
                                  Boolean forwardToReplicas,
                                  RequestOptions requestOptions)

Delete all rules in an index.

Parameters:

forwardToReplicas - Forward the request to the replicas if so

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

clearRules

default DeleteResponse clearRules(RequestOptions requestOptions)

Delete all rules in an index.

Parameters:

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

clearRulesAsync

default CompletableFuture<DeleteResponse> clearRulesAsync()

Delete all rules in an index.

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

clearRulesAsync

default CompletableFuture<DeleteResponse> clearRulesAsync(@Nonnull
                                                          Boolean forwardToReplicas)

Delete all rules in an index.

Parameters:

forwardToReplicas - Forward the request to the replicas if so

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

clearRulesAsync

default CompletableFuture<DeleteResponse> clearRulesAsync(@Nonnull
                                                          Boolean forwardToReplicas,
                                                          RequestOptions requestOptions)

Delete all rules in an index.

Parameters:

forwardToReplicas - Forward the request to the replicas if so

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization

clearRulesAsync

default CompletableFuture<DeleteResponse> clearRulesAsync(RequestOptions requestOptions)

Delete all rules in an index.

Parameters:

requestOptions - Options to pass to this request

Throws:

AlgoliaRetryException - When the retry has failed on all hosts

AlgoliaApiException - When the API sends an http error code

AlgoliaRuntimeException - When an error occurred during the serialization