Class protos.google.monitoring.v3.TimeSeriesDescriptor.ValueDescriptor

Represents a ValueDescriptor.

Package

@google-cloud/monitoring

Constructors

(constructor)(properties)

constructor(properties?: google.monitoring.v3.TimeSeriesDescriptor.IValueDescriptor);

Constructs a new ValueDescriptor.

Parameter
NameDescription
properties IValueDescriptor

Properties to set

Properties

key

public key: string;

ValueDescriptor key.

metricKind

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

ValueDescriptor metricKind.

unit

public unit: string;

ValueDescriptor unit.

valueType

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

ValueDescriptor valueType.

Methods

create(properties)

public static create(properties?: google.monitoring.v3.TimeSeriesDescriptor.IValueDescriptor): google.monitoring.v3.TimeSeriesDescriptor.ValueDescriptor;

Creates a new ValueDescriptor instance using the specified properties.

Parameter
NameDescription
properties IValueDescriptor

Properties to set

Returns
TypeDescription
google.monitoring.v3.TimeSeriesDescriptor.ValueDescriptor

ValueDescriptor instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.monitoring.v3.TimeSeriesDescriptor.ValueDescriptor;

Decodes a ValueDescriptor 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.monitoring.v3.TimeSeriesDescriptor.ValueDescriptor

ValueDescriptor

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.monitoring.v3.TimeSeriesDescriptor.ValueDescriptor;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.monitoring.v3.TimeSeriesDescriptor.ValueDescriptor

ValueDescriptor

encode(message, writer)

public static encode(message: google.monitoring.v3.TimeSeriesDescriptor.IValueDescriptor, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ValueDescriptor message. Does not implicitly messages.

Parameters
NameDescription
message IValueDescriptor

ValueDescriptor 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.monitoring.v3.TimeSeriesDescriptor.IValueDescriptor, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IValueDescriptor

ValueDescriptor 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.monitoring.v3.TimeSeriesDescriptor.ValueDescriptor;

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

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

Plain object

Returns
TypeDescription
google.monitoring.v3.TimeSeriesDescriptor.ValueDescriptor

ValueDescriptor

toJSON()

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

Converts this ValueDescriptor to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.monitoring.v3.TimeSeriesDescriptor.ValueDescriptor, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message google.monitoring.v3.TimeSeriesDescriptor.ValueDescriptor

ValueDescriptor

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