Skip to main content

Class: Failure

coresdk.workflow_completion.Failure

Failure to activate or execute a workflow

Implements​

Constructors​

constructor​

β€’ new Failure(properties?): Failure

Constructs a new Failure.

Parameters​

NameTypeDescription
properties?IFailureProperties to set

Returns​

Failure

Properties​

failure​

β€’ Optional failure: null | IFailure

Failure failure.

Implementation of​

IFailure.failure


forceCause​

β€’ forceCause: WorkflowTaskFailedCause

Forces overriding the WFT failure cause

Implementation of​

IFailure.forceCause

Methods​

toJSON​

β–Έ toJSON(): Object

Converts this Failure to JSON.

Returns​

Object

JSON object


create​

β–Έ create(properties?): Failure

Creates a new Failure instance using the specified properties.

Parameters​

NameTypeDescription
properties?IFailureProperties to set

Returns​

Failure

Failure instance


decode​

β–Έ decode(reader, length?): Failure

Decodes a Failure message from the specified reader or buffer.

Parameters​

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

Returns​

Failure

Failure

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited​

β–Έ decodeDelimited(reader): Failure

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

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

Failure

Failure

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 Failure message. Does not implicitly coresdk.workflow_completion.Failure.verify|verify messages.

Parameters​

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

Returns​

Writer

Writer


encodeDelimited​

β–Έ encodeDelimited(message, writer?): Writer

Encodes the specified Failure message, length delimited. Does not implicitly coresdk.workflow_completion.Failure.verify|verify messages.

Parameters​

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

Returns​

Writer

Writer


fromObject​

β–Έ fromObject(object): Failure

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

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

Failure

Failure


getTypeUrl​

β–Έ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for Failure

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 Failure message. Also converts values to other types if specified.

Parameters​

NameTypeDescription
messageFailureFailure
options?IConversionOptionsConversion options

Returns​

Object

Plain object