Skip to main content

Class: Metrics

Represents a Metrics.

Properties​

uri​

uri: string

The prometheus metrics endpoint uri. This is only populated when the metrics is enabled in the metrics specification.

Methods​

toJSON()​

toJSON(): object

Converts this Metrics to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): Metrics & $Properties

Creates a new Metrics instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Metrics & $Properties

Metrics instance

Call Signature​

static create(properties?): Metrics

Creates a new Metrics instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

Metrics

Metrics instance

decode()​

static decode(reader, length?): Metrics & $Properties

Decodes a Metrics 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​

Metrics & $Properties

Metrics

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): Metrics & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

Metrics & $Properties

Metrics

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 Metrics message. Does not implicitly temporal.api.cloud.account.v1.Metrics.verify|verify messages.

Parameters​

message​

$Properties

Metrics message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

Encodes the specified Metrics message, length delimited. Does not implicitly temporal.api.cloud.account.v1.Metrics.verify|verify messages.

Parameters​

message​

$Properties

Metrics message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): Metrics

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

Metrics

Metrics

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

Metrics

Metrics

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object