Skip to main content

Class: 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?: $Properties | null

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()​

Call Signature​

static create(properties?): DeclinedTargetVersionUpgrade & $Properties

Creates a new DeclinedTargetVersionUpgrade instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DeclinedTargetVersionUpgrade & $Properties

DeclinedTargetVersionUpgrade instance

Call Signature​

static create(properties?): DeclinedTargetVersionUpgrade

Creates a new DeclinedTargetVersionUpgrade instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

DeclinedTargetVersionUpgrade

DeclinedTargetVersionUpgrade instance


decode()​

static decode(reader, length?): DeclinedTargetVersionUpgrade & $Properties

Decodes a DeclinedTargetVersionUpgrade message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | 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()​

static decodeDelimited(reader): DeclinedTargetVersionUpgrade & $Properties

Decodes a DeclinedTargetVersionUpgrade message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | 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()​

static encode(message, writer?): Writer

Encodes the specified DeclinedTargetVersionUpgrade message. Does not implicitly temporal.api.history.v1.DeclinedTargetVersionUpgrade.verify|verify messages.

Parameters​

message​

$Properties

DeclinedTargetVersionUpgrade message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified DeclinedTargetVersionUpgrade message, length delimited. Does not implicitly temporal.api.history.v1.DeclinedTargetVersionUpgrade.verify|verify messages.

Parameters​

message​

$Properties

DeclinedTargetVersionUpgrade message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer


fromObject()​

static fromObject(object): DeclinedTargetVersionUpgrade

Creates a DeclinedTargetVersionUpgrade message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

DeclinedTargetVersionUpgrade

DeclinedTargetVersionUpgrade


toObject()​

static toObject(message, options?): object

Creates a plain object from a DeclinedTargetVersionUpgrade message. Also converts values to other types if specified.

Parameters​

message​

DeclinedTargetVersionUpgrade

DeclinedTargetVersionUpgrade

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object