Class: DeclinedTargetVersionUpgrade
history.v1.DeclinedTargetVersionUpgrade
Wrapper for a target deployment version that the SDK declined to upgrade to. See declined_target_version_upgrade on WorkflowExecutionStartedEventAttributes.
Properties
deploymentVersion
• Optional deploymentVersion: null | $Properties
DeclinedTargetVersionUpgrade deploymentVersion.
revisionNumber
• revisionNumber: Long
Revision number of the task queue routing config at the time the target was declined. If an incoming target's revision is <= this value, it is not newer and is not used for deciding whether or not to suppress the upgrade signal.
Methods
toJSON
▸ toJSON(): Object
Converts this DeclinedTargetVersionUpgrade to JSON.
Returns
Object
JSON object
create
▸ create(properties?): DeclinedTargetVersionUpgrade & $Properties
Creates a new DeclinedTargetVersionUpgrade instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
DeclinedTargetVersionUpgrade & $Properties
DeclinedTargetVersionUpgrade instance
▸ create(properties?): DeclinedTargetVersionUpgrade
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): DeclinedTargetVersionUpgrade & $Properties
Decodes a DeclinedTargetVersionUpgrade 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
DeclinedTargetVersionUpgrade & $Properties
DeclinedTargetVersionUpgrade
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): DeclinedTargetVersionUpgrade & $Properties
Decodes a DeclinedTargetVersionUpgrade message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
DeclinedTargetVersionUpgrade & $Properties
DeclinedTargetVersionUpgrade
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 DeclinedTargetVersionUpgrade message. Does not implicitly temporal.api.history.v1.DeclinedTargetVersionUpgrade.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | DeclinedTargetVersionUpgrade message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified DeclinedTargetVersionUpgrade message, length delimited. Does not implicitly temporal.api.history.v1.DeclinedTargetVersionUpgrade.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | DeclinedTargetVersionUpgrade message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): DeclinedTargetVersionUpgrade
Creates a DeclinedTargetVersionUpgrade message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
DeclinedTargetVersionUpgrade
toObject
▸ toObject(message, options?): Object
Creates a plain object from a DeclinedTargetVersionUpgrade message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | DeclinedTargetVersionUpgrade | DeclinedTargetVersionUpgrade |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object