Skip to main content

NodeDescriptor

Namespace: Meshmakers.Octo.Sdk.Common.EtlDataPipeline.Configuration

Describes a pipeline node type with its configuration schema.

public record NodeDescriptor : IEquatable<NodeDescriptor>

Inheritance Object → NodeDescriptor
Implements IEquatable<NodeDescriptor>

Properties​

NodeName​

The qualified name of the node (e.g. "Select@1")

public string NodeName { get; set; }

Property Value​

String

Version​

The version of the node

public int Version { get; set; }

Property Value​

Int32

Category​

The category derived from namespace (e.g. "Trigger", "Transform", "Control")

public string Category { get; set; }

Property Value​

String

IsTrigger​

Whether this node is a trigger node

public bool IsTrigger { get; set; }

Property Value​

Boolean

SupportsChildren​

Whether this node supports child transformations

public bool SupportsChildren { get; set; }

Property Value​

Boolean

ConfigurationSchemaJson​

JSON Schema string describing the configuration

public string ConfigurationSchemaJson { get; set; }

Property Value​

String

IsDeprecated​

Whether this node is deprecated (see NodeDeprecatedAttribute)

public bool IsDeprecated { get; set; }

Property Value​

Boolean

DeprecationMessage​

Optional reason or migration hint when the node is deprecated

public string DeprecationMessage { get; set; }

Property Value​

String

RequiresRunningProcess​

Whether this trigger node only works while the adapter process is running (see NodeRequiresRunningProcessAttribute)

public bool RequiresRunningProcess { get; set; }

Property Value​

Boolean

ExecutionClass​

The scheduling class this trigger implies on a leased adapter pool (see NodeExecutionClassAttribute). Defaults to PipelineExecutionClass.Batch — a trigger that declares nothing must never jump a queue.

public PipelineExecutionClass ExecutionClass { get; set; }

Property Value​

PipelineExecutionClass

Constructors​

NodeDescriptor(String, Int32, String, Boolean, Boolean, String, Boolean, String, Boolean, PipelineExecutionClass)​

Describes a pipeline node type with its configuration schema.

public NodeDescriptor(string NodeName, int Version, string Category, bool IsTrigger, bool SupportsChildren, string ConfigurationSchemaJson, bool IsDeprecated, string DeprecationMessage, bool RequiresRunningProcess, PipelineExecutionClass ExecutionClass)

Parameters​

NodeName String
The qualified name of the node (e.g. "Select@1")

Version Int32
The version of the node

Category String
The category derived from namespace (e.g. "Trigger", "Transform", "Control")

IsTrigger Boolean
Whether this node is a trigger node

SupportsChildren Boolean
Whether this node supports child transformations

ConfigurationSchemaJson String
JSON Schema string describing the configuration

IsDeprecated Boolean
Whether this node is deprecated (see NodeDeprecatedAttribute)

DeprecationMessage String
Optional reason or migration hint when the node is deprecated

RequiresRunningProcess Boolean
Whether this trigger node only works while the adapter process is running (see NodeRequiresRunningProcessAttribute)

ExecutionClass PipelineExecutionClass
The scheduling class this trigger implies on a leased adapter pool (see NodeExecutionClassAttribute). Defaults to PipelineExecutionClass.Batch — a trigger that declares nothing must never jump a queue.