Class DeliveryRule


  • public final class DeliveryRule
    extends Object
    A rule that specifies a set of actions and conditions.
    • Constructor Detail

      • DeliveryRule

        public DeliveryRule()
    • Method Detail

      • name

        public String name()
        Get the name property: Name of the rule.
        Returns:
        the name value.
      • withName

        public DeliveryRule withName​(String name)
        Set the name property: Name of the rule.
        Parameters:
        name - the name value to set.
        Returns:
        the DeliveryRule object itself.
      • order

        public int order()
        Get the order property: The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.
        Returns:
        the order value.
      • withOrder

        public DeliveryRule withOrder​(int order)
        Set the order property: The order in which the rules are applied for the endpoint. Possible values {0,1,2,3,………}. A rule with a lesser order will be applied before a rule with a greater order. Rule with order 0 is a special rule. It does not require any condition and actions listed in it will always be applied.
        Parameters:
        order - the order value to set.
        Returns:
        the DeliveryRule object itself.
      • conditions

        public List<DeliveryRuleCondition> conditions()
        Get the conditions property: A list of conditions that must be matched for the actions to be executed.
        Returns:
        the conditions value.
      • withConditions

        public DeliveryRule withConditions​(List<DeliveryRuleCondition> conditions)
        Set the conditions property: A list of conditions that must be matched for the actions to be executed.
        Parameters:
        conditions - the conditions value to set.
        Returns:
        the DeliveryRule object itself.
      • actions

        public List<DeliveryRuleAction> actions()
        Get the actions property: A list of actions that are executed when all the conditions of a rule are satisfied.
        Returns:
        the actions value.
      • withActions

        public DeliveryRule withActions​(List<DeliveryRuleAction> actions)
        Set the actions property: A list of actions that are executed when all the conditions of a rule are satisfied.
        Parameters:
        actions - the actions value to set.
        Returns:
        the DeliveryRule object itself.
      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.