Class protos.google.monitoring.dashboard.v1.TimeSeriesFilterRatio

Represents a TimeSeriesFilterRatio.

Package

@google-cloud/monitoring-dashboards!

Constructors

(constructor)(properties)

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

Constructs a new TimeSeriesFilterRatio.

Parameter
TypeNameDescription
ITimeSeriesFilterRatioproperties

Properties to set

Properties

denominator

public denominator?: (google.monitoring.dashboard.v1.TimeSeriesFilterRatio.IRatioPart|null);

TimeSeriesFilterRatio denominator.

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

numerator

public numerator?: (google.monitoring.dashboard.v1.TimeSeriesFilterRatio.IRatioPart|null);

TimeSeriesFilterRatio numerator.

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

outputFilter

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

TimeSeriesFilterRatio outputFilter.

Property Value
TypeDescription
("pickTimeSeriesFilter"|"statisticalTimeSeriesFilter")

pickTimeSeriesFilter

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

TimeSeriesFilterRatio pickTimeSeriesFilter.

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

secondaryAggregation

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

TimeSeriesFilterRatio secondaryAggregation.

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

statisticalTimeSeriesFilter

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

TimeSeriesFilterRatio statisticalTimeSeriesFilter.

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

Methods

create(properties)

public static create(properties?: google.monitoring.dashboard.v1.ITimeSeriesFilterRatio): google.monitoring.dashboard.v1.TimeSeriesFilterRatio;

Creates a new TimeSeriesFilterRatio instance using the specified properties.

Parameter
TypeNameDescription
ITimeSeriesFilterRatioproperties

Properties to set

Returns
TypeDescription
google.monitoring.dashboard.v1.TimeSeriesFilterRatio

TimeSeriesFilterRatio instance

decode(reader, length)

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

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

TimeSeriesFilterRatio

decodeDelimited(reader)

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

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

TimeSeriesFilterRatio

encode(message, writer)

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

Encodes the specified TimeSeriesFilterRatio message. Does not implicitly messages.

Parameters
TypeNameDescription
ITimeSeriesFilterRatiomessage

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

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

Parameters
TypeNameDescription
ITimeSeriesFilterRatiomessage

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

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

TimeSeriesFilterRatio

toJSON()

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

Converts this TimeSeriesFilterRatio to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
TypeNameDescription
google.monitoring.dashboard.v1.TimeSeriesFilterRatiomessage

TimeSeriesFilterRatio

$protobuf.IConversionOptionsoptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a TimeSeriesFilterRatio 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