Class DataPipelineRun
- Assembly
- FoundationaLLM.Common.dll
Provider the model for a data pipeline run.
public class DataPipelineRun : AzureCosmosDBResource, IRunnableResource
- Inheritance
-
DataPipelineRun
- Implements
- Inherited Members
- Extension Methods
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
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
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
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
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
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
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
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
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
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
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
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
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
stringThe object identifier of the data pipeline.
triggerName
stringThe name of the data pipeline trigger.
triggerParameterValues
Dictionary<string, object>The dictionary of data pipeline parameter values required by the trigger.
upn
stringThe UPN that is associated with the data pipeline run.
processor
stringThe name of the processor that is used to process the data pipeline run. Must be one of the values from DataPipelineRunProcessors.