NameListRule¶

class oci.data_integration.models.NameListRule(**kwargs)¶

Bases: oci.data_integration.models.projection_rule.ProjectionRule

The name list rule which defines how fields are projected. For example, this may be all fields begining with STR.

Attributes

`MATCHING_STRATEGY_NAME_ONLY`	A constant which can be used with the matching_strategy property of a NameListRule.
`MATCHING_STRATEGY_NAME_OR_TAGS`	A constant which can be used with the matching_strategy property of a NameListRule.
`MATCHING_STRATEGY_TAGS_ONLY`	A constant which can be used with the matching_strategy property of a NameListRule.
`MODEL_TYPE_GROUPED_NAME_PATTERN_RULE`	str(object=’’) -> str
`MODEL_TYPE_NAME_LIST_RULE`	str(object=’’) -> str
`MODEL_TYPE_NAME_PATTERN_RULE`	str(object=’’) -> str
`MODEL_TYPE_RENAME_RULE`	str(object=’’) -> str
`MODEL_TYPE_TYPED_NAME_PATTERN_RULE`	str(object=’’) -> str
`MODEL_TYPE_TYPE_LIST_RULE`	str(object=’’) -> str
`RULE_TYPE_EXCLUDE`	A constant which can be used with the rule_type property of a NameListRule.
`RULE_TYPE_INCLUDE`	A constant which can be used with the rule_type property of a NameListRule.
`config_values`	Gets the config_values of this ProjectionRule.
`description`	Gets the description of this ProjectionRule.
`is_cascade`	Gets the is_cascade of this NameListRule.
`is_case_sensitive`	Gets the is_case_sensitive of this NameListRule.
`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 NameListRule.
`key`	Gets the key of this ProjectionRule.
`matching_strategy`	Gets the matching_strategy of this NameListRule.
`model_type`	[Required] Gets the model_type of this ProjectionRule.
`model_version`	Gets the model_version of this ProjectionRule.
`names`	Gets the names of this NameListRule.
`object_status`	Gets the object_status of this ProjectionRule.
`parent_ref`	Gets the parent_ref of this ProjectionRule.
`rule_type`	Gets the rule_type of this NameListRule.
`scope`	Gets the scope of this NameListRule.

Methods

`__init__`(**kwargs)	Initializes a new NameListRule 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 NameListRule. 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 NameListRule. 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 NameListRule. This constant has a value of “TAGS_ONLY”

MODEL_TYPE_GROUPED_NAME_PATTERN_RULE = 'GROUPED_NAME_PATTERN_RULE'¶

MODEL_TYPE_NAME_LIST_RULE = 'NAME_LIST_RULE'¶

MODEL_TYPE_NAME_PATTERN_RULE = 'NAME_PATTERN_RULE'¶

MODEL_TYPE_RENAME_RULE = 'RENAME_RULE'¶

MODEL_TYPE_TYPED_NAME_PATTERN_RULE = 'TYPED_NAME_PATTERN_RULE'¶

MODEL_TYPE_TYPE_LIST_RULE = 'TYPE_LIST_RULE'¶

RULE_TYPE_EXCLUDE = 'EXCLUDE'¶: A constant which can be used with the rule_type property of a NameListRule. This constant has a value of “EXCLUDE”

RULE_TYPE_INCLUDE = 'INCLUDE'¶: A constant which can be used with the rule_type property of a NameListRule. This constant has a value of “INCLUDE”

__init__(**kwargs)¶

Initializes a new NameListRule object with values from keyword arguments. The default value of the model_type attribute of this class is NAME_LIST_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 NameListRule. 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 NameListRule.
model_version (str) – The value to assign to the model_version property of this NameListRule.
parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this NameListRule.
is_java_regex_syntax (bool) – The value to assign to the is_java_regex_syntax property of this NameListRule.
config_values (oci.data_integration.models.ConfigValues) – The value to assign to the config_values property of this NameListRule.
object_status (int) – The value to assign to the object_status property of this NameListRule.
description (str) – The value to assign to the description property of this NameListRule.
is_skip_remaining_rules_on_match (bool) – The value to assign to the is_skip_remaining_rules_on_match property of this NameListRule.
scope (object) – The value to assign to the scope property of this NameListRule.
is_cascade (bool) – The value to assign to the is_cascade property of this NameListRule.
matching_strategy (str) – The value to assign to the matching_strategy property of this NameListRule. 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 NameListRule.
rule_type (str) – The value to assign to the rule_type property of this NameListRule. 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’.
names (list[str]) – The value to assign to the names property of this NameListRule.

config_values¶

Gets the config_values of this ProjectionRule.

Returns:	The config_values of this ProjectionRule.
Return type:	oci.data_integration.models.ConfigValues

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.

is_cascade¶

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

Returns:	The is_cascade of this NameListRule.
Return type:	bool

is_case_sensitive¶

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

Returns:	The is_case_sensitive of this NameListRule.
Return type:	bool

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

is_skip_remaining_rules_on_match¶

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

Returns:	The is_skip_remaining_rules_on_match of this NameListRule.
Return type:	bool

key¶

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

Returns:	The key of this ProjectionRule.
Return type:	str

matching_strategy¶

Gets the matching_strategy of this NameListRule. 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 NameListRule.
Return type:	str

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

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

names¶

Gets the names of this NameListRule. Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Returns:	The names of this NameListRule.
Return type:	list[str]

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

parent_ref¶

Gets the parent_ref of this ProjectionRule.

Returns:	The parent_ref of this ProjectionRule.
Return type:	oci.data_integration.models.ParentReference

rule_type¶

Gets the rule_type of this NameListRule. 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 NameListRule.
Return type:	str

scope¶

Gets the scope of this NameListRule. 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 NameListRule.
Return type:	object