PipelineMLJobStepUpdateDetails

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

Bases: PipelineStepUpdateDetails

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

Attributes:

STEP_TYPE_CONTAINER

A constant which can be used with the step_type property of a PipelineStepUpdateDetails.

STEP_TYPE_CUSTOM_SCRIPT

A constant which can be used with the step_type property of a PipelineStepUpdateDetails.

STEP_TYPE_DATAFLOW

A constant which can be used with the step_type property of a PipelineStepUpdateDetails.

STEP_TYPE_ML_JOB

A constant which can be used with the step_type property of a PipelineStepUpdateDetails.

description

Gets the description of this PipelineStepUpdateDetails.

step_configuration_details

Gets the step_configuration_details of this PipelineStepUpdateDetails.

step_name

[Required] Gets the step_name of this PipelineStepUpdateDetails.

step_parameters

Gets the step_parameters of this PipelineMLJobStepUpdateDetails.

step_run_name

Gets the step_run_name of this PipelineMLJobStepUpdateDetails.

step_type

[Required] Gets the step_type of this PipelineStepUpdateDetails.

Methods:

__init__(**kwargs)

Initializes a new PipelineMLJobStepUpdateDetails 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'

A constant which can be used with the step_type property of a PipelineStepUpdateDetails. This constant has a value of “CONTAINER”

STEP_TYPE_CUSTOM_SCRIPT = 'CUSTOM_SCRIPT'

A constant which can be used with the step_type property of a PipelineStepUpdateDetails. This constant has a value of “CUSTOM_SCRIPT”

STEP_TYPE_DATAFLOW = 'DATAFLOW'

A constant which can be used with the step_type property of a PipelineStepUpdateDetails. This constant has a value of “DATAFLOW”

STEP_TYPE_ML_JOB = 'ML_JOB'

A constant which can be used with the step_type property of a PipelineStepUpdateDetails. This constant has a value of “ML_JOB”

__init__(**kwargs)

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

  • description (str) – The value to assign to the description property of this PipelineMLJobStepUpdateDetails.

  • step_configuration_details (oci.data_science.models.PipelineStepConfigurationDetails) – The value to assign to the step_configuration_details property of this PipelineMLJobStepUpdateDetails.

  • step_run_name (str) – The value to assign to the step_run_name property of this PipelineMLJobStepUpdateDetails.

  • step_parameters (oci.data_science.models.PipelineStepParameterDetails) – The value to assign to the step_parameters property of this PipelineMLJobStepUpdateDetails.

property description

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

Returns

The description of this PipelineStepUpdateDetails.

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.

property step_configuration_details

Gets the step_configuration_details of this PipelineStepUpdateDetails.

Returns

The step_configuration_details of this PipelineStepUpdateDetails.

Return type

oci.data_science.models.PipelineStepConfigurationDetails

property step_name

[Required] Gets the step_name of this PipelineStepUpdateDetails. The name of the step.

Returns

The step_name of this PipelineStepUpdateDetails.

Return type

str

property step_parameters

Gets the step_parameters of this PipelineMLJobStepUpdateDetails.

Returns

The step_parameters of this PipelineMLJobStepUpdateDetails.

Return type

oci.data_science.models.PipelineStepParameterDetails

property step_run_name

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

Returns

The step_run_name of this PipelineMLJobStepUpdateDetails.

Return type

str

property step_type

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

Allowed values for this property are: “ML_JOB”, “CUSTOM_SCRIPT”, “CONTAINER”, “DATAFLOW”

Returns

The step_type of this PipelineStepUpdateDetails.

Return type

str