Class protos.google.monitoring.v3.TimeSeries

Represents a TimeSeries.

Package

@google-cloud/monitoring

Constructors

(constructor)(properties)

constructor(properties?: google.monitoring.v3.ITimeSeries);

Constructs a new TimeSeries.

Parameter
NameDescription
properties ITimeSeries

Properties to set

Properties

metadata

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

TimeSeries metadata.

metric

public metric?: (google.api.IMetric|null);

TimeSeries metric.

metricKind

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

TimeSeries metricKind.

points

public points: google.monitoring.v3.IPoint[];

TimeSeries points.

resource

public resource?: (google.api.IMonitoredResource|null);

TimeSeries resource.

unit

public unit: string;

TimeSeries unit.

valueType

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

TimeSeries valueType.

Methods

create(properties)

public static create(properties?: google.monitoring.v3.ITimeSeries): google.monitoring.v3.TimeSeries;

Creates a new TimeSeries instance using the specified properties.

Parameter
NameDescription
properties ITimeSeries

Properties to set

Returns
TypeDescription
google.monitoring.v3.TimeSeries

TimeSeries instance

decode(reader, length)

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

Decodes a TimeSeries 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.TimeSeries

TimeSeries

decodeDelimited(reader)

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

Decodes a TimeSeries 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.TimeSeries

TimeSeries

encode(message, writer)

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

Encodes the specified TimeSeries message. Does not implicitly messages.

Parameters
NameDescription
message ITimeSeries

TimeSeries 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.ITimeSeries, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ITimeSeries

TimeSeries 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.TimeSeries;

Creates a TimeSeries 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.TimeSeries

TimeSeries

toJSON()

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

Converts this TimeSeries to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.monitoring.v3.TimeSeries

TimeSeries

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