Class: HostingEnvironment
v1.EnvironmentInfo.HostingEnvironment
Represents a HostingEnvironment.
Implements
Constructors
constructor
• new HostingEnvironment(properties?): HostingEnvironment
Constructs a new HostingEnvironment.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IHostingEnvironment | Properties to set |
Returns
Properties
type
• type: HostingEnvironmentType
The type of hosting environment.
Implementation of
version
• version: string
The version of the hosting environment, if obtainable.
Implementation of
Methods
toJSON
▸ toJSON(): Object
Converts this HostingEnvironment to JSON.
Returns
Object
JSON object
create
▸ create(properties?): HostingEnvironment
Creates a new HostingEnvironment instance using the specified properties.
Parameters
| Name | Type | Description |
|---|---|---|
properties? | IHostingEnvironment | Properties to set |
Returns
HostingEnvironment instance
decode
▸ decode(reader, length?): HostingEnvironment
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
Throws
If the payload is not a reader or valid buffer
Throws
If required fields are missing
decodeDelimited
▸ decodeDelimited(reader): HostingEnvironment
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
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 | IHostingEnvironment | 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 | IHostingEnvironment | 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
getTypeUrl
▸ getTypeUrl(typeUrlPrefix?): string
Gets the default type url for HostingEnvironment
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 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