RunSummary¶

class oci.data_flow.models.RunSummary(**kwargs)¶

Bases: object

A summary of the run.

Attributes:

`LANGUAGE_JAVA`	A constant which can be used with the language property of a RunSummary.
`LANGUAGE_PYTHON`	A constant which can be used with the language property of a RunSummary.
`LANGUAGE_SCALA`	A constant which can be used with the language property of a RunSummary.
`LANGUAGE_SQL`	A constant which can be used with the language property of a RunSummary.
`LIFECYCLE_STATE_ACCEPTED`	A constant which can be used with the lifecycle_state property of a RunSummary.
`LIFECYCLE_STATE_CANCELED`	A constant which can be used with the lifecycle_state property of a RunSummary.
`LIFECYCLE_STATE_CANCELING`	A constant which can be used with the lifecycle_state property of a RunSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a RunSummary.
`LIFECYCLE_STATE_IN_PROGRESS`	A constant which can be used with the lifecycle_state property of a RunSummary.
`LIFECYCLE_STATE_STOPPED`	A constant which can be used with the lifecycle_state property of a RunSummary.
`LIFECYCLE_STATE_STOPPING`	A constant which can be used with the lifecycle_state property of a RunSummary.
`LIFECYCLE_STATE_SUCCEEDED`	A constant which can be used with the lifecycle_state property of a RunSummary.
`TYPE_BATCH`	A constant which can be used with the type property of a RunSummary.
`TYPE_SESSION`	A constant which can be used with the type property of a RunSummary.
`TYPE_STREAMING`	A constant which can be used with the type property of a RunSummary.
`application_id`	[Required] Gets the application_id of this RunSummary.
`compartment_id`	[Required] Gets the compartment_id of this RunSummary.
`data_read_in_bytes`	Gets the data_read_in_bytes of this RunSummary.
`data_written_in_bytes`	Gets the data_written_in_bytes of this RunSummary.
`defined_tags`	[Required] Gets the defined_tags of this RunSummary.
`display_name`	Gets the display_name of this RunSummary.
`freeform_tags`	[Required] Gets the freeform_tags of this RunSummary.
`id`	[Required] Gets the id of this RunSummary.
`language`	[Required] Gets the language of this RunSummary.
`lifecycle_details`	Gets the lifecycle_details of this RunSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this RunSummary.
`opc_request_id`	Gets the opc_request_id of this RunSummary.
`owner_principal_id`	Gets the owner_principal_id of this RunSummary.
`owner_user_name`	Gets the owner_user_name of this RunSummary.
`pool_id`	Gets the pool_id of this RunSummary.
`run_duration_in_milliseconds`	Gets the run_duration_in_milliseconds of this RunSummary.
`time_created`	[Required] Gets the time_created of this RunSummary.
`time_updated`	[Required] Gets the time_updated of this RunSummary.
`total_o_cpu`	Gets the total_o_cpu of this RunSummary.
`type`	Gets the type of this RunSummary.

Methods:

__init__(**kwargs)

Initializes a new RunSummary object with values from keyword arguments.

LANGUAGE_JAVA = 'JAVA'¶: A constant which can be used with the language property of a RunSummary. This constant has a value of “JAVA”

LANGUAGE_PYTHON = 'PYTHON'¶: A constant which can be used with the language property of a RunSummary. This constant has a value of “PYTHON”

LANGUAGE_SCALA = 'SCALA'¶: A constant which can be used with the language property of a RunSummary. This constant has a value of “SCALA”

LANGUAGE_SQL = 'SQL'¶: A constant which can be used with the language property of a RunSummary. This constant has a value of “SQL”

LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'¶: A constant which can be used with the lifecycle_state property of a RunSummary. This constant has a value of “ACCEPTED”

LIFECYCLE_STATE_CANCELED = 'CANCELED'¶: A constant which can be used with the lifecycle_state property of a RunSummary. This constant has a value of “CANCELED”

LIFECYCLE_STATE_CANCELING = 'CANCELING'¶: A constant which can be used with the lifecycle_state property of a RunSummary. This constant has a value of “CANCELING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a RunSummary. This constant has a value of “FAILED”

LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the lifecycle_state property of a RunSummary. This constant has a value of “IN_PROGRESS”

LIFECYCLE_STATE_STOPPED = 'STOPPED'¶: A constant which can be used with the lifecycle_state property of a RunSummary. This constant has a value of “STOPPED”

LIFECYCLE_STATE_STOPPING = 'STOPPING'¶: A constant which can be used with the lifecycle_state property of a RunSummary. This constant has a value of “STOPPING”

LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'¶: A constant which can be used with the lifecycle_state property of a RunSummary. This constant has a value of “SUCCEEDED”

TYPE_BATCH = 'BATCH'¶: A constant which can be used with the type property of a RunSummary. This constant has a value of “BATCH”

TYPE_SESSION = 'SESSION'¶: A constant which can be used with the type property of a RunSummary. This constant has a value of “SESSION”

TYPE_STREAMING = 'STREAMING'¶: A constant which can be used with the type property of a RunSummary. This constant has a value of “STREAMING”

__init__(**kwargs)¶

Initializes a new RunSummary object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters

application_id (str) – The value to assign to the application_id property of this RunSummary.
compartment_id (str) – The value to assign to the compartment_id property of this RunSummary.
data_read_in_bytes (int) – The value to assign to the data_read_in_bytes property of this RunSummary.
data_written_in_bytes (int) – The value to assign to the data_written_in_bytes property of this RunSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this RunSummary.
display_name (str) – The value to assign to the display_name property of this RunSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this RunSummary.
id (str) – The value to assign to the id property of this RunSummary.
language (str) – The value to assign to the language property of this RunSummary. Allowed values for this property are: “SCALA”, “JAVA”, “PYTHON”, “SQL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this RunSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this RunSummary. Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “CANCELING”, “CANCELED”, “FAILED”, “SUCCEEDED”, “STOPPING”, “STOPPED”, ‘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 RunSummary.
owner_principal_id (str) – The value to assign to the owner_principal_id property of this RunSummary.
owner_user_name (str) – The value to assign to the owner_user_name property of this RunSummary.
pool_id (str) – The value to assign to the pool_id property of this RunSummary.
run_duration_in_milliseconds (int) – The value to assign to the run_duration_in_milliseconds property of this RunSummary.
total_o_cpu (int) – The value to assign to the total_o_cpu property of this RunSummary.
time_created (datetime) – The value to assign to the time_created property of this RunSummary.
time_updated (datetime) – The value to assign to the time_updated property of this RunSummary.
type (str) – The value to assign to the type property of this RunSummary. Allowed values for this property are: “BATCH”, “STREAMING”, “SESSION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

property application_id¶

[Required] Gets the application_id of this RunSummary. The application ID.

Returns: The application_id of this RunSummary.
Return type: str

property compartment_id¶

[Required] Gets the compartment_id of this RunSummary. The OCID of a compartment.

Returns: The compartment_id of this RunSummary.
Return type: str

property data_read_in_bytes¶

Gets the data_read_in_bytes of this RunSummary. The data read by the run in bytes.

Returns: The data_read_in_bytes of this RunSummary.
Return type: int

property data_written_in_bytes¶

Gets the data_written_in_bytes of this RunSummary. The data written by the run in bytes.

Returns: The data_written_in_bytes of this RunSummary.
Return type: int

property defined_tags¶

[Required] Gets the defined_tags of this RunSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

Returns: The defined_tags of this RunSummary.
Return type: dict(str, dict(str, object))

property display_name¶

Gets the display_name of this RunSummary. A user-friendly name. This name is not necessarily unique.

Returns: The display_name of this RunSummary.
Return type: str

property freeform_tags¶

[Required] Gets the freeform_tags of this RunSummary. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {“Department”: “Finance”}

Returns: The freeform_tags of this RunSummary.
Return type: dict(str, str)

property id¶

[Required] Gets the id of this RunSummary. The ID of a run.

Returns: The id of this RunSummary.
Return type: str

property language¶

[Required] Gets the language of this RunSummary. The Spark language.

Allowed values for this property are: “SCALA”, “JAVA”, “PYTHON”, “SQL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The language of this RunSummary.
Return type: str

property lifecycle_details¶

Gets the lifecycle_details of this RunSummary. The detailed messages about the lifecycle state.

Returns: The lifecycle_details of this RunSummary.
Return type: str

property lifecycle_state¶

[Required] Gets the lifecycle_state of this RunSummary. The current state of this run.

Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “CANCELING”, “CANCELED”, “FAILED”, “SUCCEEDED”, “STOPPING”, “STOPPED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns: The lifecycle_state of this RunSummary.
Return type: str

property opc_request_id¶

Gets the opc_request_id of this RunSummary. Unique Oracle assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

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

property owner_principal_id¶

Gets the owner_principal_id of this RunSummary. The OCID of the user who created the resource.

Returns: The owner_principal_id of this RunSummary.
Return type: str

property owner_user_name¶

Gets the owner_user_name of this RunSummary. The username of the user who created the resource. If the username of the owner does not exist, null will be returned and the caller should refer to the ownerPrincipalId value instead.

Returns: The owner_user_name of this RunSummary.
Return type: str

property pool_id¶

Gets the pool_id of this RunSummary. The OCID of a pool. Unique Id to indentify a dataflow pool resource.

Returns: The pool_id of this RunSummary.
Return type: str

property run_duration_in_milliseconds¶

Gets the run_duration_in_milliseconds of this RunSummary. The duration of the run in milliseconds.

Returns: The run_duration_in_milliseconds of this RunSummary.
Return type: int

property time_created¶

[Required] Gets the time_created of this RunSummary. The date and time the resource was created, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

Returns: The time_created of this RunSummary.
Return type: datetime

property time_updated¶

[Required] Gets the time_updated of this RunSummary. The date and time the resource was updated, expressed in RFC 3339 timestamp format. Example: 2018-04-03T21:10:29.600Z

Returns: The time_updated of this RunSummary.
Return type: datetime

property total_o_cpu¶

Gets the total_o_cpu of this RunSummary. The total number of oCPU requested by the run.

Returns: The total_o_cpu of this RunSummary.
Return type: int

property type¶

Gets the type of this RunSummary. The Spark application processing type.

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

Returns: The type of this RunSummary.
Return type: str