Skip to main content

Class: WorkflowTaskCompletedEventAttributes

Represents a WorkflowTaskCompletedEventAttributes.

Properties​

binaryChecksum​

binaryChecksum: string

Binary ID of the worker who completed this task Deprecated. Replaced with deployment_version.

deployment?​

optional deployment?: $Properties | null

The deployment that completed this task. May or may not be set for unversioned workers, depending on whether a value is sent by the SDK. This value updates workflow execution's versioning_info.deployment. Deprecated. Replaced with deployment_version.

deploymentVersion?​

optional deploymentVersion?: $Properties | null

The Worker Deployment Version that completed this task. Must be set if versioning_behavior is set. This value updates workflow execution's versioning_info.deployment_version.

identity​

identity: string

Identity of the worker who completed this task

meteringMetadata?​

optional meteringMetadata?: $Properties | null

Local usage data sent during workflow task completion and recorded here for posterity

scheduledEventId​

scheduledEventId: Long

The id of the WORKFLOW_TASK_SCHEDULED event this task corresponds to

sdkMetadata?​

optional sdkMetadata?: $Properties | null

Data the SDK wishes to record for itself, but server need not interpret, and does not directly impact workflow state.

startedEventId​

startedEventId: Long

The id of the WORKFLOW_TASK_STARTED event this task corresponds to

versioningBehavior​

versioningBehavior: VersioningBehavior

Versioning behavior sent by the worker that completed this task for this particular workflow execution. UNSPECIFIED means the task was completed by an unversioned worker. This value updates workflow execution's versioning_info.behavior.

workerDeploymentName​

workerDeploymentName: string

The name of Worker Deployment that completed this task. Must be set if versioning_behavior is set. This value updates workflow execution's worker_deployment_name.

workerDeploymentVersion​

workerDeploymentVersion: string

The Worker Deployment Version that completed this task. Must be set if versioning_behavior is set. This value updates workflow execution's versioning_info.version. Deprecated. Replaced with deployment_version.

workerVersion?​

optional workerVersion?: $Properties | null

Version info of the worker who processed this workflow task. If present, the build_id field within is also used as binary_checksum, which may be omitted in that case (it may also be populated to preserve compatibility). Deprecated. Use deployment_version and versioning_behavior instead.

Methods​

toJSON()​

toJSON(): object

Converts this WorkflowTaskCompletedEventAttributes to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): WorkflowTaskCompletedEventAttributes & $Properties

Creates a new WorkflowTaskCompletedEventAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowTaskCompletedEventAttributes & $Properties

WorkflowTaskCompletedEventAttributes instance

Call Signature​

static create(properties?): WorkflowTaskCompletedEventAttributes

Creates a new WorkflowTaskCompletedEventAttributes instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

WorkflowTaskCompletedEventAttributes

WorkflowTaskCompletedEventAttributes instance

decode()​

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

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

WorkflowTaskCompletedEventAttributes & $Properties

WorkflowTaskCompletedEventAttributes

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): WorkflowTaskCompletedEventAttributes & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

WorkflowTaskCompletedEventAttributes & $Properties

WorkflowTaskCompletedEventAttributes

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

Parameters​

message​

$Properties

WorkflowTaskCompletedEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

WorkflowTaskCompletedEventAttributes message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): WorkflowTaskCompletedEventAttributes

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

Parameters​

object​

Plain object

Returns​

WorkflowTaskCompletedEventAttributes

WorkflowTaskCompletedEventAttributes

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

WorkflowTaskCompletedEventAttributes

WorkflowTaskCompletedEventAttributes

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object