Skip to main content

Interface: IWorkerDeploymentVersionInfo

deployment.v1.IWorkerDeploymentVersionInfo

Properties of a WorkerDeploymentVersionInfo.

Implemented by​

Properties​

createTime​

• Optional createTime: null | ITimestamp

WorkerDeploymentVersionInfo createTime

currentSinceTime​

• Optional currentSinceTime: null | ITimestamp

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

deploymentName​

• Optional deploymentName: null | string

WorkerDeploymentVersionInfo deploymentName

drainageInfo​

• Optional drainageInfo: null | IVersionDrainageInfo

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".

metadata​

• Optional metadata: null | IVersionMetadata

Arbitrary user-provided metadata attached to this version.

rampPercentage​

• Optional rampPercentage: null | number

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.

rampingSinceTime​

• Optional rampingSinceTime: null | ITimestamp

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

routingChangedTime​

• Optional routingChangedTime: null | ITimestamp

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

taskQueueInfos​

• Optional taskQueueInfos: null | IVersionTaskQueueInfo[]

All the Task Queues that have ever polled from this Deployment version.

version​

• Optional version: null | string

The fully-qualified string representation of the version, in the form "<deployment_name>.<build_id>".