SubsettingRule¶

class oci.data_safe.models.SubsettingRule(**kwargs)¶

Bases: object

Defines a rule for subsetting data in specific tables or schemas, including scope and processing strategies

Attributes

`PEER_TABLES_ACTION_MAXIMUM_ROWS`	A constant which can be used with the peer_tables_action property of a SubsettingRule.
`PEER_TABLES_ACTION_MINIMUM_ROWS`	A constant which can be used with the peer_tables_action property of a SubsettingRule.
`PEER_TABLES_ACTION_SUBSET`	A constant which can be used with the peer_tables_action property of a SubsettingRule.
`RELATED_TABLES_PROPAGATION_ANCESTORS`	A constant which can be used with the related_tables_propagation property of a SubsettingRule.
`RELATED_TABLES_PROPAGATION_ANCESTORS_AND_DESCENDANTS`	A constant which can be used with the related_tables_propagation property of a SubsettingRule.
`RELATED_TABLES_PROPAGATION_DESCENDANTS`	A constant which can be used with the related_tables_propagation property of a SubsettingRule.
`RELATED_TABLES_PROPAGATION_NONE`	A constant which can be used with the related_tables_propagation property of a SubsettingRule.
`RULE_COMBINATION_MODE_SERIAL`	A constant which can be used with the rule_combination_mode property of a SubsettingRule.
`RULE_COMBINATION_MODE_UNION`	A constant which can be used with the rule_combination_mode property of a SubsettingRule.
`description`	Gets the description of this SubsettingRule.
`display_name`	Gets the display_name of this SubsettingRule.
`key`	[Required] Gets the key of this SubsettingRule.
`peer_tables_action`	[Required] Gets the peer_tables_action of this SubsettingRule.
`related_tables_propagation`	[Required] Gets the related_tables_propagation of this SubsettingRule.
`rule_combination_mode`	Gets the rule_combination_mode of this SubsettingRule.
`scope`	[Required] Gets the scope of this SubsettingRule.
`subset_rule_entry`	[Required] Gets the subset_rule_entry of this SubsettingRule.

Methods

__init__(**kwargs) Initializes a new SubsettingRule object with values from keyword arguments.

PEER_TABLES_ACTION_MAXIMUM_ROWS = 'MAXIMUM_ROWS'¶: A constant which can be used with the peer_tables_action property of a SubsettingRule. This constant has a value of “MAXIMUM_ROWS”

PEER_TABLES_ACTION_MINIMUM_ROWS = 'MINIMUM_ROWS'¶: A constant which can be used with the peer_tables_action property of a SubsettingRule. This constant has a value of “MINIMUM_ROWS”

PEER_TABLES_ACTION_SUBSET = 'SUBSET'¶: A constant which can be used with the peer_tables_action property of a SubsettingRule. This constant has a value of “SUBSET”

RELATED_TABLES_PROPAGATION_ANCESTORS = 'ANCESTORS'¶: A constant which can be used with the related_tables_propagation property of a SubsettingRule. This constant has a value of “ANCESTORS”

RELATED_TABLES_PROPAGATION_ANCESTORS_AND_DESCENDANTS = 'ANCESTORS_AND_DESCENDANTS'¶: A constant which can be used with the related_tables_propagation property of a SubsettingRule. This constant has a value of “ANCESTORS_AND_DESCENDANTS”

RELATED_TABLES_PROPAGATION_DESCENDANTS = 'DESCENDANTS'¶: A constant which can be used with the related_tables_propagation property of a SubsettingRule. This constant has a value of “DESCENDANTS”

RELATED_TABLES_PROPAGATION_NONE = 'NONE'¶: A constant which can be used with the related_tables_propagation property of a SubsettingRule. This constant has a value of “NONE”

RULE_COMBINATION_MODE_SERIAL = 'SERIAL'¶: A constant which can be used with the rule_combination_mode property of a SubsettingRule. This constant has a value of “SERIAL”

RULE_COMBINATION_MODE_UNION = 'UNION'¶: A constant which can be used with the rule_combination_mode property of a SubsettingRule. This constant has a value of “UNION”

__init__(**kwargs)¶

Initializes a new SubsettingRule object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

key (str) – The value to assign to the key property of this SubsettingRule.
description (str) – The value to assign to the description property of this SubsettingRule.
display_name (str) – The value to assign to the display_name property of this SubsettingRule.
scope (oci.data_safe.models.SubsetScope) – The value to assign to the scope property of this SubsettingRule.
subset_rule_entry (oci.data_safe.models.SubsetRuleEntry) – The value to assign to the subset_rule_entry property of this SubsettingRule.
rule_combination_mode (str) – The value to assign to the rule_combination_mode property of this SubsettingRule. Allowed values for this property are: “UNION”, “SERIAL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
related_tables_propagation (str) – The value to assign to the related_tables_propagation property of this SubsettingRule. Allowed values for this property are: “ANCESTORS_AND_DESCENDANTS”, “ANCESTORS”, “DESCENDANTS”, “NONE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
peer_tables_action (str) – The value to assign to the peer_tables_action property of this SubsettingRule. Allowed values for this property are: “MINIMUM_ROWS”, “SUBSET”, “MAXIMUM_ROWS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

description¶

Gets the description of this SubsettingRule. The description of the subset rule

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

display_name¶

Gets the display_name of this SubsettingRule. The display name of the subset rule

Returns:	The display_name of this SubsettingRule.
Return type:	str

key¶

[Required] Gets the key of this SubsettingRule. The unique key that identifies a subsetting rule. The key is numeric and unique within a subsetting policy

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

peer_tables_action¶

[Required] Gets the peer_tables_action of this SubsettingRule. Strategy to be applied while processing peer tables

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

Returns:	The peer_tables_action of this SubsettingRule.
Return type:	str

related_tables_propagation¶

[Required] Gets the related_tables_propagation of this SubsettingRule. Strategy to be applied while propagating subsetting rule to related tables

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

Returns:	The related_tables_propagation of this SubsettingRule.
Return type:	str

rule_combination_mode¶

Gets the rule_combination_mode of this SubsettingRule. Specifies how this rule combines with other rules. UNION evaluates this rule independently and adds matching rows to the result set. SERIAL applies this rule sequentially to filter rows selected by a compatible preceding rule.

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

Returns:	The rule_combination_mode of this SubsettingRule.
Return type:	str

scope¶

[Required] Gets the scope of this SubsettingRule.

Returns:	The scope of this SubsettingRule.
Return type:	oci.data_safe.models.SubsetScope

subset_rule_entry¶

[Required] Gets the subset_rule_entry of this SubsettingRule.

Returns:	The subset_rule_entry of this SubsettingRule.
Return type:	oci.data_safe.models.SubsetRuleEntry