Skip to main content

Class: BatchOperationSignal

BatchOperationSignal sends signals to batch workflows. Keep the parameter in sync with temporal.api.workflowservice.v1.SignalWorkflowExecutionRequest.

Properties​

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

signal​

signal: string

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

Methods​

toJSON()​

toJSON(): object

Converts this BatchOperationSignal to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): BatchOperationSignal & $Properties

Creates a new BatchOperationSignal instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

BatchOperationSignal & $Properties

BatchOperationSignal instance

Call Signature​

static create(properties?): BatchOperationSignal

Creates a new BatchOperationSignal instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

BatchOperationSignal

BatchOperationSignal instance

decode()​

static decode(reader, length?): BatchOperationSignal & $Properties

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

BatchOperationSignal & $Properties

BatchOperationSignal

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): BatchOperationSignal & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

BatchOperationSignal & $Properties

BatchOperationSignal

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

Parameters​

message​

$Properties

BatchOperationSignal message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

BatchOperationSignal message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): BatchOperationSignal

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

BatchOperationSignal

BatchOperationSignal

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

BatchOperationSignal

BatchOperationSignal

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object