Skip to main content

Class: MetricsSpec

Represents a MetricsSpec.

Properties​

acceptedClientCa​

acceptedClientCa: Uint8Array

The ca cert(s) in PEM format that clients connecting to the metrics endpoint can use for authentication. This must only be one value, but the CA can have a chain.

Methods​

toJSON()​

toJSON(): object

Converts this MetricsSpec to JSON.

Returns​

object

JSON object

create()​

Call Signature​

static create(properties?): MetricsSpec & $Properties

Creates a new MetricsSpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

MetricsSpec & $Properties

MetricsSpec instance

Call Signature​

static create(properties?): MetricsSpec

Creates a new MetricsSpec instance using the specified properties.

Parameters​
properties?​

$Properties

Properties to set

Returns​

MetricsSpec

MetricsSpec instance

decode()​

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

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

MetricsSpec & $Properties

MetricsSpec

Throws​

If the payload is not a reader or valid buffer

Throws​

If required fields are missing

decodeDelimited()​

static decodeDelimited(reader): MetricsSpec & $Properties

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

Parameters​

reader​

Uint8Array<ArrayBufferLike> | Reader

Reader or buffer to decode from

Returns​

MetricsSpec & $Properties

MetricsSpec

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

Parameters​

message​

$Properties

MetricsSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

encodeDelimited()​

static encodeDelimited(message, writer?): Writer

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

Parameters​

message​

$Properties

MetricsSpec message or plain object to encode

writer?​

Writer

Writer to encode to

Returns​

Writer

Writer

fromObject()​

static fromObject(object): MetricsSpec

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

Parameters​

object​

{[k: string]: any; }

Plain object

Returns​

MetricsSpec

MetricsSpec

toObject()​

static toObject(message, options?): object

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

Parameters​

message​

MetricsSpec

MetricsSpec

options?​

IConversionOptions

Conversion options

Returns​

object

Plain object