Skip to main content

Class: MetricsSpec

account.v1.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

create(properties?): MetricsSpec & $Properties

Creates a new MetricsSpec instance using the specified properties.

Parameters

NameTypeDescription
properties?$PropertiesProperties to set

Returns

MetricsSpec & $Properties

MetricsSpec instance

create(properties?): MetricsSpec

Parameters

NameType
properties?$Properties

Returns

MetricsSpec


decode

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

Decodes a MetricsSpec message from the specified reader or buffer.

Parameters

NameTypeDescription
readerUint8Array | ReaderReader or buffer to decode from
length?numberMessage 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

decodeDelimited(reader): MetricsSpec & $Properties

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

Parameters

NameTypeDescription
readerUint8Array | ReaderReader 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

encode(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


encodeDelimited

encodeDelimited(message, writer?): Writer

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

Parameters

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

Returns

Writer

Writer


fromObject

fromObject(object): MetricsSpec

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

Parameters

NameTypeDescription
objectObjectPlain object

Returns

MetricsSpec

MetricsSpec


toObject

toObject(message, options?): Object

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

Parameters

NameTypeDescription
messageMetricsSpecMetricsSpec
options?IConversionOptionsConversion options

Returns

Object

Plain object