Class: VersioningOverride
workflow.v1.VersioningOverride
Used to override the versioning behavior and deployment of a specific workflow execution. If set,
takes precedence over the worker-sent values. See WorkflowExecutionInfo.VersioningInfo for more
information. To remove the override, call UpdateWorkflowExecutionOptions with a null
VersioningOverride, and use the update_mask to indicate that it should be mutated.
Implements
Constructors
constructor
• new VersioningOverride(properties?): VersioningOverride
Constructs a new VersioningOverride.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IVersioningOverride | Properties to set |
Returns
Properties
behavior
• behavior: VersioningBehavior
Required.
Implementation of
deployment
• Optional deployment: null | IDeployment
Required if behavior is PINNED. Must be null if behavior is AUTO_UPGRADE.
Identifies the worker deployment to pin the workflow to.
Implementation of
IVersioningOverride.deployment
Methods
toJSON
▸ toJSON(): Object
Converts this VersioningOverride to JSON.
Returns
Object
JSON object
create
▸ create(properties?): VersioningOverride
Creates a new VersioningOverride instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IVersioningOverride | Properties to set |
Returns
VersioningOverride instance
decode
▸ decode(reader, length?): VersioningOverride
Decodes a VersioningOverride 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
VersioningOverride
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): VersioningOverride
Decodes a VersioningOverride message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
VersioningOverride
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 VersioningOverride message. Does not implicitly temporal.api.workflow.v1.VersioningOverride.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IVersioningOverride | VersioningOverride message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified VersioningOverride message, length delimited. Does not implicitly temporal.api.workflow.v1.VersioningOverride.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | IVersioningOverride | VersioningOverride message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): VersioningOverride
Creates a VersioningOverride message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
VersioningOverride
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for VersioningOverride
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 VersioningOverride message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | VersioningOverride | VersioningOverride |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object