Class PipelineBuilder<T>

Namespace

Pipelinez.Core

Assembly

Pipelinez.dll

Builds a Pipelinez pipeline by composing a source, zero or more segments, and a destination.

public class PipelineBuilder<T> where T : PipelineRecord

Type Parameters

T

The pipeline record type processed by the pipeline.

Inheritance

object

PipelineBuilder<T>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

AzureServiceBusPipelineBuilderExtensions.WithAzureServiceBusDeadLetterDestination<T>(PipelineBuilder<T>, AzureServiceBusDeadLetterOptions, Func<PipelineDeadLetterRecord<T>, ServiceBusMessage>)

AzureServiceBusPipelineBuilderExtensions.WithAzureServiceBusDestination<T>(PipelineBuilder<T>, AzureServiceBusDestinationOptions, Func<T, ServiceBusMessage>)

AzureServiceBusPipelineBuilderExtensions.WithAzureServiceBusSource<T>(PipelineBuilder<T>, AzureServiceBusSourceOptions, Func<ServiceBusReceivedMessage, T>)

PostgreSqlPipelineBuilderExtensions.WithPostgreSqlDeadLetterDestination<TRecord>(PipelineBuilder<TRecord>, PostgreSqlDeadLetterOptions, PostgreSqlTableMap<PipelineDeadLetterRecord<TRecord>>)

PostgreSqlPipelineBuilderExtensions.WithPostgreSqlDeadLetterDestination<TRecord>(PipelineBuilder<TRecord>, PostgreSqlDeadLetterOptions, Func<PipelineDeadLetterRecord<TRecord>, PostgreSqlCommandDefinition>)

PostgreSqlPipelineBuilderExtensions.WithPostgreSqlDestination<TRecord>(PipelineBuilder<TRecord>, PostgreSqlDestinationOptions, PostgreSqlTableMap<TRecord>)

PostgreSqlPipelineBuilderExtensions.WithPostgreSqlDestination<TRecord>(PipelineBuilder<TRecord>, PostgreSqlDestinationOptions, Func<TRecord, PostgreSqlCommandDefinition>)

RabbitMqPipelineBuilderExtensions.WithRabbitMqDeadLetterDestination<T>(PipelineBuilder<T>, RabbitMqDeadLetterOptions, Func<PipelineDeadLetterRecord<T>, RabbitMqPublishMessage>)

RabbitMqPipelineBuilderExtensions.WithRabbitMqDestination<T>(PipelineBuilder<T>, RabbitMqDestinationOptions, Func<T, RabbitMqPublishMessage>)

RabbitMqPipelineBuilderExtensions.WithRabbitMqSource<T>(PipelineBuilder<T>, RabbitMqSourceOptions, Func<RabbitMqDeliveryContext, T>)

Constructors

PipelineBuilder(string)

Builds a Pipelinez pipeline by composing a source, zero or more segments, and a destination.

public PipelineBuilder(string pipelineName)

Parameters

pipelineName string

Properties

PipelineName

Gets the logical name of the pipeline being built.

public string PipelineName { get; }

Property Value

string

Methods

AddSegment(IPipelineSegment<T>, object)

Adds a segment to the pipeline.

public PipelineBuilder<T> AddSegment(IPipelineSegment<T> segment, object config)

Parameters

segment IPipelineSegment<T>

The segment to add.

config object

Reserved segment configuration input.

Returns

PipelineBuilder<T>

The builder instance.

AddSegment(IPipelineSegment<T>, object, PipelineExecutionOptions)

Adds a segment to the pipeline with explicit execution options.

public PipelineBuilder<T> AddSegment(IPipelineSegment<T> segment, object config, PipelineExecutionOptions executionOptions)

Parameters

segment IPipelineSegment<T>

The segment to add.

config object

Reserved segment configuration input.

executionOptions PipelineExecutionOptions

The execution options to apply to the segment.

Returns

PipelineBuilder<T>

The builder instance.

AddSegment(IPipelineSegment<T>, object, PipelineExecutionOptions, PipelineRetryPolicy<T>)

Adds a segment to the pipeline with explicit execution options and retry policy.

public PipelineBuilder<T> AddSegment(IPipelineSegment<T> segment, object config, PipelineExecutionOptions executionOptions, PipelineRetryPolicy<T> retryPolicy)

Parameters

segment IPipelineSegment<T>

The segment to add.

config object

Reserved segment configuration input.

executionOptions PipelineExecutionOptions

The execution options to apply to the segment.

retryPolicy PipelineRetryPolicy<T>

The retry policy to apply to the segment.

Returns

PipelineBuilder<T>

The builder instance.

AddSegment(IPipelineSegment<T>, object, PipelineRetryPolicy<T>)

Adds a segment to the pipeline with an explicit retry policy.

public PipelineBuilder<T> AddSegment(IPipelineSegment<T> segment, object config, PipelineRetryPolicy<T> retryPolicy)

Parameters

segment IPipelineSegment<T>

The segment to add.

config object

Reserved segment configuration input.

retryPolicy PipelineRetryPolicy<T>

The retry policy to apply to the segment.

Returns

PipelineBuilder<T>

The builder instance.

Build()

Builds the pipeline using the configured components and options.

public IPipeline<T> Build()

Returns

IPipeline<T>

The built pipeline instance.

UseDeadLetterOptions(PipelineDeadLetterOptions)

Configures dead-letter behavior for the pipeline.

public PipelineBuilder<T> UseDeadLetterOptions(PipelineDeadLetterOptions options)

Parameters

options PipelineDeadLetterOptions

The dead-letter options to apply.

Returns

PipelineBuilder<T>

The builder instance.

UseFlowControlOptions(PipelineFlowControlOptions)

Configures pipeline-wide flow-control behavior.

public PipelineBuilder<T> UseFlowControlOptions(PipelineFlowControlOptions options)

Parameters

options PipelineFlowControlOptions

The flow-control options to apply.

Returns

PipelineBuilder<T>

The builder instance.

UseHostOptions(PipelineHostOptions)

Configures host-level execution options.

public PipelineBuilder<T> UseHostOptions(PipelineHostOptions options)

Parameters

options PipelineHostOptions

The host options to apply.

Returns

PipelineBuilder<T>

The builder instance.

UseLogger(ILoggerFactory)

Configures the logger factory used by pipeline components.

public PipelineBuilder<T> UseLogger(ILoggerFactory logFactory)

Parameters

logFactory ILoggerFactory

The logger factory to use.

Returns

PipelineBuilder<T>

The builder instance.

UseOperationalOptions(PipelineOperationalOptions)

Configures operational tooling behavior for the pipeline.

public PipelineBuilder<T> UseOperationalOptions(PipelineOperationalOptions options)

Parameters

options PipelineOperationalOptions

The operational options to apply.

Returns

PipelineBuilder<T>

The builder instance.

UsePerformanceOptions(PipelinePerformanceOptions)

Configures performance and execution-tuning options for the pipeline.

public PipelineBuilder<T> UsePerformanceOptions(PipelinePerformanceOptions options)

Parameters

options PipelinePerformanceOptions

The performance options to apply.

Returns

PipelineBuilder<T>

The builder instance.

UseRetryOptions(PipelineRetryOptions<T>)

Configures default retry behavior for segments and destinations.

public PipelineBuilder<T> UseRetryOptions(PipelineRetryOptions<T> options)

Parameters

options PipelineRetryOptions<T>

The retry options to apply.

Returns

PipelineBuilder<T>

The builder instance.

WithDeadLetterDestination(IPipelineDeadLetterDestination<T>)

Configures the dead-letter destination used for terminally handled faults.

public PipelineBuilder<T> WithDeadLetterDestination(IPipelineDeadLetterDestination<T> deadLetterDestination)

Parameters

deadLetterDestination IPipelineDeadLetterDestination<T>

The dead-letter destination to use.

Returns

PipelineBuilder<T>

The builder instance.

WithDestination(IPipelineDestination<T>)

Configures the pipeline destination.

public PipelineBuilder<T> WithDestination(IPipelineDestination<T> destination)

Parameters

destination IPipelineDestination<T>

The destination to use.

Returns

PipelineBuilder<T>

The builder instance.

WithDestination(IPipelineDestination<T>, PipelineExecutionOptions)

Configures the pipeline destination with explicit execution options.

public PipelineBuilder<T> WithDestination(IPipelineDestination<T> destination, PipelineExecutionOptions executionOptions)

Parameters

destination IPipelineDestination<T>

The destination to use.

executionOptions PipelineExecutionOptions

The execution options to apply to the destination.

Returns

PipelineBuilder<T>

The builder instance.

WithDestination(IPipelineDestination<T>, PipelineExecutionOptions, PipelineRetryPolicy<T>)

Configures the pipeline destination with explicit execution options and retry policy.

public PipelineBuilder<T> WithDestination(IPipelineDestination<T> destination, PipelineExecutionOptions executionOptions, PipelineRetryPolicy<T> retryPolicy)

Parameters

destination IPipelineDestination<T>

The destination to use.

executionOptions PipelineExecutionOptions

The execution options to apply to the destination.

retryPolicy PipelineRetryPolicy<T>

The retry policy to apply to the destination.

Returns

PipelineBuilder<T>

The builder instance.

WithDestination(IPipelineDestination<T>, PipelineRetryPolicy<T>)

Configures the pipeline destination with an explicit retry policy.

public PipelineBuilder<T> WithDestination(IPipelineDestination<T> destination, PipelineRetryPolicy<T> retryPolicy)

Parameters

destination IPipelineDestination<T>

The destination to use.

retryPolicy PipelineRetryPolicy<T>

The retry policy to apply to the destination.

Returns

PipelineBuilder<T>

The builder instance.

WithErrorHandler(PipelineErrorHandler<T>)

Configures the asynchronous error handler used after retries are exhausted.

public PipelineBuilder<T> WithErrorHandler(PipelineErrorHandler<T> errorHandler)

Parameters

errorHandler PipelineErrorHandler<T>

The error handler to use.

Returns

PipelineBuilder<T>

The builder instance.

WithErrorHandler(Func<PipelineErrorContext<T>, PipelineErrorAction>)

Configures the synchronous error handler used after retries are exhausted.

public PipelineBuilder<T> WithErrorHandler(Func<PipelineErrorContext<T>, PipelineErrorAction> errorHandler)

Parameters

errorHandler Func<PipelineErrorContext<T>, PipelineErrorAction>

The error handler to use.

Returns

PipelineBuilder<T>

The builder instance.

WithInMemoryDestination(string)

Configures the built-in in-memory destination.

public PipelineBuilder<T> WithInMemoryDestination(string config)

Parameters

config string

Reserved destination configuration input.

Returns

PipelineBuilder<T>

The builder instance.

WithInMemorySource(object)

Configures the built-in in-memory source.

public PipelineBuilder<T> WithInMemorySource(object config)

Parameters

config object

Reserved source configuration input.

Returns

PipelineBuilder<T>

The builder instance.

WithSource(IPipelineSource<T>)

Configures the pipeline source.

public PipelineBuilder<T> WithSource(IPipelineSource<T> source)

Parameters

source IPipelineSource<T>

The source to use.

Returns

PipelineBuilder<T>

The builder instance.

WithSource(IPipelineSource<T>, PipelineExecutionOptions)

Configures the pipeline source with explicit execution options.

public PipelineBuilder<T> WithSource(IPipelineSource<T> source, PipelineExecutionOptions executionOptions)

Parameters

source IPipelineSource<T>

The source to use.

executionOptions PipelineExecutionOptions

The execution options to apply to the source.

Returns

PipelineBuilder<T>

The builder instance.