Class: Platform
v1.EnvironmentInfo.Platform
Represents a Platform.
Properties
linux
• Optional linux: null | $Properties
Platform linux.
macos
• Optional macos: null | $Properties
Platform macos.
variant
• Optional variant: "linux" | "macos" | "windows"
Platform variant.
windows
• Optional windows: null | $Properties
Platform windows.
Methods
toJSON
▸ toJSON(): Object
Converts this Platform to JSON.
Returns
Object
JSON object
create
▸ create(properties?): Platform & $Shape
Creates a new Platform instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
Platform instance
▸ create(properties?): Platform
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): Platform & $Shape
Decodes a Platform 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
Platform
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): Platform & $Shape
Decodes a Platform message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
Platform
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 Platform message. Does not implicitly temporal.api.worker.v1.EnvironmentInfo.Platform.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Platform message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified Platform message, length delimited. Does not implicitly temporal.api.worker.v1.EnvironmentInfo.Platform.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | Platform message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): Platform
Creates a Platform message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
Platform
toObject
▸ toObject(message, options?): Object
Creates a plain object from a Platform message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | Platform | Platform |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object