Class DataPipelineRun

Namespace

FoundationaLLM.Common.Models.ResourceProviders.DataPipeline

Assembly

FoundationaLLM.Common.dll

Provider the model for a data pipeline run.

public class DataPipelineRun : AzureCosmosDBResource, IRunnableResource

Inheritance

object

ResourceName

ResourceBase

AzureCosmosDBResource

DataPipelineRun

Implements

IRunnableResource

Inherited Members

AzureCosmosDBResource.Id

AzureCosmosDBResource.UPN

AzureCosmosDBResource.InstanceId

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>)

Constructors

DataPipelineRun()

Set default property values.

public DataPipelineRun()

Properties

ActiveStages

Gets or sets the list of active stages in the data pipeline run.

[JsonPropertyName("active_stages")]
[JsonPropertyOrder(7)]
public List<string> ActiveStages { get; set; }

Property Value

List<string>

AllStages

Gets or sets the list of all stages in the data pipeline run.

[JsonPropertyName("all_stages")]
[JsonPropertyOrder(8)]
public List<string> AllStages { get; set; }

Property Value

List<string>

Completed

Gets or sets the flag that indicates whether the resource run is completed.

[JsonPropertyName("completed")]
[JsonPropertyOrder(11)]
public bool Completed { get; set; }

Property Value

bool

CompletedStages

Gets or sets the list of completed stages in the data pipeline run.

[JsonPropertyName("completed_stages")]
[JsonPropertyOrder(9)]
public List<string> CompletedStages { get; set; }

Property Value

List<string>

DataPipelineObjectId

Gets or sets the object identifier of the data pipeline.

[JsonPropertyName("data_pipeline_object_id")]
[JsonPropertyOrder(2)]
public required string DataPipelineObjectId { get; set; }

Property Value

string

Errors

Gets or sets the list of errors encountered during the data pipeline run.

[JsonPropertyName("errors")]
[JsonPropertyOrder(14)]
public List<string>? Errors { get; set; }

Property Value

List<string>

FailedStages

Gets or sets the list of failed stages in the data pipeline run.

[JsonPropertyName("failed_stages")]
[JsonPropertyOrder(10)]
public List<string> FailedStages { get; set; }

Property Value

List<string>

Processor

Gets or sets the name of the processor that is used to process the data pipeline run.

[JsonPropertyName("processor")]
[JsonPropertyOrder(6)]
public required string Processor { get; set; }

Property Value

string

Remarks

Must be one of the values from DataPipelineRunProcessors.

RunId

The unique identifier of the data pipeline run.

[JsonPropertyName("run_id")]
[JsonPropertyOrder(1)]
public string RunId { get; }

Property Value

string

StagesMetrics

Gets or sets the metrics for each stage in the data pipeline run.

[JsonPropertyName("stages_metrics")]
[JsonPropertyOrder(13)]
public Dictionary<string, DataPipelineStageMetrics> StagesMetrics { get; set; }

Property Value

Dictionary<string, DataPipelineStageMetrics>

Successful

Gets or sets the flag that indicates whether the resource run was successful.

[JsonPropertyName("successful")]
[JsonPropertyOrder(12)]
public bool Successful { get; set; }

Property Value

bool

TriggerName

Gets or sets the name of the manual trigger used to start the pipeline.

[JsonPropertyName("trigger_name")]
[JsonPropertyOrder(3)]
public required string TriggerName { get; set; }

Property Value

string

TriggerParameterValues

Gets or sets a dictionary that contains the parameter values required to trigger the pipeline.

[JsonPropertyName("trigger_parameter_values")]
[JsonPropertyOrder(4)]
public required Dictionary<string, object> TriggerParameterValues { get; set; }

Property Value

Dictionary<string, object>

TriggeringUPN

Gets or sets the user principal name (UPN) of the user that triggered the creation of the data pipeline run.

[JsonPropertyName("triggering_upn")]
[JsonPropertyOrder(5)]
public required string TriggeringUPN { get; set; }

Property Value

string

Methods

Create(string, string, Dictionary<string, object>, string, string)

Creates a new DataPipelineRun instance.

public static DataPipelineRun Create(string dataPipelineObjectId, string triggerName, Dictionary<string, object> triggerParameterValues, string upn, string processor)

Parameters

dataPipelineObjectId string

The object identifier of the data pipeline.

triggerName string

The name of the data pipeline trigger.

triggerParameterValues Dictionary<string, object>

The dictionary of data pipeline parameter values required by the trigger.

upn string

The UPN that is associated with the data pipeline run.

processor string

The name of the processor that is used to process the data pipeline run. Must be one of the values from DataPipelineRunProcessors.

Returns

DataPipelineRun

FromTriggerRequest(DataPipelineTriggerRequest, UnifiedUserIdentity)

Creates a new DataPipelineRun instance from a data pipeline trigger request.

public static DataPipelineRun FromTriggerRequest(DataPipelineTriggerRequest request, UnifiedUserIdentity ownerUserIdentity)

Parameters

request DataPipelineTriggerRequest

The data pipeline trigger request used to create the run.

ownerUserIdentity UnifiedUserIdentity

The identity of the user that owns the newly created data pipeline run.

Returns

DataPipelineRun

The newly created data pipeline run object.