Skip to main content

Class: WorkflowActivationCompletion

Result of a single workflow activation, reported from lang to core

Properties​

failed?​

optional failed?: $Properties | null

WorkflowActivationCompletion failed.

payloadDownloadMetrics?​

optional payloadDownloadMetrics?: $Properties | null

Metrics for external payload storage downloads (retrievals) performed while processing this activation. Only set when external storage retrieved payloads.

payloadUploadMetrics?​

optional payloadUploadMetrics?: $Properties | null

Metrics for external payload storage uploads (stores) performed while processing this activation. Only set when external storage stored payloads.

runId​

runId: string

The run id from the workflow activation you are completing

status?​

optional status?: "failed" | "successful"

WorkflowActivationCompletion status.

successful?​

optional successful?: $Properties | null

WorkflowActivationCompletion successful.

Methods​

toJSON()​

toJSON(): object

Converts this WorkflowActivationCompletion to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkflowActivationCompletion & $Shape

Creates a new WorkflowActivationCompletion instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

WorkflowActivationCompletion & $Shape

WorkflowActivationCompletion instance

Call Signature​

static create(properties?): WorkflowActivationCompletion

Creates a new WorkflowActivationCompletion instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowActivationCompletion

WorkflowActivationCompletion instance

decode()​

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

Decodes a WorkflowActivationCompletion 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​

WorkflowActivationCompletion & $Shape

WorkflowActivationCompletion

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkflowActivationCompletion & $Shape

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkflowActivationCompletion & $Shape

WorkflowActivationCompletion

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

Parameters​

message​

$Properties

WorkflowActivationCompletion message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkflowActivationCompletion message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkflowActivationCompletion

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

WorkflowActivationCompletion

WorkflowActivationCompletion

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkflowActivationCompletion

WorkflowActivationCompletion

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object