Skip to main content

Class: WorkflowTaskCompletedMetadata

Represents a WorkflowTaskCompletedMetadata.

Properties​

coreUsedFlags​

coreUsedFlags: number[]

Internal flags used by the core SDK. SDKs using flags must comply with the following behavior:

During replay:

  • If a flag is not recognized (value is too high or not defined), it must fail the workflow task.
  • If a flag is recognized, it is stored in a set of used flags for the run. Code checks for that flag during and after this WFT are allowed to assume that the flag is present.
  • If a code check for a flag does not find the flag in the set of used flags, it must take the branch corresponding to the absence of that flag.

During non-replay execution of new WFTs:

  • The SDK is free to use all flags it knows about. It must record any newly-used (IE: not previously recorded) flags when completing the WFT.

SDKs which are too old to even know about this field at all are considered to produce undefined behavior if they replay workflows which used this mechanism.

(-- api-linter: core::0141::forbidden-types=disabled aip.dev/not-precedent: These really shouldn't have negative values. --)

langUsedFlags​

langUsedFlags: number[]

Flags used by the SDK lang. No attempt is made to distinguish between different SDK languages here as processing a workflow with a different language than the one which authored it is already undefined behavior. See core_used_patches for more.

(-- api-linter: core::0141::forbidden-types=disabled aip.dev/not-precedent: These really shouldn't have negative values. --)

sdkName​

sdkName: string

Name of the SDK that processed the task. This is usually something like "temporal-go" and is usually the same as client-name gRPC header. This should only be set if its value changed since the last time recorded on the workflow (or be set on the first task).

(-- api-linter: core::0122::name-suffix=disabled aip.dev/not-precedent: We're ok with a name suffix here. --)

sdkVersion​

sdkVersion: string

Version of the SDK that processed the task. This is usually something like "1.20.0" and is usually the same as client-version gRPC header. This should only be set if its value changed since the last time recorded on the workflow (or be set on the first task).

Methods​

toJSON()​

toJSON(): object

Converts this WorkflowTaskCompletedMetadata to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkflowTaskCompletedMetadata & $Properties

Creates a new WorkflowTaskCompletedMetadata instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowTaskCompletedMetadata & $Properties

WorkflowTaskCompletedMetadata instance

Call Signature​

static create(properties?): WorkflowTaskCompletedMetadata

Creates a new WorkflowTaskCompletedMetadata instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowTaskCompletedMetadata

WorkflowTaskCompletedMetadata instance

decode()​

static decode(reader, length?): WorkflowTaskCompletedMetadata & $Properties

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

WorkflowTaskCompletedMetadata & $Properties

WorkflowTaskCompletedMetadata

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkflowTaskCompletedMetadata & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkflowTaskCompletedMetadata & $Properties

WorkflowTaskCompletedMetadata

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

Parameters​

message​

$Properties

WorkflowTaskCompletedMetadata message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkflowTaskCompletedMetadata message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkflowTaskCompletedMetadata

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

Parameters​

object​

Plain object

Returns​

WorkflowTaskCompletedMetadata

WorkflowTaskCompletedMetadata

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkflowTaskCompletedMetadata

WorkflowTaskCompletedMetadata

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object