Class: WorkflowExecutionSignaledEventAttributes

Represents a WorkflowExecutionSignaledEventAttributes.

Properties

externalWorkflowExecution?

optional externalWorkflowExecution?: $Properties | null

When signal origin is a workflow execution, this field is set.

---

header?

optional header?: $Properties | null

Headers that were passed by the sender of the signal and copied by temporal server into the workflow task.

---

identity

identity: string

id of the worker/client who sent this signal

---

input?

optional input?: $Properties | null

Will be deserialized and provided as argument(s) to the signal handler

---

requestId

requestId: string

The request ID of the Signal request, used by the server to attach this to the correct Event ID when generating link.

---

signalName

signalName: string

The name/type of the signal to fire

---

skipGenerateWorkflowTask

skipGenerateWorkflowTask: boolean

Deprecated. This field is never respected and should always be set to false.

Methods

toJSON()

toJSON(): object

Converts this WorkflowExecutionSignaledEventAttributes to JSON.

Returns

object

JSON object

---

create()

Call Signature

static create(properties?): WorkflowExecutionSignaledEventAttributes & $Properties

Creates a new WorkflowExecutionSignaledEventAttributes instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

WorkflowExecutionSignaledEventAttributes & $Properties

WorkflowExecutionSignaledEventAttributes instance

Call Signature

static create(properties?): WorkflowExecutionSignaledEventAttributes

Creates a new WorkflowExecutionSignaledEventAttributes instance using the specified properties.

Parameters

properties?

$Properties

Properties to set

Returns

WorkflowExecutionSignaledEventAttributes

WorkflowExecutionSignaledEventAttributes instance

---

decode()

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

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

WorkflowExecutionSignaledEventAttributes & $Properties

WorkflowExecutionSignaledEventAttributes

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited()

static decodeDelimited(reader): WorkflowExecutionSignaledEventAttributes & $Properties

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

Parameters

reader

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns

WorkflowExecutionSignaledEventAttributes & $Properties

WorkflowExecutionSignaledEventAttributes

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

Parameters

message

$Properties

WorkflowExecutionSignaledEventAttributes message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

encodeDelimited()

static encodeDelimited(message, writer?): Writer

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

Parameters

message

$Properties

WorkflowExecutionSignaledEventAttributes message or plain object to encode

writer?

Writer

Writer to encode to

Returns

Writer

Writer

---

fromObject()

static fromObject(object): WorkflowExecutionSignaledEventAttributes

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

Parameters

object

Plain object

Returns

WorkflowExecutionSignaledEventAttributes

WorkflowExecutionSignaledEventAttributes

---

toObject()

static toObject(message, options?): object

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

Parameters

message

WorkflowExecutionSignaledEventAttributes

WorkflowExecutionSignaledEventAttributes

options?

IConversionOptions

Conversion options

Returns

object

Plain object