Package com.algolia.model.search

Class Rule

java.lang.Object
com.algolia.model.search.Rule
public class Rule extends Object
Rule object.

  • Constructor Details

    • Rule

      public Rule()

  • Method Details

    • setObjectID

      public Rule setObjectID(String objectID)

    • getObjectID

      @Nonnull public String getObjectID()
      Unique identifier for a rule object.
      Returns:
      objectID

    • setConditions

      public Rule setConditions(List<Condition> conditions)

    • addConditions

      public Rule addConditions(Condition conditionsItem)

    • getConditions

      @Nullable public List<Condition> getConditions()
      [Conditions](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/#conditions) required to activate a rule. You can use up to 25 conditions per rule.
      Returns:
      conditions

    • setConsequence

      public Rule setConsequence(Consequence consequence)

    • getConsequence

      @Nullable public Consequence getConsequence()
      Get consequence
      Returns:
      consequence

    • setDescription

      public Rule setDescription(String description)

    • getDescription

      @Nullable public String getDescription()
      Description of the rule's purpose. This can be helpful for display in the Algolia dashboard.
      Returns:
      description

    • setEnabled

      public Rule setEnabled(Boolean enabled)

    • getEnabled

      @Nullable public Boolean getEnabled()
      Indicates whether to enable the rule. If it isn't enabled, it isn't applied at query time.
      Returns:
      enabled

    • setValidity

      public Rule setValidity(List<TimeRange> validity)

    • addValidity

      public Rule addValidity(TimeRange validityItem)

    • getValidity

      @Nullable public List<TimeRange> getValidity()
      If you specify a validity period, the rule _only_ applies only during that period. If specified, the array must not be empty.
      Returns:
      validity

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object