Class protos.google.logging.v2.LogMetric

Represents a LogMetric.

Package

@google-cloud/logging

Constructors

(constructor)(properties)

constructor(properties?: google.logging.v2.ILogMetric);

Constructs a new LogMetric.

Parameter
NameDescription
properties ILogMetric

Properties to set

Properties

bucketOptions

public bucketOptions?: (google.api.Distribution.IBucketOptions|null);

LogMetric bucketOptions.

Property Value
TypeDescription
(google.api.Distribution.IBucketOptions|null)

createTime

public createTime?: (google.protobuf.ITimestamp|null);

LogMetric createTime.

Property Value
TypeDescription
(google.protobuf.ITimestamp|null)

description

public description: string;

LogMetric description.

Property Value
TypeDescription
string

filter

public filter: string;

LogMetric filter.

Property Value
TypeDescription
string

labelExtractors

public labelExtractors: { [k: string]: string };

LogMetric labelExtractors.

Property Value
TypeDescription
{ [k: string]: string }

metricDescriptor

public metricDescriptor?: (google.api.IMetricDescriptor|null);

LogMetric metricDescriptor.

Property Value
TypeDescription
(google.api.IMetricDescriptor|null)

name

public name: string;

LogMetric name.

Property Value
TypeDescription
string

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

LogMetric updateTime.

Property Value
TypeDescription
(google.protobuf.ITimestamp|null)

valueExtractor

public valueExtractor: string;

LogMetric valueExtractor.

Property Value
TypeDescription
string

version

public version: (google.logging.v2.LogMetric.ApiVersion|keyof typeof google.logging.v2.LogMetric.ApiVersion);

LogMetric version.

Property Value
TypeDescription
(google.logging.v2.LogMetric.ApiVersion|keyof typeof google.logging.v2.LogMetric.ApiVersion)

Methods

create(properties)

public static create(properties?: google.logging.v2.ILogMetric): google.logging.v2.LogMetric;

Creates a new LogMetric instance using the specified properties.

Parameter
NameDescription
properties ILogMetric

Properties to set

Returns
TypeDescription
google.logging.v2.LogMetric

LogMetric instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.logging.v2.LogMetric;

Decodes a LogMetric message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.logging.v2.LogMetric

LogMetric

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.logging.v2.LogMetric;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.logging.v2.LogMetric

LogMetric

encode(message, writer)

public static encode(message: google.logging.v2.ILogMetric, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified LogMetric message. Does not implicitly messages.

Parameters
NameDescription
message ILogMetric

LogMetric message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.logging.v2.ILogMetric, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ILogMetric

LogMetric message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.logging.v2.LogMetric;

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

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

Plain object

Returns
TypeDescription
google.logging.v2.LogMetric

LogMetric

toJSON()

public toJSON(): { [k: string]: any };

Converts this LogMetric to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.logging.v2.LogMetric, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message google.logging.v2.LogMetric

LogMetric

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a LogMetric 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