Class: TaskQueueVersioningInfo

taskqueue.v1.TaskQueueVersioningInfo

Experimental. Worker Deployments are experimental and might significantly change in the future.

Implements

• ITaskQueueVersioningInfo

Constructors

constructor

• new TaskQueueVersioningInfo(properties?): TaskQueueVersioningInfo

Constructs a new TaskQueueVersioningInfo.

Parameters

Name	Type	Description
properties?	ITaskQueueVersioningInfo	Properties to set

Returns

TaskQueueVersioningInfo

Properties

currentVersion

• currentVersion: string

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

Implementation of

ITaskQueueVersioningInfo.currentVersion

---

rampingVersion

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

Implementation of

ITaskQueueVersioningInfo.rampingVersion

---

rampingVersionPercentage

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

Implementation of

ITaskQueueVersioningInfo.rampingVersionPercentage

---

updateTime

• Optional updateTime: null | ITimestamp

Last time versioning information of this Task Queue changed.

Implementation of

ITaskQueueVersioningInfo.updateTime

Methods

toJSON

▸ toJSON(): Object

Converts this TaskQueueVersioningInfo to JSON.

Returns

Object

JSON object

---

create

▸ create(properties?): TaskQueueVersioningInfo

Creates a new TaskQueueVersioningInfo instance using the specified properties.

Parameters

Name	Type	Description
properties?	ITaskQueueVersioningInfo	Properties to set

Returns

TaskQueueVersioningInfo

TaskQueueVersioningInfo instance

---

decode

▸ decode(reader, length?): TaskQueueVersioningInfo

Decodes a TaskQueueVersioningInfo 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

TaskQueueVersioningInfo

TaskQueueVersioningInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): TaskQueueVersioningInfo

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

Parameters

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

Returns

TaskQueueVersioningInfo

TaskQueueVersioningInfo

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 TaskQueueVersioningInfo message. Does not implicitly temporal.api.taskqueue.v1.TaskQueueVersioningInfo.verify|verify messages.

Parameters

Name	Type	Description
message	ITaskQueueVersioningInfo	TaskQueueVersioningInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	ITaskQueueVersioningInfo	TaskQueueVersioningInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): TaskQueueVersioningInfo

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

TaskQueueVersioningInfo

TaskQueueVersioningInfo

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for TaskQueueVersioningInfo

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 TaskQueueVersioningInfo message. Also converts values to other types if specified.

Parameters

Name	Type	Description
message	TaskQueueVersioningInfo	TaskQueueVersioningInfo
options?	IConversionOptions	Conversion options

Returns

Object

Plain object