Pipeline

class oci.data_integration.models.Pipeline(**kwargs)

Bases: object

A pipeline is a logical grouping of tasks that together perform a higher level operation. For example, a pipeline could contain a set of tasks that load and clean data, then execute a dataflow to analyze the data. The pipeline allows you to manage the activities as a unit instead of individually. Users can also schedule the pipeline instead of the tasks independently.

Methods:

__init__(**kwargs)

Initializes a new Pipeline object with values from keyword arguments.

Attributes:

description

Gets the description of this Pipeline.

flow_config_values

Gets the flow_config_values of this Pipeline.

identifier

Gets the identifier of this Pipeline.

key

Gets the key of this Pipeline.

metadata

Gets the metadata of this Pipeline.

model_type

Gets the model_type of this Pipeline.

model_version

Gets the model_version of this Pipeline.

name

Gets the name of this Pipeline.

nodes

Gets the nodes of this Pipeline.

object_status

Gets the object_status of this Pipeline.

object_version

Gets the object_version of this Pipeline.

parameters

Gets the parameters of this Pipeline.

parent_ref

Gets the parent_ref of this Pipeline.

variables

Gets the variables of this Pipeline.

__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
  • key (str) – The value to assign to the key property of this Pipeline.

  • model_version (str) – The value to assign to the model_version property of this Pipeline.

  • parent_ref (oci.data_integration.models.ParentReference) – The value to assign to the parent_ref property of this Pipeline.

  • name (str) – The value to assign to the name property of this Pipeline.

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

  • model_type (str) – The value to assign to the model_type property of this Pipeline.

  • object_version (int) – The value to assign to the object_version property of this Pipeline.

  • object_status (int) – The value to assign to the object_status property of this Pipeline.

  • identifier (str) – The value to assign to the identifier property of this Pipeline.

  • nodes (list[oci.data_integration.models.FlowNode]) – The value to assign to the nodes property of this Pipeline.

  • parameters (list[oci.data_integration.models.Parameter]) – The value to assign to the parameters property of this Pipeline.

  • flow_config_values (oci.data_integration.models.ConfigValues) – The value to assign to the flow_config_values property of this Pipeline.

  • variables (list[oci.data_integration.models.Variable]) – The value to assign to the variables property of this Pipeline.

  • metadata (oci.data_integration.models.ObjectMetadata) – The value to assign to the metadata property of this Pipeline.

property description

Gets the description of this Pipeline. Detailed description for the object.

Returns

The description of this Pipeline.

Return type

str

property flow_config_values

Gets the flow_config_values of this Pipeline.

Returns

The flow_config_values of this Pipeline.

Return type

oci.data_integration.models.ConfigValues

property identifier

Gets the identifier of this Pipeline. Value can only contain upper case letters, underscore, and numbers. It should begin with upper case letter or underscore. The value can be modified.

Returns

The identifier of this Pipeline.

Return type

str

property key

Gets the key of this Pipeline. Generated key that can be used in API calls to identify pipeline. On scenarios where reference to the pipeline is needed, a value can be passed in create.

Returns

The key of this Pipeline.

Return type

str

property metadata

Gets the metadata of this Pipeline.

Returns

The metadata of this Pipeline.

Return type

oci.data_integration.models.ObjectMetadata

property model_type

Gets the model_type of this Pipeline. The type of the object.

Returns

The model_type of this Pipeline.

Return type

str

property model_version

Gets the model_version of this Pipeline. This is a version number that is used by the service to upgrade objects if needed through releases of the service.

Returns

The model_version of this Pipeline.

Return type

str

property name

Gets the name of this Pipeline. Free form text without any restriction on permitted characters. Name can have letters, numbers, and special characters. The value is editable and is restricted to 1000 characters.

Returns

The name of this Pipeline.

Return type

str

property nodes

Gets the nodes of this Pipeline. A list of nodes attached to the pipeline.

Returns

The nodes of this Pipeline.

Return type

list[oci.data_integration.models.FlowNode]

property object_status

Gets the object_status of this Pipeline. The status of an object that can be set to value 1 for shallow references across objects, other values reserved.

Returns

The object_status of this Pipeline.

Return type

int

property object_version

Gets the object_version of this Pipeline. This is used by the service for optimistic locking of the object, to prevent multiple users from simultaneously updating the object.

Returns

The object_version of this Pipeline.

Return type

int

property parameters

Gets the parameters of this Pipeline. A list of parameters for the pipeline, this allows certain aspects of the pipeline to be configured when the pipeline is executed.

Returns

The parameters of this Pipeline.

Return type

list[oci.data_integration.models.Parameter]

property parent_ref

Gets the parent_ref of this Pipeline.

Returns

The parent_ref of this Pipeline.

Return type

oci.data_integration.models.ParentReference

property variables

Gets the variables of this Pipeline. The list of variables required in pipeline, variables can be used to store values that can be used as inputs to tasks in the pipeline.

Returns

The variables of this Pipeline.

Return type

list[oci.data_integration.models.Variable]