PipelineDataflowStepDetails

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

Bases: PipelineStepDetails

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

Attributes:

STEP_TYPE_CONTAINER

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

STEP_TYPE_CUSTOM_SCRIPT

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

STEP_TYPE_DATAFLOW

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

STEP_TYPE_ML_JOB

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

application_id

[Required] Gets the application_id of this PipelineDataflowStepDetails.

depends_on

Gets the depends_on of this PipelineStepDetails.

description

Gets the description of this PipelineStepDetails.

step_configuration_details

Gets the step_configuration_details of this PipelineStepDetails.

step_dataflow_configuration_details

Gets the step_dataflow_configuration_details of this PipelineDataflowStepDetails.

step_name

[Required] Gets the step_name of this PipelineStepDetails.

step_type

[Required] Gets the step_type of this PipelineStepDetails.

Methods:

__init__(**kwargs)

Initializes a new PipelineDataflowStepDetails 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 PipelineStepDetails. 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 PipelineStepDetails. 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 PipelineStepDetails. 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 PipelineStepDetails. This constant has a value of “ML_JOB”

__init__(**kwargs)

Initializes a new PipelineDataflowStepDetails object with values from keyword arguments. The default value of the step_type attribute of this class is DATAFLOW 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 PipelineDataflowStepDetails. 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 PipelineDataflowStepDetails.

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

  • depends_on (list[str]) – The value to assign to the depends_on property of this PipelineDataflowStepDetails.

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

  • application_id (str) – The value to assign to the application_id property of this PipelineDataflowStepDetails.

  • step_dataflow_configuration_details (oci.data_science.models.PipelineDataflowConfigurationDetails) – The value to assign to the step_dataflow_configuration_details property of this PipelineDataflowStepDetails.

property application_id

[Required] Gets the application_id of this PipelineDataflowStepDetails. The OCID of the dataflow application to be used as a step.

Returns

The application_id of this PipelineDataflowStepDetails.

Return type

str

property 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]

property 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.

property 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

property step_dataflow_configuration_details

Gets the step_dataflow_configuration_details of this PipelineDataflowStepDetails.

Returns

The step_dataflow_configuration_details of this PipelineDataflowStepDetails.

Return type

oci.data_science.models.PipelineDataflowConfigurationDetails

property 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

property 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