Interface IDataPipelineServiceClient

Namespace

FoundationaLLM.DataPipeline.Interfaces

Assembly

FoundationaLLM.DataPipeline.dll

Defines the interface for Data Pipeline API clients.

public interface IDataPipelineServiceClient : IResourceProviderClient

Inherited Members

IResourceProviderClient.ResourceProviders

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Methods

CreateDataPipelineRunAsync(string, DataPipelineRun, DataPipelineDefinitionSnapshot, UnifiedUserIdentity)

Creates a new data pipeline run.

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.

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.

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.

Task<BinaryData> GetServiceStateAsync()

Returns

Task<BinaryData>

The state of the service in binary format.