PathMatchCondition¶

class oci.load_balancer.models.PathMatchCondition(**kwargs)¶

Bases: oci.load_balancer.models.rule_condition.RuleCondition

The path string and match condition to apply when evaluating an incoming URI for redirection.

Attributes

`ATTRIBUTE_NAME_PATH`	str(object=’’) -> str
`ATTRIBUTE_NAME_SOURCE_IP_ADDRESS`	str(object=’’) -> str
`ATTRIBUTE_NAME_SOURCE_VCN_ID`	str(object=’’) -> str
`ATTRIBUTE_NAME_SOURCE_VCN_IP_ADDRESS`	str(object=’’) -> str
`OPERATOR_EXACT_MATCH`	A constant which can be used with the operator property of a PathMatchCondition.
`OPERATOR_FORCE_LONGEST_PREFIX_MATCH`	A constant which can be used with the operator property of a PathMatchCondition.
`OPERATOR_PREFIX_MATCH`	A constant which can be used with the operator property of a PathMatchCondition.
`OPERATOR_SUFFIX_MATCH`	A constant which can be used with the operator property of a PathMatchCondition.
`attribute_name`	[Required] Gets the attribute_name of this RuleCondition.
`attribute_value`	[Required] Gets the attribute_value of this PathMatchCondition.
`operator`	[Required] Gets the operator of this PathMatchCondition.

Methods

`__init__`(**kwargs)	Initializes a new PathMatchCondition 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.

ATTRIBUTE_NAME_PATH = 'PATH'¶

ATTRIBUTE_NAME_SOURCE_IP_ADDRESS = 'SOURCE_IP_ADDRESS'¶

ATTRIBUTE_NAME_SOURCE_VCN_ID = 'SOURCE_VCN_ID'¶

ATTRIBUTE_NAME_SOURCE_VCN_IP_ADDRESS = 'SOURCE_VCN_IP_ADDRESS'¶

OPERATOR_EXACT_MATCH = 'EXACT_MATCH'¶: A constant which can be used with the operator property of a PathMatchCondition. This constant has a value of “EXACT_MATCH”

OPERATOR_FORCE_LONGEST_PREFIX_MATCH = 'FORCE_LONGEST_PREFIX_MATCH'¶: A constant which can be used with the operator property of a PathMatchCondition. This constant has a value of “FORCE_LONGEST_PREFIX_MATCH”

OPERATOR_PREFIX_MATCH = 'PREFIX_MATCH'¶: A constant which can be used with the operator property of a PathMatchCondition. This constant has a value of “PREFIX_MATCH”

OPERATOR_SUFFIX_MATCH = 'SUFFIX_MATCH'¶: A constant which can be used with the operator property of a PathMatchCondition. This constant has a value of “SUFFIX_MATCH”

__init__(**kwargs)¶

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

Parameters:

attribute_name (str) – The value to assign to the attribute_name property of this PathMatchCondition. Allowed values for this property are: “SOURCE_IP_ADDRESS”, “SOURCE_VCN_ID”, “SOURCE_VCN_IP_ADDRESS”, “PATH”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
attribute_value (str) – The value to assign to the attribute_value property of this PathMatchCondition.
operator (str) – The value to assign to the operator property of this PathMatchCondition. Allowed values for this property are: “EXACT_MATCH”, “FORCE_LONGEST_PREFIX_MATCH”, “PREFIX_MATCH”, “SUFFIX_MATCH”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

attribute_name¶

[Required] Gets the attribute_name of this RuleCondition. Allowed values for this property are: “SOURCE_IP_ADDRESS”, “SOURCE_VCN_ID”, “SOURCE_VCN_IP_ADDRESS”, “PATH”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The attribute_name of this RuleCondition.
Return type:	str

attribute_value¶

[Required] Gets the attribute_value of this PathMatchCondition. The path string that the redirection rule applies to.

Example: /example

Returns:	The attribute_value of this PathMatchCondition.
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.

operator¶

[Required] Gets the operator of this PathMatchCondition. A string that specifies how to compare the PathMatchCondition object’s attributeValue string to the incoming URI.

EXACT_MATCH - The incoming URI path must exactly and completely match the attributeValue string.
FORCE_LONGEST_PREFIX_MATCH - The system looks for the attributeValue string with the best, longest match of the beginning portion of the incoming URI path.
PREFIX_MATCH - The beginning portion of the incoming URI path must exactly match the attributeValue string.
SUFFIX_MATCH - The ending portion of the incoming URI path must exactly match the attributeValue string.

Allowed values for this property are: “EXACT_MATCH”, “FORCE_LONGEST_PREFIX_MATCH”, “PREFIX_MATCH”, “SUFFIX_MATCH”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The operator of this PathMatchCondition.
Return type:	str