Class: SignalExternalWorkflowExecutionInitiatedEventAttributes

Represents a SignalExternalWorkflowExecutionInitiatedEventAttributes.

Properties

childWorkflowOnly

childWorkflowOnly: boolean

Workers are expected to set this to true if the workflow they are requesting to cancel is a child of the workflow which issued the request

---

control

control: string

Deprecated.

---

header?

optional header?: $Properties | null

SignalExternalWorkflowExecutionInitiatedEventAttributes header.

---

input?

optional input?: $Properties | null

Serialized arguments to provide to the signal handler

---

namespace

namespace: string

Namespace of the to-be-signalled workflow. SDKs and UI tools should use namespace field but server must use namespace_id only.

---

namespaceId

namespaceId: string

SignalExternalWorkflowExecutionInitiatedEventAttributes namespaceId.

---

signalName

signalName: string

name/type of the signal to fire in the external workflow

---

workflowExecution?

optional workflowExecution?: $Properties | null

SignalExternalWorkflowExecutionInitiatedEventAttributes workflowExecution.

---

workflowTaskCompletedEventId

workflowTaskCompletedEventId: Long

The WORKFLOW_TASK_COMPLETED event which this command was reported with

Methods

toJSON()

toJSON(): object

Converts this SignalExternalWorkflowExecutionInitiatedEventAttributes to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): SignalExternalWorkflowExecutionInitiatedEventAttributes & $Properties

Creates a new SignalExternalWorkflowExecutionInitiatedEventAttributes instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

SignalExternalWorkflowExecutionInitiatedEventAttributes & $Properties

SignalExternalWorkflowExecutionInitiatedEventAttributes instance

Call Signature

static create(properties?): SignalExternalWorkflowExecutionInitiatedEventAttributes

Creates a new SignalExternalWorkflowExecutionInitiatedEventAttributes instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

SignalExternalWorkflowExecutionInitiatedEventAttributes

SignalExternalWorkflowExecutionInitiatedEventAttributes instance

---

decode()

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

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

SignalExternalWorkflowExecutionInitiatedEventAttributes & $Properties

SignalExternalWorkflowExecutionInitiatedEventAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): SignalExternalWorkflowExecutionInitiatedEventAttributes & $Properties

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

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

SignalExternalWorkflowExecutionInitiatedEventAttributes & $Properties

SignalExternalWorkflowExecutionInitiatedEventAttributes

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

Parameters

message

$Properties

SignalExternalWorkflowExecutionInitiatedEventAttributes message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

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

Parameters

message

$Properties

SignalExternalWorkflowExecutionInitiatedEventAttributes message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): SignalExternalWorkflowExecutionInitiatedEventAttributes

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

Parameters

object

Plain object

Returns

SignalExternalWorkflowExecutionInitiatedEventAttributes

SignalExternalWorkflowExecutionInitiatedEventAttributes

---

toObject()

static toObject(message, options?): object

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

Parameters

message

SignalExternalWorkflowExecutionInitiatedEventAttributes

SignalExternalWorkflowExecutionInitiatedEventAttributes

options?

IConversionOptions

Conversion options

Returns

object

Plain object