Class: TaskQueueVersioningInfo
taskqueue.v1.TaskQueueVersioningInfo
Represents a TaskQueueVersioningInfo.
Properties
currentDeploymentVersion
• Optional currentDeploymentVersion: null | $Properties
Specifies which Deployment Version should receive new workflow executions and tasks of
existing unversioned or AutoUpgrade workflows.
Nil value represents 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 ramp percentage
is non-zero (see ramping_deployment_version and ramping_version_percentage).
currentVersion
• currentVersion: string
Deprecated. Use current_deployment_version.
rampingDeploymentVersion
• Optional rampingDeploymentVersion: null | $Properties
When ramp percentage is non-zero, that portion of traffic is shifted from the Current Version to the Ramping Version.
Must always be different from current_deployment_version unless both are nil.
Nil value represents 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.
rampingVersion
• rampingVersion: string
Deprecated. Use ramping_deployment_version.
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. A 0% value means the Ramping Version is receiving no traffic.
updateTime
• Optional updateTime: null | $Properties
Last time versioning information of this Task Queue changed.
Methods
toJSON
▸ toJSON(): Object
Converts this TaskQueueVersioningInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): TaskQueueVersioningInfo & $Properties
Creates a new TaskQueueVersioningInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
TaskQueueVersioningInfo & $Properties
TaskQueueVersioningInfo instance
▸ create(properties?): TaskQueueVersioningInfo
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): TaskQueueVersioningInfo & $Properties
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 & $Properties
TaskQueueVersioningInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): TaskQueueVersioningInfo & $Properties
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 & $Properties
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 | $Properties | 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 | $Properties | 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
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