SteeringPolicyFilterRule¶

class oci.dns.models.SteeringPolicyFilterRule(**kwargs)¶

Bases: oci.dns.models.steering_policy_rule.SteeringPolicyRule

SteeringPolicyFilterRule model.

Attributes

`RULE_TYPE_FILTER`	str(object=’’) -> str
`RULE_TYPE_HEALTH`	str(object=’’) -> str
`RULE_TYPE_LIMIT`	str(object=’’) -> str
`RULE_TYPE_PRIORITY`	str(object=’’) -> str
`RULE_TYPE_WEIGHTED`	str(object=’’) -> str
`cases`	Gets the cases of this SteeringPolicyFilterRule.
`default_answer_data`	Gets the default_answer_data of this SteeringPolicyFilterRule.
`description`	Gets the description of this SteeringPolicyRule.
`rule_type`	[Required] Gets the rule_type of this SteeringPolicyRule.

Methods

`__init__`(**kwargs)	Initializes a new SteeringPolicyFilterRule object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

RULE_TYPE_FILTER = 'FILTER'¶

RULE_TYPE_HEALTH = 'HEALTH'¶

RULE_TYPE_LIMIT = 'LIMIT'¶

RULE_TYPE_PRIORITY = 'PRIORITY'¶

RULE_TYPE_WEIGHTED = 'WEIGHTED'¶

__init__(**kwargs)¶

Initializes a new SteeringPolicyFilterRule object with values from keyword arguments. The default value of the rule_type attribute of this class is FILTER and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

description (str) – The value to assign to the description property of this SteeringPolicyFilterRule.
rule_type (str) – The value to assign to the rule_type property of this SteeringPolicyFilterRule. Allowed values for this property are: “FILTER”, “HEALTH”, “WEIGHTED”, “PRIORITY”, “LIMIT”
cases (list[oci.dns.models.SteeringPolicyFilterRuleCase]) – The value to assign to the cases property of this SteeringPolicyFilterRule.
default_answer_data (list[oci.dns.models.SteeringPolicyFilterAnswerData]) – The value to assign to the default_answer_data property of this SteeringPolicyFilterRule.

cases¶

Gets the cases of this SteeringPolicyFilterRule. An array of caseConditions. A rule may optionally include a sequence of cases defining alternate configurations for how it should behave during processing for any given DNS query. When a rule has no sequence of cases, it is always evaluated with the same configuration during processing. When a rule has an empty sequence of cases, it is always ignored during processing. When a rule has a non-empty sequence of cases, its behavior during processing is configured by the first matching case in the sequence. When a rule has no matching cases the rule is ignored. A rule case with no caseCondition always matches. A rule case with a caseCondition matches only when that expression evaluates to true for the given query.

Returns:	The cases of this SteeringPolicyFilterRule.
Return type:	list[oci.dns.models.SteeringPolicyFilterRuleCase]

default_answer_data¶

Gets the default_answer_data of this SteeringPolicyFilterRule. Defines a default set of answer conditions and values that are applied to an answer when cases is not defined for the rule, or a matching case does not have any matching answerCondition`s in its `answerData. defaultAnswerData is not applied if cases is defined and there are no matching cases. In this scenario, the next rule will be processed.

Returns:	The default_answer_data of this SteeringPolicyFilterRule.
Return type:	list[oci.dns.models.SteeringPolicyFilterAnswerData]

description¶

Gets the description of this SteeringPolicyRule. A user-defined description of the rule’s purpose or behavior.

Returns:	The description of this SteeringPolicyRule.
Return type:	str

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

rule_type¶

[Required] Gets the rule_type of this SteeringPolicyRule. The type of a rule determines its sorting/filtering behavior. * FILTER - Filters the list of answers based on their defined boolean data. Answers remain

only if their shouldKeep value is true.

HEALTH - Removes answers from the list if their rdata matches a target in the health check monitor referenced by the steering policy and the target is reported down.
WEIGHTED - Uses a number between 0 and 255 to determine how often an answer will be served in relation to other answers. Anwers with a higher weight will be served more frequently.
PRIORITY - Uses a defined rank value of answers to determine which answer to serve, moving those with the lowest values to the beginning of the list without changing the relative order of those with the same value. Answers can be given a value between 0 and 255.
LIMIT - Filters answers that are too far down the list. Parameter defaultCount specifies how many answers to keep. Example: If defaultCount has a value of 2 and there are five answers left, when the LIMIT rule is processed, only the first two answers will remain in the list.

Allowed values for this property are: “FILTER”, “HEALTH”, “WEIGHTED”, “PRIORITY”, “LIMIT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The rule_type of this SteeringPolicyRule.
Return type:	str