Skip to main content

Interface: ISetWorkerDeploymentRampingVersionRequest

workflowservice.v1.ISetWorkerDeploymentRampingVersionRequest

Properties of a SetWorkerDeploymentRampingVersionRequest.

Hierarchy​

  • $Properties

    ↳ ISetWorkerDeploymentRampingVersionRequest

Properties​

allowNoPollers​

• Optional allowNoPollers: null | boolean

Optional. By default this request will be rejected if no pollers have been seen for the proposed Current Version, in order to protect users from routing tasks to pollers that do not exist, leading to possible timeouts. Pass true here to bypass this protection.

Inherited from​

$Properties.allowNoPollers

buildId​

• Optional buildId: null | string

The build id of the Version that you want to ramp traffic to. Pass an empty value to set the Ramping Version to nil. A nil Ramping Version represents all the unversioned workers (those with UNVERSIONED (or unspecified) WorkerVersioningMode.)

Inherited from​

$Properties.buildId

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.

Inherited from​

$Properties.conflictToken

deploymentName​

• Optional deploymentName: null | string

SetWorkerDeploymentRampingVersionRequest deploymentName

Inherited from​

$Properties.deploymentName

identity​

• Optional identity: null | string

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

Inherited from​

$Properties.identity

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.

Inherited from​

$Properties.ignoreMissingTaskQueues

namespace​

• Optional namespace: null | string

SetWorkerDeploymentRampingVersionRequest namespace

Inherited from​

$Properties.namespace

percentage​

• Optional percentage: null | number

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

Inherited from​

$Properties.percentage

version​

• Optional version: null | string

Deprecated. Use build_id.

Inherited from​

$Properties.version