Class DataPipelineRunsController
- Namespace
- FoundationaLLM.DataPipeline.API.Controllers
- Assembly
- FoundationaLLM.DataPipeline.API.dll
Provides the routes for the Data Pipelines API data pipelines controller.
[ApiController]
[APIKeyAuthentication]
[Route("instances/{instanceId}")]
public class DataPipelineRunsController : ControllerBase- Inheritance
-
DataPipelineRunsController
- Inherited Members
- Extension Methods
Constructors
DataPipelineRunsController(IDataPipelineService, IOrchestrationContext, ILogger<DataPipelineRunsController>)
Provides the routes for the Data Pipelines API data pipelines controller.
public DataPipelineRunsController(IDataPipelineService dataPipelineService, IOrchestrationContext orchestrationContext, ILogger<DataPipelineRunsController> logger)Parameters
dataPipelineServiceIDataPipelineServiceThe service used to manage data pipeline runs.
orchestrationContextIOrchestrationContextThe orchestration context that provides FoundationaLLM context information
loggerILogger<DataPipelineRunsController>The ILogger used for logging.
Methods
CreateDataPipelineRun(string, DataPipelineRun)
Creates a new data pipeline run.
[HttpPost("datapipelineruns")]
public Task<IActionResult> CreateDataPipelineRun(string instanceId, DataPipelineRun dataPipelineRun)Parameters
instanceIdstringThe FoundationaLLM instance identifier.
dataPipelineRunDataPipelineRunThe object with the properties of the new data pipeline run.
Returns
- Task<IActionResult>
The newly created data pipeline run.
GetDataPipelineRun(string, string, string)
Retrieves a data pipeline run by its name.
[HttpGet("datapipelines/{dataPipelineName}/datapipelineruns/{runId}")]
public Task<IActionResult> GetDataPipelineRun(string instanceId, string dataPipelineName, string runId)Parameters
instanceIdstringThe FoundationaLLM instance identifier.
dataPipelineNamestringThe name of the data pipeline.
runIdstringThe identifier of the data pipeline run.
Returns
- Task<IActionResult>
The data pipeline run identified by the provided identifier.
GetDataPipelineRuns(string, DataPipelineRunFilter)
Retrieves a list of data pipeline runs filtered by the provided filter criteria.
[HttpPost("datapipelineruns/filter")]
public Task<IActionResult> GetDataPipelineRuns(string instanceId, DataPipelineRunFilter dataPipelineRunFilter)Parameters
instanceIdstringThe FoundationaLLM instance identifier.
dataPipelineRunFilterDataPipelineRunFilterThe definition of the filter criteria.
Returns
- Task<IActionResult>
The requested list of data pipeline run objects.