Skip to main content

ITriggerContext

Namespace: Meshmakers.Octo.Sdk.Common.EtlDataPipeline

Interface for extract node context

public interface ITriggerContext

Properties​

TenantId​

Returns the tenant id of the pipeline

public abstract string TenantId { get; }

Property Value​

String

DataFlowRtId​

Runtime id of the data flow

public abstract OctoObjectId DataFlowRtId { get; }

Property Value​

OctoObjectId

PipelineRtEntityId​

Returns the pipeline runtime id

public abstract RtEntityId PipelineRtEntityId { get; }

Property Value​

RtEntityId

NodeContext​

Returns the node context, that contains information about the current node

public abstract INodeContext NodeContext { get; }

Property Value​

INodeContext

GlobalConfiguration​

Returns the global configuration for the pipeline

public abstract IGlobalConfiguration GlobalConfiguration { get; }

Property Value​

IGlobalConfiguration

Methods​

ExecuteAsync(ExecutePipelineOptions, Object)​

Triggers the execution of the recent transformation pipeline

Task<object> ExecuteAsync(ExecutePipelineOptions executePipelineOptions, object input)

Parameters​

executePipelineOptions ExecutePipelineOptions

input Object

Returns​

Task<Object>

StartExecutePipelineAsync(ExecutePipelineOptions, Object)​

Starts the execution of a pipeline

Task<Guid> StartExecutePipelineAsync(ExecutePipelineOptions executePipelineOptions, object value)

Parameters​

executePipelineOptions ExecutePipelineOptions
Options for executing the pipeline

value Object
Input value that is passed to the first node of the pipeline

Returns​

Task<Guid>
The pipeline execution id that is unique per execution

EndExecutePipelineAsync(Guid)​

Ends the execution of a pipeline

Task<object> EndExecutePipelineAsync(Guid pipelineExecutionId)

Parameters​

pipelineExecutionId Guid
The pipeline execution id that is unique per execution

Returns​

Task<Object>
The result of the pipeline execution

ReportStatusAsync(String, Boolean, CancellationToken)​

Reports the pipeline's live status line — what this trigger last did — to the communication controller, which writes it to the pipeline entity's StatusMessage (AB#5385). Meant to be called after every poll and from the poll loop's failure path, so an operator sees the last outcome on the pipeline instead of a "Deployed" that has been failing for days.

Task ReportStatusAsync(string message, bool isError, CancellationToken cancellationToken)

Parameters​

message String
One status line, e.g. an ISO-8601 UTC timestamp, the source polled and the counts

isError Boolean
True when the line reports a failed poll

cancellationToken CancellationToken
Cancellation token

Returns​

Task

Remarks:

Fire-and-forget for the caller: never throws and never blocks the poll on the controller. A failure to deliver (hub down, a controller predating the method) is logged at Debug and rate-limited, not surfaced — the next poll replaces the line anyway. Keep the line short (the controller truncates at 1000 characters) and never include credentials or message bodies in it.