PipelineRun

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

Bases: object

Description of PipelineRun.

Attributes

LIFECYCLE_STATE_ACCEPTED A constant which can be used with the lifecycle_state property of a PipelineRun.
LIFECYCLE_STATE_CANCELED A constant which can be used with the lifecycle_state property of a PipelineRun.
LIFECYCLE_STATE_CANCELING A constant which can be used with the lifecycle_state property of a PipelineRun.
LIFECYCLE_STATE_DELETED A constant which can be used with the lifecycle_state property of a PipelineRun.
LIFECYCLE_STATE_DELETING A constant which can be used with the lifecycle_state property of a PipelineRun.
LIFECYCLE_STATE_FAILED A constant which can be used with the lifecycle_state property of a PipelineRun.
LIFECYCLE_STATE_IN_PROGRESS A constant which can be used with the lifecycle_state property of a PipelineRun.
LIFECYCLE_STATE_SUCCEEDED A constant which can be used with the lifecycle_state property of a PipelineRun.
compartment_id [Required] Gets the compartment_id of this PipelineRun.
configuration_details Gets the configuration_details of this PipelineRun.
configuration_override_details Gets the configuration_override_details of this PipelineRun.
created_by [Required] Gets the created_by of this PipelineRun.
defined_tags Gets the defined_tags of this PipelineRun.
display_name [Required] Gets the display_name of this PipelineRun.
freeform_tags Gets the freeform_tags of this PipelineRun.
id [Required] Gets the id of this PipelineRun.
lifecycle_details Gets the lifecycle_details of this PipelineRun.
lifecycle_state [Required] Gets the lifecycle_state of this PipelineRun.
log_configuration_override_details Gets the log_configuration_override_details of this PipelineRun.
log_details Gets the log_details of this PipelineRun.
pipeline_id [Required] Gets the pipeline_id of this PipelineRun.
project_id [Required] Gets the project_id of this PipelineRun.
step_override_details Gets the step_override_details of this PipelineRun.
step_runs [Required] Gets the step_runs of this PipelineRun.
system_tags Gets the system_tags of this PipelineRun.
time_accepted [Required] Gets the time_accepted of this PipelineRun.
time_finished Gets the time_finished of this PipelineRun.
time_started Gets the time_started of this PipelineRun.
time_updated Gets the time_updated of this PipelineRun.

Methods

__init__(**kwargs) Initializes a new PipelineRun object with values from keyword arguments.
LIFECYCLE_STATE_ACCEPTED = 'ACCEPTED'

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

LIFECYCLE_STATE_CANCELED = 'CANCELED'

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

LIFECYCLE_STATE_CANCELING = 'CANCELING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

__init__(**kwargs)

Initializes a new PipelineRun 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 PipelineRun.
  • time_accepted (datetime) – The value to assign to the time_accepted property of this PipelineRun.
  • time_started (datetime) – The value to assign to the time_started property of this PipelineRun.
  • time_updated (datetime) – The value to assign to the time_updated property of this PipelineRun.
  • time_finished (datetime) – The value to assign to the time_finished property of this PipelineRun.
  • created_by (str) – The value to assign to the created_by property of this PipelineRun.
  • project_id (str) – The value to assign to the project_id property of this PipelineRun.
  • compartment_id (str) – The value to assign to the compartment_id property of this PipelineRun.
  • pipeline_id (str) – The value to assign to the pipeline_id property of this PipelineRun.
  • display_name (str) – The value to assign to the display_name property of this PipelineRun.
  • configuration_details (oci.data_science.models.PipelineConfigurationDetails) – The value to assign to the configuration_details property of this PipelineRun.
  • configuration_override_details (oci.data_science.models.PipelineConfigurationDetails) – The value to assign to the configuration_override_details property of this PipelineRun.
  • log_configuration_override_details (oci.data_science.models.PipelineLogConfigurationDetails) – The value to assign to the log_configuration_override_details property of this PipelineRun.
  • step_override_details (list[oci.data_science.models.PipelineStepOverrideDetails]) – The value to assign to the step_override_details property of this PipelineRun.
  • log_details (oci.data_science.models.PipelineRunLogDetails) – The value to assign to the log_details property of this PipelineRun.
  • step_runs (list[oci.data_science.models.PipelineStepRun]) – The value to assign to the step_runs property of this PipelineRun.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this PipelineRun. 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 PipelineRun.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this PipelineRun.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this PipelineRun.
  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this PipelineRun.
compartment_id

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

Returns:The compartment_id of this PipelineRun.
Return type:str
configuration_details

Gets the configuration_details of this PipelineRun.

Returns:The configuration_details of this PipelineRun.
Return type:oci.data_science.models.PipelineConfigurationDetails
configuration_override_details

Gets the configuration_override_details of this PipelineRun.

Returns:The configuration_override_details of this PipelineRun.
Return type:oci.data_science.models.PipelineConfigurationDetails
created_by

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

Returns:The created_by of this PipelineRun.
Return type:str
defined_tags

Gets the defined_tags of this PipelineRun. 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 PipelineRun.
Return type:dict(str, dict(str, object))
display_name

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

Returns:The display_name of this PipelineRun.
Return type:str
freeform_tags

Gets the freeform_tags of this PipelineRun. 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 PipelineRun.
Return type:dict(str, str)
id

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

Returns:The id of this PipelineRun.
Return type:str
lifecycle_details

Gets the lifecycle_details of this PipelineRun. 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 PipelineRun.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this PipelineRun. The current 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 PipelineRun.
Return type:str
log_configuration_override_details

Gets the log_configuration_override_details of this PipelineRun.

Returns:The log_configuration_override_details of this PipelineRun.
Return type:oci.data_science.models.PipelineLogConfigurationDetails
log_details

Gets the log_details of this PipelineRun.

Returns:The log_details of this PipelineRun.
Return type:oci.data_science.models.PipelineRunLogDetails
pipeline_id

[Required] Gets the pipeline_id of this PipelineRun. The OCID of the pipeline.

Returns:The pipeline_id of this PipelineRun.
Return type:str
project_id

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

Returns:The project_id of this PipelineRun.
Return type:str
step_override_details

Gets the step_override_details of this PipelineRun. Array of step override details. Only Step Configuration is allowed to be overridden.

Returns:The step_override_details of this PipelineRun.
Return type:list[oci.data_science.models.PipelineStepOverrideDetails]
step_runs

[Required] Gets the step_runs of this PipelineRun. Array of StepRun object for each step.

Returns:The step_runs of this PipelineRun.
Return type:list[oci.data_science.models.PipelineStepRun]
system_tags

Gets the system_tags of this PipelineRun. 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 PipelineRun.
Return type:dict(str, dict(str, object))
time_accepted

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

Returns:The time_accepted of this PipelineRun.
Return type:datetime
time_finished

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

Returns:The time_finished of this PipelineRun.
Return type:datetime
time_started

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

Returns:The time_started of this PipelineRun.
Return type:datetime
time_updated

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

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