TaskRun¶

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

Bases: object

The information about a task run.

Attributes

`AUTH_MODE_OBO`	A constant which can be used with the auth_mode property of a TaskRun.
`AUTH_MODE_RESOURCE_PRINCIPAL`	A constant which can be used with the auth_mode property of a TaskRun.
`AUTH_MODE_USER_CERTIFICATE`	A constant which can be used with the auth_mode property of a TaskRun.
`EXPECTED_DURATION_UNIT_DAYS`	A constant which can be used with the expected_duration_unit property of a TaskRun.
`EXPECTED_DURATION_UNIT_HOURS`	A constant which can be used with the expected_duration_unit property of a TaskRun.
`EXPECTED_DURATION_UNIT_MINUTES`	A constant which can be used with the expected_duration_unit property of a TaskRun.
`EXPECTED_DURATION_UNIT_SECONDS`	A constant which can be used with the expected_duration_unit property of a TaskRun.
`STATUS_ERROR`	A constant which can be used with the status property of a TaskRun.
`STATUS_NOT_STARTED`	A constant which can be used with the status property of a TaskRun.
`STATUS_QUEUED`	A constant which can be used with the status property of a TaskRun.
`STATUS_RUNNING`	A constant which can be used with the status property of a TaskRun.
`STATUS_SUCCESS`	A constant which can be used with the status property of a TaskRun.
`STATUS_TERMINATED`	A constant which can be used with the status property of a TaskRun.
`STATUS_TERMINATING`	A constant which can be used with the status property of a TaskRun.
`TASK_TYPE_DATA_LOADER_TASK`	A constant which can be used with the task_type property of a TaskRun.
`TASK_TYPE_INTEGRATION_TASK`	A constant which can be used with the task_type property of a TaskRun.
`TASK_TYPE_OCI_DATAFLOW_TASK`	A constant which can be used with the task_type property of a TaskRun.
`TASK_TYPE_PIPELINE_TASK`	A constant which can be used with the task_type property of a TaskRun.
`TASK_TYPE_REST_TASK`	A constant which can be used with the task_type property of a TaskRun.
`TASK_TYPE_SQL_TASK`	A constant which can be used with the task_type property of a TaskRun.
`auth_mode`	Gets the auth_mode of this TaskRun.
`bytes_processed`	Gets the bytes_processed of this TaskRun.
`config_provider`	Gets the config_provider of this TaskRun.
`description`	Gets the description of this TaskRun.
`end_time_millis`	Gets the end_time_millis of this TaskRun.
`error_message`	Gets the error_message of this TaskRun.
`execution_errors`	Gets the execution_errors of this TaskRun.
`expected_duration`	Gets the expected_duration of this TaskRun.
`expected_duration_unit`	Gets the expected_duration_unit of this TaskRun.
`external_id`	Gets the external_id of this TaskRun.
`identifier`	Gets the identifier of this TaskRun.
`is_log_processing_in_progress`	Gets the is_log_processing_in_progress of this TaskRun.
`key`	Gets the key of this TaskRun.
`key_map`	Gets the key_map of this TaskRun.
`last_updated`	Gets the last_updated of this TaskRun.
`metadata`	Gets the metadata of this TaskRun.
`metrics`	Gets the metrics of this TaskRun.
`model_type`	Gets the model_type of this TaskRun.
`model_version`	Gets the model_version of this TaskRun.
`name`	Gets the name of this TaskRun.
`object_status`	Gets the object_status of this TaskRun.
`object_version`	Gets the object_version of this TaskRun.
`opc_request_id`	Gets the opc_request_id of this TaskRun.
`outputs`	Gets the outputs of this TaskRun.
`parent_ref`	Gets the parent_ref of this TaskRun.
`records_written`	Gets the records_written of this TaskRun.
`retry_attempt`	Gets the retry_attempt of this TaskRun.
`start_time_millis`	Gets the start_time_millis of this TaskRun.
`status`	Gets the status of this TaskRun.
`task_key`	Gets the task_key of this TaskRun.
`task_schedule`	Gets the task_schedule of this TaskRun.
`task_type`	Gets the task_type of this TaskRun.
`termination_errors`	Gets the termination_errors of this TaskRun.

Methods

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

AUTH_MODE_OBO = 'OBO'¶: A constant which can be used with the auth_mode property of a TaskRun. This constant has a value of “OBO”

AUTH_MODE_RESOURCE_PRINCIPAL = 'RESOURCE_PRINCIPAL'¶: A constant which can be used with the auth_mode property of a TaskRun. This constant has a value of “RESOURCE_PRINCIPAL”

AUTH_MODE_USER_CERTIFICATE = 'USER_CERTIFICATE'¶: A constant which can be used with the auth_mode property of a TaskRun. This constant has a value of “USER_CERTIFICATE”

EXPECTED_DURATION_UNIT_DAYS = 'DAYS'¶: A constant which can be used with the expected_duration_unit property of a TaskRun. 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 TaskRun. 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 TaskRun. 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 TaskRun. This constant has a value of “SECONDS”

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

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

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

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

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

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

STATUS_TERMINATING = 'TERMINATING'¶: A constant which can be used with the status property of a TaskRun. 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 TaskRun. 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 TaskRun. 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 TaskRun. 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 TaskRun. 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 TaskRun. 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 TaskRun. This constant has a value of “SQL_TASK”

__init__(**kwargs)¶

Initializes a new TaskRun 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 TaskRun.
model_type (str) – The value to assign to the model_type property of this TaskRun.
model_version (str) – The value to assign to the model_version property of this TaskRun.
parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this TaskRun.
name (str) – The value to assign to the name property of this TaskRun.
description (str) – The value to assign to the description property of this TaskRun.
object_version (int) – The value to assign to the object_version property of this TaskRun.
config_provider (oci.data_integration.models.ConfigProvider) – The value to assign to the config_provider property of this TaskRun.
status (str) – The value to assign to the status property of this TaskRun. 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’.
start_time_millis (int) – The value to assign to the start_time_millis property of this TaskRun.
end_time_millis (int) – The value to assign to the end_time_millis property of this TaskRun.
last_updated (int) – The value to assign to the last_updated property of this TaskRun.
records_written (int) – The value to assign to the records_written property of this TaskRun.
bytes_processed (int) – The value to assign to the bytes_processed property of this TaskRun.
error_message (str) – The value to assign to the error_message property of this TaskRun.
expected_duration (float) – The value to assign to the expected_duration property of this TaskRun.
expected_duration_unit (str) – The value to assign to the expected_duration_unit property of this TaskRun. 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_key (str) – The value to assign to the task_key property of this TaskRun.
external_id (str) – The value to assign to the external_id property of this TaskRun.
retry_attempt (int) – The value to assign to the retry_attempt property of this TaskRun.
task_schedule (oci.data_integration.models.TaskSchedule) – The value to assign to the task_schedule property of this TaskRun.
metrics (dict(str, float)) – The value to assign to the metrics property of this TaskRun.
outputs (dict(str, ParameterValue)) – The value to assign to the outputs property of this TaskRun.
execution_errors (list[str]) – The value to assign to the execution_errors property of this TaskRun.
termination_errors (list[str]) – The value to assign to the termination_errors property of this TaskRun.
auth_mode (str) – The value to assign to the auth_mode property of this TaskRun. Allowed values for this property are: “OBO”, “RESOURCE_PRINCIPAL”, “USER_CERTIFICATE”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
opc_request_id (str) – The value to assign to the opc_request_id property of this TaskRun.
object_status (int) – The value to assign to the object_status property of this TaskRun.
task_type (str) – The value to assign to the task_type property of this TaskRun. 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’.
is_log_processing_in_progress (bool) – The value to assign to the is_log_processing_in_progress property of this TaskRun.
identifier (str) – The value to assign to the identifier property of this TaskRun.
metadata (oci.data_integration.models.ObjectMetadata) – The value to assign to the metadata property of this TaskRun.
key_map (dict(str, str)) – The value to assign to the key_map property of this TaskRun.

auth_mode¶

Gets the auth_mode of this TaskRun. The autorization mode for when the task was executed.

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

Returns:	The auth_mode of this TaskRun.
Return type:	str

bytes_processed¶

Gets the bytes_processed of this TaskRun. The number of bytes processed in the task run.

Returns:	The bytes_processed of this TaskRun.
Return type:	int

config_provider¶

Gets the config_provider of this TaskRun.

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

description¶

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

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

end_time_millis¶

Gets the end_time_millis of this TaskRun. The end time.

Returns:	The end_time_millis of this TaskRun.
Return type:	int

error_message¶

Gets the error_message of this TaskRun. Contains an error message if status is ERROR.

Returns:	The error_message of this TaskRun.
Return type:	str

execution_errors¶

Gets the execution_errors of this TaskRun. An array of execution errors from the run.

Returns:	The execution_errors of this TaskRun.
Return type:	list[str]

expected_duration¶

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

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

expected_duration_unit¶

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

external_id¶

Gets the external_id of this TaskRun. The external identifier for the task run.

Returns:	The external_id of this TaskRun.
Return type:	str

identifier¶

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

is_log_processing_in_progress¶

Gets the is_log_processing_in_progress of this TaskRun. This field tells the user if there is any logs being fetched in backend for failure. Applicable only for failed pipeline tasks.

Returns:	The is_log_processing_in_progress of this TaskRun.
Return type:	bool

key¶

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

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

key_map¶

Gets the key_map of this TaskRun. A key map. If provided, key is replaced with generated key. This structure provides mapping between user provided key and generated key.

Returns:	The key_map of this TaskRun.
Return type:	dict(str, str)

last_updated¶

Gets the last_updated of this TaskRun. The date and time the object was last updated.

Returns:	The last_updated of this TaskRun.
Return type:	int

metadata¶

Gets the metadata of this TaskRun.

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

metrics¶

Gets the metrics of this TaskRun. A map of metrics for the run.

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

model_type¶

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

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

model_version¶

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

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

name¶

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

object_status¶

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

object_version¶

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

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

opc_request_id¶

Gets the opc_request_id of this TaskRun. The OPC request ID of execution of the task run.

Returns:	The opc_request_id of this TaskRun.
Return type:	str

outputs¶

Gets the outputs of this TaskRun. A map of the outputs of the run.

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

parent_ref¶

Gets the parent_ref of this TaskRun.

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

records_written¶

Gets the records_written of this TaskRun. The number of records processed in the task run.

Returns:	The records_written of this TaskRun.
Return type:	int

retry_attempt¶

Gets the retry_attempt of this TaskRun. Holds the particular attempt number.

Returns:	The retry_attempt of this TaskRun.
Return type:	int

start_time_millis¶

Gets the start_time_millis of this TaskRun. The start time.

Returns:	The start_time_millis of this TaskRun.
Return type:	int

status¶

Gets the status of this TaskRun. The status of the task run.

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 TaskRun.
Return type:	str

task_key¶

Gets the task_key of this TaskRun. Task Key of the task for which TaskRun is being created. If not specified, the AggregatorKey in RegistryMetadata will be assumed to be the TaskKey

Returns:	The task_key of this TaskRun.
Return type:	str

task_schedule¶

Gets the task_schedule of this TaskRun.

Returns:	The task_schedule of this TaskRun.
Return type:	oci.data_integration.models.TaskSchedule

task_type¶

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

termination_errors¶

Gets the termination_errors of this TaskRun. An array of termination errors from the run.

Returns:	The termination_errors of this TaskRun.
Return type:	list[str]