Skip to main content

Interface: $Properties

Properties of a WorkflowTaskCompletedEventAttributes.

Extended by​

Properties​

binaryChecksum?​

optional binaryChecksum?: string | null

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?​

optional identity?: string | null

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?​

optional scheduledEventId?: Long | null

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?​

optional startedEventId?: Long | null

The id of the WORKFLOW_TASK_STARTED event this task corresponds to

versioningBehavior?​

optional versioningBehavior?: VersioningBehavior | null

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?​

optional workerDeploymentName?: string | null

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?​

optional workerDeploymentVersion?: string | 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.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.