Class DataPipelineDefinition

Namespace

FoundationaLLM.Common.Models.ResourceProviders.DataPipeline

Assembly

FoundationaLLM.Common.dll

Provides the model for a data pipeline.

public class DataPipelineDefinition : ResourceBase

Inheritance

object

ResourceName

ResourceBase

DataPipelineDefinition

Inherited Members

ResourceBase.ObjectId

ResourceBase.DisplayName

ResourceBase.Description

ResourceBase.CostCenter

ResourceBase.Properties

ResourceBase.CreatedOn

ResourceBase.UpdatedOn

ResourceBase.CreatedBy

ResourceBase.UpdatedBy

ResourceBase.Deleted

ResourceBase.ExpirationDate

ResourceName.Type

ResourceName.Name

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Properties

Active

Gets or sets a value that indicates whether the pipeline is active or not.

[JsonPropertyName("active")]
public bool Active { get; set; }

Property Value

bool

Remarks

When the pipeline is inactive, it cannot be triggered to execute.

AllStageNames

Gets the names of all the data pipeline stages.

[JsonIgnore]
public List<string> AllStageNames { get; }

Property Value

List<string>

AllStages

Gets all the data pipeline stages.

[JsonIgnore]
public List<DataPipelineStage> AllStages { get; }

Property Value

List<DataPipelineStage>

DataSource

Gets or sets the DataPipelineDataSource model that represents the data source for the pipeline.

[JsonPropertyName("data_source")]
public required DataPipelineDataSource DataSource { get; set; }

Property Value

DataPipelineDataSource

MostRecentSnapshotObjectId

Gets or sets the object identifier of the most recent snapshot of the data pipeline.

[JsonPropertyName("most_recent_snapshot_object_id")]
public string MostRecentSnapshotObjectId { get; set; }

Property Value

string

StartingStages

Gets or sets the list of starting stages in the data pipeline.

[JsonPropertyName("starting_stages")]
public List<DataPipelineStage> StartingStages { get; set; }

Property Value

List<DataPipelineStage>

Triggers

Gets or sets the list of triggers that can be used to start the pipeline.

[JsonPropertyName("triggers")]
public List<DataPipelineTrigger> Triggers { get; set; }

Property Value

List<DataPipelineTrigger>

Methods

GetNextStages(string)

Gets the list of data pipeline stages that follow the specified stage.

public List<DataPipelineStage> GetNextStages(string stageName)

Parameters

stageName string

The name of the stage to search for.

Returns

List<DataPipelineStage>

The list of data pipeline stages that follow the specified stage.

Exceptions

ArgumentException

GetStage(string)

Gets the data pipeline stage with the specified name.

public DataPipelineStage GetStage(string stageName)

Parameters

stageName string

The name of the stage to search for.

Returns

DataPipelineStage

The data pipeline stage with the specified name.

Exceptions

ArgumentException