Skip to main content

Class: SignalExternalWorkflowExecutionFailedEventAttributes

Represents a SignalExternalWorkflowExecutionFailedEventAttributes.

Properties​

cause​

cause: SignalExternalWorkflowExecutionFailedCause

SignalExternalWorkflowExecutionFailedEventAttributes cause.

control​

control: string

Deprecated.

initiatedEventId​

initiatedEventId: Long

SignalExternalWorkflowExecutionFailedEventAttributes initiatedEventId.

namespace​

namespace: string

Namespace of the workflow which failed the signal. SDKs and UI tools should use namespace field but server must use namespace_id only.

namespaceId​

namespaceId: string

SignalExternalWorkflowExecutionFailedEventAttributes namespaceId.

workflowExecution?​

optional workflowExecution?: $Properties | null

SignalExternalWorkflowExecutionFailedEventAttributes workflowExecution.

workflowTaskCompletedEventId​

workflowTaskCompletedEventId: Long

The WORKFLOW_TASK_COMPLETED event which this command was reported with

Methods​

toJSON()​

toJSON(): object

Converts this SignalExternalWorkflowExecutionFailedEventAttributes to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): SignalExternalWorkflowExecutionFailedEventAttributes & $Properties

Creates a new SignalExternalWorkflowExecutionFailedEventAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

SignalExternalWorkflowExecutionFailedEventAttributes & $Properties

SignalExternalWorkflowExecutionFailedEventAttributes instance

Call Signature​

static create(properties?): SignalExternalWorkflowExecutionFailedEventAttributes

Creates a new SignalExternalWorkflowExecutionFailedEventAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

SignalExternalWorkflowExecutionFailedEventAttributes

SignalExternalWorkflowExecutionFailedEventAttributes instance

decode()​

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

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

SignalExternalWorkflowExecutionFailedEventAttributes & $Properties

SignalExternalWorkflowExecutionFailedEventAttributes

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): SignalExternalWorkflowExecutionFailedEventAttributes & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

SignalExternalWorkflowExecutionFailedEventAttributes & $Properties

SignalExternalWorkflowExecutionFailedEventAttributes

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

Parameters​

message​

$Properties

SignalExternalWorkflowExecutionFailedEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

SignalExternalWorkflowExecutionFailedEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): SignalExternalWorkflowExecutionFailedEventAttributes

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

Parameters​

object​

Plain object

Returns​

SignalExternalWorkflowExecutionFailedEventAttributes

SignalExternalWorkflowExecutionFailedEventAttributes

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

SignalExternalWorkflowExecutionFailedEventAttributes

SignalExternalWorkflowExecutionFailedEventAttributes

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object