Skip to main content

Interface: INewWorkflowExecutionInfo

workflow.v1.INewWorkflowExecutionInfo

Properties of a NewWorkflowExecutionInfo.

Hierarchy​

Properties​

cronSchedule​

• Optional cronSchedule: null | string

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

Inherited from​

$Properties.cronSchedule

• Optional header: null | $Properties

NewWorkflowExecutionInfo header

Inherited from​

$Properties.header

input​

• Optional input: null | $Properties

Serialized arguments to the workflow.

Inherited from​

$Properties.input

memo​

• Optional memo: null | $Properties

NewWorkflowExecutionInfo memo

Inherited from​

$Properties.memo

priority​

• Optional priority: null | $Properties

Priority metadata

Inherited from​

$Properties.priority

retryPolicy​

• Optional retryPolicy: null | $Properties

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

Inherited from​

$Properties.retryPolicy

searchAttributes​

• Optional searchAttributes: null | $Properties

NewWorkflowExecutionInfo searchAttributes

Inherited from​

$Properties.searchAttributes

taskQueue​

• Optional taskQueue: null | $Properties

NewWorkflowExecutionInfo taskQueue

Inherited from​

$Properties.taskQueue

userMetadata​

• Optional userMetadata: null | $Properties

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.

Inherited from​

$Properties.userMetadata

versioningOverride​

• Optional versioningOverride: null | $Properties

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.

Inherited from​

$Properties.versioningOverride

workflowExecutionTimeout​

• Optional workflowExecutionTimeout: null | $Properties

Total workflow execution timeout including retries and continue as new.

Inherited from​

$Properties.workflowExecutionTimeout

workflowId​

• Optional workflowId: null | string

NewWorkflowExecutionInfo workflowId

Inherited from​

$Properties.workflowId

workflowIdReusePolicy​

• Optional workflowIdReusePolicy: null | WorkflowIdReusePolicy

Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.

Inherited from​

$Properties.workflowIdReusePolicy

workflowRunTimeout​

• Optional workflowRunTimeout: null | $Properties

Timeout of a single workflow run.

Inherited from​

$Properties.workflowRunTimeout

workflowTaskTimeout​

• Optional workflowTaskTimeout: null | $Properties

Timeout of a single workflow task.

Inherited from​

$Properties.workflowTaskTimeout

workflowType​

• Optional workflowType: null | $Properties

NewWorkflowExecutionInfo workflowType

Inherited from​

$Properties.workflowType