Skip to main content

Interface: $Properties

Properties of an InitializeWorkflow.

Extended by​

Properties​

arguments?​

optional arguments?: $Properties[] | null

Inputs to the workflow code

attempt?​

optional attempt?: number | null

Starting at 1, the number of times we have tried to execute this workflow

continuedFailure?​

optional continuedFailure?: $Properties | null

If this workflow was a continuation and that continuation failed, the details of that.

continuedFromExecutionRunId?​

optional continuedFromExecutionRunId?: string | null

Run id of the previous workflow which continued-as-new or retired or cron executed into this workflow, if any.

continuedInitiator?​

optional continuedInitiator?: ContinueAsNewInitiator | null

If this workflow was a continuation, indicates the type of continuation.

cronSchedule?​

optional cronSchedule?: string | null

If this workflow runs on a cron schedule, it will appear here

cronScheduleToScheduleInterval?​

optional cronScheduleToScheduleInterval?: $Properties | null

For a cron workflow, this contains the amount of time between when this iteration of the cron workflow was scheduled and when it should run next per its cron_schedule.

firstExecutionRunId?​

optional firstExecutionRunId?: string | null

This is the very first run id the workflow ever had, following continuation chains.

headers?​

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

Used to add metadata e.g. for tracing and auth, meant to be read and written to by interceptors.

identity?​

optional identity?: string | null

Identity of the client who requested this execution

lastCompletionResult?​

optional lastCompletionResult?: $Properties | null

If this workflow was a continuation and that continuation completed, the details of that.

memo?​

optional memo?: $Properties | null

User-defined memo

originalExecutionRunId?​

optional originalExecutionRunId?: string | null

The run id recorded on the WORKFLOW_EXECUTION_STARTED event. Unlike the execution's current run id, this value is preserved across workflow resets. Mirrors the original_execution_run_id field from WorkflowExecutionStartedEventAttributes.

parentWorkflowInfo?​

optional parentWorkflowInfo?: $Properties | null

If this workflow is a child, information about the parent

priority?​

optional priority?: $Properties | null

Priority of this workflow execution

propagatedNexusSerializationContext?​

optional propagatedNexusSerializationContext?: $Properties | null

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

randomnessSeed?​

optional randomnessSeed?: Long | null

The seed must be used to initialize the random generator used by SDK. RandomSeedUpdatedAttributes are used to deliver seed updates.

retryPolicy?​

optional retryPolicy?: $Properties | null

This workflow's retry policy

rootWorkflow?​

optional rootWorkflow?: $Properties | null

Contains information about the root workflow execution. It is possible for the namespace to be different than this workflow if using OSS and cross-namespace children, but this information is not retained. Users should take care to track it by other means in such situations.

The root workflow execution is defined as follows:

  1. A workflow without parent workflow is its own root workflow.
  2. A workflow that has a parent workflow has the same root workflow as its parent workflow.

See field in WorkflowExecutionStarted for more detail.

searchAttributes?​

optional searchAttributes?: $Properties | null

Search attributes created/updated when this workflow was started

startTime?​

optional startTime?: $Properties | null

When the workflow execution started event was first written

workflowExecutionExpirationTime?​

optional workflowExecutionExpirationTime?: $Properties | null

The absolute time at which the workflow will be timed out. This is passed without change to the next run/retry of a workflow.

workflowExecutionTimeout?​

optional workflowExecutionTimeout?: $Properties | null

Total workflow execution timeout including retries and continue as new.

workflowId?​

optional workflowId?: string | null

The workflow id used on the temporal server

workflowRunTimeout?​

optional workflowRunTimeout?: $Properties | null

Timeout of a single workflow run.

workflowTaskTimeout?​

optional workflowTaskTimeout?: $Properties | null

Timeout of a single workflow task.

workflowType?​

optional workflowType?: string | null

The identifier the lang-specific sdk uses to execute workflow code