Interface: IWorkerDeploymentVersionInfo
deployment.v1.IWorkerDeploymentVersionInfo
Properties of a WorkerDeploymentVersionInfo.
Hierarchy
-
↳
IWorkerDeploymentVersionInfo
Properties
computeConfig
• Optional computeConfig: null | $Properties
Optional. Contains the new worker compute configuration for the Worker Deployment. Used for worker scale management.
Inherited from
createTime
• Optional createTime: null | $Properties
WorkerDeploymentVersionInfo createTime
Inherited from
currentSinceTime
• Optional currentSinceTime: null | $Properties
(-- 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
deploymentName
• Optional deploymentName: null | string
Deprecated. User deployment_version.deployment_name.
Inherited from
deploymentVersion
• Optional deploymentVersion: null | $Properties
Required.
Inherited from
drainageInfo
• Optional drainageInfo: null | $Properties
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
firstActivationTime
• Optional firstActivationTime: null | $Properties
Timestamp when this version first became current or ramping.
Inherited from
$Properties.firstActivationTime
lastCurrentTime
• Optional lastCurrentTime: null | $Properties
Timestamp when this version last became current. Can be used to determine whether a version has ever been Current.
Inherited from
lastDeactivationTime
• Optional lastDeactivationTime: null | $Properties
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: null | string
Identity of the last client who modified the configuration of this Version. As of now, this field only covers changes through the following APIs:
CreateWorkerDeploymentVersionUpdateWorkerDeploymentVersionComputeConfigUpdateWorkerDeploymentVersionMetadata
Inherited from
$Properties.lastModifierIdentity
metadata
• Optional metadata: null | $Properties
Arbitrary user-provided metadata attached to this version.
Inherited from
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.
Inherited from
rampingSinceTime
• Optional rampingSinceTime: null | $Properties
(-- 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
routingChangedTime
• Optional routingChangedTime: null | $Properties
Last time current_since_time, ramping_since_time, or ramp_percentage` of this version changed.
Inherited from
$Properties.routingChangedTime
status
• Optional status: null | WorkerDeploymentVersionStatus
The status of the Worker Deployment Version.
Inherited from
taskQueueInfos
• Optional taskQueueInfos: null | $Properties[]
All the Task Queues that have ever polled from this Deployment version.
Deprecated. Use version_task_queues in DescribeWorkerDeploymentVersionResponse instead.
Inherited from
version
• Optional version: null | string
Deprecated. Use deployment_version.