Skip to main content

Interface: ITaskQueueVersioningInfo

taskqueue.v1.ITaskQueueVersioningInfo

Properties of a TaskQueueVersioningInfo.

Implemented by

Properties

currentVersion

Optional currentVersion: null | string

Always present. Specifies which Deployment Version should receive new workflow executions and tasks of existing unversioned or AutoUpgrade workflows. Can be one of the following:

  • A Deployment Version identifier in the form "<deployment_name>.<build_id>".
  • Or, the "unversioned" special value, to represent all the unversioned workers (those with UNVERSIONED (or unspecified) WorkerVersioningMode.) Note: Current Version is overridden by the Ramping Version for a portion of traffic when a ramp is set (see ramping_version.)

rampingVersion

Optional rampingVersion: null | string

When present, it means the traffic is being shifted from the Current Version to the Ramping Version. Must always be different from current_version. Can be one of the following:

  • A Deployment Version identifier in the form "<deployment_name>.<build_id>".
  • Or, the "unversioned" special value, to represent all the unversioned workers (those with UNVERSIONED (or unspecified) WorkerVersioningMode.) Note that it is possible to ramp from one Version to another Version, or from unversioned workers to a particular Version, or from a particular Version to unversioned workers.

rampingVersionPercentage

Optional rampingVersionPercentage: null | number

Percentage of tasks that are routed to the Ramping Version instead of the Current Version. Valid range: [0, 100]. A 100% value means the Ramping Version is receiving full traffic but not yet "promoted" to be the Current Version, likely due to pending validations.


updateTime

Optional updateTime: null | ITimestamp

Last time versioning information of this Task Queue changed.