Skip to main content

IPipelineConfigurationSerializer

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

Interface for pipeline configuration serializer

public interface IPipelineConfigurationSerializer

Methods​

SerializeAsync(NodeDefinitionRoot)​

Serialize pipeline configuration to a string

Task<string> SerializeAsync(NodeDefinitionRoot nodeDefinition)

Parameters​

nodeDefinition NodeDefinitionRoot
The pipeline object to configure

Returns​

Task<String>

SerializeAsync(StreamWriter, NodeDefinitionRoot)​

Serialize pipeline configuration to a stream

Task SerializeAsync(StreamWriter streamWriter, NodeDefinitionRoot nodeDefinition)

Parameters​

streamWriter StreamWriter
A stream ready to write used for serialization

nodeDefinition NodeDefinitionRoot
The pipeline object to configure

Returns​

Task

DeserializeAsync(String)​

Deserializes the pipeline configuration from a string

Task<NodeDefinitionRoot> DeserializeAsync(string formattedText)

Parameters​

formattedText String
Formatted text to deserialize

Returns​

Task<NodeDefinitionRoot>

DeserializeAsync(Stream, Nullable<CancellationToken>)​

Deserializes the pipeline configuration from a stream

Task<NodeDefinitionRoot> DeserializeAsync(Stream stream, Nullable<CancellationToken> cancellationToken)

Parameters​

stream Stream
The stream to read

cancellationToken Nullable<CancellationToken>
Token to cancel the operation

Returns​

Task<NodeDefinitionRoot>
The deserialized object