Class protos.google.api.Metric (11.2.0)

Represents a Metric.

Package

@google-cloud/logging

Constructors

(constructor)(properties)

constructor(properties?:google.api.IMetric);

Constructs a new Metric.

Parameter
NameDescription
propertiesIMetric

Properties to set

Properties

labels

publiclabels:{[k:string]:string};

Metric labels.

type

publictype:string;

Metric type.

Methods

create(properties)

publicstaticcreate(properties?:google.api.IMetric):google.api.Metric;

Creates a new Metric instance using the specified properties.

Parameter
NameDescription
propertiesIMetric

Properties to set

Returns
TypeDescription
Metric

Metric instance

decode(reader, length)

publicstaticdecode(reader:($protobuf.Reader|Uint8Array),length?:number):google.api.Metric;

Decodes a Metric message from the specified reader or buffer.

Parameters
NameDescription
reader(Reader|Uint8Array)

Reader or buffer to decode from

lengthnumber

Message length if known beforehand

Returns
TypeDescription
Metric

Metric

decodeDelimited(reader)

publicstaticdecodeDelimited(reader:($protobuf.Reader|Uint8Array)):google.api.Metric;

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

Parameter
NameDescription
reader(Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
Metric

Metric

encode(message, writer)

publicstaticencode(message:google.api.IMetric,writer?:$protobuf.Writer):$protobuf.Writer;

Encodes the specified Metric message. Does not implicitly messages.

Parameters
NameDescription
messageIMetric

Metric message or plain object to encode

writer$protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

publicstaticencodeDelimited(message:google.api.IMetric,writer?:$protobuf.Writer):$protobuf.Writer;

Encodes the specified Metric message, length delimited. Does not implicitly messages.

Parameters
NameDescription
messageIMetric

Metric message or plain object to encode

writer$protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

publicstaticfromObject(object:{[k:string]:any}):google.api.Metric;

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

Parameter
NameDescription
object{ [k: string]: any }

Plain object

Returns
TypeDescription
Metric

Metric

getTypeUrl(typeUrlPrefix)

publicstaticgetTypeUrl(typeUrlPrefix?:string):string;

Gets the default type url for Metric

Parameter
NameDescription
typeUrlPrefixstring

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

publictoJSON():{[k:string]:any};

Converts this Metric to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

publicstatictoObject(message:google.api.Metric,options?:$protobuf.IConversionOptions):{[k:string]:any};

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

Parameters
NameDescription
messageMetric

Metric

options$protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

publicstaticverify(message:{[k:string]:any}):(string|null);

Verifies a Metric message.

Parameter
NameDescription
message{ [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-10-30 UTC.