Skip to main content

Interface: ISignalWithStartWorkflowExecutionRequest

workflowservice.v1.ISignalWithStartWorkflowExecutionRequest

Properties of a SignalWithStartWorkflowExecutionRequest.

Hierarchy​

  • $Properties

    ↳ ISignalWithStartWorkflowExecutionRequest

Properties​

control​

• Optional control: null | string

Deprecated.

Inherited from​

$Properties.control

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

SignalWithStartWorkflowExecutionRequest header

Inherited from​

$Properties.header

identity​

• Optional identity: null | string

The identity of the worker/client

Inherited from​

$Properties.identity

input​

• Optional input: null | $Properties

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

Inherited from​

$Properties.input

• Optional links: null | $Properties[]

Links to be associated with the WorkflowExecutionStarted and WorkflowExecutionSignaled events.

Inherited from​

$Properties.links

memo​

• Optional memo: null | $Properties

SignalWithStartWorkflowExecutionRequest memo

Inherited from​

$Properties.memo

namespace​

• Optional namespace: null | string

SignalWithStartWorkflowExecutionRequest namespace

Inherited from​

$Properties.namespace

priority​

• Optional priority: null | $Properties

Priority metadata

Inherited from​

$Properties.priority

requestId​

• Optional requestId: null | string

Used to de-dupe signal w/ start requests

Inherited from​

$Properties.requestId

retryPolicy​

• Optional retryPolicy: null | $Properties

Retry policy for the workflow

Inherited from​

$Properties.retryPolicy

searchAttributes​

• Optional searchAttributes: null | $Properties

SignalWithStartWorkflowExecutionRequest searchAttributes

Inherited from​

$Properties.searchAttributes

signalInput​

• Optional signalInput: null | $Properties

Serialized value(s) to provide with the signal

Inherited from​

$Properties.signalInput

signalName​

• Optional signalName: null | string

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

Inherited from​

$Properties.signalName

taskQueue​

• Optional taskQueue: null | $Properties

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

Inherited from​

$Properties.taskQueue

timeSkippingConfig​

• Optional timeSkippingConfig: null | $Properties

Time-skipping configuration. If not set, time skipping is disabled.

Inherited from​

$Properties.timeSkippingConfig

userMetadata​

• Optional userMetadata: null | $Properties

Metadata on the workflow if it is started. This is carried over to the WorkflowExecutionInfo 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

SignalWithStartWorkflowExecutionRequest workflowId

Inherited from​

$Properties.workflowId

workflowIdConflictPolicy​

• Optional workflowIdConflictPolicy: null | WorkflowIdConflictPolicy

Defines how to resolve a workflow id conflict with a running workflow. The default policy is WORKFLOW_ID_CONFLICT_POLICY_USE_EXISTING. Note that WORKFLOW_ID_CONFLICT_POLICY_FAIL is an invalid option.

See workflow_id_reuse_policy for handling a workflow id duplication with a closed workflow.

Inherited from​

$Properties.workflowIdConflictPolicy

workflowIdReusePolicy​

• Optional workflowIdReusePolicy: null | WorkflowIdReusePolicy

Defines whether to allow re-using the workflow id from a previously closed workflow. The default policy is WORKFLOW_ID_REUSE_POLICY_ALLOW_DUPLICATE.

See workflow_id_reuse_policy for handling a workflow id duplication with a running workflow.

Inherited from​

$Properties.workflowIdReusePolicy

workflowRunTimeout​

• Optional workflowRunTimeout: null | $Properties

Timeout of a single workflow run

Inherited from​

$Properties.workflowRunTimeout

workflowStartDelay​

• Optional workflowStartDelay: null | $Properties

Time to wait before making the first workflow task available for dispatch. 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 a workflow task will be made available for dispatch 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.

Inherited from​

$Properties.workflowStartDelay

workflowTaskTimeout​

• Optional workflowTaskTimeout: null | $Properties

Timeout of a single workflow task

Inherited from​

$Properties.workflowTaskTimeout

workflowType​

• Optional workflowType: null | $Properties

SignalWithStartWorkflowExecutionRequest workflowType

Inherited from​

$Properties.workflowType