TaskRunSummary

class oci.data_integration.models.TaskRunSummary(**kwargs)

Bases: object

The information about a task run.

Attributes

STATUS_ERROR A constant which can be used with the status property of a TaskRunSummary.
STATUS_NOT_STARTED A constant which can be used with the status property of a TaskRunSummary.
STATUS_QUEUED A constant which can be used with the status property of a TaskRunSummary.
STATUS_RUNNING A constant which can be used with the status property of a TaskRunSummary.
STATUS_SUCCESS A constant which can be used with the status property of a TaskRunSummary.
STATUS_TERMINATED A constant which can be used with the status property of a TaskRunSummary.
STATUS_TERMINATING A constant which can be used with the status property of a TaskRunSummary.
TASK_TYPE_DATA_LOADER_TASK A constant which can be used with the task_type property of a TaskRunSummary.
TASK_TYPE_INTEGRATION_TASK A constant which can be used with the task_type property of a TaskRunSummary.
TASK_TYPE_OCI_DATAFLOW_TASK A constant which can be used with the task_type property of a TaskRunSummary.
TASK_TYPE_PIPELINE_TASK A constant which can be used with the task_type property of a TaskRunSummary.
TASK_TYPE_REST_TASK A constant which can be used with the task_type property of a TaskRunSummary.
TASK_TYPE_SQL_TASK A constant which can be used with the task_type property of a TaskRunSummary.
bytes_processed Gets the bytes_processed of this TaskRunSummary.
description Gets the description of this TaskRunSummary.
end_time_millis Gets the end_time_millis of this TaskRunSummary.
identifier Gets the identifier of this TaskRunSummary.
key Gets the key of this TaskRunSummary.
last_updated Gets the last_updated of this TaskRunSummary.
metadata Gets the metadata of this TaskRunSummary.
model_type Gets the model_type of this TaskRunSummary.
model_version Gets the model_version of this TaskRunSummary.
name Gets the name of this TaskRunSummary.
object_status Gets the object_status of this TaskRunSummary.
object_version Gets the object_version of this TaskRunSummary.
parent_ref Gets the parent_ref of this TaskRunSummary.
records_written Gets the records_written of this TaskRunSummary.
start_time_millis Gets the start_time_millis of this TaskRunSummary.
status Gets the status of this TaskRunSummary.
task_type Gets the task_type of this TaskRunSummary.

Methods

__init__(**kwargs) Initializes a new TaskRunSummary object with values from keyword arguments.
STATUS_ERROR = 'ERROR'

A constant which can be used with the status property of a TaskRunSummary. This constant has a value of “ERROR”

STATUS_NOT_STARTED = 'NOT_STARTED'

A constant which can be used with the status property of a TaskRunSummary. This constant has a value of “NOT_STARTED”

STATUS_QUEUED = 'QUEUED'

A constant which can be used with the status property of a TaskRunSummary. This constant has a value of “QUEUED”

STATUS_RUNNING = 'RUNNING'

A constant which can be used with the status property of a TaskRunSummary. This constant has a value of “RUNNING”

STATUS_SUCCESS = 'SUCCESS'

A constant which can be used with the status property of a TaskRunSummary. This constant has a value of “SUCCESS”

STATUS_TERMINATED = 'TERMINATED'

A constant which can be used with the status property of a TaskRunSummary. This constant has a value of “TERMINATED”

STATUS_TERMINATING = 'TERMINATING'

A constant which can be used with the status property of a TaskRunSummary. 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 TaskRunSummary. 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 TaskRunSummary. 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 TaskRunSummary. 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 TaskRunSummary. 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 TaskRunSummary. 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 TaskRunSummary. This constant has a value of “SQL_TASK”

__init__(**kwargs)

Initializes a new TaskRunSummary 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 TaskRunSummary.
  • model_type (str) – The value to assign to the model_type property of this TaskRunSummary.
  • model_version (str) – The value to assign to the model_version property of this TaskRunSummary.
  • parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this TaskRunSummary.
  • name (str) – The value to assign to the name property of this TaskRunSummary.
  • description (str) – The value to assign to the description property of this TaskRunSummary.
  • object_version (int) – The value to assign to the object_version property of this TaskRunSummary.
  • status (str) – The value to assign to the status property of this TaskRunSummary. 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 TaskRunSummary.
  • end_time_millis (int) – The value to assign to the end_time_millis property of this TaskRunSummary.
  • last_updated (int) – The value to assign to the last_updated property of this TaskRunSummary.
  • records_written (int) – The value to assign to the records_written property of this TaskRunSummary.
  • bytes_processed (int) – The value to assign to the bytes_processed property of this TaskRunSummary.
  • object_status (int) – The value to assign to the object_status property of this TaskRunSummary.
  • task_type (str) – The value to assign to the task_type property of this TaskRunSummary. 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’.
  • identifier (str) – The value to assign to the identifier property of this TaskRunSummary.
  • metadata (oci.data_integration.models.ObjectMetadata) – The value to assign to the metadata property of this TaskRunSummary.
bytes_processed

Gets the bytes_processed of this TaskRunSummary. Number of bytes processed in task run.

Returns:The bytes_processed of this TaskRunSummary.
Return type:int
description

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

Returns:The description of this TaskRunSummary.
Return type:str
end_time_millis

Gets the end_time_millis of this TaskRunSummary. The task run end time.

Returns:The end_time_millis of this TaskRunSummary.
Return type:int
identifier

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

Gets the key of this TaskRunSummary. The object key.

Returns:The key of this TaskRunSummary.
Return type:str
last_updated

Gets the last_updated of this TaskRunSummary. The date and time the task run was last updated.

Returns:The last_updated of this TaskRunSummary.
Return type:int
metadata

Gets the metadata of this TaskRunSummary.

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

Gets the model_type of this TaskRunSummary. The object type.

Returns:The model_type of this TaskRunSummary.
Return type:str
model_version

Gets the model_version of this TaskRunSummary. The object’s model version.

Returns:The model_version of this TaskRunSummary.
Return type:str
name

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

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

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

Returns:The object_version of this TaskRunSummary.
Return type:int
parent_ref

Gets the parent_ref of this TaskRunSummary.

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

Gets the records_written of this TaskRunSummary. Number of records processed in task run.

Returns:The records_written of this TaskRunSummary.
Return type:int
start_time_millis

Gets the start_time_millis of this TaskRunSummary. The task run start time.

Returns:The start_time_millis of this TaskRunSummary.
Return type:int
status

Gets the status of this TaskRunSummary. status

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

Gets the task_type of this TaskRunSummary. The type of the task for the 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 TaskRunSummary.
Return type:str