PipelineSummary

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

Bases: object

The pipeline summary type contains the audit summary information and the definition of the pipeline.

Methods:

__init__(**kwargs)

Initializes a new PipelineSummary object with values from keyword arguments.

Attributes:

description

Gets the description of this PipelineSummary.

flow_config_values

Gets the flow_config_values of this PipelineSummary.

identifier

Gets the identifier of this PipelineSummary.

key

Gets the key of this PipelineSummary.

metadata

Gets the metadata of this PipelineSummary.

model_type

Gets the model_type of this PipelineSummary.

model_version

Gets the model_version of this PipelineSummary.

name

Gets the name of this PipelineSummary.

nodes

Gets the nodes of this PipelineSummary.

object_status

Gets the object_status of this PipelineSummary.

object_version

Gets the object_version of this PipelineSummary.

parameters

Gets the parameters of this PipelineSummary.

parent_ref

Gets the parent_ref of this PipelineSummary.

variables

Gets the variables of this PipelineSummary.

__init__(**kwargs)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

property description

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

Returns

The description of this PipelineSummary.

Return type

str

property flow_config_values

Gets the flow_config_values of this PipelineSummary.

Returns

The flow_config_values of this PipelineSummary.

Return type

oci.data_integration.models.ConfigValues

property identifier

Gets the identifier of this PipelineSummary. 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 PipelineSummary.

Return type

str

property key

Gets the key of this PipelineSummary. 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 PipelineSummary.

Return type

str

property metadata

Gets the metadata of this PipelineSummary.

Returns

The metadata of this PipelineSummary.

Return type

oci.data_integration.models.ObjectMetadata

property model_type

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

Returns

The model_type of this PipelineSummary.

Return type

str

property model_version

Gets the model_version of this PipelineSummary. 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 PipelineSummary.

Return type

str

property name

Gets the name of this PipelineSummary. 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 PipelineSummary.

Return type

str

property nodes

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

Returns

The nodes of this PipelineSummary.

Return type

list[oci.data_integration.models.FlowNode]

property object_status

Gets the object_status of this PipelineSummary. 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 PipelineSummary.

Return type

int

property object_version

Gets the object_version of this PipelineSummary. 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 PipelineSummary.

Return type

int

property parameters

Gets the parameters of this PipelineSummary. 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 PipelineSummary.

Return type

list[oci.data_integration.models.Parameter]

property parent_ref

Gets the parent_ref of this PipelineSummary.

Returns

The parent_ref of this PipelineSummary.

Return type

oci.data_integration.models.ParentReference

property variables

Gets the variables of this PipelineSummary. 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 PipelineSummary.

Return type

list[oci.data_integration.models.Variable]