Interface IDataPipelineService

Namespace

FoundationaLLM.DataPipelineEngine.Interfaces

Assembly

FoundationaLLM.DataPipelineEngine.dll

Interface for the Data Pipeline Service.

public interface IDataPipelineService

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Methods

CreateDataPipelineRun(string, DataPipelineRun, UnifiedUserIdentity)

Creates a new data pipeline run.

Task<DataPipelineRun> CreateDataPipelineRun(string instanceId, DataPipelineRun dataPipelineRun, UnifiedUserIdentity userIdentity)

Parameters

instanceId string

The FoundationaLLM instance identifier.

dataPipelineRun DataPipelineRun

The object with the properties of the new data pipeline run.

userIdentity UnifiedUserIdentity

Returns

Task<DataPipelineRun>

The newly created data pipeline run.

GetDataPipelineRun(string, string, string, UnifiedUserIdentity)

Retrieves a data pipeline run by its name.

Task<DataPipelineRun> GetDataPipelineRun(string instanceId, string dataPipelineName, string runId, UnifiedUserIdentity userIdentiy)

Parameters

instanceId string

The FoundationaLLM instance identifier.

dataPipelineName string

The name of the data pipeline.

runId string

The identifier of the data pipeline run.

userIdentiy UnifiedUserIdentity

The identity of the user running the operation.

Returns

Task<DataPipelineRun>

The data pipeline run identified by the provided identifier.

GetDataPipelineRuns(string, DataPipelineRunFilter, UnifiedUserIdentity)

Retrieves a list of data pipeline runs filtered by the provided filter criteria.

Task<List<DataPipelineRun>> GetDataPipelineRuns(string instanceId, DataPipelineRunFilter dataPipelineRunFilter, UnifiedUserIdentity userIdentity)

Parameters

instanceId string

The FoundationaLLM instance identifier.

dataPipelineRunFilter DataPipelineRunFilter

The definition of the filter criteria.

userIdentity UnifiedUserIdentity

The identity of the user running the operation.

Returns

Task<List<DataPipelineRun>>

The requested list of data pipeline run objects.