Skip to main content

Interface: ISetWorkerDeploymentRampingVersionRequest

workflowservice.v1.ISetWorkerDeploymentRampingVersionRequest

Properties of a SetWorkerDeploymentRampingVersionRequest.

Implemented by​

Properties​

conflictToken​

• Optional conflictToken: null | Uint8Array

Optional. This can be the value of conflict_token from a Describe, or another Worker Deployment API. Passing a non-nil conflict token will cause this request to fail if the Deployment's configuration has been modified between the API call that generated the token and this one.

deploymentName​

• Optional deploymentName: null | string

SetWorkerDeploymentRampingVersionRequest deploymentName

identity​

• Optional identity: null | string

Optional. The identity of the client who initiated this request.

ignoreMissingTaskQueues​

• Optional ignoreMissingTaskQueues: null | boolean

Optional. By default this request would be rejected if not all the expected Task Queues are being polled by the new Version, to protect against accidental removal of Task Queues, or worker health issues. Pass true here to bypass this protection. The set of expected Task Queues equals to all the Task Queues ever polled from the existing Current Version of the Deployment, with the following exclusions:

  • Task Queues that are not used anymore (inferred by having empty backlog and a task add_rate of 0.)
  • Task Queues that are moved to another Worker Deployment (inferred by the Task Queue having a different Current Version than the Current Version of this deployment.) WARNING: Do not set this flag unless you are sure that the missing task queue poller are not needed. If the request is unexpectedly rejected due to missing pollers, then that means the pollers have not reached to the server yet. Only set this if you expect those pollers to never arrive. Note: this check only happens when the ramping version is about to change, not every time that the percentage changes. Also note that the check is against the deployment's Current Version, not the previous Ramping Version.

namespace​

• Optional namespace: null | string

SetWorkerDeploymentRampingVersionRequest namespace

percentage​

• Optional percentage: null | number

Ramp percentage to set. Valid range: [0,100].

version​

• Optional version: null | string

Can be one of the following:

  • Absent/empty value to unset the Ramping Version. Must be paired with percentage=0.
  • 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.)