Skip to main content

Class: SetWorkerDeploymentRampingVersionRequest

workflowservice.v1.SetWorkerDeploymentRampingVersionRequest

Set/unset the Ramping Version of a Worker Deployment and its ramp percentage.

Properties​

allowNoPollers​

• allowNoPollers: 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.

buildId​

• buildId: 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.)

conflictToken​

• conflictToken: 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​

• deploymentName: string

SetWorkerDeploymentRampingVersionRequest deploymentName.

identity​

• identity: string

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

ignoreMissingTaskQueues​

• ignoreMissingTaskQueues: 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​

• namespace: string

SetWorkerDeploymentRampingVersionRequest namespace.

percentage​

• percentage: number

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

version​

• version: string

Deprecated. Use build_id.

Methods​

toJSON​

▸ toJSON(): Object

Converts this SetWorkerDeploymentRampingVersionRequest to JSON.

Returns​

Object

JSON object

create​

▸ create(properties?): SetWorkerDeploymentRampingVersionRequest & $Properties

Creates a new SetWorkerDeploymentRampingVersionRequest instance using the specified properties.

Parameters​

NameTypeDescription
properties?$PropertiesProperties to set

Returns​

SetWorkerDeploymentRampingVersionRequest & $Properties

SetWorkerDeploymentRampingVersionRequest instance

▸ create(properties?): SetWorkerDeploymentRampingVersionRequest

Parameters​

NameType
properties?$Properties

Returns​

SetWorkerDeploymentRampingVersionRequest

decode​

▸ decode(reader, length?): SetWorkerDeploymentRampingVersionRequest & $Properties

Decodes a SetWorkerDeploymentRampingVersionRequest message from the specified reader or buffer.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns​

SetWorkerDeploymentRampingVersionRequest & $Properties

SetWorkerDeploymentRampingVersionRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

decodeDelimited​

▸ decodeDelimited(reader): SetWorkerDeploymentRampingVersionRequest & $Properties

Decodes a SetWorkerDeploymentRampingVersionRequest message from the specified reader or buffer, length delimited.

Parameters​

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns​

SetWorkerDeploymentRampingVersionRequest & $Properties

SetWorkerDeploymentRampingVersionRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

encode​

▸ encode(message, writer?): Writer

Encodes the specified SetWorkerDeploymentRampingVersionRequest message. Does not implicitly temporal.api.workflowservice.v1.SetWorkerDeploymentRampingVersionRequest.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesSetWorkerDeploymentRampingVersionRequest message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer

encodeDelimited​

▸ encodeDelimited(message, writer?): Writer

Encodes the specified SetWorkerDeploymentRampingVersionRequest message, length delimited. Does not implicitly temporal.api.workflowservice.v1.SetWorkerDeploymentRampingVersionRequest.verify|verify messages.

Parameters​

NameTypeDescription
message$PropertiesSetWorkerDeploymentRampingVersionRequest message or plain object to encode
writer?WriterWriter to encode to

Returns​

Writer

Writer

fromObject​

▸ fromObject(object): SetWorkerDeploymentRampingVersionRequest

Creates a SetWorkerDeploymentRampingVersionRequest message from a plain object. Also converts values to their respective internal types.

Parameters​

NameTypeDescription
objectObjectPlain object

Returns​

SetWorkerDeploymentRampingVersionRequest

SetWorkerDeploymentRampingVersionRequest

toObject​

▸ toObject(message, options?): Object

Creates a plain object from a SetWorkerDeploymentRampingVersionRequest message. Also converts values to other types if specified.

Parameters​

NameTypeDescription
messageSetWorkerDeploymentRampingVersionRequestSetWorkerDeploymentRampingVersionRequest
options?IConversionOptionsConversion options

Returns​

Object

Plain object