Skip to main content

Interface: IWorkerDeploymentVersionInfo

Properties of a WorkerDeploymentVersionInfo.

Extends​

Properties​

computeConfig?​

optional computeConfig?: $Properties | null

Optional. Contains the new worker compute configuration for the Worker Deployment. Used for worker scale management.

Inherited from​

$Properties.computeConfig

createTime?​

optional createTime?: $Properties | null

WorkerDeploymentVersionInfo createTime

Inherited from​

$Properties.createTime

currentSinceTime?​

optional currentSinceTime?: $Properties | null

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --) Unset if not current.

Inherited from​

$Properties.currentSinceTime

deploymentName?​

optional deploymentName?: string | null

Deprecated. User deployment_version.deployment_name.

Inherited from​

$Properties.deploymentName

deploymentVersion?​

optional deploymentVersion?: $Properties | null

Required.

Inherited from​

$Properties.deploymentVersion

drainageInfo?​

optional drainageInfo?: $Properties | null

Helps user determine when it is safe to decommission the workers of this Version. Not present when version is current or ramping. Current limitations:

  • Not supported for Unversioned mode.
  • Periodically refreshed, may have delays up to few minutes (consult the last_checked_time value).
  • Refreshed only when version is not current or ramping AND the status is not "drained" yet.
  • Once the status is changed to "drained", it is not changed until the Version becomes Current or Ramping again, at which time the drainage info is cleared. This means if the Version is "drained" but new workflows are sent to it via Pinned Versioning Override, the status does not account for those Pinned-override executions and remains "drained".

Inherited from​

$Properties.drainageInfo

firstActivationTime?​

optional firstActivationTime?: $Properties | null

Timestamp when this version first became current or ramping.

Inherited from​

$Properties.firstActivationTime

lastCurrentTime?​

optional lastCurrentTime?: $Properties | null

Timestamp when this version last became current. Can be used to determine whether a version has ever been Current.

Inherited from​

$Properties.lastCurrentTime

lastDeactivationTime?​

optional lastDeactivationTime?: $Properties | null

Timestamp when this version last stopped being current or ramping. Cleared if the version becomes current or ramping again.

Inherited from​

$Properties.lastDeactivationTime

lastModifierIdentity?​

optional lastModifierIdentity?: string | null

Identity of the last client who modified the configuration of this Version. As of now, this field only covers changes through the following APIs:

  • CreateWorkerDeploymentVersion
  • UpdateWorkerDeploymentVersionComputeConfig
  • UpdateWorkerDeploymentVersionMetadata

Inherited from​

$Properties.lastModifierIdentity

metadata?​

optional metadata?: $Properties | null

Arbitrary user-provided metadata attached to this version.

Inherited from​

$Properties.metadata

rampingSinceTime?​

optional rampingSinceTime?: $Properties | null

(-- api-linter: core::0140::prepositions=disabled aip.dev/not-precedent: 'Since' captures the field semantics despite being a preposition. --) Unset if not ramping. Updated when the version first starts ramping, not on each ramp change.

Inherited from​

$Properties.rampingSinceTime

rampPercentage?​

optional rampPercentage?: number | null

Range: [0, 100]. Must be zero if the version is not ramping (i.e. ramping_since_time is nil). Can be in the range [0, 100] if the version is ramping.

Inherited from​

$Properties.rampPercentage

routingChangedTime?​

optional routingChangedTime?: $Properties | null

Last time current_since_time, ramping_since_time, or ramp_percentage` of this version changed.

Inherited from​

$Properties.routingChangedTime

status?​

optional status?: WorkerDeploymentVersionStatus | null

The status of the Worker Deployment Version.

Inherited from​

$Properties.status

taskQueueInfos?​

optional taskQueueInfos?: $Properties[] | null

All the Task Queues that have ever polled from this Deployment version. Deprecated. Use version_task_queues in DescribeWorkerDeploymentVersionResponse instead.

Inherited from​

$Properties.taskQueueInfos

version?​

optional version?: string | null

Deprecated. Use deployment_version.

Inherited from​

$Properties.version