Class protos.google.monitoring.dashboard.v1.TimeSeriesFilter

Represents a TimeSeriesFilter.

Package

@google-cloud/monitoring-dashboards

Constructors

(constructor)(properties)

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

Constructs a new TimeSeriesFilter.

Parameter
NameDescription
properties ITimeSeriesFilter

Properties to set

Properties

aggregation

public aggregation?: (google.monitoring.dashboard.v1.IAggregation|null);

TimeSeriesFilter aggregation.

filter

public filter: string;

TimeSeriesFilter filter.

outputFilter

public outputFilter?: ("pickTimeSeriesFilter"|"statisticalTimeSeriesFilter");

TimeSeriesFilter outputFilter.

pickTimeSeriesFilter

public pickTimeSeriesFilter?: (google.monitoring.dashboard.v1.IPickTimeSeriesFilter|null);

TimeSeriesFilter pickTimeSeriesFilter.

secondaryAggregation

public secondaryAggregation?: (google.monitoring.dashboard.v1.IAggregation|null);

TimeSeriesFilter secondaryAggregation.

statisticalTimeSeriesFilter

public statisticalTimeSeriesFilter?: (google.monitoring.dashboard.v1.IStatisticalTimeSeriesFilter|null);

TimeSeriesFilter statisticalTimeSeriesFilter.

Methods

create(properties)

public static create(properties?: google.monitoring.dashboard.v1.ITimeSeriesFilter): google.monitoring.dashboard.v1.TimeSeriesFilter;

Creates a new TimeSeriesFilter instance using the specified properties.

Parameter
NameDescription
properties ITimeSeriesFilter

Properties to set

Returns
TypeDescription
google.monitoring.dashboard.v1.TimeSeriesFilter

TimeSeriesFilter instance

decode(reader, length)

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

Decodes a TimeSeriesFilter 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.dashboard.v1.TimeSeriesFilter

TimeSeriesFilter

decodeDelimited(reader)

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

Decodes a TimeSeriesFilter 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.dashboard.v1.TimeSeriesFilter

TimeSeriesFilter

encode(message, writer)

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

Encodes the specified TimeSeriesFilter message. Does not implicitly messages.

Parameters
NameDescription
message ITimeSeriesFilter

TimeSeriesFilter 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.dashboard.v1.ITimeSeriesFilter, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message ITimeSeriesFilter

TimeSeriesFilter 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.dashboard.v1.TimeSeriesFilter;

Creates a TimeSeriesFilter 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.dashboard.v1.TimeSeriesFilter

TimeSeriesFilter

toJSON()

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

Converts this TimeSeriesFilter to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.monitoring.dashboard.v1.TimeSeriesFilter

TimeSeriesFilter

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