Skip to main content

Class: Success

coresdk.child_workflow.Success

Used in ChildWorkflowResult to report successful completion.

Implements

Constructors

constructor

new Success(properties?): Success

Constructs a new Success.

Parameters

NameTypeDescription
properties?ISuccessProperties to set

Returns

Success

Properties

result

Optional result: null | IPayload

Success result.

Implementation of

ISuccess.result

Methods

toJSON

toJSON(): Object

Converts this Success to JSON.

Returns

Object

JSON object


create

create(properties?): Success

Creates a new Success instance using the specified properties.

Parameters

NameTypeDescription
properties?ISuccessProperties to set

Returns

Success

Success instance


decode

decode(reader, length?): Success

Decodes a Success message from the specified reader or buffer.

Parameters

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

Returns

Success

Success

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): Success

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

Success

Success

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 Success message. Does not implicitly coresdk.child_workflow.Success.verify|verify messages.

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): Success

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

Success

Success


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for Success

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 a Success message. Also converts values to other types if specified.

Parameters

NameTypeDescription
messageSuccessSuccess
options?IConversionOptionsConversion options

Returns

Object

Plain object