Class protos.google.monitoring.dashboard.v1.TimeSeriesQuery

Represents a TimeSeriesQuery.

Package

@google-cloud/monitoring-dashboards!

Constructors

(constructor)(properties)

constructor(properties?: google.monitoring.dashboard.v1.ITimeSeriesQuery);

Constructs a new TimeSeriesQuery.

Parameter
TypeNameDescription
ITimeSeriesQueryproperties

Properties to set

Properties

source

public source?: ("timeSeriesFilter"|"timeSeriesFilterRatio"|"timeSeriesQueryLanguage");

TimeSeriesQuery source.

Property Value
TypeDescription
("timeSeriesFilter"|"timeSeriesFilterRatio"|"timeSeriesQueryLanguage")

timeSeriesFilter

public timeSeriesFilter?: (google.monitoring.dashboard.v1.ITimeSeriesFilter|null);

TimeSeriesQuery timeSeriesFilter.

Property Value
TypeDescription
(google.monitoring.dashboard.v1.ITimeSeriesFilter|null)

timeSeriesFilterRatio

public timeSeriesFilterRatio?: (google.monitoring.dashboard.v1.ITimeSeriesFilterRatio|null);

TimeSeriesQuery timeSeriesFilterRatio.

Property Value
TypeDescription
(google.monitoring.dashboard.v1.ITimeSeriesFilterRatio|null)

timeSeriesQueryLanguage

public timeSeriesQueryLanguage?: (string|null);

TimeSeriesQuery timeSeriesQueryLanguage.

Property Value
TypeDescription
(string|null)

unitOverride

public unitOverride: string;

TimeSeriesQuery unitOverride.

Property Value
TypeDescription
string

Methods

create(properties)

public static create(properties?: google.monitoring.dashboard.v1.ITimeSeriesQuery): google.monitoring.dashboard.v1.TimeSeriesQuery;

Creates a new TimeSeriesQuery instance using the specified properties.

Parameter
TypeNameDescription
ITimeSeriesQueryproperties

Properties to set

Returns
TypeDescription
google.monitoring.dashboard.v1.TimeSeriesQuery

TimeSeriesQuery instance

decode(reader, length)

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

Decodes a TimeSeriesQuery message from the specified reader or buffer.

Parameters
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

numberlength

Message length if known beforehand

Returns
TypeDescription
google.monitoring.dashboard.v1.TimeSeriesQuery

TimeSeriesQuery

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.monitoring.dashboard.v1.TimeSeriesQuery;

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

Parameter
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

Returns
TypeDescription
google.monitoring.dashboard.v1.TimeSeriesQuery

TimeSeriesQuery

encode(message, writer)

public static encode(message: google.monitoring.dashboard.v1.ITimeSeriesQuery, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified TimeSeriesQuery message. Does not implicitly messages.

Parameters
TypeNameDescription
ITimeSeriesQuerymessage

TimeSeriesQuery message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.monitoring.dashboard.v1.ITimeSeriesQuery, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
TypeNameDescription
ITimeSeriesQuerymessage

TimeSeriesQuery message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.monitoring.dashboard.v1.TimeSeriesQuery;

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

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

Plain object

Returns
TypeDescription
google.monitoring.dashboard.v1.TimeSeriesQuery

TimeSeriesQuery

toJSON()

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

Converts this TimeSeriesQuery to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
TypeNameDescription
google.monitoring.dashboard.v1.TimeSeriesQuerymessage

TimeSeriesQuery

$protobuf.IConversionOptionsoptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a TimeSeriesQuery message.

Parameter
TypeNameDescription
{ [k: string]: any }message

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not