Skip to main content

Class: Failure

failure.v1.Failure

Represents a Failure.

Implements#

Constructors#

constructor#

new Failure(properties?)

Constructs a new Failure.

Parameters#

NameType
properties?IFailure

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


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


decode#

Static decode(reader, length?): Failure

Decodes a Failure 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#

Failure

Failure


decodeDelimited#

Static decodeDelimited(reader): Failure

Decodes a Failure 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#

Failure

Failure


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

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


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?IConversionOptions-

Returns#

Object

Plain object