PipelineRunSummary

class oci.data_science.models.PipelineRunSummary(**kwargs)

Bases: object

Summary of the PipelineRun.

Attributes:

LIFECYCLE_STATE_ACCEPTED

A constant which can be used with the lifecycle_state property of a PipelineRunSummary.

LIFECYCLE_STATE_CANCELED

A constant which can be used with the lifecycle_state property of a PipelineRunSummary.

LIFECYCLE_STATE_CANCELING

A constant which can be used with the lifecycle_state property of a PipelineRunSummary.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a PipelineRunSummary.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a PipelineRunSummary.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a PipelineRunSummary.

LIFECYCLE_STATE_IN_PROGRESS

A constant which can be used with the lifecycle_state property of a PipelineRunSummary.

LIFECYCLE_STATE_SUCCEEDED

A constant which can be used with the lifecycle_state property of a PipelineRunSummary.

compartment_id

[Required] Gets the compartment_id of this PipelineRunSummary.

created_by

[Required] Gets the created_by of this PipelineRunSummary.

defined_tags

Gets the defined_tags of this PipelineRunSummary.

display_name

[Required] Gets the display_name of this PipelineRunSummary.

freeform_tags

Gets the freeform_tags of this PipelineRunSummary.

id

[Required] Gets the id of this PipelineRunSummary.

lifecycle_details

Gets the lifecycle_details of this PipelineRunSummary.

lifecycle_state

[Required] Gets the lifecycle_state of this PipelineRunSummary.

pipeline_id

[Required] Gets the pipeline_id of this PipelineRunSummary.

project_id

[Required] Gets the project_id of this PipelineRunSummary.

system_tags

Gets the system_tags of this PipelineRunSummary.

time_accepted

[Required] Gets the time_accepted of this PipelineRunSummary.

time_finished

Gets the time_finished of this PipelineRunSummary.

time_started

Gets the time_started of this PipelineRunSummary.

time_updated

Gets the time_updated of this PipelineRunSummary.

Methods:

__init__(**kwargs)

Initializes a new PipelineRunSummary object with values from keyword arguments.

LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'

A constant which can be used with the lifecycle_state property of a PipelineRunSummary. This constant has a value of “ACCEPTED”

LIFECYCLE_STATE_CANCELED = 'CANCELED'

A constant which can be used with the lifecycle_state property of a PipelineRunSummary. This constant has a value of “CANCELED”

LIFECYCLE_STATE_CANCELING = 'CANCELING'

A constant which can be used with the lifecycle_state property of a PipelineRunSummary. This constant has a value of “CANCELING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a PipelineRunSummary. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a PipelineRunSummary. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

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

LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'

A constant which can be used with the lifecycle_state property of a PipelineRunSummary. This constant has a value of “SUCCEEDED”

__init__(**kwargs)

Initializes a new PipelineRunSummary 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 PipelineRunSummary.

  • time_accepted (datetime) – The value to assign to the time_accepted property of this PipelineRunSummary.

  • time_started (datetime) – The value to assign to the time_started property of this PipelineRunSummary.

  • time_finished (datetime) – The value to assign to the time_finished property of this PipelineRunSummary.

  • time_updated (datetime) – The value to assign to the time_updated property of this PipelineRunSummary.

  • created_by (str) – The value to assign to the created_by property of this PipelineRunSummary.

  • project_id (str) – The value to assign to the project_id property of this PipelineRunSummary.

  • compartment_id (str) – The value to assign to the compartment_id property of this PipelineRunSummary.

  • pipeline_id (str) – The value to assign to the pipeline_id property of this PipelineRunSummary.

  • display_name (str) – The value to assign to the display_name property of this PipelineRunSummary.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this PipelineRunSummary. Allowed values for this property are: “ACCEPTED”, “IN_PROGRESS”, “FAILED”, “SUCCEEDED”, “CANCELING”, “CANCELED”, “DELETING”, “DELETED”, ‘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 PipelineRunSummary.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this PipelineRunSummary.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this PipelineRunSummary.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this PipelineRunSummary.

property compartment_id

[Required] Gets the compartment_id of this PipelineRunSummary. The OCID of the compartment where you want to create the pipeline run.

Returns

The compartment_id of this PipelineRunSummary.

Return type

str

property created_by

[Required] Gets the created_by of this PipelineRunSummary. The OCID of the user who created the pipeline run.

Returns

The created_by of this PipelineRunSummary.

Return type

str

property defined_tags

Gets the defined_tags of this PipelineRunSummary. 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 PipelineRunSummary.

Return type

dict(str, dict(str, object))

property display_name

[Required] Gets the display_name of this PipelineRunSummary. A user-friendly display name for the resource.

Returns

The display_name of this PipelineRunSummary.

Return type

str

property freeform_tags

Gets the freeform_tags of this PipelineRunSummary. 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 PipelineRunSummary.

Return type

dict(str, str)

property id

[Required] Gets the id of this PipelineRunSummary. The OCID of the pipeline run.

Returns

The id of this PipelineRunSummary.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this PipelineRunSummary. A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in ‘Failed’ state.

Returns

The lifecycle_details of this PipelineRunSummary.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this PipelineRunSummary. The state of the pipeline run.

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

Returns

The lifecycle_state of this PipelineRunSummary.

Return type

str

property pipeline_id

[Required] Gets the pipeline_id of this PipelineRunSummary. The OCID of the pipeline for which pipeline run is created.

Returns

The pipeline_id of this PipelineRunSummary.

Return type

str

property project_id

[Required] Gets the project_id of this PipelineRunSummary. The OCID of the project to associate the pipeline run with.

Returns

The project_id of this PipelineRunSummary.

Return type

str

property system_tags

Gets the system_tags of this PipelineRunSummary. Usage of system tag keys. These predefined keys are scoped to namespaces. Example: {“orcl-cloud”: {“free-tier-retained”: “true”}}

Returns

The system_tags of this PipelineRunSummary.

Return type

dict(str, dict(str, object))

property time_accepted

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

Returns

The time_accepted of this PipelineRunSummary.

Return type

datetime

property time_finished

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

Returns

The time_finished of this PipelineRunSummary.

Return type

datetime

property time_started

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

Returns

The time_started of this PipelineRunSummary.

Return type

datetime

property time_updated

Gets the time_updated of this PipelineRunSummary. The date and time the pipeline run was updated in the timestamp format defined by RFC3339.

Returns

The time_updated of this PipelineRunSummary.

Return type

datetime