JobRunSummary¶

class oci.data_science.models.JobRunSummary(**kwargs)¶

Bases: object

Summary information for a Job.

Attributes

`LIFECYCLE_STATE_ACCEPTED`	A constant which can be used with the lifecycle_state property of a JobRunSummary.
`LIFECYCLE_STATE_CANCELED`	A constant which can be used with the lifecycle_state property of a JobRunSummary.
`LIFECYCLE_STATE_CANCELING`	A constant which can be used with the lifecycle_state property of a JobRunSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a JobRunSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a JobRunSummary.
`LIFECYCLE_STATE_IN_PROGRESS`	A constant which can be used with the lifecycle_state property of a JobRunSummary.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a JobRunSummary.
`LIFECYCLE_STATE_SUCCEEDED`	A constant which can be used with the lifecycle_state property of a JobRunSummary.
`compartment_id`	[Required] Gets the compartment_id of this JobRunSummary.
`created_by`	[Required] Gets the created_by of this JobRunSummary.
`defined_tags`	Gets the defined_tags of this JobRunSummary.
`display_name`	Gets the display_name of this JobRunSummary.
`freeform_tags`	Gets the freeform_tags of this JobRunSummary.
`id`	[Required] Gets the id of this JobRunSummary.
`job_id`	[Required] Gets the job_id of this JobRunSummary.
`lifecycle_details`	Gets the lifecycle_details of this JobRunSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this JobRunSummary.
`project_id`	[Required] Gets the project_id of this JobRunSummary.
`time_accepted`	[Required] Gets the time_accepted of this JobRunSummary.
`time_finished`	Gets the time_finished of this JobRunSummary.
`time_started`	Gets the time_started of this JobRunSummary.

Methods

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

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

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

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

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a JobRunSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a JobRunSummary. 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 JobRunSummary. This constant has a value of “IN_PROGRESS”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a JobRunSummary. This constant has a value of “NEEDS_ATTENTION”

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

__init__(**kwargs)¶

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

Parameters:

id (str) – The value to assign to the id property of this JobRunSummary.
time_accepted (datetime) – The value to assign to the time_accepted property of this JobRunSummary.
time_started (datetime) – The value to assign to the time_started property of this JobRunSummary.
time_finished (datetime) – The value to assign to the time_finished property of this JobRunSummary.
created_by (str) – The value to assign to the created_by property of this JobRunSummary.
project_id (str) – The value to assign to the project_id property of this JobRunSummary.
compartment_id (str) – The value to assign to the compartment_id property of this JobRunSummary.
job_id (str) – The value to assign to the job_id property of this JobRunSummary.
display_name (str) – The value to assign to the display_name property of this JobRunSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this JobRunSummary. Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”, “DELETED”, “NEEDS_ATTENTION”, ‘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 JobRunSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this JobRunSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this JobRunSummary.

compartment_id¶

[Required] Gets the compartment_id of this JobRunSummary. The OCID of the compartment where you want to create the job.

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

created_by¶

[Required] Gets the created_by of this JobRunSummary. The OCID of the user who created the job run.

Returns:	The created_by of this JobRunSummary.
Return type:	str

defined_tags¶

Gets the defined_tags of this JobRunSummary. Defined tags for this resource. Each key is predefined and scoped to a namespace. See Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}}

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

display_name¶

Gets the display_name of this JobRunSummary. A user-friendly display name for the resource.

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

freeform_tags¶

Gets the freeform_tags of this JobRunSummary. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. See Resource Tags. Example: {“Department”: “Finance”}

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

id¶

[Required] Gets the id of this JobRunSummary. The OCID of the job run.

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

job_id¶

[Required] Gets the job_id of this JobRunSummary. The OCID of the job run.

Returns:	The job_id of this JobRunSummary.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this JobRunSummary. Details of the state of the job run.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this JobRunSummary. The state of the job.

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

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

project_id¶

[Required] Gets the project_id of this JobRunSummary. The OCID of the project to associate the job with.

Returns:	The project_id of this JobRunSummary.
Return type:	str

time_accepted¶

[Required] Gets the time_accepted of this JobRunSummary. The date and time the job run was accepted in the timestamp format defined by RFC3339.

Returns:	The time_accepted of this JobRunSummary.
Return type:	datetime

time_finished¶

Gets the time_finished of this JobRunSummary. The date and time the job run request was finished in the timestamp format defined by RFC3339.

Returns:	The time_finished of this JobRunSummary.
Return type:	datetime

time_started¶

Gets the time_started of this JobRunSummary. The date and time the job run request was started in the timestamp format defined by RFC3339.

Returns:	The time_started of this JobRunSummary.
Return type:	datetime