MacroField¶

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

Bases: oci.data_integration.models.typed_object.TypedObject

The type representing the macro field concept. Macro fields have an expression to define a macro.

Attributes

`MODEL_TYPE_CONDITIONAL_OUTPUT_PORT`	str(object=’’) -> str
`MODEL_TYPE_DECISION_OUTPUT_PORT`	str(object=’’) -> str
`MODEL_TYPE_DERIVED_FIELD`	str(object=’’) -> str
`MODEL_TYPE_DYNAMIC_INPUT_FIELD`	str(object=’’) -> str
`MODEL_TYPE_DYNAMIC_PROXY_FIELD`	str(object=’’) -> str
`MODEL_TYPE_INPUT_FIELD`	str(object=’’) -> str
`MODEL_TYPE_INPUT_PORT`	str(object=’’) -> str
`MODEL_TYPE_INPUT_PROXY_FIELD`	str(object=’’) -> str
`MODEL_TYPE_MACRO_FIELD`	str(object=’’) -> str
`MODEL_TYPE_MACRO_PIVOT_FIELD`	str(object=’’) -> str
`MODEL_TYPE_MATERIALIZED_DYNAMIC_FIELD`	str(object=’’) -> str
`MODEL_TYPE_OUTPUT_FIELD`	str(object=’’) -> str
`MODEL_TYPE_OUTPUT_PORT`	str(object=’’) -> str
`MODEL_TYPE_PARAMETER`	str(object=’’) -> str
`MODEL_TYPE_PIVOT_FIELD`	str(object=’’) -> str
`MODEL_TYPE_PROXY_FIELD`	str(object=’’) -> str
`MODEL_TYPE_SHAPE`	str(object=’’) -> str
`MODEL_TYPE_SHAPE_FIELD`	str(object=’’) -> str
`config_values`	Gets the config_values of this TypedObject.
`description`	Gets the description of this TypedObject.
`expr`	Gets the expr of this MacroField.
`is_use_source_type`	Gets the is_use_source_type of this MacroField.
`key`	Gets the key of this TypedObject.
`labels`	Gets the labels of this MacroField.
`model_type`	[Required] Gets the model_type of this TypedObject.
`model_version`	Gets the model_version of this TypedObject.
`name`	Gets the name of this TypedObject.
`object_status`	Gets the object_status of this TypedObject.
`parent_ref`	Gets the parent_ref of this TypedObject.
`type`	Gets the type of this MacroField.
`use_type`	Gets the use_type of this MacroField.

Methods

`__init__`(**kwargs)	Initializes a new MacroField 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_CONDITIONAL_OUTPUT_PORT = 'CONDITIONAL_OUTPUT_PORT'¶

MODEL_TYPE_DECISION_OUTPUT_PORT = 'DECISION_OUTPUT_PORT'¶

MODEL_TYPE_DERIVED_FIELD = 'DERIVED_FIELD'¶

MODEL_TYPE_DYNAMIC_INPUT_FIELD = 'DYNAMIC_INPUT_FIELD'¶

MODEL_TYPE_DYNAMIC_PROXY_FIELD = 'DYNAMIC_PROXY_FIELD'¶

MODEL_TYPE_INPUT_FIELD = 'INPUT_FIELD'¶

MODEL_TYPE_INPUT_PORT = 'INPUT_PORT'¶

MODEL_TYPE_INPUT_PROXY_FIELD = 'INPUT_PROXY_FIELD'¶

MODEL_TYPE_MACRO_FIELD = 'MACRO_FIELD'¶

MODEL_TYPE_MACRO_PIVOT_FIELD = 'MACRO_PIVOT_FIELD'¶

MODEL_TYPE_MATERIALIZED_DYNAMIC_FIELD = 'MATERIALIZED_DYNAMIC_FIELD'¶

MODEL_TYPE_OUTPUT_FIELD = 'OUTPUT_FIELD'¶

MODEL_TYPE_OUTPUT_PORT = 'OUTPUT_PORT'¶

MODEL_TYPE_PARAMETER = 'PARAMETER'¶

MODEL_TYPE_PIVOT_FIELD = 'PIVOT_FIELD'¶

MODEL_TYPE_PROXY_FIELD = 'PROXY_FIELD'¶

MODEL_TYPE_SHAPE = 'SHAPE'¶

MODEL_TYPE_SHAPE_FIELD = 'SHAPE_FIELD'¶

__init__(**kwargs)¶

Initializes a new MacroField object with values from keyword arguments. The default value of the model_type attribute of this class is MACRO_FIELD 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 MacroField. Allowed values for this property are: “SHAPE”, “INPUT_PORT”, “SHAPE_FIELD”, “INPUT_FIELD”, “DERIVED_FIELD”, “MACRO_FIELD”, “OUTPUT_FIELD”, “DYNAMIC_PROXY_FIELD”, “OUTPUT_PORT”, “DYNAMIC_INPUT_FIELD”, “PROXY_FIELD”, “PARAMETER”, “PIVOT_FIELD”, “MACRO_PIVOT_FIELD”, “CONDITIONAL_OUTPUT_PORT”, “INPUT_PROXY_FIELD”, “MATERIALIZED_DYNAMIC_FIELD”, “DECISION_OUTPUT_PORT”
key (str) – The value to assign to the key property of this MacroField.
model_version (str) – The value to assign to the model_version property of this MacroField.
parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this MacroField.
config_values (oci.data_integration.models.ConfigValues) – The value to assign to the config_values property of this MacroField.
object_status (int) – The value to assign to the object_status property of this MacroField.
name (str) – The value to assign to the name property of this MacroField.
description (str) – The value to assign to the description property of this MacroField.
expr (oci.data_integration.models.Expression) – The value to assign to the expr property of this MacroField.
type (oci.data_integration.models.BaseType) – The value to assign to the type property of this MacroField.
is_use_source_type (bool) – The value to assign to the is_use_source_type property of this MacroField.
use_type (oci.data_integration.models.ConfiguredType) – The value to assign to the use_type property of this MacroField.
labels (list[str]) – The value to assign to the labels property of this MacroField.

config_values¶

Gets the config_values of this TypedObject.

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

description¶

Gets the description of this TypedObject. Detailed description for the object.

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

expr¶

Gets the expr of this MacroField.

Returns:	The expr of this MacroField.
Return type:	oci.data_integration.models.Expression

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_use_source_type¶

Gets the is_use_source_type of this MacroField. Specifies whether the type of macro fields is inferred from an expression or useType (false) or the source field (true).

Returns:	The is_use_source_type of this MacroField.
Return type:	bool

key¶

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

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

labels¶

Gets the labels of this MacroField. Labels are keywords or labels that you can add to data assets, dataflows, and so on. You can define your own labels and use them to categorize content.

Returns:	The labels of this MacroField.
Return type:	list[str]

model_type¶

[Required] Gets the model_type of this TypedObject. The type of the types object.

Allowed values for this property are: “SHAPE”, “INPUT_PORT”, “SHAPE_FIELD”, “INPUT_FIELD”, “DERIVED_FIELD”, “MACRO_FIELD”, “OUTPUT_FIELD”, “DYNAMIC_PROXY_FIELD”, “OUTPUT_PORT”, “DYNAMIC_INPUT_FIELD”, “PROXY_FIELD”, “PARAMETER”, “PIVOT_FIELD”, “MACRO_PIVOT_FIELD”, “CONDITIONAL_OUTPUT_PORT”, “INPUT_PROXY_FIELD”, “MATERIALIZED_DYNAMIC_FIELD”, “DECISION_OUTPUT_PORT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The model_type of this TypedObject.
Return type:	str

model_version¶

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

Returns:	The model_version of this TypedObject.
Return type:	str

name¶

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

object_status¶

Gets the object_status of this TypedObject. 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 TypedObject.
Return type:	int

parent_ref¶

Gets the parent_ref of this TypedObject.

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

type¶

Gets the type of this MacroField.

Returns:	The type of this MacroField.
Return type:	oci.data_integration.models.BaseType

use_type¶

Gets the use_type of this MacroField.

Returns:	The use_type of this MacroField.
Return type:	oci.data_integration.models.ConfiguredType