NamePatternRule

class oci.data_integration.models.NamePatternRule(**kwargs)

Bases: ProjectionRule

This rule projects fields by a name pattern, for example it may start with STR_ or end with _DATE. This is defined using a regular expression.

Attributes:

MATCHING_STRATEGY_NAME_ONLY	A constant which can be used with the matching_strategy property of a NamePatternRule.
MATCHING_STRATEGY_NAME_OR_TAGS	A constant which can be used with the matching_strategy property of a NamePatternRule.
MATCHING_STRATEGY_TAGS_ONLY	A constant which can be used with the matching_strategy property of a NamePatternRule.
MODEL_TYPE_GROUPED_NAME_PATTERN_RULE	A constant which can be used with the model_type property of a ProjectionRule.
MODEL_TYPE_NAME_LIST_RULE	A constant which can be used with the model_type property of a ProjectionRule.
MODEL_TYPE_NAME_PATTERN_RULE	A constant which can be used with the model_type property of a ProjectionRule.
MODEL_TYPE_RENAME_RULE	A constant which can be used with the model_type property of a ProjectionRule.
MODEL_TYPE_TYPED_NAME_PATTERN_RULE	A constant which can be used with the model_type property of a ProjectionRule.
MODEL_TYPE_TYPE_LIST_RULE	A constant which can be used with the model_type property of a ProjectionRule.
RULE_TYPE_EXCLUDE	A constant which can be used with the rule_type property of a NamePatternRule.
RULE_TYPE_INCLUDE	A constant which can be used with the rule_type property of a NamePatternRule.
config_values	Gets the config_values of this ProjectionRule.
description	Gets the description of this ProjectionRule.
is_cascade	Gets the is_cascade of this NamePatternRule.
is_case_sensitive	Gets the is_case_sensitive of this NamePatternRule.
is_java_regex_syntax	Gets the is_java_regex_syntax of this ProjectionRule.
is_skip_remaining_rules_on_match	Gets the is_skip_remaining_rules_on_match of this NamePatternRule.
key	Gets the key of this ProjectionRule.
matching_strategy	Gets the matching_strategy of this NamePatternRule.
model_type	[Required] Gets the model_type of this ProjectionRule.
model_version	Gets the model_version of this ProjectionRule.
object_status	Gets the object_status of this ProjectionRule.
parent_ref	Gets the parent_ref of this ProjectionRule.
pattern	Gets the pattern of this NamePatternRule.
rule_type	Gets the rule_type of this NamePatternRule.
scope	Gets the scope of this NamePatternRule.

Methods:

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

MATCHING_STRATEGY_NAME_ONLY = 'NAME_ONLY'

A constant which can be used with the matching_strategy property of a NamePatternRule. This constant has a value of “NAME_ONLY”

MATCHING_STRATEGY_NAME_OR_TAGS = 'NAME_OR_TAGS'

A constant which can be used with the matching_strategy property of a NamePatternRule. This constant has a value of “NAME_OR_TAGS”

MATCHING_STRATEGY_TAGS_ONLY = 'TAGS_ONLY'

A constant which can be used with the matching_strategy property of a NamePatternRule. This constant has a value of “TAGS_ONLY”

MODEL_TYPE_GROUPED_NAME_PATTERN_RULE = 'GROUPED_NAME_PATTERN_RULE'

A constant which can be used with the model_type property of a ProjectionRule. This constant has a value of “GROUPED_NAME_PATTERN_RULE”

MODEL_TYPE_NAME_LIST_RULE = 'NAME_LIST_RULE'

A constant which can be used with the model_type property of a ProjectionRule. This constant has a value of “NAME_LIST_RULE”

MODEL_TYPE_NAME_PATTERN_RULE = 'NAME_PATTERN_RULE'

A constant which can be used with the model_type property of a ProjectionRule. This constant has a value of “NAME_PATTERN_RULE”

MODEL_TYPE_RENAME_RULE = 'RENAME_RULE'

A constant which can be used with the model_type property of a ProjectionRule. This constant has a value of “RENAME_RULE”

MODEL_TYPE_TYPED_NAME_PATTERN_RULE = 'TYPED_NAME_PATTERN_RULE'

A constant which can be used with the model_type property of a ProjectionRule. This constant has a value of “TYPED_NAME_PATTERN_RULE”

MODEL_TYPE_TYPE_LIST_RULE = 'TYPE_LIST_RULE'

A constant which can be used with the model_type property of a ProjectionRule. This constant has a value of “TYPE_LIST_RULE”

RULE_TYPE_EXCLUDE = 'EXCLUDE'

A constant which can be used with the rule_type property of a NamePatternRule. This constant has a value of “EXCLUDE”

RULE_TYPE_INCLUDE = 'INCLUDE'

A constant which can be used with the rule_type property of a NamePatternRule. This constant has a value of “INCLUDE”

__init__(**kwargs)

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

Parameters

• model_type (str) – The value to assign to the model_type property of this NamePatternRule. Allowed values for this property are: “NAME_PATTERN_RULE”, “TYPE_LIST_RULE”, “NAME_LIST_RULE”, “TYPED_NAME_PATTERN_RULE”, “RENAME_RULE”, “GROUPED_NAME_PATTERN_RULE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

• key (str) – The value to assign to the key property of this NamePatternRule.

• model_version (str) – The value to assign to the model_version property of this NamePatternRule.

• parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this NamePatternRule.

• is_java_regex_syntax (bool) – The value to assign to the is_java_regex_syntax property of this NamePatternRule.

• config_values (oci.data_integration.models.ConfigValues) – The value to assign to the config_values property of this NamePatternRule.

• object_status (int) – The value to assign to the object_status property of this NamePatternRule.

• description (str) – The value to assign to the description property of this NamePatternRule.

• is_skip_remaining_rules_on_match (bool) – The value to assign to the is_skip_remaining_rules_on_match property of this NamePatternRule.

• scope (object) – The value to assign to the scope property of this NamePatternRule.

• is_cascade (bool) – The value to assign to the is_cascade property of this NamePatternRule.

• matching_strategy (str) – The value to assign to the matching_strategy property of this NamePatternRule. Allowed values for this property are: “NAME_OR_TAGS”, “TAGS_ONLY”, “NAME_ONLY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

• is_case_sensitive (bool) – The value to assign to the is_case_sensitive property of this NamePatternRule.

• rule_type (str) – The value to assign to the rule_type property of this NamePatternRule. Allowed values for this property are: “INCLUDE”, “EXCLUDE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

• pattern (str) – The value to assign to the pattern property of this NamePatternRule.

property config_values

Gets the config_values of this ProjectionRule.

Returns

The config_values of this ProjectionRule.

Return type

oci.data_integration.models.ConfigValues

property description

Gets the description of this ProjectionRule. A user defined description for the object.

Returns

The description of this ProjectionRule.

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.

property is_cascade

Gets the is_cascade of this NamePatternRule. Specifies whether to cascade or not.

Returns

The is_cascade of this NamePatternRule.

Return type

bool

property is_case_sensitive

Gets the is_case_sensitive of this NamePatternRule. Specifies if the rule is case sensitive.

Returns

The is_case_sensitive of this NamePatternRule.

Return type

bool

property is_java_regex_syntax

Gets the is_java_regex_syntax of this ProjectionRule. Specifies whether the rule uses a java regex syntax.

Returns

The is_java_regex_syntax of this ProjectionRule.

Return type

bool

property is_skip_remaining_rules_on_match

Gets the is_skip_remaining_rules_on_match of this NamePatternRule. Specifies whether to skip remaining rules when a match is found.

Returns

The is_skip_remaining_rules_on_match of this NamePatternRule.

Return type

bool

property key

Gets the key of this ProjectionRule. The key of the object.

Returns

The key of this ProjectionRule.

Return type

str

property matching_strategy

Gets the matching_strategy of this NamePatternRule. The pattern matching strategy.

Allowed values for this property are: “NAME_OR_TAGS”, “TAGS_ONLY”, “NAME_ONLY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The matching_strategy of this NamePatternRule.

Return type

str

property model_type

[Required] Gets the model_type of this ProjectionRule. The type of the project rule.

Allowed values for this property are: “NAME_PATTERN_RULE”, “TYPE_LIST_RULE”, “NAME_LIST_RULE”, “TYPED_NAME_PATTERN_RULE”, “RENAME_RULE”, “GROUPED_NAME_PATTERN_RULE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The model_type of this ProjectionRule.

Return type

str

property model_version

Gets the model_version of this ProjectionRule. The model version of an object.

Returns

The model_version of this ProjectionRule.

Return type

str

property object_status

Gets the object_status of this ProjectionRule. The status of an object that can be set to value 1 for shallow references across objects, other values reserved.

Returns

The object_status of this ProjectionRule.

Return type

int

property parent_ref

Gets the parent_ref of this ProjectionRule.

Returns

The parent_ref of this ProjectionRule.

Return type

oci.data_integration.models.ParentReference

property pattern

Gets the pattern of this NamePatternRule. The rule pattern.

Returns

The pattern of this NamePatternRule.

Return type

str

property rule_type

Gets the rule_type of this NamePatternRule. The rule type.

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

Returns

The rule_type of this NamePatternRule.

Return type

str

property scope

Gets the scope of this NamePatternRule. Reference to a typed object. This can be either a key value to an object within the document, a shall referenced to a TypedObject, or a full TypedObject definition.

Returns

The scope of this NamePatternRule.

Return type

object