Table of Contents

Class DataPipelineRunnerService

Namespace
FoundationaLLM.DataPipelineEngine.Services
Assembly
FoundationaLLM.DataPipelineEngine.dll

Provides capabilities for running data pipelines.

public class DataPipelineRunnerService : DataPipelineBackgroundService, IHostedService, IDisposable, IResourceProviderClient, IDataPipelineRunnerService
Inheritance
DataPipelineRunnerService
Implements
Inherited Members
Extension Methods

Constructors

DataPipelineRunnerService(IDataPipelineStateService, IServiceProvider, IOptions<DataPipelineServiceSettings>, ILogger<DataPipelineRunnerService>)

Initializes a new instance of the service.

public DataPipelineRunnerService(IDataPipelineStateService stateService, IServiceProvider serviceProvider, IOptions<DataPipelineServiceSettings> options, ILogger<DataPipelineRunnerService> logger)

Parameters

stateService IDataPipelineStateService

The Data Pipeline State service providing state management services.

serviceProvider IServiceProvider

The service collection provided by the dependency injection container.

options IOptions<DataPipelineServiceSettings>
logger ILogger<DataPipelineRunnerService>

The logger used for logging.

Properties

CurrentRunners 

public Dictionary<string, DataPipelineRunner> CurrentRunners { get; }

Property Value

Dictionary<string, DataPipelineRunner>

ServiceName 

protected override string ServiceName { get; }

Property Value

string

Methods

CanStartRun(DataPipelineRun)

Inidicates whether the specified data pipeline run can be started.

public Task<bool> CanStartRun(DataPipelineRun dataPipelineRun)

Parameters

dataPipelineRun DataPipelineRun

The data pipeline run to start.

Returns

Task<bool>

true if the specified data pipeline run can be started, false otherwise.

ExecuteAsyncInternal(CancellationToken)

Executes the background service's main logic.

protected override Task ExecuteAsyncInternal(CancellationToken stoppingToken)

Parameters

stoppingToken CancellationToken

The cancellation token used to signal a request to stop the service.

Returns

Task

InitializeAsyncInternal(CancellationToken)

Performs additional initialization for the background service.

protected override Task InitializeAsyncInternal(CancellationToken stoppingToken)

Parameters

stoppingToken CancellationToken

The cancellation token used to signal a request to stop the service.

Returns

Task

StartRun(DataPipelineRun, List<DataPipelineContentItem>, DataPipelineDefinition, UnifiedUserIdentity)

Starts a data pipeline run.

public Task<DataPipelineRun> StartRun(DataPipelineRun dataPipelineRun, List<DataPipelineContentItem> contentItems, DataPipelineDefinition dataPipelineDefinition, UnifiedUserIdentity userIdentity)

Parameters

dataPipelineRun DataPipelineRun

The data pipeline run to start.

contentItems List<DataPipelineContentItem>

The list of content items to process.

dataPipelineDefinition DataPipelineDefinition

The snapshot of the definition of the data pipeline at the time the run was triggered.

userIdentity UnifiedUserIdentity

The identity of the user running the operation.

Returns

Task<DataPipelineRun>

The started data pipeline run.

StopAsync(CancellationToken)

Triggered when the application host is performing a graceful shutdown.

public override Task StopAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Indicates that the shutdown process should no longer be graceful.

Returns

Task

A Task that represents the asynchronous Stop operation.

Edit this page