Interface IDataPipelineStagePlugin

Namespace

FoundationaLLM.Common.Interfaces.Plugins

Assembly

FoundationaLLM.Common.dll

Defines the interface for a data pipeline stage plugin.

public interface IDataPipelineStagePlugin

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Methods

GetStageWorkItems(DataPipelineDefinition, DataPipelineRun, List<string>, string, string)

Gets the list of data pipeline work items based on the provided content items canonical identifiers.

Task<List<DataPipelineRunWorkItem>> GetStageWorkItems(DataPipelineDefinition dataPipelineDefinition, DataPipelineRun dataPipelineRun, List<string> contentItemsCanonicalIds, string dataPipelineStageName, string previousDataPipelineStageName)

Parameters

dataPipelineDefinition DataPipelineDefinition

The definition of the data pipeline.

dataPipelineRun DataPipelineRun

The data pipeline run.

contentItemsCanonicalIds List<string>

The list of icontent items canonical identifiers.

dataPipelineStageName string

The name of the data pipeline stage.

previousDataPipelineStageName string

The name of the previous data pipeline stage.

Returns

Task<List<DataPipelineRunWorkItem>>

A list of data pipeline work items.

GetStartingStageWorkItems(DataPipelineDefinition, DataPipelineRun, List<DataPipelineContentItem>, string)

Gets the list of data pipeline work items based on the provided content items.

Task<List<DataPipelineRunWorkItem>> GetStartingStageWorkItems(DataPipelineDefinition dataPipelineDefinition, DataPipelineRun dataPipelineRun, List<DataPipelineContentItem> contentItems, string dataPipelineStageName)

Parameters

dataPipelineDefinition DataPipelineDefinition

The definition of the data pipeline.

dataPipelineRun DataPipelineRun

The data pipeline run.

contentItems List<DataPipelineContentItem>

The list of content items.

dataPipelineStageName string

The name of the data pipeline stage.

Returns

Task<List<DataPipelineRunWorkItem>>

A list of data pipeline work items.

ProcessWorkItem(DataPipelineDefinition, DataPipelineRun, DataPipelineRunWorkItem)

Processes a specified data pipeline run work item.

Task<PluginResult> ProcessWorkItem(DataPipelineDefinition dataPipelineDefinition, DataPipelineRun dataPipelineRun, DataPipelineRunWorkItem dataPipelineRunWorkItem)

Parameters

dataPipelineDefinition DataPipelineDefinition

The definition of the data pipeline associated with the data pipeline run work item.

dataPipelineRun DataPipelineRun

The data pipeline run associated with the data pipeline run work item.

dataPipelineRunWorkItem DataPipelineRunWorkItem

The data pipeline run work item to process.

Returns

Task<PluginResult>

An object that contains the processing result.