Skip to main content

Interface: ISignalWithStartWorkflowExecutionRequest

workflowservice.v1.ISignalWithStartWorkflowExecutionRequest

Properties of a SignalWithStartWorkflowExecutionRequest.

Implemented by

Properties

control

Optional control: null | string

Deprecated


cronSchedule

Optional cronSchedule: null | string

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


Optional header: null | IHeader

SignalWithStartWorkflowExecutionRequest header


identity

Optional identity: null | string

The identity of the worker/client


input

Optional input: null | IPayloads

Serialized arguments to the workflow. These are passed as arguments to the workflow function.


memo

Optional memo: null | IMemo

SignalWithStartWorkflowExecutionRequest memo


namespace

Optional namespace: null | string

SignalWithStartWorkflowExecutionRequest namespace


requestId

Optional requestId: null | string

Used to de-dupe signal w/ start requests


retryPolicy

Optional retryPolicy: null | IRetryPolicy

Retry policy for the workflow Default: WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.


searchAttributes

Optional searchAttributes: null | ISearchAttributes

SignalWithStartWorkflowExecutionRequest searchAttributes


signalInput

Optional signalInput: null | IPayloads

Serialized value(s) to provide with the signal


signalName

Optional signalName: null | string

The workflow author-defined name of the signal to send to the workflow


skipGenerateWorkflowTask

Optional skipGenerateWorkflowTask: null | boolean

Indicates that a new workflow task should not be generated when this signal is received.


taskQueue

Optional taskQueue: null | ITaskQueue

The task queue to start this workflow on, if it will be started


workflowExecutionTimeout

Optional workflowExecutionTimeout: null | IDuration

Total workflow execution timeout including retries and continue as new


workflowId

Optional workflowId: null | string

SignalWithStartWorkflowExecutionRequest workflowId


workflowIdReusePolicy

Optional workflowIdReusePolicy: null | WorkflowIdReusePolicy

SignalWithStartWorkflowExecutionRequest workflowIdReusePolicy


workflowRunTimeout

Optional workflowRunTimeout: null | IDuration

Timeout of a single workflow run


workflowStartDelay

Optional workflowStartDelay: null | IDuration

Time to wait before dispatching the first workflow task. Cannot be used with cron_schedule. Note that the signal will be delivered with the first workflow task. If the workflow gets another SignalWithStartWorkflow before the delay and skip_generate_workflow_task is false or not set, a workflow task will be dispatched immediately and the rest of the delay period will be ignored, even if that request also had a delay. Signal via SignalWorkflowExecution will not unblock the workflow.


workflowTaskTimeout

Optional workflowTaskTimeout: null | IDuration

Timeout of a single workflow task


workflowType

Optional workflowType: null | IWorkflowType

SignalWithStartWorkflowExecutionRequest workflowType