Class protos.google.api.MetricDescriptor

Represents a MetricDescriptor.

Package

@google-cloud/logging!

Constructors

(constructor)(properties)

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

Constructs a new MetricDescriptor.

Parameter
NameDescription
properties IMetricDescriptor

Properties to set

Properties

description

public description: string;

MetricDescriptor description.

Property Value
TypeDescription
string

displayName

public displayName: string;

MetricDescriptor displayName.

Property Value
TypeDescription
string

labels

public labels: google.api.ILabelDescriptor[];

MetricDescriptor labels.

Property Value
TypeDescription
google.api.ILabelDescriptor[]

launchStage

public launchStage: (google.api.LaunchStage|keyof typeof google.api.LaunchStage);

MetricDescriptor launchStage.

Property Value
TypeDescription
(google.api.LaunchStage|keyof typeof google.api.LaunchStage)

metadata

public metadata?: (google.api.MetricDescriptor.IMetricDescriptorMetadata|null);

MetricDescriptor metadata.

Property Value
TypeDescription
(google.api.MetricDescriptor.IMetricDescriptorMetadata|null)

metricKind

public metricKind: (google.api.MetricDescriptor.MetricKind|keyof typeof google.api.MetricDescriptor.MetricKind);

MetricDescriptor metricKind.

Property Value
TypeDescription
(google.api.MetricDescriptor.MetricKind|keyof typeof google.api.MetricDescriptor.MetricKind)

monitoredResourceTypes

public monitoredResourceTypes: string[];

MetricDescriptor monitoredResourceTypes.

Property Value
TypeDescription
string[]

name

public name: string;

MetricDescriptor name.

Property Value
TypeDescription
string

type

public type: string;

MetricDescriptor type.

Property Value
TypeDescription
string

unit

public unit: string;

MetricDescriptor unit.

Property Value
TypeDescription
string

valueType

public valueType: (google.api.MetricDescriptor.ValueType|keyof typeof google.api.MetricDescriptor.ValueType);

MetricDescriptor valueType.

Property Value
TypeDescription
(google.api.MetricDescriptor.ValueType|keyof typeof google.api.MetricDescriptor.ValueType)

Methods

create(properties)

public static create(properties?: google.api.IMetricDescriptor): google.api.MetricDescriptor;

Creates a new MetricDescriptor instance using the specified properties.

Parameter
NameDescription
properties IMetricDescriptor

Properties to set

Returns
TypeDescription
google.api.MetricDescriptor

MetricDescriptor instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.api.MetricDescriptor;

Decodes a MetricDescriptor 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.api.MetricDescriptor

MetricDescriptor

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.api.MetricDescriptor;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.api.MetricDescriptor

MetricDescriptor

encode(message, writer)

public static encode(message: google.api.IMetricDescriptor, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified MetricDescriptor message. Does not implicitly messages.

Parameters
NameDescription
message IMetricDescriptor

MetricDescriptor 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.api.IMetricDescriptor, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IMetricDescriptor

MetricDescriptor 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.api.MetricDescriptor;

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

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

Plain object

Returns
TypeDescription
google.api.MetricDescriptor

MetricDescriptor

toJSON()

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

Converts this MetricDescriptor to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.api.MetricDescriptor

MetricDescriptor

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 MetricDescriptor 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