Skip to main content

Interface: IDoUpdate

coresdk.workflow_activation.IDoUpdate

Properties of a DoUpdate.

Implemented by

Properties

headers

Optional headers: null | { [k: string]: IPayload; }

Headers attached to the update


id

Optional id: null | string

A workflow-unique identifier for this update


input

Optional input: null | IPayload[]

The input to the update


meta

Optional meta: null | IMeta

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: null | string

The name of the update handler


protocolInstanceId

Optional protocolInstanceId: null | string

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


runValidator

Optional runValidator: null | boolean

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.