Class DataPipelineTriggerRequest

Namespace

FoundationaLLM.Common.Models.ResourceProviders.DataPipeline

Assembly

FoundationaLLM.Common.dll

Represents a request to trigger a data pipeline run.

public class DataPipelineTriggerRequest

Inheritance

object

DataPipelineTriggerRequest

Inherited Members

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

DataPipelineCanonicalRunId

Gets or sets the canonical run identifier to be used for the data pipeline run.

[JsonPropertyName("data_pipeline_canonical_run_id")]
[JsonPropertyOrder(5)]
public string? DataPipelineCanonicalRunId { get; set; }

Property Value

string

Remarks

Providing this value allows the caller to force using a specific canonical run identifier, which allows the new run to execute using an already existing canonical data from previous pipeline runs. If not provided, the canonical run identifier will be generated based on the data pipeline name and trigger parameters. When provided, it should only be a value that matches and already existing canonical run identifier. In general, it is recommended to leave this value empty and let the system generate it automatically, unless there is a specific need to reuse an existing canonical run identifier (e.g., for testing or troubleshooting purposes).

DataPipelineObjectId

Gets or sets the object identifier of the data pipeline.

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

Property Value

string

Processor

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

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

Property Value

string

Remarks

Must be one of the values from DataPipelineRunProcessors.

TriggerName

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

[JsonPropertyName("trigger_name")]
[JsonPropertyOrder(2)]
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(3)]
public required Dictionary<string, object> TriggerParameterValues { get; set; }

Property Value

Dictionary<string, object>