Skip to main content

Interface: IDoUpdate

Properties of a DoUpdate.

Extends​

Properties​

headers?​

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

Headers attached to the update

Inherited from​

$Properties.headers

id?​

optional id?: string | null

A workflow-unique identifier for this update

Inherited from​

$Properties.id

input?​

optional input?: $Properties[] | null

The input to the update

Inherited from​

$Properties.input

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.

Inherited from​

$Properties.meta

name?​

optional name?: string | null

The name of the update handler

Inherited from​

$Properties.name

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.

Inherited from​

$Properties.propagatedNexusSerializationContext

protocolInstanceId?​

optional protocolInstanceId?: string | null

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

Inherited from​

$Properties.protocolInstanceId

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.

Inherited from​

$Properties.runValidator