Krill SDK/krill.zone.shared.krillapp.executor.webhook/WebHookOutMetaData

WebHookOutMetaData

@Serializable

data class WebHookOutMetaData(val name: String = "", val sources: List<NodeIdentity> = emptyList(), val url: String = "", val method: HttpMethod = HttpMethod.GET, val params: List<Pair<String, String>> = emptyList(), val headers: List<Pair<String, String>> = emptyList(), val snapshot: Snapshot = Snapshot(), val invocationTriggers: List<InvocationTrigger> = emptyList(), val nodeAction: NodeAction = NodeAction.EXECUTE, val error: String = "", val inputs: List<NodeIdentity> = emptyList()) : SourceMetaData(source)

Payload for an OutgoingWebHook executor node.

Constructors

WebHookOutMetaData

constructor(name: String = "", sources: List<NodeIdentity> = emptyList(), url: String = "", method: HttpMethod = HttpMethod.GET, params: List<Pair<String, String>> = emptyList(), headers: List<Pair<String, String>> = emptyList(), snapshot: Snapshot = Snapshot(), invocationTriggers: List<InvocationTrigger> = emptyList(), nodeAction: NodeAction = NodeAction.EXECUTE, error: String = "", inputs: List<NodeIdentity> = emptyList())

Properties

error

open override val error: String

Last known error message for this node, or empty string when healthy.

headers

val headers: List<Pair<String, String>>

HTTP headers, as ordered key/value pairs. Same multi-value rationale as params.

inputs

open override val inputs: List<NodeIdentity>

sets the nodes this node reads from to complete its work when invoked

invocationTriggers

open override val invocationTriggers: List<InvocationTrigger>

The set of InvocationTriggers configured to wake this node. The node processor checks the incoming event against this list before doing any work. An empty list means "never auto-fire" — only manual execution.

method

val method: HttpMethod

HTTP verb to use — defaults to GET.

name

val name: String

nodeAction

open override val nodeAction: NodeAction

The action this node performs when it fires. Defaults to NodeAction.EXECUTE on every concrete implementation so that deserialising a payload that predates this field yields the original behaviour unchanged.

params

val params: List<Pair<String, String>>

Query / form params, as ordered key/value pairs. List<Pair> rather than Map so authors can express the same key twice (e.g. ?tag=a&tag=b), which servers like Prometheus actually require.

snapshot

open override val snapshot: Snapshot

Stores the last result of when this node was invoked and is a source of data

sources

open override val sources: List<NodeIdentity>

Upstream nodes whose values feed this one. For a filter or executor this is the data being read; for a trigger it is the value being watched.

url

val url: String