Skip to main content

Class: FailWorkflowExecution

coresdk.workflow_commands.FailWorkflowExecution

Issued when the workflow errors out

Implements#

Constructors#

constructor#

new FailWorkflowExecution(properties?)

Constructs a new FailWorkflowExecution.

Parameters#

NameType
properties?IFailWorkflowExecution

Properties#

failure#

Optional failure: null | IFailure

FailWorkflowExecution failure.

Implementation of#

IFailWorkflowExecution.failure

Methods#

toJSON#

toJSON(): Object

Converts this FailWorkflowExecution to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): FailWorkflowExecution

Decodes a FailWorkflowExecution message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

FailWorkflowExecution

FailWorkflowExecution


decodeDelimited#

Static decodeDelimited(reader): FailWorkflowExecution

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

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

FailWorkflowExecution

FailWorkflowExecution


encode#

Static encode(message, writer?): Writer

Encodes the specified FailWorkflowExecution message. Does not implicitly {@link coresdk.workflow_commands.FailWorkflowExecution.verify|verify} messages.

Parameters#

NameTypeDescription
messageIFailWorkflowExecutionFailWorkflowExecution message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

Encodes the specified FailWorkflowExecution message, length delimited. Does not implicitly {@link coresdk.workflow_commands.FailWorkflowExecution.verify|verify} messages.

Parameters#

NameTypeDescription
messageIFailWorkflowExecutionFailWorkflowExecution message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


fromObject#

Static fromObject(object): FailWorkflowExecution

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

FailWorkflowExecution

FailWorkflowExecution


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageFailWorkflowExecutionFailWorkflowExecution
options?IConversionOptions-

Returns#

Object

Plain object