Skip to main content

Class: Success

Successful workflow activation with a list of commands generated by the workflow execution

Properties​

commands​

commands: $Properties[]

A list of commands to send back to the temporal server

usedInternalFlags​

usedInternalFlags: number[]

Any internal flags which the lang SDK used in the processing of this activation

versioningBehavior​

versioningBehavior: VersioningBehavior

The versioning behavior this workflow is currently using

Methods​

toJSON()​

toJSON(): object

Converts this Success to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Success & $Shape

Creates a new Success instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

Success & $Shape

Success instance

Call Signature​

static create(properties?): Success

Creates a new Success instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Success

Success instance

decode()​

static decode(reader, length?): Success & $Shape

Decodes a Success message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

Success & $Shape

Success

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Success & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Success & $Shape

Success

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified Success message. Does not implicitly coresdk.workflow_completion.Success.verify|verify messages.

Parameters​

message​

$Properties

Success message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

Success message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Success

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

Success

Success

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

Success

Success

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object