ParameterDeclaration interface

Single topology parameter declaration. Declared parameters can and must be referenced throughout the topology and can optionally have default values to be used when they are not defined in the pipelines.

Properties

default

The default value for the parameter to be used if the pipeline does not specify a value.

description

Description of the parameter.

name

Name of the parameter.

type

Type of the parameter.

Property Details

default

The default value for the parameter to be used if the pipeline does not specify a value.

default?: string

Property Value

string

description

Description of the parameter.

description?: string

Property Value

string

name

Name of the parameter.

name: string

Property Value

string

type

Type of the parameter.

type: string

Property Value

string