Class: SignalExternalWorkflowExecutionCommandAttributes

Represents a SignalExternalWorkflowExecutionCommandAttributes.

Properties

childWorkflowOnly

childWorkflowOnly: boolean

Set this to true if the workflow being cancelled is a child of the workflow originating this command. The request will be rejected if it is set to true and the target workflow is not a child of the requesting workflow.

---

control

control: string

Deprecated

---

execution?

optional execution?: $Properties | null

SignalExternalWorkflowExecutionCommandAttributes execution.

---

header?

optional header?: $Properties | null

Headers that are passed by the workflow that is sending a signal to the external workflow that is receiving this signal.

---

input?

optional input?: $Properties | null

Serialized value(s) to provide with the signal.

---

namespace

namespace: string

Deprecated. Cross-namespace operations are disabled by default as of server 1.30.1.

---

signalName

signalName: string

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

Methods

toJSON()

toJSON(): object

Converts this SignalExternalWorkflowExecutionCommandAttributes to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): SignalExternalWorkflowExecutionCommandAttributes & $Properties

Creates a new SignalExternalWorkflowExecutionCommandAttributes instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

SignalExternalWorkflowExecutionCommandAttributes & $Properties

SignalExternalWorkflowExecutionCommandAttributes instance

Call Signature

static create(properties?): SignalExternalWorkflowExecutionCommandAttributes

Creates a new SignalExternalWorkflowExecutionCommandAttributes instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

SignalExternalWorkflowExecutionCommandAttributes

SignalExternalWorkflowExecutionCommandAttributes instance

---

decode()

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

Decodes a SignalExternalWorkflowExecutionCommandAttributes 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

SignalExternalWorkflowExecutionCommandAttributes & $Properties

SignalExternalWorkflowExecutionCommandAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): SignalExternalWorkflowExecutionCommandAttributes & $Properties

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

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

SignalExternalWorkflowExecutionCommandAttributes & $Properties

SignalExternalWorkflowExecutionCommandAttributes

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

Parameters

message

$Properties

SignalExternalWorkflowExecutionCommandAttributes message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

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

Parameters

message

$Properties

SignalExternalWorkflowExecutionCommandAttributes message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): SignalExternalWorkflowExecutionCommandAttributes

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

Parameters

object

Plain object

Returns

SignalExternalWorkflowExecutionCommandAttributes

SignalExternalWorkflowExecutionCommandAttributes

---

toObject()

static toObject(message, options?): object

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

Parameters

message

SignalExternalWorkflowExecutionCommandAttributes

SignalExternalWorkflowExecutionCommandAttributes

options?

IConversionOptions

Conversion options

Returns

object

Plain object