Skip to main content

Interface: $Properties

Properties of a NewWorkflowExecutionInfo.

Extended by​

Properties​

cronSchedule?​

optional cronSchedule?: string | null

See https://docs.temporal.io/docs/content/what-is-a-temporal-cron-job/

optional header?: $Properties | null

NewWorkflowExecutionInfo header

input?​

optional input?: $Properties | null

Serialized arguments to the workflow.

memo?​

optional memo?: $Properties | null

NewWorkflowExecutionInfo memo

priority?​

optional priority?: $Properties | null

Priority metadata

retryPolicy?​

optional retryPolicy?: $Properties | null

The retry policy for the workflow. Will never exceed workflow_execution_timeout.

searchAttributes?​

optional searchAttributes?: $Properties | null

NewWorkflowExecutionInfo searchAttributes

taskQueue?​

optional taskQueue?: $Properties | null

NewWorkflowExecutionInfo taskQueue

userMetadata?​

optional userMetadata?: $Properties | null

Metadata on the workflow if it is started. This is carried over to the WorkflowExecutionConfig for use by user interfaces to display the fixed as-of-start summary and details of the workflow.

versioningOverride?​

optional versioningOverride?: $Properties | null

If set, takes precedence over the Versioning Behavior sent by the SDK on Workflow Task completion. To unset the override after the workflow is running, use UpdateWorkflowExecutionOptions.

workflowExecutionTimeout?​

optional workflowExecutionTimeout?: $Properties | null

Total workflow execution timeout including retries and continue as new.

workflowId?​

optional workflowId?: string | null

NewWorkflowExecutionInfo workflowId

workflowIdReusePolicy?​

optional workflowIdReusePolicy?: WorkflowIdReusePolicy | null

Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.

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?: $Properties | null

NewWorkflowExecutionInfo workflowType