Represents a LogMetric.
Package
@google-cloud/loggingConstructors
(constructor)(properties)
constructor(properties?: google.logging.v2.ILogMetric);Constructs a new LogMetric.
| Parameter | |
|---|---|
| Name | Description |
properties |
ILogMetric
Properties to set |
Properties
bucketName
public bucketName: string;LogMetric bucketName.
bucketOptions
public bucketOptions?: (google.api.Distribution.IBucketOptions|null);LogMetric bucketOptions.
createTime
public createTime?: (google.protobuf.ITimestamp|null);LogMetric createTime.
description
public description: string;LogMetric description.
disabled
public disabled: boolean;LogMetric disabled.
filter
public filter: string;LogMetric filter.
labelExtractors
public labelExtractors: { [k: string]: string };LogMetric labelExtractors.
metricDescriptor
public metricDescriptor?: (google.api.IMetricDescriptor|null);LogMetric metricDescriptor.
name
public name: string;LogMetric name.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);LogMetric updateTime.
valueExtractor
public valueExtractor: string;LogMetric valueExtractor.
version
public version: (google.logging.v2.LogMetric.ApiVersion|keyof typeof google.logging.v2.LogMetric.ApiVersion);LogMetric version.
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 | |
|---|---|
| Name | Description |
properties |
ILogMetric
Properties to set |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
message |
ILogMetric
LogMetric message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Name | Description |
message |
ILogMetric
LogMetric message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
LogMetric | LogMetric |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for LogMetric
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this LogMetric to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [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 | |
|---|---|
| Name | Description |
message |
LogMetric
LogMetric |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a LogMetric message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|