Skip to main content

Variable: RUN_EVENT_SCHEMA

const RUN_EVENT_SCHEMA: object

One stored history event.

Type Declaration​

$defs​

readonly $defs: object

$defs.canOptions​

readonly canOptions: object

$defs.canOptions.additionalProperties​

readonly additionalProperties: false

$defs.canOptions.description​

readonly description: "Options of a CONTINUE_AS_NEW command (C-SCHEMA, frozen in R2). retry is the R2 run-retry policy of the new run, or the R1 activity shape (retryDelay, maxRetries, maxDelay) that R1 bundles wrote and R2 bundles still write for that shape: it never had a meaning, and the service ignores it instead of reading it as a run-retry policy."

$defs.canOptions.properties​

readonly properties: object

$defs.canOptions.properties.context​

readonly context: object

$defs.canOptions.properties.context.type​

readonly type: "object"

$defs.canOptions.properties.retry​

readonly retry: object

$defs.canOptions.properties.retry.oneOf​

readonly oneOf: readonly [{ $ref: "#/$defs/runRetryPolicy"; }, { $ref: "#/$defs/legacyCanRetryPolicy"; }]

$defs.canOptions.properties.searchAttributes​

readonly searchAttributes: object

$defs.canOptions.properties.searchAttributes.description​

readonly description: "Gap G13: search attributes of the new run (name to value; null leaves a name unset). Needs c.searchAttributes."

$defs.canOptions.properties.searchAttributes.minProperties​

readonly minProperties: 1

$defs.canOptions.properties.searchAttributes.type​

readonly type: "object"

$defs.canOptions.properties.taskQueue​

readonly taskQueue: object

$defs.canOptions.properties.taskQueue.maxLength​

readonly maxLength: 256

$defs.canOptions.properties.taskQueue.minLength​

readonly minLength: 1

$defs.canOptions.properties.taskQueue.type​

readonly type: "string"

$defs.canOptions.properties.versioningBehavior​

readonly versioningBehavior: object

$defs.canOptions.properties.versioningBehavior.enum​

readonly enum: readonly ["PINNED", "AUTO_UPGRADE"]

$defs.canOptions.properties.workflowTaskTimeout​

readonly workflowTaskTimeout: object

$defs.canOptions.properties.workflowTaskTimeout.minimum​

readonly minimum: 0

$defs.canOptions.properties.workflowTaskTimeout.type​

readonly type: "integer"

$defs.canOptions.type​

readonly type: "object"

$defs.childOptions​

readonly childOptions: object

$defs.childOptions.properties​

readonly properties: object

$defs.childOptions.properties.cancellationType​

readonly cancellationType: object

$defs.childOptions.properties.cancellationType.enum​

readonly enum: readonly ["WAIT_CANCELLATION_COMPLETED", "WAIT_CANCELLATION_REQUESTED", "TRY_CANCEL", "ABANDON"]

$defs.childOptions.properties.context​

readonly context: object

$defs.childOptions.properties.context.type​

readonly type: "object"

$defs.childOptions.properties.details​

readonly details: object

$defs.childOptions.properties.details.type​

readonly type: "string"

$defs.childOptions.properties.executionTimeout​

readonly executionTimeout: object

$defs.childOptions.properties.executionTimeout.minimum​

readonly minimum: 0

$defs.childOptions.properties.executionTimeout.type​

readonly type: "integer"

$defs.childOptions.properties.fairnessKey​

readonly fairnessKey: object

$defs.childOptions.properties.fairnessKey.description​

readonly description: "The fairness key of the task (11 §2.11); default the workspace id."

$defs.childOptions.properties.fairnessKey.maxLength​

readonly maxLength: 255

$defs.childOptions.properties.fairnessKey.minLength​

readonly minLength: 1

$defs.childOptions.properties.fairnessKey.type​

readonly type: "string"

$defs.childOptions.properties.fairnessWeight​

readonly fairnessWeight: object

$defs.childOptions.properties.fairnessWeight.description​

readonly description: "The weight of the fairness key, 0.1 to 10 (default 1)."

$defs.childOptions.properties.fairnessWeight.maximum​

readonly maximum: 10

$defs.childOptions.properties.fairnessWeight.minimum​

readonly minimum: 0.1

$defs.childOptions.properties.fairnessWeight.type​

readonly type: "number"

$defs.childOptions.properties.idConflictPolicy​

readonly idConflictPolicy: object

$defs.childOptions.properties.idConflictPolicy.enum​

readonly enum: readonly ["FAIL", "USE_EXISTING", "TERMINATE_EXISTING"]

$defs.childOptions.properties.idReusePolicy​

readonly idReusePolicy: object

$defs.childOptions.properties.idReusePolicy.enum​

readonly enum: readonly ["ALLOW_DUPLICATE", "ALLOW_DUPLICATE_FAILED_ONLY", "REJECT_DUPLICATE"]

$defs.childOptions.properties.parentClosePolicy​

readonly parentClosePolicy: object

$defs.childOptions.properties.parentClosePolicy.enum​

readonly enum: readonly ["TERMINATE", "ABANDON", "REQUEST_CANCEL"]

$defs.childOptions.properties.priority​

readonly priority: object

$defs.childOptions.properties.priority.maximum​

readonly maximum: 5

$defs.childOptions.properties.priority.minimum​

readonly minimum: 1

$defs.childOptions.properties.priority.type​

readonly type: "integer"

$defs.childOptions.properties.retry​

readonly retry: object

$defs.childOptions.properties.retry.$ref​

readonly $ref: "#/$defs/runRetryPolicy"

$defs.childOptions.properties.runTimeout​

readonly runTimeout: object

$defs.childOptions.properties.runTimeout.minimum​

readonly minimum: 0

$defs.childOptions.properties.runTimeout.type​

readonly type: "integer"

$defs.childOptions.properties.searchAttributes​

readonly searchAttributes: object

$defs.childOptions.properties.searchAttributes.description​

readonly description: "Gap G13: search attributes of the new run (name to value; null leaves a name unset). Needs c.searchAttributes."

$defs.childOptions.properties.searchAttributes.minProperties​

readonly minProperties: 1

$defs.childOptions.properties.searchAttributes.type​

readonly type: "object"

$defs.childOptions.properties.startDelay​

readonly startDelay: object

$defs.childOptions.properties.startDelay.minimum​

readonly minimum: 0

$defs.childOptions.properties.startDelay.type​

readonly type: "integer"

$defs.childOptions.properties.summary​

readonly summary: object

$defs.childOptions.properties.summary.maxLength​

readonly maxLength: 200

$defs.childOptions.properties.summary.type​

readonly type: "string"

$defs.childOptions.properties.taskQueue​

readonly taskQueue: object

$defs.childOptions.properties.taskQueue.maxLength​

readonly maxLength: 256

$defs.childOptions.properties.taskQueue.minLength​

readonly minLength: 1

$defs.childOptions.properties.taskQueue.type​

readonly type: "string"

$defs.childOptions.properties.versioningBehavior​

readonly versioningBehavior: object

$defs.childOptions.properties.versioningBehavior.enum​

readonly enum: readonly ["PINNED", "AUTO_UPGRADE"]

$defs.childOptions.properties.workflowId​

readonly workflowId: object

$defs.childOptions.properties.workflowId.maxLength​

readonly maxLength: 256

$defs.childOptions.properties.workflowId.minLength​

readonly minLength: 1

$defs.childOptions.properties.workflowId.type​

readonly type: "string"

$defs.childOptions.properties.workflowTaskTimeout​

readonly workflowTaskTimeout: object

$defs.childOptions.properties.workflowTaskTimeout.minimum​

readonly minimum: 0

$defs.childOptions.properties.workflowTaskTimeout.type​

readonly type: "integer"

$defs.childOptions.required​

readonly required: readonly ["parentClosePolicy"]

$defs.childOptions.type​

readonly type: "object"

$defs.failure​

readonly failure: object

$defs.failure.additionalProperties​

readonly additionalProperties: false

$defs.failure.properties​

readonly properties: object

$defs.failure.properties.category​

readonly category: object

$defs.failure.properties.category.const​

readonly const: "BENIGN"

$defs.failure.properties.cause​

readonly cause: object

$defs.failure.properties.cause.$ref​

readonly $ref: "#/$defs/failure"

$defs.failure.properties.details​

readonly details: object

$defs.failure.properties.errorType​

readonly errorType: object

$defs.failure.properties.errorType.enum​

readonly enum: readonly ErrorType[]

$defs.failure.properties.message​

readonly message: object

$defs.failure.properties.message.type​

readonly type: "string"

$defs.failure.properties.nextRetryDelayMs​

readonly nextRetryDelayMs: object

$defs.failure.properties.nextRetryDelayMs.minimum​

readonly minimum: 0

$defs.failure.properties.nextRetryDelayMs.type​

readonly type: "integer"

$defs.failure.properties.nonRetryable​

readonly nonRetryable: object

$defs.failure.properties.nonRetryable.type​

readonly type: "boolean"

$defs.failure.properties.source​

readonly source: object

$defs.failure.properties.source.type​

readonly type: "string"

$defs.failure.properties.stackTrace​

readonly stackTrace: object

$defs.failure.properties.stackTrace.type​

readonly type: "string"

$defs.failure.properties.timeoutType​

readonly timeoutType: object

$defs.failure.properties.timeoutType.type​

readonly type: "string"

$defs.failure.properties.type​

readonly type: object

$defs.failure.properties.type.type​

readonly type: "string"

$defs.failure.required​

readonly required: readonly ["errorType", "message"]

$defs.failure.type​

readonly type: "object"

$defs.headers​

readonly headers: object

$defs.headers.additionalProperties​

readonly additionalProperties: object

$defs.headers.additionalProperties.type​

readonly type: "string"

$defs.headers.description​

readonly description: "Interceptor headers (11 §2.10): string values; a user activity carries at most 16 KiB of JSON (checked by validateCommands)."

$defs.headers.type​

readonly type: "object"

$defs.json​

readonly json: object

$defs.json.description​

readonly description: "Any JSON value."

$defs.legacyCanRetryPolicy​

readonly legacyCanRetryPolicy: object

$defs.legacyCanRetryPolicy.additionalProperties​

readonly additionalProperties: false

$defs.legacyCanRetryPolicy.description​

readonly description: "The R1 activity-shaped CONTINUE_AS_NEW retry: whatever explicitRetryPolicy wrote from a Partial<RetryPolicy>, so numbers carry no integer or minimum constraint. It never had a meaning, and the service ignores it."

$defs.legacyCanRetryPolicy.properties​

readonly properties: object

$defs.legacyCanRetryPolicy.properties.backoffMultiplier​

readonly backoffMultiplier: object

$defs.legacyCanRetryPolicy.properties.backoffMultiplier.type​

readonly type: "number"

$defs.legacyCanRetryPolicy.properties.maxDelay​

readonly maxDelay: object

$defs.legacyCanRetryPolicy.properties.maxDelay.type​

readonly type: "number"

$defs.legacyCanRetryPolicy.properties.maxRetries​

readonly maxRetries: object

$defs.legacyCanRetryPolicy.properties.maxRetries.type​

readonly type: "number"

$defs.legacyCanRetryPolicy.properties.nonRetryableErrorTypes​

readonly nonRetryableErrorTypes: object

$defs.legacyCanRetryPolicy.properties.nonRetryableErrorTypes.items​

readonly items: object

$defs.legacyCanRetryPolicy.properties.nonRetryableErrorTypes.items.type​

readonly type: "string"

$defs.legacyCanRetryPolicy.properties.nonRetryableErrorTypes.type​

readonly type: "array"

$defs.legacyCanRetryPolicy.properties.retryDelay​

readonly retryDelay: object

$defs.legacyCanRetryPolicy.properties.retryDelay.type​

readonly type: "number"

$defs.legacyCanRetryPolicy.properties.retryOnErrorTypes​

readonly retryOnErrorTypes: object

$defs.legacyCanRetryPolicy.properties.retryOnErrorTypes.items​

readonly items: object

$defs.legacyCanRetryPolicy.properties.retryOnErrorTypes.items.type​

readonly type: "string"

$defs.legacyCanRetryPolicy.properties.retryOnErrorTypes.type​

readonly type: "array"

$defs.legacyCanRetryPolicy.required​

readonly required: readonly ["retryDelay"]

$defs.legacyCanRetryPolicy.type​

readonly type: "object"

$defs.retryPolicy​

readonly retryPolicy: object

$defs.retryPolicy.additionalProperties​

readonly additionalProperties: false

$defs.retryPolicy.description​

readonly description: "maxRetries absent means unlimited attempts, bounded by scheduleToCloseTimeout."

$defs.retryPolicy.properties​

readonly properties: object

$defs.retryPolicy.properties.backoffMultiplier​

readonly backoffMultiplier: object

$defs.retryPolicy.properties.backoffMultiplier.minimum​

readonly minimum: 1

$defs.retryPolicy.properties.backoffMultiplier.type​

readonly type: "number"

$defs.retryPolicy.properties.maxDelay​

readonly maxDelay: object

$defs.retryPolicy.properties.maxDelay.minimum​

readonly minimum: 0

$defs.retryPolicy.properties.maxDelay.type​

readonly type: "integer"

$defs.retryPolicy.properties.maxRetries​

readonly maxRetries: object

$defs.retryPolicy.properties.maxRetries.minimum​

readonly minimum: 0

$defs.retryPolicy.properties.maxRetries.type​

readonly type: "integer"

$defs.retryPolicy.properties.nonRetryableErrorTypes​

readonly nonRetryableErrorTypes: object

$defs.retryPolicy.properties.nonRetryableErrorTypes.items​

readonly items: object

$defs.retryPolicy.properties.nonRetryableErrorTypes.items.type​

readonly type: "string"

$defs.retryPolicy.properties.nonRetryableErrorTypes.type​

readonly type: "array"

$defs.retryPolicy.properties.retryDelay​

readonly retryDelay: object

$defs.retryPolicy.properties.retryDelay.minimum​

readonly minimum: 0

$defs.retryPolicy.properties.retryDelay.type​

readonly type: "integer"

$defs.retryPolicy.properties.retryOnErrorTypes​

readonly retryOnErrorTypes: object

$defs.retryPolicy.properties.retryOnErrorTypes.items​

readonly items: object

$defs.retryPolicy.properties.retryOnErrorTypes.items.enum​

readonly enum: readonly ErrorType[]

$defs.retryPolicy.properties.retryOnErrorTypes.type​

readonly type: "array"

$defs.retryPolicy.required​

readonly required: readonly ["retryDelay"]

$defs.retryPolicy.type​

readonly type: "object"

$defs.runRetryPolicy​

readonly runRetryPolicy: object

$defs.runRetryPolicy.additionalProperties​

readonly additionalProperties: false

$defs.runRetryPolicy.description​

readonly description: "Run-level retry (11 §2.17), in milliseconds. maxAttempts counts every attempt; absent means unlimited, bounded by the execution timeout."

$defs.runRetryPolicy.properties​

readonly properties: object

$defs.runRetryPolicy.properties.backoffMultiplier​

readonly backoffMultiplier: object

$defs.runRetryPolicy.properties.backoffMultiplier.minimum​

readonly minimum: 1

$defs.runRetryPolicy.properties.backoffMultiplier.type​

readonly type: "number"

$defs.runRetryPolicy.properties.initialDelayMs​

readonly initialDelayMs: object

$defs.runRetryPolicy.properties.initialDelayMs.minimum​

readonly minimum: 0

$defs.runRetryPolicy.properties.initialDelayMs.type​

readonly type: "integer"

$defs.runRetryPolicy.properties.maxAttempts​

readonly maxAttempts: object

$defs.runRetryPolicy.properties.maxAttempts.minimum​

readonly minimum: 1

$defs.runRetryPolicy.properties.maxAttempts.type​

readonly type: "integer"

$defs.runRetryPolicy.properties.maxDelayMs​

readonly maxDelayMs: object

$defs.runRetryPolicy.properties.maxDelayMs.minimum​

readonly minimum: 0

$defs.runRetryPolicy.properties.maxDelayMs.type​

readonly type: "integer"

$defs.runRetryPolicy.properties.nonRetryableErrorTypes​

readonly nonRetryableErrorTypes: object

$defs.runRetryPolicy.properties.nonRetryableErrorTypes.items​

readonly items: object

$defs.runRetryPolicy.properties.nonRetryableErrorTypes.items.type​

readonly type: "string"

$defs.runRetryPolicy.properties.nonRetryableErrorTypes.type​

readonly type: "array"

$defs.runRetryPolicy.properties.retryOnErrorTypes​

readonly retryOnErrorTypes: object

$defs.runRetryPolicy.properties.retryOnErrorTypes.items​

readonly items: object

$defs.runRetryPolicy.properties.retryOnErrorTypes.items.enum​

readonly enum: readonly ErrorType[]

$defs.runRetryPolicy.properties.retryOnErrorTypes.type​

readonly type: "array"

$defs.runRetryPolicy.required​

readonly required: readonly ["initialDelayMs"]

$defs.runRetryPolicy.type​

readonly type: "object"

$defs.runTarget​

readonly runTarget: object

$defs.runTarget.oneOf​

readonly oneOf: readonly [{ additionalProperties: false; properties: { runId: { maxLength: 256; minLength: 1; type: "string"; }; }; required: readonly ["runId"]; type: "object"; }, { additionalProperties: false; properties: { parent: { const: true; }; }; required: readonly ["parent"]; type: "object"; }, { additionalProperties: false; properties: { childId: { maxLength: 256; minLength: 1; type: "string"; }; }; required: readonly ["childId"]; type: "object"; }, { additionalProperties: false; description: "The open run of a workflow id, following its continue-as-new chain; firstRunId pins the chain (R2)."; properties: { firstRunId: { maxLength: 256; minLength: 1; type: "string"; }; workflowId: { maxLength: 256; minLength: 1; type: "string"; }; workflowKey: { maxLength: 256; minLength: 1; type: "string"; }; }; required: readonly ["workflowKey", "workflowId"]; type: "object"; }]

$defs.timeouts​

readonly timeouts: object

$defs.timeouts.additionalProperties​

readonly additionalProperties: false

$defs.timeouts.description​

readonly description: "The three workflow timeouts (11 §2.20), in milliseconds."

$defs.timeouts.properties​

readonly properties: object

$defs.timeouts.properties.executionTimeout​

readonly executionTimeout: object

$defs.timeouts.properties.executionTimeout.minimum​

readonly minimum: 0

$defs.timeouts.properties.executionTimeout.type​

readonly type: "integer"

$defs.timeouts.properties.runTimeout​

readonly runTimeout: object

$defs.timeouts.properties.runTimeout.minimum​

readonly minimum: 0

$defs.timeouts.properties.runTimeout.type​

readonly type: "integer"

$defs.timeouts.properties.workflowTaskTimeout​

readonly workflowTaskTimeout: object

$defs.timeouts.properties.workflowTaskTimeout.minimum​

readonly minimum: 0

$defs.timeouts.properties.workflowTaskTimeout.type​

readonly type: "integer"

$defs.timeouts.type​

readonly type: "object"

$id​

readonly $id: "https://docs.fluidgrids.ai/schemas/run-event.schema.json"

$schema​

readonly $schema: "https://json-schema.org/draft/2020-12/schema"

allOf​

readonly allOf: object[]

description​

readonly description: "One row of workflow_run_events as the service returns it (offloaded payloads inlined). type is UPPER_SNAKE."

properties​

readonly properties: object

properties.createdAt​

readonly createdAt: object

properties.createdAt.minLength​

readonly minLength: 1

properties.createdAt.type​

readonly type: "string"

properties.dedupeKey​

readonly dedupeKey: object

properties.dedupeKey.type​

readonly type: readonly ["string", "null"]

properties.payload​

readonly payload: object

properties.payload.type​

readonly type: "object"

properties.seq​

readonly seq: object

properties.seq.minimum​

readonly minimum: 1

properties.seq.type​

readonly type: "integer"

properties.taskId​

readonly taskId: object

properties.taskId.type​

readonly type: readonly ["string", "null"]

properties.type​

readonly type: object

properties.type.enum​

readonly enum: readonly ["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"]

required​

readonly required: readonly ["seq", "type", "payload", "createdAt"]

title​

readonly title: "FluidGrids durable-function history event"

type​

readonly type: "object"