Class protos.google.api.MetricDescriptor (0.4.0)

Represents a MetricDescriptor.

Package

Constructors

(constructor)(properties)

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

Constructs a new MetricDescriptor.

Parameter

Name	Description
properties	`IMetricDescriptor` Properties to set

Properties

description

public description: string;

MetricDescriptor description.

displayName

public displayName: string;

MetricDescriptor displayName.

labels

public labels: google.api.ILabelDescriptor[];

MetricDescriptor labels.

launchStage

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

MetricDescriptor launchStage.

metadata

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

MetricDescriptor metadata.

metricKind

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

MetricDescriptor metricKind.

monitoredResourceTypes

public monitoredResourceTypes: string[];

MetricDescriptor monitoredResourceTypes.

name

public name: string;

MetricDescriptor name.

type

public type: string;

MetricDescriptor type.

unit

public unit: string;

MetricDescriptor unit.

valueType

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

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

Name	Description
properties	`IMetricDescriptor` Properties to set

Returns

Type	Description
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

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
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

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
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

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

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

Parameters

Name	Description
message	`IMetricDescriptor` MetricDescriptor 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.api.MetricDescriptor;

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

toJSON()

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

Converts this MetricDescriptor to JSON.

Returns

Type	Description
{ [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

Name	Description
message	`google.api.MetricDescriptor` MetricDescriptor
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 MetricDescriptor message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not