Skip to main content

Class: VersionInfo

version.v1.VersionInfo

Represents a VersionInfo.

Implements#

Constructors#

constructor#

new VersionInfo(properties?)

Constructs a new VersionInfo.

Parameters#

NameType
properties?IVersionInfo

Properties#

alerts#

alerts: IAlert[]

VersionInfo alerts.

Implementation of#

IVersionInfo.alerts


current#

Optional current: null | IReleaseInfo

VersionInfo current.

Implementation of#

IVersionInfo.current


instructions#

instructions: string

VersionInfo instructions.

Implementation of#

IVersionInfo.instructions


lastUpdateTime#

Optional lastUpdateTime: null | ITimestamp

VersionInfo lastUpdateTime.

Implementation of#

IVersionInfo.lastUpdateTime


recommended#

Optional recommended: null | IReleaseInfo

VersionInfo recommended.

Implementation of#

IVersionInfo.recommended

Methods#

toJSON#

toJSON(): Object

Converts this VersionInfo to JSON.

Returns#

Object

JSON object


decode#

Static decode(reader, length?): VersionInfo

Decodes a VersionInfo message from the specified reader or buffer.

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?number-

Returns#

VersionInfo

VersionInfo


decodeDelimited#

Static decodeDelimited(reader): VersionInfo

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

throws {Error} If the payload is not a reader or valid buffer

throws {$protobuf.util.ProtocolError} If required fields are missing

Parameters#

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns#

VersionInfo

VersionInfo


encode#

Static encode(message, writer?): Writer

Encodes the specified VersionInfo message. Does not implicitly {@link temporal.api.version.v1.VersionInfo.verify|verify} messages.

Parameters#

NameTypeDescription
messageIVersionInfoVersionInfo message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


encodeDelimited#

Static encodeDelimited(message, writer?): Writer

Encodes the specified VersionInfo message, length delimited. Does not implicitly {@link temporal.api.version.v1.VersionInfo.verify|verify} messages.

Parameters#

NameTypeDescription
messageIVersionInfoVersionInfo message or plain object to encode
writer?Writer-

Returns#

Writer

Writer


fromObject#

Static fromObject(object): VersionInfo

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

Parameters#

NameTypeDescription
objectObjectPlain object

Returns#

VersionInfo

VersionInfo


toObject#

Static toObject(message, options?): Object

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

Parameters#

NameTypeDescription
messageVersionInfoVersionInfo
options?IConversionOptions-

Returns#

Object

Plain object