Variable: PAYLOAD_FIELDS_DOCUMENT
constPAYLOAD_FIELDS_DOCUMENT:object
schema/payload-fields.json: the pointers and the encoded form, for other SDKs.
Type Declaration
commandFailures
readonlycommandFailures:Readonly<Partial<Record<"SCHEDULE_ACTIVITY"|"REQUEST_CANCEL_ACTIVITY"|"START_TIMER"|"CANCEL_TIMER"|"START_CHILD_RUN"|"SIGNAL_RUN"|"RECORD_SIDE_EFFECT"|"RECORD_MARKER"|"COMPLETE_WORKFLOW"|"FAIL_WORKFLOW"|"CANCEL_WORKFLOW"|"UPSERT_CONTEXT"|"RECORD_LOCAL_ACTIVITY"|"CONTINUE_AS_NEW"|"REQUEST_CANCEL_EXTERNAL_RUN"|"UPSERT_SEARCH_ATTRIBUTES"|"ACCEPT_UPDATE"|"REJECT_UPDATE"|"COMPLETE_UPDATE", readonlystring[]>>>
commands
readonlycommands:Readonly<Partial<Record<"SCHEDULE_ACTIVITY"|"REQUEST_CANCEL_ACTIVITY"|"START_TIMER"|"CANCEL_TIMER"|"START_CHILD_RUN"|"SIGNAL_RUN"|"RECORD_SIDE_EFFECT"|"RECORD_MARKER"|"COMPLETE_WORKFLOW"|"FAIL_WORKFLOW"|"CANCEL_WORKFLOW"|"UPSERT_CONTEXT"|"RECORD_LOCAL_ACTIVITY"|"CONTINUE_AS_NEW"|"REQUEST_CANCEL_EXTERNAL_RUN"|"UPSERT_SEARCH_ATTRIBUTES"|"ACCEPT_UPDATE"|"REJECT_UPDATE"|"COMPLETE_UPDATE", readonlystring[]>>>
description
readonlydescription: "JSON pointers of user payloads per event type (relative to the payload) and per command type (relative to the command). `events` and `commands` are plain payload pointers. `eventFailures` and `commandFailures` point at failure objects: the payloads of a failure are the `failure.payloads` pointers relative to it, and the same rule applies again to the failure at `failure.cause` (recursively, to the end of the cause chain). Payload codecs and the at-rest envelope apply to these pointers only; everything else stays in clear text. A value that is not plain JSON is carried as {"$fgp": 1, "encoding", "metadata"?, "data" (base64)}."
encodedMarker
readonlyencodedMarker:"$fgp"
encodedVersion
readonlyencodedVersion:1
encodings
readonlyencodings: readonly ["json/plain","binary/plain","binary/encrypted","kms/envelope"]
eventFailures
readonlyeventFailures:Readonly<Partial<Record<"WORKFLOW_STARTED"|"WORKFLOW_TASK_SCHEDULED"|"WORKFLOW_TASK_STARTED"|"WORKFLOW_TASK_COMPLETED"|"WORKFLOW_TASK_FAILED"|"WORKFLOW_TASK_TIMED_OUT"|"ACTIVITY_SCHEDULED"|"ACTIVITY_STARTED"|"ACTIVITY_HEARTBEAT"|"ACTIVITY_COMPLETED"|"ACTIVITY_FAILED"|"ACTIVITY_TIMED_OUT"|"ACTIVITY_CANCEL_REQUESTED"|"ACTIVITY_CANCELLED"|"ACTIVITY_PAUSED"|"ACTIVITY_UNPAUSED"|"ACTIVITY_RESET"|"ACTIVITY_OPTIONS_UPDATED"|"TIMER_STARTED"|"TIMER_FIRED"|"TIMER_CANCELLED"|"SIGNAL_RECEIVED"|"UPDATE_ADMITTED"|"UPDATE_ACCEPTED"|"UPDATE_COMPLETED"|"CHILD_RUN_INITIATED"|"CHILD_RUN_STARTED"|"CHILD_RUN_COMPLETED"|"CHILD_RUN_FAILED"|"CHILD_RUN_CANCELLED"|"CHILD_RUN_TERMINATED"|"CHILD_RUN_TIMED_OUT"|"EXTERNAL_RUN_CANCEL_REQUESTED"|"EXTERNAL_RUN_CANCEL_RESOLVED"|"EXTERNAL_RUN_SIGNALED"|"SIDE_EFFECT_RECORDED"|"LOCAL_ACTIVITY_COMPLETED"|"LOCAL_ACTIVITY_FAILED"|"SEARCH_ATTRIBUTES_UPSERTED"|"CONTEXT_UPSERTED"|"MARKER_RECORDED"|"WORKFLOW_CANCEL_REQUESTED"|"WORKFLOW_RESET"|"VERSIONING_OVERRIDE_SET"|"WORKFLOW_COMPLETED"|"WORKFLOW_FAILED"|"WORKFLOW_CANCELLED"|"WORKFLOW_TERMINATED"|"WORKFLOW_TIMED_OUT"|"WORKFLOW_CONTINUED_AS_NEW", readonlystring[]>>>
events
readonlyevents:Readonly<Partial<Record<"WORKFLOW_STARTED"|"WORKFLOW_TASK_SCHEDULED"|"WORKFLOW_TASK_STARTED"|"WORKFLOW_TASK_COMPLETED"|"WORKFLOW_TASK_FAILED"|"WORKFLOW_TASK_TIMED_OUT"|"ACTIVITY_SCHEDULED"|"ACTIVITY_STARTED"|"ACTIVITY_HEARTBEAT"|"ACTIVITY_COMPLETED"|"ACTIVITY_FAILED"|"ACTIVITY_TIMED_OUT"|"ACTIVITY_CANCEL_REQUESTED"|"ACTIVITY_CANCELLED"|"ACTIVITY_PAUSED"|"ACTIVITY_UNPAUSED"|"ACTIVITY_RESET"|"ACTIVITY_OPTIONS_UPDATED"|"TIMER_STARTED"|"TIMER_FIRED"|"TIMER_CANCELLED"|"SIGNAL_RECEIVED"|"UPDATE_ADMITTED"|"UPDATE_ACCEPTED"|"UPDATE_COMPLETED"|"CHILD_RUN_INITIATED"|"CHILD_RUN_STARTED"|"CHILD_RUN_COMPLETED"|"CHILD_RUN_FAILED"|"CHILD_RUN_CANCELLED"|"CHILD_RUN_TERMINATED"|"CHILD_RUN_TIMED_OUT"|"EXTERNAL_RUN_CANCEL_REQUESTED"|"EXTERNAL_RUN_CANCEL_RESOLVED"|"EXTERNAL_RUN_SIGNALED"|"SIDE_EFFECT_RECORDED"|"LOCAL_ACTIVITY_COMPLETED"|"LOCAL_ACTIVITY_FAILED"|"SEARCH_ATTRIBUTES_UPSERTED"|"CONTEXT_UPSERTED"|"MARKER_RECORDED"|"WORKFLOW_CANCEL_REQUESTED"|"WORKFLOW_RESET"|"VERSIONING_OVERRIDE_SET"|"WORKFLOW_COMPLETED"|"WORKFLOW_FAILED"|"WORKFLOW_CANCELLED"|"WORKFLOW_TERMINATED"|"WORKFLOW_TIMED_OUT"|"WORKFLOW_CONTINUED_AS_NEW", readonlystring[]>>>
failure
readonlyfailure:object
failure.cause
readonlycause:"/cause"
failure.payloads
readonlypayloads: readonlystring[]
format
readonlyformat:"fluidgrids.payload-fields"
formatVersion
readonlyformatVersion:2