Skip to main content

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?: $Properties | null

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()​

Call Signature​

static create(properties?): EnvironmentInfo & $Shape

Creates a new EnvironmentInfo instance using the specified properties.

Parameters​
properties?​

$Shape

Properties to set

Returns​

EnvironmentInfo & $Shape

EnvironmentInfo instance

Call Signature​

static create(properties?): EnvironmentInfo

Creates a new EnvironmentInfo instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

EnvironmentInfo

EnvironmentInfo instance

decode()​

static decode(reader, length?): EnvironmentInfo & $Shape

Decodes an EnvironmentInfo message from the specified reader or buffer.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

length?​

number

Message length if known beforehand

Returns​

EnvironmentInfo & $Shape

EnvironmentInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): EnvironmentInfo & $Shape

Decodes an EnvironmentInfo message from the specified reader or buffer, length delimited.

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

EnvironmentInfo & $Shape

EnvironmentInfo

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

encode()​

static encode(message, writer?): Writer

Encodes the specified EnvironmentInfo message. Does not implicitly temporal.api.worker.v1.EnvironmentInfo.verify|verify messages.

Parameters​

message​

$Properties

EnvironmentInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified EnvironmentInfo message, length delimited. Does not implicitly temporal.api.worker.v1.EnvironmentInfo.verify|verify messages.

Parameters​

message​

$Properties

EnvironmentInfo message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): EnvironmentInfo

Creates an EnvironmentInfo message from a plain object. Also converts values to their respective internal types.

Parameters​

object​

Plain object

Returns​

EnvironmentInfo

EnvironmentInfo

toObject()​

static toObject(message, options?): object

Creates a plain object from an EnvironmentInfo message. Also converts values to other types if specified.

Parameters​

message​

EnvironmentInfo

EnvironmentInfo

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object