Class: EnvironmentInfo
Represents an EnvironmentInfo.
Properties
hostingEnvironments
• hostingEnvironments: $Properties[]
The hosting environment(s) the SDK is operating in. Repeated to allow for layering (ex: Docker inside k8s).
platform
• Optional platform: null | $Properties
The platform the SDK is operating on.
runtimes
• runtimes: $Properties[]
The runtime(s) the SDK is operating in.
Methods
toJSON
▸ toJSON(): Object
Converts this EnvironmentInfo to JSON.
Returns
Object
JSON object
create
▸ create(properties?): EnvironmentInfo & $Shape
Creates a new EnvironmentInfo instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | $Shape | Properties to set |
Returns
EnvironmentInfo instance
▸ create(properties?): EnvironmentInfo
Parameters
| Name | Type |
|---|---|
properties? | $Properties |
Returns
decode
▸ decode(reader, length?): EnvironmentInfo & $Shape
Decodes an EnvironmentInfo 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
EnvironmentInfo
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): EnvironmentInfo & $Shape
Decodes an EnvironmentInfo message from the specified reader or buffer, length delimited.
Parameters
| Name | Type | Description |
|---|---|---|
reader | Uint8Array | Reader | Reader or buffer to decode from |
Returns
EnvironmentInfo
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 EnvironmentInfo message. Does not implicitly temporal.api.worker.v1.EnvironmentInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | EnvironmentInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
encodeDelimited
▸ encodeDelimited(message, writer?): Writer
Encodes the specified EnvironmentInfo message, length delimited. Does not implicitly temporal.api.worker.v1.EnvironmentInfo.verify|verify messages.
Parameters
| Name | Type | Description |
|---|---|---|
message | $Properties | EnvironmentInfo message or plain object to encode |
writer? | Writer | Writer to encode to |
Returns
Writer
Writer
fromObject
▸ fromObject(object): EnvironmentInfo
Creates an EnvironmentInfo message from a plain object. Also converts values to their respective internal types.
Parameters
| Name | Type | Description |
|---|---|---|
object | Object | Plain object |
Returns
EnvironmentInfo
toObject
▸ toObject(message, options?): Object
Creates a plain object from an EnvironmentInfo message. Also converts values to other types if specified.
Parameters
| Name | Type | Description |
|---|---|---|
message | EnvironmentInfo | EnvironmentInfo |
options? | IConversionOptions | Conversion options |
Returns
Object
Plain object