Pipeline¶

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

Bases: object

A Pipeline to orchestrate and execute machine learning workflows.

Attributes:

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a Pipeline.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a Pipeline.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a Pipeline.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a Pipeline.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a Pipeline.
`compartment_id`	[Required] Gets the compartment_id of this Pipeline.
`configuration_details`	Gets the configuration_details of this Pipeline.
`created_by`	[Required] Gets the created_by of this Pipeline.
`defined_tags`	Gets the defined_tags of this Pipeline.
`description`	Gets the description of this Pipeline.
`display_name`	[Required] Gets the display_name of this Pipeline.
`freeform_tags`	Gets the freeform_tags of this Pipeline.
`id`	[Required] Gets the id of this Pipeline.
`infrastructure_configuration_details`	Gets the infrastructure_configuration_details of this Pipeline.
`lifecycle_details`	Gets the lifecycle_details of this Pipeline.
`lifecycle_state`	[Required] Gets the lifecycle_state of this Pipeline.
`log_configuration_details`	Gets the log_configuration_details of this Pipeline.
`parameters`	Gets the parameters of this Pipeline.
`pipeline_run_retention_period_in_days`	Gets the pipeline_run_retention_period_in_days of this Pipeline.
`project_id`	[Required] Gets the project_id of this Pipeline.
`step_details`	[Required] Gets the step_details of this Pipeline.
`storage_mount_configuration_details_list`	Gets the storage_mount_configuration_details_list of this Pipeline.
`system_tags`	Gets the system_tags of this Pipeline.
`time_created`	[Required] Gets the time_created of this Pipeline.
`time_updated`	Gets the time_updated of this Pipeline.

Methods:

__init__(**kwargs)

Initializes a new Pipeline object with values from keyword arguments.

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a Pipeline. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a Pipeline. This constant has a value of “CREATING”

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

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a Pipeline. This constant has a value of “DELETING”

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

__init__(**kwargs)¶

Initializes a new Pipeline 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 Pipeline.
time_created (datetime) – The value to assign to the time_created property of this Pipeline.
time_updated (datetime) – The value to assign to the time_updated property of this Pipeline.
created_by (str) – The value to assign to the created_by property of this Pipeline.
project_id (str) – The value to assign to the project_id property of this Pipeline.
compartment_id (str) – The value to assign to the compartment_id property of this Pipeline.
display_name (str) – The value to assign to the display_name property of this Pipeline.
description (str) – The value to assign to the description property of this Pipeline.
pipeline_run_retention_period_in_days (int) – The value to assign to the pipeline_run_retention_period_in_days property of this Pipeline.
configuration_details (oci.data_science.models.PipelineConfigurationDetails) – The value to assign to the configuration_details property of this Pipeline.
log_configuration_details (oci.data_science.models.PipelineLogConfigurationDetails) – The value to assign to the log_configuration_details property of this Pipeline.
infrastructure_configuration_details (oci.data_science.models.PipelineInfrastructureConfigurationDetails) – The value to assign to the infrastructure_configuration_details property of this Pipeline.
storage_mount_configuration_details_list (list[oci.data_science.models.StorageMountConfigurationDetails]) – The value to assign to the storage_mount_configuration_details_list property of this Pipeline.
parameters (dict(str, str)) – The value to assign to the parameters property of this Pipeline.
step_details (list[oci.data_science.models.PipelineStepDetails]) – The value to assign to the step_details property of this Pipeline.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this Pipeline. Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “FAILED”, “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 Pipeline.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Pipeline.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Pipeline.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Pipeline.

property compartment_id¶

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

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

property configuration_details¶

Gets the configuration_details of this Pipeline.

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

property created_by¶

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

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

property defined_tags¶

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

property description¶

Gets the description of this Pipeline. A short description of the pipeline.

Returns: The description of this Pipeline.
Return type: str

property display_name¶

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

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

property freeform_tags¶

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

property id¶

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

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

property infrastructure_configuration_details¶

Gets the infrastructure_configuration_details of this Pipeline.

Returns: The infrastructure_configuration_details of this Pipeline.
Return type: oci.data_science.models.PipelineInfrastructureConfigurationDetails

property lifecycle_details¶

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

property lifecycle_state¶

[Required] Gets the lifecycle_state of this Pipeline. The current state of the pipeline.

Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “FAILED”, “DELETED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

property log_configuration_details¶

Gets the log_configuration_details of this Pipeline.

Returns: The log_configuration_details of this Pipeline.
Return type: oci.data_science.models.PipelineLogConfigurationDetails

property parameters¶

Gets the parameters of this Pipeline. Parameters used in the pipeline.

Returns: The parameters of this Pipeline.
Return type: dict(str, str)

property pipeline_run_retention_period_in_days¶

Gets the pipeline_run_retention_period_in_days of this Pipeline. Retention period in days for pipeline runs.

Returns: The pipeline_run_retention_period_in_days of this Pipeline.
Return type: int

property project_id¶

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

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

property step_details¶

[Required] Gets the step_details of this Pipeline. Array of step details for each step.

Returns: The step_details of this Pipeline.
Return type: list[oci.data_science.models.PipelineStepDetails]

property storage_mount_configuration_details_list¶

Gets the storage_mount_configuration_details_list of this Pipeline. The storage mount details to mount to the instance running the pipeline step.

Returns: The storage_mount_configuration_details_list of this Pipeline.
Return type: list[oci.data_science.models.StorageMountConfigurationDetails]

property system_tags¶

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

property time_created¶

[Required] Gets the time_created of this Pipeline. The date and time the resource was created in the timestamp format defined by RFC3339. Example: 2020-08-06T21:10:29.41Z

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

property time_updated¶

Gets the time_updated of this Pipeline. The date and time the resource was updated in the timestamp format defined by RFC3339. Example: 2020-08-06T21:10:29.41Z

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