RuntimeOperator¶

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

Bases: object

Runtime operator model which holds the runtime metadata of the task operator executed.

Attributes

`EXECUTION_STATE_ERROR`	A constant which can be used with the execution_state property of a RuntimeOperator.
`EXECUTION_STATE_IGNORED`	A constant which can be used with the execution_state property of a RuntimeOperator.
`EXECUTION_STATE_NOT_STARTED`	A constant which can be used with the execution_state property of a RuntimeOperator.
`EXECUTION_STATE_RUNNING`	A constant which can be used with the execution_state property of a RuntimeOperator.
`EXECUTION_STATE_SKIPPED`	A constant which can be used with the execution_state property of a RuntimeOperator.
`EXECUTION_STATE_SUCCESS`	A constant which can be used with the execution_state property of a RuntimeOperator.
`EXECUTION_STATE_TERMINATED`	A constant which can be used with the execution_state property of a RuntimeOperator.
`EXECUTION_STATE_UNKNOWN`	A constant which can be used with the execution_state property of a RuntimeOperator.
`OPERATOR_TYPE_ACTUAL_END_OPERATOR`	A constant which can be used with the operator_type property of a RuntimeOperator.
`OPERATOR_TYPE_BASH_OPERATOR`	A constant which can be used with the operator_type property of a RuntimeOperator.
`OPERATOR_TYPE_DECISION_OPERATOR`	A constant which can be used with the operator_type property of a RuntimeOperator.
`OPERATOR_TYPE_END_OPERATOR`	A constant which can be used with the operator_type property of a RuntimeOperator.
`OPERATOR_TYPE_EXPRESSION_OPERATOR`	A constant which can be used with the operator_type property of a RuntimeOperator.
`OPERATOR_TYPE_LOOP_OPERATOR`	A constant which can be used with the operator_type property of a RuntimeOperator.
`OPERATOR_TYPE_MERGE_OPERATOR`	A constant which can be used with the operator_type property of a RuntimeOperator.
`OPERATOR_TYPE_REST_OPERATOR`	A constant which can be used with the operator_type property of a RuntimeOperator.
`OPERATOR_TYPE_START_OPERATOR`	A constant which can be used with the operator_type property of a RuntimeOperator.
`OPERATOR_TYPE_TASK_OPERATOR`	A constant which can be used with the operator_type property of a RuntimeOperator.
`STATUS_ERROR`	A constant which can be used with the status property of a RuntimeOperator.
`STATUS_NOT_STARTED`	A constant which can be used with the status property of a RuntimeOperator.
`STATUS_QUEUED`	A constant which can be used with the status property of a RuntimeOperator.
`STATUS_RUNNING`	A constant which can be used with the status property of a RuntimeOperator.
`STATUS_SUCCESS`	A constant which can be used with the status property of a RuntimeOperator.
`STATUS_TERMINATED`	A constant which can be used with the status property of a RuntimeOperator.
`STATUS_TERMINATING`	A constant which can be used with the status property of a RuntimeOperator.
`TASK_TYPE_DATA_LOADER_TASK`	A constant which can be used with the task_type property of a RuntimeOperator.
`TASK_TYPE_INTEGRATION_TASK`	A constant which can be used with the task_type property of a RuntimeOperator.
`TASK_TYPE_OCI_DATAFLOW_TASK`	A constant which can be used with the task_type property of a RuntimeOperator.
`TASK_TYPE_PIPELINE_TASK`	A constant which can be used with the task_type property of a RuntimeOperator.
`TASK_TYPE_REST_TASK`	A constant which can be used with the task_type property of a RuntimeOperator.
`TASK_TYPE_SQL_TASK`	A constant which can be used with the task_type property of a RuntimeOperator.
`config_provider`	Gets the config_provider of this RuntimeOperator.
`end_time_in_millis`	Gets the end_time_in_millis of this RuntimeOperator.
`execution_state`	Gets the execution_state of this RuntimeOperator.
`identifier`	Gets the identifier of this RuntimeOperator.
`inputs`	Gets the inputs of this RuntimeOperator.
`key`	Gets the key of this RuntimeOperator.
`metadata`	Gets the metadata of this RuntimeOperator.
`metrics`	Gets the metrics of this RuntimeOperator.
`model_type`	Gets the model_type of this RuntimeOperator.
`model_version`	Gets the model_version of this RuntimeOperator.
`name`	Gets the name of this RuntimeOperator.
`object_status`	Gets the object_status of this RuntimeOperator.
`object_version`	Gets the object_version of this RuntimeOperator.
`operator`	Gets the operator of this RuntimeOperator.
`operator_type`	Gets the operator_type of this RuntimeOperator.
`outputs`	Gets the outputs of this RuntimeOperator.
`parameters`	Gets the parameters of this RuntimeOperator.
`parent_ref`	Gets the parent_ref of this RuntimeOperator.
`start_time_in_millis`	Gets the start_time_in_millis of this RuntimeOperator.
`status`	Gets the status of this RuntimeOperator.
`task_run_key`	Gets the task_run_key of this RuntimeOperator.
`task_type`	Gets the task_type of this RuntimeOperator.

Methods

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

EXECUTION_STATE_ERROR = 'ERROR'¶: A constant which can be used with the execution_state property of a RuntimeOperator. This constant has a value of “ERROR”

EXECUTION_STATE_IGNORED = 'IGNORED'¶: A constant which can be used with the execution_state property of a RuntimeOperator. This constant has a value of “IGNORED”

EXECUTION_STATE_NOT_STARTED = 'NOT_STARTED'¶: A constant which can be used with the execution_state property of a RuntimeOperator. This constant has a value of “NOT_STARTED”

EXECUTION_STATE_RUNNING = 'RUNNING'¶: A constant which can be used with the execution_state property of a RuntimeOperator. This constant has a value of “RUNNING”

EXECUTION_STATE_SKIPPED = 'SKIPPED'¶: A constant which can be used with the execution_state property of a RuntimeOperator. This constant has a value of “SKIPPED”

EXECUTION_STATE_SUCCESS = 'SUCCESS'¶: A constant which can be used with the execution_state property of a RuntimeOperator. This constant has a value of “SUCCESS”

EXECUTION_STATE_TERMINATED = 'TERMINATED'¶: A constant which can be used with the execution_state property of a RuntimeOperator. This constant has a value of “TERMINATED”

EXECUTION_STATE_UNKNOWN = 'UNKNOWN'¶: A constant which can be used with the execution_state property of a RuntimeOperator. This constant has a value of “UNKNOWN”

OPERATOR_TYPE_ACTUAL_END_OPERATOR = 'ACTUAL_END_OPERATOR'¶: A constant which can be used with the operator_type property of a RuntimeOperator. This constant has a value of “ACTUAL_END_OPERATOR”

OPERATOR_TYPE_BASH_OPERATOR = 'BASH_OPERATOR'¶: A constant which can be used with the operator_type property of a RuntimeOperator. This constant has a value of “BASH_OPERATOR”

OPERATOR_TYPE_DECISION_OPERATOR = 'DECISION_OPERATOR'¶: A constant which can be used with the operator_type property of a RuntimeOperator. This constant has a value of “DECISION_OPERATOR”

OPERATOR_TYPE_END_OPERATOR = 'END_OPERATOR'¶: A constant which can be used with the operator_type property of a RuntimeOperator. This constant has a value of “END_OPERATOR”

OPERATOR_TYPE_EXPRESSION_OPERATOR = 'EXPRESSION_OPERATOR'¶: A constant which can be used with the operator_type property of a RuntimeOperator. This constant has a value of “EXPRESSION_OPERATOR”

OPERATOR_TYPE_LOOP_OPERATOR = 'LOOP_OPERATOR'¶: A constant which can be used with the operator_type property of a RuntimeOperator. This constant has a value of “LOOP_OPERATOR”

OPERATOR_TYPE_MERGE_OPERATOR = 'MERGE_OPERATOR'¶: A constant which can be used with the operator_type property of a RuntimeOperator. This constant has a value of “MERGE_OPERATOR”

OPERATOR_TYPE_REST_OPERATOR = 'REST_OPERATOR'¶: A constant which can be used with the operator_type property of a RuntimeOperator. This constant has a value of “REST_OPERATOR”

OPERATOR_TYPE_START_OPERATOR = 'START_OPERATOR'¶: A constant which can be used with the operator_type property of a RuntimeOperator. This constant has a value of “START_OPERATOR”

OPERATOR_TYPE_TASK_OPERATOR = 'TASK_OPERATOR'¶: A constant which can be used with the operator_type property of a RuntimeOperator. This constant has a value of “TASK_OPERATOR”

STATUS_ERROR = 'ERROR'¶: A constant which can be used with the status property of a RuntimeOperator. This constant has a value of “ERROR”

STATUS_NOT_STARTED = 'NOT_STARTED'¶: A constant which can be used with the status property of a RuntimeOperator. This constant has a value of “NOT_STARTED”

STATUS_QUEUED = 'QUEUED'¶: A constant which can be used with the status property of a RuntimeOperator. This constant has a value of “QUEUED”

STATUS_RUNNING = 'RUNNING'¶: A constant which can be used with the status property of a RuntimeOperator. This constant has a value of “RUNNING”

STATUS_SUCCESS = 'SUCCESS'¶: A constant which can be used with the status property of a RuntimeOperator. This constant has a value of “SUCCESS”

STATUS_TERMINATED = 'TERMINATED'¶: A constant which can be used with the status property of a RuntimeOperator. This constant has a value of “TERMINATED”

STATUS_TERMINATING = 'TERMINATING'¶: A constant which can be used with the status property of a RuntimeOperator. This constant has a value of “TERMINATING”

TASK_TYPE_DATA_LOADER_TASK = 'DATA_LOADER_TASK'¶: A constant which can be used with the task_type property of a RuntimeOperator. 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 RuntimeOperator. 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 RuntimeOperator. 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 RuntimeOperator. 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 RuntimeOperator. 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 RuntimeOperator. This constant has a value of “SQL_TASK”

__init__(**kwargs)¶

Initializes a new RuntimeOperator 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 RuntimeOperator.
task_run_key (str) – The value to assign to the task_run_key property of this RuntimeOperator.
start_time_in_millis (int) – The value to assign to the start_time_in_millis property of this RuntimeOperator.
end_time_in_millis (int) – The value to assign to the end_time_in_millis property of this RuntimeOperator.
status (str) – The value to assign to the status property of this RuntimeOperator. Allowed values for this property are: “NOT_STARTED”, “QUEUED”, “RUNNING”, “TERMINATING”, “TERMINATED”, “SUCCESS”, “ERROR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
model_type (str) – The value to assign to the model_type property of this RuntimeOperator.
model_version (str) – The value to assign to the model_version property of this RuntimeOperator.
parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this RuntimeOperator.
name (str) – The value to assign to the name property of this RuntimeOperator.
object_version (int) – The value to assign to the object_version property of this RuntimeOperator.
identifier (str) – The value to assign to the identifier property of this RuntimeOperator.
execution_state (str) – The value to assign to the execution_state property of this RuntimeOperator. Allowed values for this property are: “NOT_STARTED”, “RUNNING”, “TERMINATED”, “SUCCESS”, “ERROR”, “SKIPPED”, “UNKNOWN”, “IGNORED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
parameters (list[oci.data_integration.models.Parameter]) – The value to assign to the parameters property of this RuntimeOperator.
object_status (int) – The value to assign to the object_status property of this RuntimeOperator.
metadata (oci.data_integration.models.ObjectMetadata) – The value to assign to the metadata property of this RuntimeOperator.
operator (oci.data_integration.models.Operator) – The value to assign to the operator property of this RuntimeOperator.
inputs (dict(str, ParameterValue)) – The value to assign to the inputs property of this RuntimeOperator.
outputs (dict(str, ParameterValue)) – The value to assign to the outputs property of this RuntimeOperator.
task_type (str) – The value to assign to the task_type property of this RuntimeOperator. Allowed values for this property are: “INTEGRATION_TASK”, “DATA_LOADER_TASK”, “PIPELINE_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’.
config_provider (oci.data_integration.models.ConfigProvider) – The value to assign to the config_provider property of this RuntimeOperator.
operator_type (str) – The value to assign to the operator_type property of this RuntimeOperator. Allowed values for this property are: “BASH_OPERATOR”, “TASK_OPERATOR”, “REST_OPERATOR”, “START_OPERATOR”, “END_OPERATOR”, “EXPRESSION_OPERATOR”, “MERGE_OPERATOR”, “DECISION_OPERATOR”, “LOOP_OPERATOR”, “ACTUAL_END_OPERATOR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
metrics (dict(str, float)) – The value to assign to the metrics property of this RuntimeOperator.

config_provider¶

Gets the config_provider of this RuntimeOperator.

Returns:	The config_provider of this RuntimeOperator.
Return type:	oci.data_integration.models.ConfigProvider

end_time_in_millis¶

Gets the end_time_in_millis of this RuntimeOperator. The runtime operator end time.

Returns:	The end_time_in_millis of this RuntimeOperator.
Return type:	int

execution_state¶

Gets the execution_state of this RuntimeOperator. status

Allowed values for this property are: “NOT_STARTED”, “RUNNING”, “TERMINATED”, “SUCCESS”, “ERROR”, “SKIPPED”, “UNKNOWN”, “IGNORED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The execution_state of this RuntimeOperator.
Return type:	str

identifier¶

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

inputs¶

Gets the inputs of this RuntimeOperator. The configuration provider bindings.

Returns:	The inputs of this RuntimeOperator.
Return type:	dict(str, ParameterValue)

key¶

Gets the key of this RuntimeOperator. The RuntimeOperator key.

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

metadata¶

Gets the metadata of this RuntimeOperator.

Returns:	The metadata of this RuntimeOperator.
Return type:	oci.data_integration.models.ObjectMetadata

metrics¶

Gets the metrics of this RuntimeOperator. A map metrics for the task run.

Returns:	The metrics of this RuntimeOperator.
Return type:	dict(str, float)

model_type¶

Gets the model_type of this RuntimeOperator. The type of the object.

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

model_version¶

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

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

name¶

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

object_status¶

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

object_version¶

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

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

operator¶

Gets the operator of this RuntimeOperator.

Returns:	The operator of this RuntimeOperator.
Return type:	oci.data_integration.models.Operator

operator_type¶

Gets the operator_type of this RuntimeOperator. The type of Runtime Operator

Allowed values for this property are: “BASH_OPERATOR”, “TASK_OPERATOR”, “REST_OPERATOR”, “START_OPERATOR”, “END_OPERATOR”, “EXPRESSION_OPERATOR”, “MERGE_OPERATOR”, “DECISION_OPERATOR”, “LOOP_OPERATOR”, “ACTUAL_END_OPERATOR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The operator_type of this RuntimeOperator.
Return type:	str

outputs¶

Gets the outputs of this RuntimeOperator. The configuration provider bindings.

Returns:	The outputs of this RuntimeOperator.
Return type:	dict(str, ParameterValue)

parameters¶

Gets the parameters of this RuntimeOperator. A list of parameters for the pipeline, this allows certain aspects of the pipeline to be configured when the pipeline is executed.

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

parent_ref¶

Gets the parent_ref of this RuntimeOperator.

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

start_time_in_millis¶

Gets the start_time_in_millis of this RuntimeOperator. The runtime operator start time.

Returns:	The start_time_in_millis of this RuntimeOperator.
Return type:	int

status¶

Gets the status of this RuntimeOperator. Status of RuntimeOperator. This field is deprecated, use RuntimeOperator’s executionState field instead.

Allowed values for this property are: “NOT_STARTED”, “QUEUED”, “RUNNING”, “TERMINATING”, “TERMINATED”, “SUCCESS”, “ERROR”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The status of this RuntimeOperator.
Return type:	str

task_run_key¶

Gets the task_run_key of this RuntimeOperator. The TaskRun key.

Returns:	The task_run_key of this RuntimeOperator.
Return type:	str

task_type¶

Gets the task_type of this RuntimeOperator. The type of task run.

Allowed values for this property are: “INTEGRATION_TASK”, “DATA_LOADER_TASK”, “PIPELINE_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 RuntimeOperator.
Return type:	str