Class: VersionInfo

version.v1.VersionInfo

VersionInfo contains details about current and recommended release versions as well as alerts and upgrade instructions.

Implements

• IVersionInfo

Constructors

constructor

• new VersionInfo(properties?): VersionInfo

Constructs a new VersionInfo.

Parameters

Name	Type	Description
properties?	IVersionInfo	Properties to set

Returns

VersionInfo

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

---

create

▸ create(properties?): VersionInfo

Creates a new VersionInfo instance using the specified properties.

Parameters

Name	Type	Description
properties?	IVersionInfo	Properties to set

Returns

VersionInfo

VersionInfo instance

---

decode

▸ decode(reader, length?): VersionInfo

Decodes a VersionInfo 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

VersionInfo

VersionInfo

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing

---

decodeDelimited

▸ decodeDelimited(reader): VersionInfo

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

Parameters

Name	Type	Description
reader	Uint8Array | Reader	Reader or buffer to decode from

Returns

VersionInfo

VersionInfo

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 VersionInfo message. Does not implicitly temporal.api.version.v1.VersionInfo.verify|verify messages.

Parameters

Name	Type	Description
message	IVersionInfo	VersionInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

encodeDelimited

▸ encodeDelimited(message, writer?): Writer

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

Parameters

Name	Type	Description
message	IVersionInfo	VersionInfo message or plain object to encode
writer?	Writer	Writer to encode to

Returns

Writer

Writer

---

fromObject

▸ fromObject(object): VersionInfo

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

Parameters

Name	Type	Description
object	Object	Plain object

Returns

VersionInfo

VersionInfo

---

getTypeUrl

▸ getTypeUrl(typeUrlPrefix?): string

Gets the default type url for VersionInfo

Parameters

Name	Type	Description
typeUrlPrefix?	string	your custom typeUrlPrefix(default "type.googleapis.com")

Returns

string

The default type url

---

toObject

▸ toObject(message, options?): Object

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

Parameters

Name	Type	Description
message	VersionInfo	VersionInfo
options?	IConversionOptions	Conversion options

Returns

Object

Plain object