Skip to main content

Class: SignalWorkflowExecutionRequest

Keep the parameters in sync with:

  • temporal.api.batch.v1.BatchOperationSignal.
  • temporal.api.workflow.v1.PostResetOperation.SignalWorkflow.

Properties​

control​

control: string

Deprecated.

optional header?: $Properties | null

Headers that are passed with the signal to the processing workflow. These can include things like auth or tracing tokens.

identity​

identity: string

The identity of the worker/client

input?​

optional input?: $Properties | null

Serialized value(s) to provide with the signal

links: $Properties[]

Links to be associated with the WorkflowExecutionSignaled event.

namespace​

namespace: string

SignalWorkflowExecutionRequest namespace.

requestId​

requestId: string

Used to de-dupe sent signals

signalName​

signalName: string

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

workflowExecution?​

optional workflowExecution?: $Properties | null

SignalWorkflowExecutionRequest workflowExecution.

Methods​

toJSON()​

toJSON(): object

Converts this SignalWorkflowExecutionRequest to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): SignalWorkflowExecutionRequest & $Shape

Creates a new SignalWorkflowExecutionRequest instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

SignalWorkflowExecutionRequest & $Shape

SignalWorkflowExecutionRequest instance

Call Signature​

static create(properties?): SignalWorkflowExecutionRequest

Creates a new SignalWorkflowExecutionRequest instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

SignalWorkflowExecutionRequest

SignalWorkflowExecutionRequest instance

decode()​

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

Decodes a SignalWorkflowExecutionRequest 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​

SignalWorkflowExecutionRequest & $Shape

SignalWorkflowExecutionRequest

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): SignalWorkflowExecutionRequest & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

SignalWorkflowExecutionRequest & $Shape

SignalWorkflowExecutionRequest

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 SignalWorkflowExecutionRequest message. Does not implicitly temporal.api.workflowservice.v1.SignalWorkflowExecutionRequest.verify|verify messages.

Parameters​

message​

$Properties

SignalWorkflowExecutionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

SignalWorkflowExecutionRequest message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): SignalWorkflowExecutionRequest

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

Parameters​

object​

Plain object

Returns​

SignalWorkflowExecutionRequest

SignalWorkflowExecutionRequest

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

SignalWorkflowExecutionRequest

SignalWorkflowExecutionRequest

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object