RuleProperties Class

public final class RuleProperties
extends RuleUpdatePropertiesParameters

The JSON object that contains the properties of the Rules to create.

Constructor Summary

Constructor Description
RuleProperties()

Creates an instance of RuleProperties class.

Method Summary

Modifier and Type Method and Description
DeploymentStatus deploymentStatus()

Get the deploymentStatus property: The deploymentStatus property.

static RuleProperties fromJson(JsonReader jsonReader)

Reads an instance of RuleProperties from the JsonReader.

AfdProvisioningState provisioningState()

Get the provisioningState property: Provisioning status.

String ruleSetName()

Get the ruleSetName property: The name of the rule set containing the rule.

JsonWriter toJson(JsonWriter jsonWriter)
void validate()

Validates the instance.

RuleProperties withActions(List<DeliveryRuleAction> actions)

Set the actions property: A list of actions that are executed when all the conditions of a rule are satisfied.

RuleProperties withConditions(List<DeliveryRuleCondition> conditions)

Set the conditions property: A list of conditions that must be matched for the actions to be executed.

RuleProperties withMatchProcessingBehavior(MatchProcessingBehavior matchProcessingBehavior)

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

RuleProperties withOrder(Integer order)

Set the order property: The order in which the rules are applied for the endpoint.

Methods inherited from RuleUpdatePropertiesParameters

Methods inherited from java.lang.Object

Constructor Details

RuleProperties

public RuleProperties()

Creates an instance of RuleProperties class.

Method Details

deploymentStatus

public DeploymentStatus deploymentStatus()

Get the deploymentStatus property: The deploymentStatus property.

Returns:

the deploymentStatus value.

fromJson

public static RuleProperties fromJson(JsonReader jsonReader)

Reads an instance of RuleProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of RuleProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the RuleProperties.

provisioningState

public AfdProvisioningState provisioningState()

Get the provisioningState property: Provisioning status.

Returns:

the provisioningState value.

ruleSetName

public String ruleSetName()

Get the ruleSetName property: The name of the rule set containing the rule.

Overrides:

RuleProperties.ruleSetName()

Returns:

the ruleSetName value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

RuleProperties.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

validate

public void validate()

Validates the instance.

Overrides:

RuleProperties.validate()

withActions

public RuleProperties withActions(List<DeliveryRuleAction> actions)

Set the actions property: A list of actions that are executed when all the conditions of a rule are satisfied.

Overrides:

RuleProperties.withActions(List<DeliveryRuleAction> actions)

Parameters:

actions

withConditions

public RuleProperties withConditions(List<DeliveryRuleCondition> conditions)

Set the conditions property: A list of conditions that must be matched for the actions to be executed.

Overrides:

RuleProperties.withConditions(List<DeliveryRuleCondition> conditions)

Parameters:

conditions

withMatchProcessingBehavior

public RuleProperties 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.

Overrides:

RuleProperties.withMatchProcessingBehavior(MatchProcessingBehavior matchProcessingBehavior)

Parameters:

matchProcessingBehavior

withOrder

public RuleProperties withOrder(Integer 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.

Overrides:

RuleProperties.withOrder(Integer order)

Parameters:

order

Applies to