Class LocalDataPipelineServiceClient

Namespace

FoundationaLLM.DataPipelineEngine.Clients

Assembly

FoundationaLLM.DataPipelineEngine.dll

Local client for the Data Pipeline API.

public class LocalDataPipelineServiceClient : IDataPipelineServiceClient, IResourceProviderClient

Inheritance

object

LocalDataPipelineServiceClient

Implements

IDataPipelineServiceClient

IResourceProviderClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Constructors

LocalDataPipelineServiceClient(IEnumerable<IHostedService>, IDataPipelineStateService)

Local client for the Data Pipeline API.

public LocalDataPipelineServiceClient(IEnumerable<IHostedService> hostedServices, IDataPipelineStateService dataPipelineStateService)

Parameters

hostedServices IEnumerable<IHostedService>

dataPipelineStateService IDataPipelineStateService

Properties

ResourceProviders

Sets the resource providers collection.

public IEnumerable<IResourceProviderService> ResourceProviders { set; }

Property Value

IEnumerable<IResourceProviderService>

Remarks

This property must be exposed by services that cannot be injected with the resource providers. These are background services that both provide and consume services to and from the resource providers.

Methods

CreateDataPipelineRunAsync(string, DataPipelineRun, DataPipelineDefinitionSnapshot, UnifiedUserIdentity)

Creates a new data pipeline run.

public Task<DataPipelineRun?> CreateDataPipelineRunAsync(string instanceId, DataPipelineRun dataPipelineRun, DataPipelineDefinitionSnapshot dataPipelineSnapshot, UnifiedUserIdentity userIdentity)

Parameters

instanceId string

The FoundationaLLM instance identifier.

dataPipelineRun DataPipelineRun

The data pipeline run to create.

dataPipelineSnapshot DataPipelineDefinitionSnapshot

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

userIdentity UnifiedUserIdentity

Returns

Task<DataPipelineRun>

The newly created data pipeline run.

GetDataPipelineRunAsync(string, string, string, UnifiedUserIdentity)

Gets a data pipeline run by its identifier.

public Task<DataPipelineRun?> GetDataPipelineRunAsync(string instanceId, string dataPipelineName, string runId, UnifiedUserIdentity userIdentity)

Parameters

instanceId string

The FoundationaLLM instance identifier.

dataPipelineName string

The name of the data pipeline.

runId string

The data pipeline run identifier.

userIdentity UnifiedUserIdentity

Returns

Task<DataPipelineRun>

The requested data pipeline run object.

GetDataPipelineRunsAsync(string, DataPipelineRunFilter, UnifiedUserIdentity)

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

public Task<List<DataPipelineRun>> GetDataPipelineRunsAsync(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.

GetServiceStateAsync()

Retrieves the current state of the Data Pipeline service.

public Task<BinaryData> GetServiceStateAsync()

Returns

Task<BinaryData>

The state of the service in binary format.