Class: InheritedAutoUpgradeInfo
deployment.v1.InheritedAutoUpgradeInfo
Used as part of WorkflowExecutionStartedEventAttributes to pass down the AutoUpgrade behavior and source deployment version to a workflow execution whose parent/previous workflow has an AutoUpgrade behavior. Also used for Upgrade-on-CaN behaviors AutoUpgrade and UseRampingVersion.
Properties
continueAsNewInitialVersioningBehavior
• continueAsNewInitialVersioningBehavior: ContinueAsNewVersioningBehavior
Experimental. If this workflow is the result of a continue-as-new, this field is set to the initial_versioning_behavior specified in that command. Only used for the initial task of this run and the initial task of any retries of this run. Not passed to children or to future continue-as-new.
Note: In the first release of Upgrade-on-CaN, when the only ContinueAsNewVersioningBehavior was AutoUpgrade, a non-empty InheritedAutoUpgradeInfo meant that the workflow should start as AutoUpgrade. So for compatibility with history events generated during that time, know that an UNSPECIFIED value here is equivalent to AutoUpgrade value if the InheritedAutoUpgradeInfo is non-empty.
sourceDeploymentRevisionNumber
• sourceDeploymentRevisionNumber: Long
The revision number of the source deployment version of the parent/previous workflow.
sourceDeploymentVersion
• Optional sourceDeploymentVersion: null | $Properties
The source deployment version of the parent/previous workflow.
Methods
toJSON
▸ toJSON(): Object
Converts this InheritedAutoUpgradeInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): InheritedAutoUpgradeInfo & $Properties
Creates a new InheritedAutoUpgradeInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
InheritedAutoUpgradeInfo & $Properties
InheritedAutoUpgradeInfo instance
▸ create(properties?): InheritedAutoUpgradeInfo
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): InheritedAutoUpgradeInfo & $Properties
Decodes an InheritedAutoUpgradeInfo 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
InheritedAutoUpgradeInfo & $Properties
InheritedAutoUpgradeInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): InheritedAutoUpgradeInfo & $Properties
Decodes an InheritedAutoUpgradeInfo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
InheritedAutoUpgradeInfo & $Properties
InheritedAutoUpgradeInfo
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 InheritedAutoUpgradeInfo message. Does not implicitly temporal.api.deployment.v1.InheritedAutoUpgradeInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | InheritedAutoUpgradeInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified InheritedAutoUpgradeInfo message, length delimited. Does not implicitly temporal.api.deployment.v1.InheritedAutoUpgradeInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | InheritedAutoUpgradeInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): InheritedAutoUpgradeInfo
Creates an InheritedAutoUpgradeInfo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
InheritedAutoUpgradeInfo
toObject
▸ toObject(message, options?): Object
Creates a plain object from an InheritedAutoUpgradeInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | InheritedAutoUpgradeInfo | InheritedAutoUpgradeInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object