Interface ITransformStageWithProgress<TSource, TProgress>

Namespace

Wolfgang.Etl.Abstractions

Assembly

Wolfgang.Etl.Abstractions.dll

An ITransformStage<TSource> whose underlying transformer also supports progress reporting. Call WithProgress(IProgress<TProgress>) to supply an IProgress<T> sink that will be forwarded to the transformer's TransformAsync overload when the pipeline runs.

public interface ITransformStageWithProgress<TSource, out TProgress> : ITransformStage<TSource> where TSource : notnull where TProgress : notnull

Type Parameters

TSource

The current item type flowing through the pipeline.

TProgress

The type of progress report emitted by the transformer.

Inherited Members

ITransformStage<TSource>.Transform<TDestination>(ITransformAsync<TSource, TDestination>)

ITransformStage<TSource>.Transform<TDestination>(ITransformWithCancellationAsync<TSource, TDestination>)

ITransformStage<TSource>.Transform<TDestination, TProgress>(ITransformWithProgressAsync<TSource, TDestination, TProgress>)

ITransformStage<TSource>.Transform<TDestination, TProgress>(ITransformWithProgressAndCancellationAsync<TSource, TDestination, TProgress>)

ITransformStage<TSource>.Load(ILoadAsync<TSource>)

ITransformStage<TSource>.Load(ILoadWithCancellationAsync<TSource>)

ITransformStage<TSource>.Load<TProgress>(ILoadWithProgressAsync<TSource, TProgress>)

ITransformStage<TSource>.Load<TProgress>(ILoadWithProgressAndCancellationAsync<TSource, TProgress>)

Methods

WithProgress(IProgress<TProgress>)

Supplies an IProgress<T> sink that the pipeline will pass to the transformer's TransformAsync overload when the pipeline runs. The returned stage is a plain ITransformStage<TSource> — progress can only be set once.

ITransformStage<TSource> WithProgress(IProgress<out TProgress> progress)

Parameters

progress IProgress<TProgress>

The progress sink to forward reports to.

Returns

ITransformStage<TSource>

The same stage, typed as ITransformStage<TSource>.

Exceptions

ArgumentNullException

progress is null.