• Public
  • Public/Protected
  • All

Interface PipelineTopologyProperties

Package version

Pipeline topology properties.


  • PipelineTopologyProperties



Optional description

description: undefined | string

An optional description of the pipeline topology. It is recommended that the expected use of the topology to be described here.

Optional parameters

parameters: ParameterDeclaration[]

List of the topology parameter declarations. Parameters declared here can be referenced throughout the topology nodes through the use of "${PARAMETER_NAME}" string pattern. Parameters can have optional default values and can later be defined in individual instances of the pipeline.

Optional processors

List of the topology processor nodes. Processor nodes enable pipeline data to be analyzed, processed or transformed.

Optional sinks

List of the topology sink nodes. Sink nodes allow pipeline data to be stored or exported.

Optional sources

List of the topology source nodes. Source nodes enable external data to be ingested by the pipeline.

Generated using TypeDoc