ProjectionRule

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

Bases: object

Base type for how fields are projected. There are many different mechanisms for doing this such as by a name pattern, datatype and so on. See the modelType property for the types.

Attributes:

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.

config_values

Gets the config_values of this ProjectionRule.

description

Gets the description of this ProjectionRule.

is_java_regex_syntax

Gets the is_java_regex_syntax of this ProjectionRule.

key

Gets the key of this ProjectionRule.

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.

Methods:

__init__(**kwargs)

Initializes a new ProjectionRule 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.

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”

__init__(**kwargs)

Initializes a new ProjectionRule object with values from keyword arguments. This class has the following subclasses and if you are using this class as input to a service operations then you should favor using a subclass over the base class:

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 ProjectionRule. 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 ProjectionRule.

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

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

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

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

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

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

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_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 key

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

Returns

The key of this ProjectionRule.

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