PipelineMLJobStepDetails¶

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

Bases: oci.data_science.models.pipeline_step_details.PipelineStepDetails

The type of step where the job is pre-created by the user.

Attributes

`STEP_TYPE_CONTAINER`	str(object=’’) -> str
`STEP_TYPE_CUSTOM_SCRIPT`	str(object=’’) -> str
`STEP_TYPE_DATAFLOW`	str(object=’’) -> str
`STEP_TYPE_ML_JOB`	str(object=’’) -> str
`depends_on`	Gets the depends_on of this PipelineStepDetails.
`description`	Gets the description of this PipelineStepDetails.
`job_id`	[Required] Gets the job_id of this PipelineMLJobStepDetails.
`step_configuration_details`	Gets the step_configuration_details of this PipelineStepDetails.
`step_name`	[Required] Gets the step_name of this PipelineStepDetails.
`step_parameters`	Gets the step_parameters of this PipelineMLJobStepDetails.
`step_run_name`	Gets the step_run_name of this PipelineMLJobStepDetails.
`step_type`	[Required] Gets the step_type of this PipelineStepDetails.

Methods

`__init__`(**kwargs)	Initializes a new PipelineMLJobStepDetails object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

STEP_TYPE_CONTAINER = 'CONTAINER'¶

STEP_TYPE_CUSTOM_SCRIPT = 'CUSTOM_SCRIPT'¶

STEP_TYPE_DATAFLOW = 'DATAFLOW'¶

STEP_TYPE_ML_JOB = 'ML_JOB'¶

__init__(**kwargs)¶

Initializes a new PipelineMLJobStepDetails object with values from keyword arguments. The default value of the step_type attribute of this class is ML_JOB and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

step_type (str) – The value to assign to the step_type property of this PipelineMLJobStepDetails. Allowed values for this property are: “ML_JOB”, “CUSTOM_SCRIPT”, “CONTAINER”, “DATAFLOW”
step_name (str) – The value to assign to the step_name property of this PipelineMLJobStepDetails.
description (str) – The value to assign to the description property of this PipelineMLJobStepDetails.
depends_on (list[str]) – The value to assign to the depends_on property of this PipelineMLJobStepDetails.
step_configuration_details (oci.data_science.models.PipelineStepConfigurationDetails) – The value to assign to the step_configuration_details property of this PipelineMLJobStepDetails.
job_id (str) – The value to assign to the job_id property of this PipelineMLJobStepDetails.
step_run_name (str) – The value to assign to the step_run_name property of this PipelineMLJobStepDetails.
step_parameters (oci.data_science.models.PipelineStepParameterDetails) – The value to assign to the step_parameters property of this PipelineMLJobStepDetails.

depends_on¶

Gets the depends_on of this PipelineStepDetails. The list of step names this current step depends on for execution.

Returns:	The depends_on of this PipelineStepDetails.
Return type:	list[str]

description¶

Gets the description of this PipelineStepDetails. A short description of the step.

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

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

job_id¶

[Required] Gets the job_id of this PipelineMLJobStepDetails. The OCID of the job to be used as a step.

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

step_configuration_details¶

Gets the step_configuration_details of this PipelineStepDetails.

Returns:	The step_configuration_details of this PipelineStepDetails.
Return type:	oci.data_science.models.PipelineStepConfigurationDetails

step_name¶

[Required] Gets the step_name of this PipelineStepDetails. The name of the step. It must be unique within the pipeline. This is used to create the pipeline DAG.

Returns:	The step_name of this PipelineStepDetails.
Return type:	str

step_parameters¶

Gets the step_parameters of this PipelineMLJobStepDetails.

Returns:	The step_parameters of this PipelineMLJobStepDetails.
Return type:	oci.data_science.models.PipelineStepParameterDetails

step_run_name¶

Gets the step_run_name of this PipelineMLJobStepDetails. Name used when creating the steprun.

Returns:	The step_run_name of this PipelineMLJobStepDetails.
Return type:	str

step_type¶

[Required] Gets the step_type of this PipelineStepDetails. The type of step.

Allowed values for this property are: “ML_JOB”, “CUSTOM_SCRIPT”, “CONTAINER”, “DATAFLOW”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The step_type of this PipelineStepDetails.
Return type:	str