Interface IDataPipelineStateService
- Namespace
- FoundationaLLM.Common.Interfaces
- Assembly
- FoundationaLLM.Common.dll
Defines the interface for the Data Pipeline State Service.
public interface IDataPipelineStateService- Extension Methods
Methods
GetActiveDataPipelineRuns()
Gets a list of active data pipeline runs.
Task<List<DataPipelineRun>> GetActiveDataPipelineRuns()Returns
- Task<List<DataPipelineRun>>
The list of active data pipeline runs.
GetDataPipelineRun(string)
Gets a data pipeline run by its identifier.
Task<DataPipelineRun?> GetDataPipelineRun(string runId)Parameters
runIdstringThe data pipeline run identifier.
Returns
- Task<DataPipelineRun>
The requested data pipeline run object.
GetDataPipelineRunStageWorkItems(string, string)
Gets the list of data pipeline run work items associated with a specified stage of a run.
Task<List<DataPipelineRunWorkItem>> GetDataPipelineRunStageWorkItems(string runId, string stage)Parameters
Returns
- Task<List<DataPipelineRunWorkItem>>
The list of data pipeline run work items associated with the specified stage of the run.
GetDataPipelineRunWorkItem(string, string)
Gets a data pipeline run work item by its identifier.
Task<DataPipelineRunWorkItem?> GetDataPipelineRunWorkItem(string workItemId, string runId)Parameters
workItemIdstringThe data pipeline run work item identifier.
runIdstringThe data pipeline run identifier.
Returns
- Task<DataPipelineRunWorkItem>
The requests data pipeline run work item object.
GetDataPipelineRuns(DataPipelineRunFilter)
Gets a list of data pipeline runs filtered by the provided filter criteria.
Task<List<DataPipelineRun>> GetDataPipelineRuns(DataPipelineRunFilter dataPipelineRunFilter)Parameters
dataPipelineRunFilterDataPipelineRunFilterThe filter criteria used to filter data pipeline runs.
Returns
- Task<List<DataPipelineRun>>
The list of requests data pipeline runs.
InitializeDataPipelineRunState(DataPipelineRun, List<DataPipelineContentItem>)
Initializes the state of a data pipeline run.
Task<bool> InitializeDataPipelineRunState(DataPipelineRun dataPipelineRun, List<DataPipelineContentItem> contentItems)Parameters
dataPipelineRunDataPipelineRunThe details of the data pipeline run.
contentItemsList<DataPipelineContentItem>The list of content items to be processed by the data pipeline run.
Returns
LoadDataPipelineRunWorkItemArtifacts(DataPipelineDefinition, DataPipelineRun, DataPipelineRunWorkItem, string)
Loads the artifacts associated with a data pipeline run work item.
Task<List<DataPipelineStateArtifact>> LoadDataPipelineRunWorkItemArtifacts(DataPipelineDefinition dataPipelineDefinition, DataPipelineRun dataPipelineRun, DataPipelineRunWorkItem dataPipelineRunWorkItem, string artifactsNameFilter)Parameters
dataPipelineDefinitionDataPipelineDefinitionThe data pipeline definition associated with the work item.
dataPipelineRunDataPipelineRunThe data pipeline run item associated with the work item.
dataPipelineRunWorkItemDataPipelineRunWorkItemThe data pipeline run work item.
artifactsNameFilterstringThe name pattern used to identify a subset of the artifacts.
Returns
- Task<List<DataPipelineStateArtifact>>
A list with the binary contents of the artifacts.
LoadDataPipelineRunWorkItemParts<T>(DataPipelineDefinition, DataPipelineRun, DataPipelineRunWorkItem, string)
Loads the content item parts associated with a data pipeline run work item.
Task<IEnumerable<T>> LoadDataPipelineRunWorkItemParts<T>(DataPipelineDefinition dataPipelineDefinition, DataPipelineRun dataPipelineRun, DataPipelineRunWorkItem dataPipelineRunWorkItem, string fileName) where T : class, new()Parameters
dataPipelineDefinitionDataPipelineDefinitionThe data pipeline definition associated with the work item.
dataPipelineRunDataPipelineRunThe data pipeline run item associated with the work item.
dataPipelineRunWorkItemDataPipelineRunWorkItemThe data pipeline run work item.
fileNamestringThe name of the file that contains the content item parts.
Returns
- Task<IEnumerable<T>>
A list with the content item parts associated with the data pipeline run work item.
Type Parameters
TThe type of the content item parts to be loaded.
PersistDataPipelineRunWorkItems(List<DataPipelineRunWorkItem>)
Persists a list of data pipeline run work items.
Task<bool> PersistDataPipelineRunWorkItems(List<DataPipelineRunWorkItem> workItems)Parameters
workItemsList<DataPipelineRunWorkItem>The list of data pipeline work items to be persisted.
Returns
SaveDataPipelineRunWorkItemArtifacts(DataPipelineDefinition, DataPipelineRun, DataPipelineRunWorkItem, List<DataPipelineStateArtifact>)
Saves the artifacts associated with a data pipeline run work item.
Task SaveDataPipelineRunWorkItemArtifacts(DataPipelineDefinition dataPipelineDefinition, DataPipelineRun dataPipelineRun, DataPipelineRunWorkItem dataPipelineRunWorkItem, List<DataPipelineStateArtifact> artifacts)Parameters
dataPipelineDefinitionDataPipelineDefinitionThe data pipeline definition associated with the work item.
dataPipelineRunDataPipelineRunThe data pipeline run item associated with the work item.
dataPipelineRunWorkItemDataPipelineRunWorkItemThe data pipeline run work item.
artifactsList<DataPipelineStateArtifact>The list with the binary contents of the artifacts.
Returns
SaveDataPipelineRunWorkItemParts<T>(DataPipelineDefinition, DataPipelineRun, DataPipelineRunWorkItem, IEnumerable<T>, string)
Saves the content item parts associated with a data pipeline run work item.
Task SaveDataPipelineRunWorkItemParts<T>(DataPipelineDefinition dataPipelineDefinition, DataPipelineRun dataPipelineRun, DataPipelineRunWorkItem dataPipelineRunWorkItem, IEnumerable<T> contentItemParts, string fileName) where T : class, new()Parameters
dataPipelineDefinitionDataPipelineDefinitionThe data pipeline definition associated with the work item.
dataPipelineRunDataPipelineRunThe data pipeline run item associated with the work item.
dataPipelineRunWorkItemDataPipelineRunWorkItemThe data pipeline run work item.
contentItemPartsIEnumerable<T>The list with the content item parts.
fileNamestringThe name of the file that contains the content item parts.
Returns
Type Parameters
TThe type of the content item parts to be loaded.
StartDataPipelineRunWorkItemProcessing(Func<DataPipelineRunWorkItem, Task>)
Starts processing data pipeline run work items.
Task<bool> StartDataPipelineRunWorkItemProcessing(Func<DataPipelineRunWorkItem, Task> processWorkItem)Parameters
processWorkItemFunc<DataPipelineRunWorkItem, Task>The asynchronous delegate that is invoked for each data pipeline run work item.
Returns
StopDataPipelineRunWorkItemProcessing()
Stops processing data pipeline run work items.
Task StopDataPipelineRunWorkItemProcessing()Returns
UpdateDataPipelineRunStatus(DataPipelineRun)
Updates the status of a data pipeline run.
Task<bool> UpdateDataPipelineRunStatus(DataPipelineRun dataPipelineRun)Parameters
dataPipelineRunDataPipelineRunThe data pipeline run whose status is to be updated.
Returns
UpdateDataPipelineRunWorkItem(DataPipelineRunWorkItem)
Updates a data pipeline run work item.
Task<bool> UpdateDataPipelineRunWorkItem(DataPipelineRunWorkItem workItem)Parameters
workItemDataPipelineRunWorkItemThe data pipeline run work item to be updated.
Returns
UpdateDataPipelineRunWorkItemsStatus(List<DataPipelineRunWorkItem>)
Updates the status of data pipeline run work items.
Task<bool> UpdateDataPipelineRunWorkItemsStatus(List<DataPipelineRunWorkItem> workItems)Parameters
workItemsList<DataPipelineRunWorkItem>The list of data pipeline work items whose status must be updated.