TaskOperator¶

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

Bases: oci.data_integration.models.operator.Operator

An operator for task

Attributes

`EXPECTED_DURATION_UNIT_DAYS`	A constant which can be used with the expected_duration_unit property of a TaskOperator.
`EXPECTED_DURATION_UNIT_HOURS`	A constant which can be used with the expected_duration_unit property of a TaskOperator.
`EXPECTED_DURATION_UNIT_MINUTES`	A constant which can be used with the expected_duration_unit property of a TaskOperator.
`EXPECTED_DURATION_UNIT_SECONDS`	A constant which can be used with the expected_duration_unit property of a TaskOperator.
`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
`RETRY_DELAY_UNIT_DAYS`	A constant which can be used with the retry_delay_unit property of a TaskOperator.
`RETRY_DELAY_UNIT_HOURS`	A constant which can be used with the retry_delay_unit property of a TaskOperator.
`RETRY_DELAY_UNIT_MINUTES`	A constant which can be used with the retry_delay_unit property of a TaskOperator.
`RETRY_DELAY_UNIT_SECONDS`	A constant which can be used with the retry_delay_unit property of a TaskOperator.
`TASK_TYPE_DATA_LOADER_TASK`	A constant which can be used with the task_type property of a TaskOperator.
`TASK_TYPE_INTEGRATION_TASK`	A constant which can be used with the task_type property of a TaskOperator.
`TASK_TYPE_OCI_DATAFLOW_TASK`	A constant which can be used with the task_type property of a TaskOperator.
`TASK_TYPE_PIPELINE_TASK`	A constant which can be used with the task_type property of a TaskOperator.
`TASK_TYPE_REST_TASK`	A constant which can be used with the task_type property of a TaskOperator.
`TASK_TYPE_SQL_TASK`	A constant which can be used with the task_type property of a TaskOperator.
`TRIGGER_RULE_ALL_COMPLETE`	A constant which can be used with the trigger_rule property of a TaskOperator.
`TRIGGER_RULE_ALL_FAILED`	A constant which can be used with the trigger_rule property of a TaskOperator.
`TRIGGER_RULE_ALL_SUCCESS`	A constant which can be used with the trigger_rule property of a TaskOperator.
`config_provider_delegate`	Gets the config_provider_delegate of this TaskOperator.
`description`	Gets the description of this Operator.
`expected_duration`	Gets the expected_duration of this TaskOperator.
`expected_duration_unit`	Gets the expected_duration_unit of this TaskOperator.
`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.
`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.
`retry_attempts`	Gets the retry_attempts of this TaskOperator.
`retry_delay`	Gets the retry_delay of this TaskOperator.
`retry_delay_unit`	Gets the retry_delay_unit of this TaskOperator.
`task`	Gets the task of this TaskOperator.
`task_type`	Gets the task_type of this TaskOperator.
`trigger_rule`	Gets the trigger_rule of this TaskOperator.

Methods

`__init__`(**kwargs)	Initializes a new TaskOperator 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.

EXPECTED_DURATION_UNIT_DAYS = 'DAYS'¶: A constant which can be used with the expected_duration_unit property of a TaskOperator. This constant has a value of “DAYS”

EXPECTED_DURATION_UNIT_HOURS = 'HOURS'¶: A constant which can be used with the expected_duration_unit property of a TaskOperator. This constant has a value of “HOURS”

EXPECTED_DURATION_UNIT_MINUTES = 'MINUTES'¶: A constant which can be used with the expected_duration_unit property of a TaskOperator. This constant has a value of “MINUTES”

EXPECTED_DURATION_UNIT_SECONDS = 'SECONDS'¶: A constant which can be used with the expected_duration_unit property of a TaskOperator. This constant has a value of “SECONDS”

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

RETRY_DELAY_UNIT_DAYS = 'DAYS'¶: A constant which can be used with the retry_delay_unit property of a TaskOperator. This constant has a value of “DAYS”

RETRY_DELAY_UNIT_HOURS = 'HOURS'¶: A constant which can be used with the retry_delay_unit property of a TaskOperator. This constant has a value of “HOURS”

RETRY_DELAY_UNIT_MINUTES = 'MINUTES'¶: A constant which can be used with the retry_delay_unit property of a TaskOperator. This constant has a value of “MINUTES”

RETRY_DELAY_UNIT_SECONDS = 'SECONDS'¶: A constant which can be used with the retry_delay_unit property of a TaskOperator. This constant has a value of “SECONDS”

TASK_TYPE_DATA_LOADER_TASK = 'DATA_LOADER_TASK'¶: A constant which can be used with the task_type property of a TaskOperator. This constant has a value of “DATA_LOADER_TASK”

TASK_TYPE_INTEGRATION_TASK = 'INTEGRATION_TASK'¶: A constant which can be used with the task_type property of a TaskOperator. This constant has a value of “INTEGRATION_TASK”

TASK_TYPE_OCI_DATAFLOW_TASK = 'OCI_DATAFLOW_TASK'¶: A constant which can be used with the task_type property of a TaskOperator. This constant has a value of “OCI_DATAFLOW_TASK”

TASK_TYPE_PIPELINE_TASK = 'PIPELINE_TASK'¶: A constant which can be used with the task_type property of a TaskOperator. This constant has a value of “PIPELINE_TASK”

TASK_TYPE_REST_TASK = 'REST_TASK'¶: A constant which can be used with the task_type property of a TaskOperator. This constant has a value of “REST_TASK”

TASK_TYPE_SQL_TASK = 'SQL_TASK'¶: A constant which can be used with the task_type property of a TaskOperator. This constant has a value of “SQL_TASK”

TRIGGER_RULE_ALL_COMPLETE = 'ALL_COMPLETE'¶: A constant which can be used with the trigger_rule property of a TaskOperator. This constant has a value of “ALL_COMPLETE”

TRIGGER_RULE_ALL_FAILED = 'ALL_FAILED'¶: A constant which can be used with the trigger_rule property of a TaskOperator. This constant has a value of “ALL_FAILED”

TRIGGER_RULE_ALL_SUCCESS = 'ALL_SUCCESS'¶: A constant which can be used with the trigger_rule property of a TaskOperator. This constant has a value of “ALL_SUCCESS”

__init__(**kwargs)¶

Initializes a new TaskOperator object with values from keyword arguments. The default value of the model_type attribute of this class is TASK_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 TaskOperator. 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’.
key (str) – The value to assign to the key property of this TaskOperator.
model_version (str) – The value to assign to the model_version property of this TaskOperator.
parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this TaskOperator.
name (str) – The value to assign to the name property of this TaskOperator.
description (str) – The value to assign to the description property of this TaskOperator.
object_version (int) – The value to assign to the object_version property of this TaskOperator.
input_ports (list[oci.data_integration.models.InputPort]) – The value to assign to the input_ports property of this TaskOperator.
output_ports (list[oci.data_integration.models.TypedObject]) – The value to assign to the output_ports property of this TaskOperator.
object_status (int) – The value to assign to the object_status property of this TaskOperator.
identifier (str) – The value to assign to the identifier property of this TaskOperator.
parameters (list[oci.data_integration.models.Parameter]) – The value to assign to the parameters property of this TaskOperator.
op_config_values (oci.data_integration.models.ConfigValues) – The value to assign to the op_config_values property of this TaskOperator.
retry_attempts (int) – The value to assign to the retry_attempts property of this TaskOperator.
retry_delay_unit (str) – The value to assign to the retry_delay_unit property of this TaskOperator. Allowed values for this property are: “SECONDS”, “MINUTES”, “HOURS”, “DAYS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
retry_delay (float) – The value to assign to the retry_delay property of this TaskOperator.
expected_duration (float) – The value to assign to the expected_duration property of this TaskOperator.
expected_duration_unit (str) – The value to assign to the expected_duration_unit property of this TaskOperator. Allowed values for this property are: “SECONDS”, “MINUTES”, “HOURS”, “DAYS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
task_type (str) – The value to assign to the task_type property of this TaskOperator. Allowed values for this property are: “PIPELINE_TASK”, “INTEGRATION_TASK”, “DATA_LOADER_TASK”, “SQL_TASK”, “OCI_DATAFLOW_TASK”, “REST_TASK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
task (oci.data_integration.models.Task) – The value to assign to the task property of this TaskOperator.
trigger_rule (str) – The value to assign to the trigger_rule property of this TaskOperator. Allowed values for this property are: “ALL_SUCCESS”, “ALL_FAILED”, “ALL_COMPLETE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
config_provider_delegate (oci.data_integration.models.ConfigProvider) – The value to assign to the config_provider_delegate property of this TaskOperator.

config_provider_delegate¶

Gets the config_provider_delegate of this TaskOperator.

Returns:	The config_provider_delegate of this TaskOperator.
Return type:	oci.data_integration.models.ConfigProvider

description¶

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

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

expected_duration¶

Gets the expected_duration of this TaskOperator. The expected duration for the task run.

Returns:	The expected_duration of this TaskOperator.
Return type:	float

expected_duration_unit¶

Gets the expected_duration_unit of this TaskOperator. The expected duration unit of measure.

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

Returns:	The expected_duration_unit of this TaskOperator.
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

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

retry_attempts¶

Gets the retry_attempts of this TaskOperator. The number of retry attempts.

Returns:	The retry_attempts of this TaskOperator.
Return type:	int

retry_delay¶

Gets the retry_delay of this TaskOperator. The retry delay, the unit for measurement is in the property retry delay unit.

Returns:	The retry_delay of this TaskOperator.
Return type:	float

retry_delay_unit¶

Gets the retry_delay_unit of this TaskOperator. The unit for the retry delay.

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

Returns:	The retry_delay_unit of this TaskOperator.
Return type:	str

task¶

Gets the task of this TaskOperator.

Returns:	The task of this TaskOperator.
Return type:	oci.data_integration.models.Task

task_type¶

Gets the task_type of this TaskOperator. The type of the task referenced in the task property.

Allowed values for this property are: “PIPELINE_TASK”, “INTEGRATION_TASK”, “DATA_LOADER_TASK”, “SQL_TASK”, “OCI_DATAFLOW_TASK”, “REST_TASK”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The task_type of this TaskOperator.
Return type:	str

trigger_rule¶

Gets the trigger_rule of this TaskOperator. The merge condition. The conditions are ALL_SUCCESS - All the preceeding operators need to be successful. ALL_FAILED - All the preceeding operators should have failed. ALL_COMPLETE - All the preceeding operators should have completed. It could have executed successfully or failed.

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

Returns:	The trigger_rule of this TaskOperator.
Return type:	str