Skip to main content

Interface: IRoutingConfig

deployment.v1.IRoutingConfig

Properties of a RoutingConfig.

Implemented by​

Properties​

currentVersion​

• Optional currentVersion: null | string

Always present. Specifies which Deployment Version should 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.)

currentVersionChangedTime​

• Optional currentVersionChangedTime: null | ITimestamp

Last time current version was changed.

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.

rampingVersionChangedTime​

• Optional rampingVersionChangedTime: null | ITimestamp

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.

rampingVersionPercentageChangedTime​

• Optional rampingVersionPercentageChangedTime: null | ITimestamp

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