Skip to main content

Interface: $Properties

v1.RoutingConfig.$Properties

Properties of a RoutingConfig.

Hierarchy​

Properties​

currentDeploymentVersion​

• Optional currentDeploymentVersion: null | $Properties

Specifies which Deployment Version should receive new workflow executions and tasks of existing unversioned or AutoUpgrade workflows. Nil value means no Version in this Deployment (except Ramping Version, if present) receives traffic other than tasks of previously Pinned workflows. In absence of a Current Version, remaining traffic after any ramp (if set) goes to unversioned workers (those with UNVERSIONED (or unspecified) WorkerVersioningMode.). Note: Current Version is overridden by the Ramping Version for a portion of traffic when ramp percentage is non-zero (see ramping_deployment_version and ramping_version_percentage).

currentVersion​

• Optional currentVersion: null | string

Deprecated. Use current_deployment_version.

currentVersionChangedTime​

• Optional currentVersionChangedTime: null | $Properties

Last time current version was changed.

rampingDeploymentVersion​

• Optional rampingDeploymentVersion: null | $Properties

When ramp percentage is non-zero, that portion of traffic is shifted from the Current Version to the Ramping Version. Must always be different from current_deployment_version unless both are nil. Nil value represents 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.

rampingVersion​

• Optional rampingVersion: null | string

Deprecated. Use ramping_deployment_version.

rampingVersionChangedTime​

• Optional rampingVersionChangedTime: null | $Properties

Last time ramping version was changed. Not updated if only the ramp percentage changes.

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. A 0% value means the Ramping Version is receiving no traffic.

rampingVersionPercentageChangedTime​

• Optional rampingVersionPercentageChangedTime: null | $Properties

Last time ramping version percentage was changed. If ramping version is changed, this is also updated, even if the percentage stays the same.

revisionNumber​

• Optional revisionNumber: null | Long

Monotonically increasing value which is incremented on every mutation to any field of this message to achieve eventual consistency between task queues and their partitions.