Skip to main content

Class: ChildWorkflowResult

coresdk.child_workflow.ChildWorkflowResult

Used by core to resolve child workflow executions.

Implements#

Constructors#

constructor#

new ChildWorkflowResult(properties?)

Constructs a new ChildWorkflowResult.

Parameters#

NameType
properties?IChildWorkflowResult

Properties#

cancelled#

Optional cancelled: null | ICancellation

ChildWorkflowResult cancelled.

Implementation of#

IChildWorkflowResult.cancelled


completed#

Optional completed: null | ISuccess

ChildWorkflowResult completed.

Implementation of#

IChildWorkflowResult.completed


failed#

Optional failed: null | IFailure

ChildWorkflowResult failed.

Implementation of#

IChildWorkflowResult.failed


status#

Optional status: "completed" | "failed" | "cancelled"

ChildWorkflowResult status.

Methods#

toJSON#

toJSON(): Object

Converts this ChildWorkflowResult to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): ChildWorkflowResult

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

ChildWorkflowResult

ChildWorkflowResult


decodeDelimited#

Static decodeDelimited(reader): ChildWorkflowResult

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

ChildWorkflowResult

ChildWorkflowResult


encode#

Static encode(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

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

Parameters#

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

Returns#

Writer

Writer


fromObject#

Static fromObject(object): ChildWorkflowResult

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

ChildWorkflowResult

ChildWorkflowResult


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageChildWorkflowResultChildWorkflowResult
options?IConversionOptions-

Returns#

Object

Plain object