Skip to main content

Class: WFActivationCompletion

coresdk.workflow_completion.WFActivationCompletion

Result of a single workflow activation, reported from lang to core

Implements#

Constructors#

constructor#

new WFActivationCompletion(properties?)

Constructs a new WFActivationCompletion.

Parameters#

NameType
properties?IWFActivationCompletion

Properties#

failed#

Optional failed: null | IFailure

WFActivationCompletion failed.

Implementation of#

IWFActivationCompletion.failed


runId#

runId: string

WFActivationCompletion runId.

Implementation of#

IWFActivationCompletion.runId


status#

Optional status: "failed" | "successful"

WFActivationCompletion status.


successful#

Optional successful: null | ISuccess

WFActivationCompletion successful.

Implementation of#

IWFActivationCompletion.successful


taskQueue#

taskQueue: string

WFActivationCompletion taskQueue.

Implementation of#

IWFActivationCompletion.taskQueue

Methods#

toJSON#

toJSON(): Object

Converts this WFActivationCompletion to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): WFActivationCompletion

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

WFActivationCompletion

WFActivationCompletion


decodeDelimited#

Static decodeDelimited(reader): WFActivationCompletion

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

WFActivationCompletion

WFActivationCompletion


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): WFActivationCompletion

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

WFActivationCompletion

WFActivationCompletion


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageWFActivationCompletionWFActivationCompletion
options?IConversionOptions-

Returns#

Object

Plain object