Skip to main content

Interface: $Properties

Properties of a DoUpdate.

Extended by​

Properties​

headers?​

optional headers?: {[k: string]: $Properties; } | null

Headers attached to the update

id?​

optional id?: string | null

A workflow-unique identifier for this update

input?​

optional input?: $Properties[] | null

The input to the update

meta?​

optional meta?: $Properties | null

Remaining metadata associated with the update. The update_id field is stripped from here and moved to id, since it is guaranteed to be present.

name?​

optional name?: string | null

The name of the update handler

propagatedNexusSerializationContext?​

optional propagatedNexusSerializationContext?: $Properties | null

Serialization context of the Nexus operation handler that sent this update, if any. Lang should use it to serialize the update's result and failure, which are returned to the Nexus caller.

protocolInstanceId?​

optional protocolInstanceId?: string | null

The protocol message instance ID - this is used to uniquely track the ID server side and internally.

runValidator?​

optional runValidator?: boolean | null

If set true, lang must run the update's validator before running the handler. This will be set false during replay, since validation is not re-run during replay.