Skip to main content

Class: SystemWorkflowFailure

Represents a SystemWorkflowFailure.

Properties​

workflowError​

workflowError: string

Serialized error returned by the system workflow performing the underlying operation.

workflowExecution?​

optional workflowExecution?: $Properties | null

WorkflowId and RunId of the Temporal system workflow performing the underlying operation. Looking up the info of the system workflow run may help identify the issue causing the failure.

Methods​

toJSON()​

toJSON(): object

Converts this SystemWorkflowFailure to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): SystemWorkflowFailure & $Properties

Creates a new SystemWorkflowFailure instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

SystemWorkflowFailure & $Properties

SystemWorkflowFailure instance

Call Signature​

static create(properties?): SystemWorkflowFailure

Creates a new SystemWorkflowFailure instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

SystemWorkflowFailure

SystemWorkflowFailure instance

decode()​

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

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

SystemWorkflowFailure & $Properties

SystemWorkflowFailure

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): SystemWorkflowFailure & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

SystemWorkflowFailure & $Properties

SystemWorkflowFailure

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

Parameters​

message​

$Properties

SystemWorkflowFailure message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

SystemWorkflowFailure message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): SystemWorkflowFailure

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

SystemWorkflowFailure

SystemWorkflowFailure

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

SystemWorkflowFailure

SystemWorkflowFailure

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object