Class: SetWorkerDeploymentRampingVersionRequest

workflowservice.v1.SetWorkerDeploymentRampingVersionRequest

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

Implements

• ISetWorkerDeploymentRampingVersionRequest

Constructors

constructor

• new SetWorkerDeploymentRampingVersionRequest(properties?): SetWorkerDeploymentRampingVersionRequest

Constructs a new SetWorkerDeploymentRampingVersionRequest.

Parameters

Name	Type	Description
properties?	ISetWorkerDeploymentRampingVersionRequest	Properties to set

Returns

SetWorkerDeploymentRampingVersionRequest

Properties

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.

Implementation of

ISetWorkerDeploymentRampingVersionRequest.conflictToken

---

deploymentName

• deploymentName: string

SetWorkerDeploymentRampingVersionRequest deploymentName.

Implementation of

ISetWorkerDeploymentRampingVersionRequest.deploymentName

---

identity

• identity: string

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

Implementation of

ISetWorkerDeploymentRampingVersionRequest.identity

---

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.

Implementation of

ISetWorkerDeploymentRampingVersionRequest.ignoreMissingTaskQueues

---

namespace

• namespace: string

SetWorkerDeploymentRampingVersionRequest namespace.

Implementation of

ISetWorkerDeploymentRampingVersionRequest.namespace

---

percentage

• percentage: number

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

Implementation of

ISetWorkerDeploymentRampingVersionRequest.percentage

---

version

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

Implementation of

ISetWorkerDeploymentRampingVersionRequest.version

Methods

toJSON

▸ toJSON(): Object

Converts this SetWorkerDeploymentRampingVersionRequest to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): SetWorkerDeploymentRampingVersionRequest

Creates a new SetWorkerDeploymentRampingVersionRequest instance using the specified properties.

Parameters

Name	Type	Description
properties?	ISetWorkerDeploymentRampingVersionRequest	Properties to set

Returns

SetWorkerDeploymentRampingVersionRequest

SetWorkerDeploymentRampingVersionRequest instance

---

decode

▸ decode(reader, length?): SetWorkerDeploymentRampingVersionRequest

Decodes a SetWorkerDeploymentRampingVersionRequest message from the specified reader or buffer.

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from
length?	number	Message length if known beforehand

Returns

SetWorkerDeploymentRampingVersionRequest

SetWorkerDeploymentRampingVersionRequest

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): SetWorkerDeploymentRampingVersionRequest

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

SetWorkerDeploymentRampingVersionRequest

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

Name	Type	Description
message	ISetWorkerDeploymentRampingVersionRequest	SetWorkerDeploymentRampingVersionRequest message or plain object to encode
writer?	Writer	Writer 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

Name	Type	Description
message	ISetWorkerDeploymentRampingVersionRequest	SetWorkerDeploymentRampingVersionRequest message or plain object to encode
writer?	Writer	Writer 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

Name	Type	Description
object	Object	Plain object

Returns

SetWorkerDeploymentRampingVersionRequest

SetWorkerDeploymentRampingVersionRequest

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for SetWorkerDeploymentRampingVersionRequest

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	SetWorkerDeploymentRampingVersionRequest	SetWorkerDeploymentRampingVersionRequest
options?	IConversionOptions	Conversion options

Returns

Object

Plain object