Skip to main content

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.

Implements

Constructors

constructor

new InheritedAutoUpgradeInfo(properties?): InheritedAutoUpgradeInfo

Constructs a new InheritedAutoUpgradeInfo.

Parameters

NameTypeDescription
properties?IInheritedAutoUpgradeInfoProperties to set

Returns

InheritedAutoUpgradeInfo

Properties

sourceDeploymentRevisionNumber

sourceDeploymentRevisionNumber: Long

The revision number of the source deployment version of the parent/previous workflow.

Implementation of

IInheritedAutoUpgradeInfo.sourceDeploymentRevisionNumber


sourceDeploymentVersion

Optional sourceDeploymentVersion: null | IWorkerDeploymentVersion

The source deployment version of the parent/previous workflow.

Implementation of

IInheritedAutoUpgradeInfo.sourceDeploymentVersion

Methods

toJSON

toJSON(): Object

Converts this InheritedAutoUpgradeInfo to JSON.

Returns

Object

JSON object


create

create(properties?): InheritedAutoUpgradeInfo

Creates a new InheritedAutoUpgradeInfo instance using the specified properties.

Parameters

NameTypeDescription
properties?IInheritedAutoUpgradeInfoProperties to set

Returns

InheritedAutoUpgradeInfo

InheritedAutoUpgradeInfo instance


decode

decode(reader, length?): InheritedAutoUpgradeInfo

Decodes an InheritedAutoUpgradeInfo message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

InheritedAutoUpgradeInfo

InheritedAutoUpgradeInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): InheritedAutoUpgradeInfo

Decodes an InheritedAutoUpgradeInfo message from the specified reader or buffer, length delimited.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

InheritedAutoUpgradeInfo

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

NameTypeDescription
messageIInheritedAutoUpgradeInfoInheritedAutoUpgradeInfo message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
messageIInheritedAutoUpgradeInfoInheritedAutoUpgradeInfo message or plain object to encode
writer?WriterWriter 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

NameTypeDescription
objectObjectPlain object

Returns

InheritedAutoUpgradeInfo

InheritedAutoUpgradeInfo


getTypeUrl

getTypeUrl(typeUrlPrefix?): string

Gets the default type url for InheritedAutoUpgradeInfo

Parameters

NameTypeDescription
typeUrlPrefix?stringyour custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageInheritedAutoUpgradeInfoInheritedAutoUpgradeInfo
options?IConversionOptionsConversion options

Returns

Object

Plain object