Skip to main content

Class: ActivityExecutionOutcome

The outcome of a completed activity execution: either a successful result or a failure.

Properties​

failure?​

optional failure?: $Properties | null

The failure if the activity completed unsuccessfully.

result?​

optional result?: $Properties | null

The result if the activity completed successfully.

retryState​

retryState: RetryState

The retry state associated with an unsuccessful activity execution. This field is only meaningful when failure is set.

value?​

optional value?: "failure" | "result"

ActivityExecutionOutcome value.

Methods​

toJSON()​

toJSON(): object

Converts this ActivityExecutionOutcome to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): ActivityExecutionOutcome & $Shape

Creates a new ActivityExecutionOutcome instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

ActivityExecutionOutcome & $Shape

ActivityExecutionOutcome instance

Call Signature​

static create(properties?): ActivityExecutionOutcome

Creates a new ActivityExecutionOutcome instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

ActivityExecutionOutcome

ActivityExecutionOutcome instance

decode()​

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

Decodes an ActivityExecutionOutcome 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​

ActivityExecutionOutcome & $Shape

ActivityExecutionOutcome

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): ActivityExecutionOutcome & $Shape

Decodes an ActivityExecutionOutcome message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

ActivityExecutionOutcome & $Shape

ActivityExecutionOutcome

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 ActivityExecutionOutcome message. Does not implicitly temporal.api.activity.v1.ActivityExecutionOutcome.verify|verify messages.

Parameters​

message​

$Properties

ActivityExecutionOutcome message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

ActivityExecutionOutcome message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): ActivityExecutionOutcome

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

Parameters​

object​

Plain object

Returns​

ActivityExecutionOutcome

ActivityExecutionOutcome

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

ActivityExecutionOutcome

ActivityExecutionOutcome

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object