Last updated

Class: SDKPipeline

A class representing a Task object.

Implements

Implements

Table of contents

Properties

Constructors

Properties

id

• id: string

The unique identifier of the pipeline.

Implementation of

IPipeline.id


name

• name: string

The name of the pipeline.

Implementation of

IPipeline.name


creator

• creator: string

The creator of the pipeline.

Implementation of

IPipeline.creator


createdAt

• createdAt: Date

The date and time when the pipeline was created.

Implementation of

IPipeline.createdAt


updatedAt

• updatedAt: Date

The date and time when the pipeline was last updated.

Implementation of

IPipeline.updatedAt


orgId

• orgId: string

The organization ID of the pipeline.

Implementation of

IPipeline.orgId


projectId

• projectId: string

The project ID of the pipeline.

Implementation of

IPipeline.projectId


startNodes

• Optional startNodes: Dictionary[]

The start nodes of the pipeline.

Implementation of

IPipeline.startNodes


compositionId

• Optional compositionId: string

The composition ID of the pipeline.

Implementation of

IPipeline.compositionId


description

• description: string

The description of the pipeline.

Implementation of

IPipeline.description


preview

• preview: string

The preview of the pipeline.

Implementation of

IPipeline.preview


nodes

• nodes: Dictionary[]

The nodes of the pipeline.

Implementation of

IPipeline.nodes


connections

• connections: Dictionary[]

The connections of the pipeline.

Implementation of

IPipeline.connections


templateKind

• Optional templateKind: string

The template kind of the pipeline.

Implementation of

IPipeline.templateKind


info

• Optional info: Dictionary

The info of the pipeline.

Implementation of

IPipeline.info


status

• status: string

The status of the pipeline.

Implementation of

IPipeline.status


settings

• Optional settings: Dictionary

The settings of the pipeline.

Implementation of

IPipeline.settings


variables

• Optional variables: Dictionary[]

The variables of the pipeline.

Implementation of

IPipeline.variables


resetTimestamp

• Optional resetTimestamp: Date

The reset timestamp of the pipeline.

Implementation of

IPipeline.resetTimestamp


updatedBy

• Optional updatedBy: string

The user who last updated the pipeline.

Implementation of

IPipeline.updatedBy


readonly

• Optional readonly: boolean

Whether the pipeline is readonly.

Implementation of

IPipeline.readonly


active

• Optional active: boolean

Whether the pipeline is active (running).

Implementation of

IPipeline.active

Constructors

constructor

• new SDKPipeline(pipeline)

Parameters

NameType
pipelineany