Function¶

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

Bases: oci.data_integration.models.operator.Operator

The Function operator supports users adding a custom OCI Function into the data flow.

Attributes

`MODEL_TYPE_AGGREGATOR_OPERATOR`	str(object=’’) -> str
`MODEL_TYPE_DECISION_OPERATOR`	str(object=’’) -> str
`MODEL_TYPE_DISTINCT_OPERATOR`	str(object=’’) -> str
`MODEL_TYPE_END_OPERATOR`	str(object=’’) -> str
`MODEL_TYPE_EXPRESSION_OPERATOR`	str(object=’’) -> str
`MODEL_TYPE_FILTER_OPERATOR`	str(object=’’) -> str
`MODEL_TYPE_FLATTEN_OPERATOR`	str(object=’’) -> str
`MODEL_TYPE_FUNCTION_OPERATOR`	str(object=’’) -> str
`MODEL_TYPE_INTERSECT_OPERATOR`	str(object=’’) -> str
`MODEL_TYPE_JOINER_OPERATOR`	str(object=’’) -> str
`MODEL_TYPE_LOOKUP_OPERATOR`	str(object=’’) -> str
`MODEL_TYPE_MERGE_OPERATOR`	str(object=’’) -> str
`MODEL_TYPE_MINUS_OPERATOR`	str(object=’’) -> str
`MODEL_TYPE_PIPELINE_OPERATOR`	str(object=’’) -> str
`MODEL_TYPE_PIVOT_OPERATOR`	str(object=’’) -> str
`MODEL_TYPE_PROJECTION_OPERATOR`	str(object=’’) -> str
`MODEL_TYPE_SORT_OPERATOR`	str(object=’’) -> str
`MODEL_TYPE_SOURCE_OPERATOR`	str(object=’’) -> str
`MODEL_TYPE_SPLIT_OPERATOR`	str(object=’’) -> str
`MODEL_TYPE_START_OPERATOR`	str(object=’’) -> str
`MODEL_TYPE_TARGET_OPERATOR`	str(object=’’) -> str
`MODEL_TYPE_TASK_OPERATOR`	str(object=’’) -> str
`MODEL_TYPE_UNION_OPERATOR`	str(object=’’) -> str
`description`	Gets the description of this Operator.
`identifier`	Gets the identifier of this Operator.
`input_ports`	Gets the input_ports of this Operator.
`key`	Gets the key of this Operator.
`model_type`	[Required] Gets the model_type of this Operator.
`model_version`	Gets the model_version of this Operator.
`name`	Gets the name of this Operator.
`object_status`	Gets the object_status of this Operator.
`object_version`	Gets the object_version of this Operator.
`oci_function`	Gets the oci_function of this Function.
`op_config_values`	Gets the op_config_values of this Operator.
`output_ports`	Gets the output_ports of this Operator.
`parameters`	Gets the parameters of this Operator.
`parent_ref`	Gets the parent_ref of this Operator.

Methods

`__init__`(**kwargs)	Initializes a new Function 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_AGGREGATOR_OPERATOR = 'AGGREGATOR_OPERATOR'¶

MODEL_TYPE_DECISION_OPERATOR = 'DECISION_OPERATOR'¶

MODEL_TYPE_DISTINCT_OPERATOR = 'DISTINCT_OPERATOR'¶

MODEL_TYPE_END_OPERATOR = 'END_OPERATOR'¶

MODEL_TYPE_EXPRESSION_OPERATOR = 'EXPRESSION_OPERATOR'¶

MODEL_TYPE_FILTER_OPERATOR = 'FILTER_OPERATOR'¶

MODEL_TYPE_FLATTEN_OPERATOR = 'FLATTEN_OPERATOR'¶

MODEL_TYPE_FUNCTION_OPERATOR = 'FUNCTION_OPERATOR'¶

MODEL_TYPE_INTERSECT_OPERATOR = 'INTERSECT_OPERATOR'¶

MODEL_TYPE_JOINER_OPERATOR = 'JOINER_OPERATOR'¶

MODEL_TYPE_LOOKUP_OPERATOR = 'LOOKUP_OPERATOR'¶

MODEL_TYPE_MERGE_OPERATOR = 'MERGE_OPERATOR'¶

MODEL_TYPE_MINUS_OPERATOR = 'MINUS_OPERATOR'¶

MODEL_TYPE_PIPELINE_OPERATOR = 'PIPELINE_OPERATOR'¶

MODEL_TYPE_PIVOT_OPERATOR = 'PIVOT_OPERATOR'¶

MODEL_TYPE_PROJECTION_OPERATOR = 'PROJECTION_OPERATOR'¶

MODEL_TYPE_SORT_OPERATOR = 'SORT_OPERATOR'¶

MODEL_TYPE_SOURCE_OPERATOR = 'SOURCE_OPERATOR'¶

MODEL_TYPE_SPLIT_OPERATOR = 'SPLIT_OPERATOR'¶

MODEL_TYPE_START_OPERATOR = 'START_OPERATOR'¶

MODEL_TYPE_TARGET_OPERATOR = 'TARGET_OPERATOR'¶

MODEL_TYPE_TASK_OPERATOR = 'TASK_OPERATOR'¶

MODEL_TYPE_UNION_OPERATOR = 'UNION_OPERATOR'¶

__init__(**kwargs)¶

Initializes a new Function object with values from keyword arguments. The default value of the model_type attribute of this class is FUNCTION_OPERATOR 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 Function. Allowed values for this property are: “SOURCE_OPERATOR”, “FILTER_OPERATOR”, “JOINER_OPERATOR”, “AGGREGATOR_OPERATOR”, “PROJECTION_OPERATOR”, “TARGET_OPERATOR”, “FLATTEN_OPERATOR”, “DISTINCT_OPERATOR”, “SORT_OPERATOR”, “UNION_OPERATOR”, “INTERSECT_OPERATOR”, “MINUS_OPERATOR”, “MERGE_OPERATOR”, “FUNCTION_OPERATOR”, “SPLIT_OPERATOR”, “START_OPERATOR”, “END_OPERATOR”, “PIPELINE_OPERATOR”, “DECISION_OPERATOR”, “TASK_OPERATOR”, “EXPRESSION_OPERATOR”, “LOOKUP_OPERATOR”, “PIVOT_OPERATOR”
key (str) – The value to assign to the key property of this Function.
model_version (str) – The value to assign to the model_version property of this Function.
parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this Function.
name (str) – The value to assign to the name property of this Function.
description (str) – The value to assign to the description property of this Function.
object_version (int) – The value to assign to the object_version property of this Function.
input_ports (list[oci.data_integration.models.InputPort]) – The value to assign to the input_ports property of this Function.
output_ports (list[oci.data_integration.models.TypedObject]) – The value to assign to the output_ports property of this Function.
object_status (int) – The value to assign to the object_status property of this Function.
identifier (str) – The value to assign to the identifier property of this Function.
parameters (list[oci.data_integration.models.Parameter]) – The value to assign to the parameters property of this Function.
op_config_values (oci.data_integration.models.ConfigValues) – The value to assign to the op_config_values property of this Function.
oci_function (oci.data_integration.models.OciFunction) – The value to assign to the oci_function property of this Function.

description¶

Gets the description of this Operator. Details about the operator.

Returns:	The description of this Operator.
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.

identifier¶

Gets the identifier of this Operator. Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.

Returns:	The identifier of this Operator.
Return type:	str

input_ports¶

Gets the input_ports of this Operator. An array of input ports.

Returns:	The input_ports of this Operator.
Return type:	list[oci.data_integration.models.InputPort]

key¶

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

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

model_type¶

[Required] Gets the model_type of this Operator. The model type of the operator.

Allowed values for this property are: “SOURCE_OPERATOR”, “FILTER_OPERATOR”, “JOINER_OPERATOR”, “AGGREGATOR_OPERATOR”, “PROJECTION_OPERATOR”, “TARGET_OPERATOR”, “FLATTEN_OPERATOR”, “DISTINCT_OPERATOR”, “SORT_OPERATOR”, “UNION_OPERATOR”, “INTERSECT_OPERATOR”, “MINUS_OPERATOR”, “MERGE_OPERATOR”, “FUNCTION_OPERATOR”, “SPLIT_OPERATOR”, “START_OPERATOR”, “END_OPERATOR”, “PIPELINE_OPERATOR”, “DECISION_OPERATOR”, “TASK_OPERATOR”, “EXPRESSION_OPERATOR”, “LOOKUP_OPERATOR”, “PIVOT_OPERATOR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

model_version¶

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

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

name¶

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

object_status¶

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

object_version¶

Gets the object_version of this Operator. The version of the object that is used to track changes in the object instance.

Returns:	The object_version of this Operator.
Return type:	int

oci_function¶

Gets the oci_function of this Function.

Returns:	The oci_function of this Function.
Return type:	oci.data_integration.models.OciFunction

op_config_values¶

Gets the op_config_values of this Operator.

Returns:	The op_config_values of this Operator.
Return type:	oci.data_integration.models.ConfigValues

output_ports¶

Gets the output_ports of this Operator. An array of output ports.

Returns:	The output_ports of this Operator.
Return type:	list[oci.data_integration.models.TypedObject]

parameters¶

Gets the parameters of this Operator. An array of parameters used in the data flow.

Returns:	The parameters of this Operator.
Return type:	list[oci.data_integration.models.Parameter]

parent_ref¶

Gets the parent_ref of this Operator.

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