Skip to main content

Class: Runtime

v1.EnvironmentInfo.Runtime

Represents a Runtime.

Properties

type

type: RuntimeType

The type of the runtime.


version

version: string

The version of the runtime, if obtainable.

Methods

toJSON

toJSON(): Object

Converts this Runtime to JSON.

Returns

Object

JSON object


create

create(properties?): Runtime & $Properties

Creates a new Runtime instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

Runtime & $Properties

Runtime instance

create(properties?): Runtime

Parameters

NameType
properties?$Properties

Returns

Runtime


decode

decode(reader, length?): Runtime & $Properties

Decodes a Runtime message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage length if known beforehand

Returns

Runtime & $Properties

Runtime

Throws

If the payload is not a reader or valid buffer

Throws

If required fields are missing


decodeDelimited

decodeDelimited(reader): Runtime & $Properties

Decodes a Runtime message from the specified reader or buffer, length delimited.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from

Returns

Runtime & $Properties

Runtime

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 Runtime message. Does not implicitly temporal.api.worker.v1.EnvironmentInfo.Runtime.verify|verify messages.

Parameters

NameTypeDescription
message$PropertiesRuntime message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

NameTypeDescription
message$PropertiesRuntime message or plain object to encode
writer?WriterWriter to encode to

Returns

Writer

Writer


fromObject

fromObject(object): Runtime

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

Runtime

Runtime


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageRuntimeRuntime
options?IConversionOptionsConversion options

Returns

Object

Plain object