Skip to main content

Interface: IWorkflowTaskCompletedEventAttributes

history.v1.IWorkflowTaskCompletedEventAttributes

Properties of a WorkflowTaskCompletedEventAttributes.

Hierarchy

  • $Properties

    IWorkflowTaskCompletedEventAttributes

Properties

binaryChecksum

Optional binaryChecksum: null | string

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

Inherited from

$Properties.binaryChecksum


deployment

Optional deployment: null | $Properties

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.

Inherited from

$Properties.deployment


deploymentVersion

Optional deploymentVersion: null | $Properties

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.

Inherited from

$Properties.deploymentVersion


identity

Optional identity: null | string

Identity of the worker who completed this task

Inherited from

$Properties.identity


meteringMetadata

Optional meteringMetadata: null | $Properties

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

Inherited from

$Properties.meteringMetadata


scheduledEventId

Optional scheduledEventId: null | Long

The id of the WORKFLOW_TASK_SCHEDULED event this task corresponds to

Inherited from

$Properties.scheduledEventId


sdkMetadata

Optional sdkMetadata: null | $Properties

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

Inherited from

$Properties.sdkMetadata


startedEventId

Optional startedEventId: null | Long

The id of the WORKFLOW_TASK_STARTED event this task corresponds to

Inherited from

$Properties.startedEventId


versioningBehavior

Optional versioningBehavior: null | 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.

Inherited from

$Properties.versioningBehavior


workerDeploymentName

Optional workerDeploymentName: null | 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.

Inherited from

$Properties.workerDeploymentName


workerDeploymentVersion

Optional workerDeploymentVersion: null | 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.

Inherited from

$Properties.workerDeploymentVersion


workerVersion

Optional workerVersion: null | $Properties

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.

Inherited from

$Properties.workerVersion