Skip to main content

Interface: INewWorkflowExecutionInfo

workflow.v1.INewWorkflowExecutionInfo

Properties of a NewWorkflowExecutionInfo.

Implemented by​

Properties​

cronSchedule​

• Optional cronSchedule: null | string

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

• Optional header: null | IHeader

NewWorkflowExecutionInfo header

input​

• Optional input: null | IPayloads

Serialized arguments to the workflow.

memo​

• Optional memo: null | IMemo

NewWorkflowExecutionInfo memo

priority​

• Optional priority: null | IPriority

Priority metadata

retryPolicy​

• Optional retryPolicy: null | IRetryPolicy

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

searchAttributes​

• Optional searchAttributes: null | ISearchAttributes

NewWorkflowExecutionInfo searchAttributes

taskQueue​

• Optional taskQueue: null | ITaskQueue

NewWorkflowExecutionInfo taskQueue

userMetadata​

• Optional userMetadata: null | IUserMetadata

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: null | IVersioningOverride

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: null | IDuration

Total workflow execution timeout including retries and continue as new.

workflowId​

• Optional workflowId: null | string

NewWorkflowExecutionInfo workflowId

workflowIdReusePolicy​

• Optional workflowIdReusePolicy: null | WorkflowIdReusePolicy

Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.

workflowRunTimeout​

• Optional workflowRunTimeout: null | IDuration

Timeout of a single workflow run.

workflowTaskTimeout​

• Optional workflowTaskTimeout: null | IDuration

Timeout of a single workflow task.

workflowType​

• Optional workflowType: null | IWorkflowType

NewWorkflowExecutionInfo workflowType