Skip to main content

Class: Outcome

update.v1.Outcome

The outcome of a workflow update - success or failure.

Implements

Constructors

constructor

new Outcome(properties?): Outcome

Constructs a new Outcome.

Parameters

NameTypeDescription
properties?IOutcomeProperties to set

Returns

Outcome

Properties

failure

Optional failure: null | IFailure

Outcome failure.

Implementation of

IOutcome.failure


success

Optional success: null | IPayloads

Outcome success.

Implementation of

IOutcome.success


value

Optional value: "success" | "failure"

Outcome value.

Methods

toJSON

toJSON(): Object

Converts this Outcome to JSON.

Returns

Object

JSON object


create

create(properties?): Outcome

Creates a new Outcome instance using the specified properties.

Parameters

NameTypeDescription
properties?IOutcomeProperties to set

Returns

Outcome

Outcome instance


decode

decode(reader, length?): Outcome

Decodes an Outcome message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

Outcome

Outcome

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): Outcome

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

Outcome

Outcome

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


encode

encode(message, writer?): Writer

Encodes the specified Outcome message. Does not implicitly temporal.api.update.v1.Outcome.verify|verify messages.

Parameters

NameTypeDescription
messageIOutcomeOutcome message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
messageIOutcomeOutcome message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): Outcome

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

Outcome

Outcome


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for Outcome

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageOutcomeOutcome
options?IConversionOptionsConversion options

Returns

Object

Plain object