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