RulesEngineRule Class

  • java.lang.Object
    • com.azure.resourcemanager.frontdoor.models.RulesEngineRule

public final class RulesEngineRule

Contains a list of match conditions, and an action on how to modify the request/response. If multiple rules match, the actions from one rule that conflict with a previous rule overwrite for a singular action, or append in the case of headers manipulation.

Constructor Summary

Constructor Description
RulesEngineRule()

Creates an instance of RulesEngineRule class.

Method Summary

Modifier and Type Method and Description
RulesEngineAction action()

Get the action property: Actions to perform on the request and response if all of the match conditions are met.

List<RulesEngineMatchCondition> matchConditions()

Get the matchConditions property: A list of match conditions that must meet in order for the actions of this rule to run.

MatchProcessingBehavior matchProcessingBehavior()

Get the matchProcessingBehavior property: If this rule is a match should the rules engine continue running the remaining rules or stop.

String name()

Get the name property: A name to refer to this specific rule.

int priority()

Get the priority property: A priority assigned to this rule.

void validate()

Validates the instance.

RulesEngineRule withAction(RulesEngineAction action)

Set the action property: Actions to perform on the request and response if all of the match conditions are met.

RulesEngineRule withMatchConditions(List<RulesEngineMatchCondition> matchConditions)

Set the matchConditions property: A list of match conditions that must meet in order for the actions of this rule to run.

RulesEngineRule withMatchProcessingBehavior(MatchProcessingBehavior matchProcessingBehavior)

Set the matchProcessingBehavior property: If this rule is a match should the rules engine continue running the remaining rules or stop.

RulesEngineRule withName(String name)

Set the name property: A name to refer to this specific rule.

RulesEngineRule withPriority(int priority)

Set the priority property: A priority assigned to this rule.

Methods inherited from java.lang.Object

Constructor Details

RulesEngineRule

public RulesEngineRule()

Creates an instance of RulesEngineRule class.

Method Details

action

public RulesEngineAction action()

Get the action property: Actions to perform on the request and response if all of the match conditions are met.

Returns:

the action value.

matchConditions

public List matchConditions()

Get the matchConditions property: A list of match conditions that must meet in order for the actions of this rule to run. Having no match conditions means the actions will always run.

Returns:

the matchConditions value.

matchProcessingBehavior

public MatchProcessingBehavior matchProcessingBehavior()

Get the matchProcessingBehavior property: If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue.

Returns:

the matchProcessingBehavior value.

name

public String name()

Get the name property: A name to refer to this specific rule.

Returns:

the name value.

priority

public int priority()

Get the priority property: A priority assigned to this rule.

Returns:

the priority value.

validate

public void validate()

Validates the instance.

withAction

public RulesEngineRule withAction(RulesEngineAction action)

Set the action property: Actions to perform on the request and response if all of the match conditions are met.

Parameters:

action - the action value to set.

Returns:

the RulesEngineRule object itself.

withMatchConditions

public RulesEngineRule withMatchConditions(List matchConditions)

Set the matchConditions property: A list of match conditions that must meet in order for the actions of this rule to run. Having no match conditions means the actions will always run.

Parameters:

matchConditions - the matchConditions value to set.

Returns:

the RulesEngineRule object itself.

withMatchProcessingBehavior

public RulesEngineRule withMatchProcessingBehavior(MatchProcessingBehavior matchProcessingBehavior)

Set the matchProcessingBehavior property: If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue.

Parameters:

matchProcessingBehavior - the matchProcessingBehavior value to set.

Returns:

the RulesEngineRule object itself.

withName

public RulesEngineRule withName(String name)

Set the name property: A name to refer to this specific rule.

Parameters:

name - the name value to set.

Returns:

the RulesEngineRule object itself.

withPriority

public RulesEngineRule withPriority(int priority)

Set the priority property: A priority assigned to this rule.

Parameters:

priority - the priority value to set.

Returns:

the RulesEngineRule object itself.

Applies to