Skip to main content

Class: Failure

failure.v1.Failure

Represents a Failure.

Implements

Constructors

constructor

new Failure(properties?)

Constructs a new Failure.

Parameters

NameTypeDescription
properties?IFailureProperties to set

Properties

activityFailureInfo

Optional activityFailureInfo: null | IActivityFailureInfo

Failure activityFailureInfo.

Implementation of

IFailure.activityFailureInfo


applicationFailureInfo

Optional applicationFailureInfo: null | IApplicationFailureInfo

Failure applicationFailureInfo.

Implementation of

IFailure.applicationFailureInfo


canceledFailureInfo

Optional canceledFailureInfo: null | ICanceledFailureInfo

Failure canceledFailureInfo.

Implementation of

IFailure.canceledFailureInfo


cause

Optional cause: null | IFailure

Failure cause.

Implementation of

IFailure.cause


childWorkflowExecutionFailureInfo

Optional childWorkflowExecutionFailureInfo: null | IChildWorkflowExecutionFailureInfo

Failure childWorkflowExecutionFailureInfo.

Implementation of

IFailure.childWorkflowExecutionFailureInfo


encodedAttributes

Optional encodedAttributes: null | IPayload

Failure encodedAttributes.

Implementation of

IFailure.encodedAttributes


failureInfo

Optional failureInfo: "applicationFailureInfo" | "timeoutFailureInfo" | "canceledFailureInfo" | "terminatedFailureInfo" | "serverFailureInfo" | "resetWorkflowFailureInfo" | "activityFailureInfo" | "childWorkflowExecutionFailureInfo"

Failure failureInfo.


message

message: string

Failure message.

Implementation of

IFailure.message


resetWorkflowFailureInfo

Optional resetWorkflowFailureInfo: null | IResetWorkflowFailureInfo

Failure resetWorkflowFailureInfo.

Implementation of

IFailure.resetWorkflowFailureInfo


serverFailureInfo

Optional serverFailureInfo: null | IServerFailureInfo

Failure serverFailureInfo.

Implementation of

IFailure.serverFailureInfo


source

source: string

Failure source.

Implementation of

IFailure.source


stackTrace

stackTrace: string

Failure stackTrace.

Implementation of

IFailure.stackTrace


terminatedFailureInfo

Optional terminatedFailureInfo: null | ITerminatedFailureInfo

Failure terminatedFailureInfo.

Implementation of

IFailure.terminatedFailureInfo


timeoutFailureInfo

Optional timeoutFailureInfo: null | ITimeoutFailureInfo

Failure timeoutFailureInfo.

Implementation of

IFailure.timeoutFailureInfo

Methods

toJSON

toJSON(): Object

Converts this Failure to JSON.

Returns

Object

JSON object


create

Static create(properties?): Failure

Creates a new Failure instance using the specified properties.

Parameters

NameTypeDescription
properties?IFailureProperties to set

Returns

Failure

Failure instance


decode

Static decode(reader, length?): Failure

Decodes a Failure message from the specified reader or buffer.

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

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

Returns

Failure

Failure


decodeDelimited

Static decodeDelimited(reader): Failure

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

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

Failure

Failure


encode

Static encode(message, writer?): Writer

Encodes the specified Failure message. Does not implicitly temporal.api.failure.v1.Failure.verify|verify messages.

Parameters

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

Returns

Writer

Writer


encodeDelimited

Static encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

Static 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

Static 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

Static 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