Skip to main content

Class: SignalWithStartWorkflowExecutionRequest

Represents a SignalWithStartWorkflowExecutionRequest.

Properties​

control​

control: string

Deprecated.

cronSchedule​

cronSchedule: string

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

optional header?: $Properties | null

SignalWithStartWorkflowExecutionRequest header.

identity​

identity: string

The identity of the worker/client

input?​

optional input?: $Properties | null

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

links: $Properties[]

Links to be associated with the WorkflowExecutionStarted and WorkflowExecutionSignaled events.

memo?​

optional memo?: $Properties | null

SignalWithStartWorkflowExecutionRequest memo.

namespace​

namespace: string

SignalWithStartWorkflowExecutionRequest namespace.

priority?​

optional priority?: $Properties | null

Priority metadata

requestId​

requestId: string

Used to de-dupe signal w/ start requests

retryPolicy?​

optional retryPolicy?: $Properties | null

Retry policy for the workflow

searchAttributes?​

optional searchAttributes?: $Properties | null

SignalWithStartWorkflowExecutionRequest searchAttributes.

signalInput?​

optional signalInput?: $Properties | null

Serialized value(s) to provide with the signal

signalName​

signalName: string

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

taskQueue?​

optional taskQueue?: $Properties | null

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

timeSkippingConfig?​

optional timeSkippingConfig?: $Properties | null

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

userMetadata?​

optional userMetadata?: $Properties | null

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.

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​

workflowId: string

SignalWithStartWorkflowExecutionRequest workflowId.

workflowIdConflictPolicy​

workflowIdConflictPolicy: 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.

workflowIdReusePolicy​

workflowIdReusePolicy: 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.

workflowRunTimeout?​

optional workflowRunTimeout?: $Properties | null

Timeout of a single workflow run

workflowStartDelay?​

optional workflowStartDelay?: $Properties | null

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.

workflowTaskTimeout?​

optional workflowTaskTimeout?: $Properties | null

Timeout of a single workflow task

workflowType?​

optional workflowType?: $Properties | null

SignalWithStartWorkflowExecutionRequest workflowType.

Methods​

toJSON()​

toJSON(): object

Converts this SignalWithStartWorkflowExecutionRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): SignalWithStartWorkflowExecutionRequest & $Shape

Creates a new SignalWithStartWorkflowExecutionRequest instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

SignalWithStartWorkflowExecutionRequest & $Shape

SignalWithStartWorkflowExecutionRequest instance

Call Signature​

static create(properties?): SignalWithStartWorkflowExecutionRequest

Creates a new SignalWithStartWorkflowExecutionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

SignalWithStartWorkflowExecutionRequest

SignalWithStartWorkflowExecutionRequest instance

decode()​

static decode(reader, length?): SignalWithStartWorkflowExecutionRequest & $Shape

Decodes a SignalWithStartWorkflowExecutionRequest message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

SignalWithStartWorkflowExecutionRequest & $Shape

SignalWithStartWorkflowExecutionRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): SignalWithStartWorkflowExecutionRequest & $Shape

Decodes a SignalWithStartWorkflowExecutionRequest message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

SignalWithStartWorkflowExecutionRequest & $Shape

SignalWithStartWorkflowExecutionRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified SignalWithStartWorkflowExecutionRequest message. Does not implicitly temporal.api.workflowservice.v1.SignalWithStartWorkflowExecutionRequest.verify|verify messages.

Parameters​

message​

$Properties

SignalWithStartWorkflowExecutionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified SignalWithStartWorkflowExecutionRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.SignalWithStartWorkflowExecutionRequest.verify|verify messages.

Parameters​

message​

$Properties

SignalWithStartWorkflowExecutionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): SignalWithStartWorkflowExecutionRequest

Creates a SignalWithStartWorkflowExecutionRequest message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

SignalWithStartWorkflowExecutionRequest

SignalWithStartWorkflowExecutionRequest

toObject()​

static toObject(message, options?): object

Creates a plain object from a SignalWithStartWorkflowExecutionRequest message. Also converts values to other types if specified.

Parameters​

message​

SignalWithStartWorkflowExecutionRequest

SignalWithStartWorkflowExecutionRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object