Class: RoutingConfig
deployment.v1.RoutingConfig
Represents a RoutingConfig.
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 means no Version in this Deployment (except Ramping Version, if present) receives traffic other than tasks of previously Pinned workflows. In absence of a Current Version, remaining traffic after any ramp (if set) goes to 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.
currentVersionChangedTime
• Optional currentVersionChangedTime: null | $Properties
Last time current version was changed.
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.
rampingVersionChangedTime
• Optional rampingVersionChangedTime: null | $Properties
Last time ramping version was changed. Not updated if only the ramp percentage changes.
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.
rampingVersionPercentageChangedTime
• Optional rampingVersionPercentageChangedTime: null | $Properties
Last time ramping version percentage was changed. If ramping version is changed, this is also updated, even if the percentage stays the same.
revisionNumber
• revisionNumber: Long
Monotonically increasing value which is incremented on every mutation to any field of this message to achieve eventual consistency between task queues and their partitions.
Methods
toJSON
▸ toJSON(): Object
Converts this RoutingConfig to JSON.
Returns
Object
JSON object
create
▸ create(properties?): RoutingConfig & $Properties
Creates a new RoutingConfig instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
RoutingConfig instance
▸ create(properties?): RoutingConfig
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): RoutingConfig & $Properties
Decodes a RoutingConfig 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
RoutingConfig
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): RoutingConfig & $Properties
Decodes a RoutingConfig message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
RoutingConfig
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 RoutingConfig message. Does not implicitly temporal.api.deployment.v1.RoutingConfig.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | RoutingConfig message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified RoutingConfig message, length delimited. Does not implicitly temporal.api.deployment.v1.RoutingConfig.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | RoutingConfig message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): RoutingConfig
Creates a RoutingConfig message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
RoutingConfig
toObject
▸ toObject(message, options?): Object
Creates a plain object from a RoutingConfig message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | RoutingConfig | RoutingConfig |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object