Class: VersionInfo
VersionInfo contains details about current and recommended release versions as well as alerts and upgrade instructions.
Properties
alerts
• alerts: $Properties[]
VersionInfo alerts.
current
• Optional current: null | $Properties
VersionInfo current.
instructions
• instructions: string
VersionInfo instructions.
lastUpdateTime
• Optional lastUpdateTime: null | $Properties
VersionInfo lastUpdateTime.
recommended
• Optional recommended: null | $Properties
VersionInfo recommended.
Methods
toJSON
▸ toJSON(): Object
Converts this VersionInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): VersionInfo & $Properties
Creates a new VersionInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Properties | Properties to set |
Returns
VersionInfo instance
▸ create(properties?): VersionInfo
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): VersionInfo & $Properties
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
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): VersionInfo & $Properties
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
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 | $Properties | 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 | $Properties | 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
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