Skip to main content

Class: FailWorkflowExecution

coresdk.workflow_commands.FailWorkflowExecution

Issued when the workflow errors out

Implements

Constructors

constructor

new FailWorkflowExecution(properties?): FailWorkflowExecution

Constructs a new FailWorkflowExecution.

Parameters

NameTypeDescription
properties?IFailWorkflowExecutionProperties to set

Returns

FailWorkflowExecution

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


create

create(properties?): FailWorkflowExecution

Creates a new FailWorkflowExecution instance using the specified properties.

Parameters

NameTypeDescription
properties?IFailWorkflowExecutionProperties to set

Returns

FailWorkflowExecution

FailWorkflowExecution instance


decode

decode(reader, length?): FailWorkflowExecution

Decodes a FailWorkflowExecution message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

FailWorkflowExecution

FailWorkflowExecution

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): FailWorkflowExecution

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

FailWorkflowExecution

FailWorkflowExecution

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode

encode(message, writer?): Writer

Encodes the specified FailWorkflowExecution message. Does not implicitly coresdk.workflow_commands.FailWorkflowExecution.verify|verify messages.

Parameters

NameTypeDescription
messageIFailWorkflowExecutionFailWorkflowExecution message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIFailWorkflowExecutionFailWorkflowExecution message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

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


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for FailWorkflowExecution

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageFailWorkflowExecutionFailWorkflowExecution
options?IConversionOptionsConversion options

Returns

Object

Plain object