Interface TimeSeriesQueryOrBuilder (2.56.0)

Version 2.56.0

• 2.57.0 (latest)
• 2.56.0
• 2.55.0
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.6
• 2.4.0
• 2.3.0
• 2.2.6

public interface TimeSeriesQueryOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getOutputFullDuration()

public abstract boolean getOutputFullDuration()

Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value.

*Note: This could override the configured alignment period except for the cases where a series of data points are expected, like

• XyChart
• Scorecard's spark chart

bool output_full_duration = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The outputFullDuration.

getPrometheusQuery()

public abstract String getPrometheusQuery()

A query used to fetch time series with PromQL.

string prometheus_query = 6;

Returns
Type	Description
String	The prometheusQuery.

getPrometheusQueryBytes()

public abstract ByteString getPrometheusQueryBytes()

A query used to fetch time series with PromQL.

string prometheus_query = 6;

Returns
Type	Description
ByteString	The bytes for prometheusQuery.

getSourceCase()

public abstract TimeSeriesQuery.SourceCase getSourceCase()

Returns
Type	Description
TimeSeriesQuery.SourceCase

getTimeSeriesFilter()

public abstract TimeSeriesFilter getTimeSeriesFilter()

Filter parameters to fetch time series.

.google.monitoring.dashboard.v1.TimeSeriesFilter time_series_filter = 1;

Returns
Type	Description
TimeSeriesFilter	The timeSeriesFilter.

getTimeSeriesFilterOrBuilder()

public abstract TimeSeriesFilterOrBuilder getTimeSeriesFilterOrBuilder()

Filter parameters to fetch time series.

.google.monitoring.dashboard.v1.TimeSeriesFilter time_series_filter = 1;

Returns
Type	Description
TimeSeriesFilterOrBuilder

getTimeSeriesFilterRatio()

public abstract TimeSeriesFilterRatio getTimeSeriesFilterRatio()

Parameters to fetch a ratio between two time series filters.

.google.monitoring.dashboard.v1.TimeSeriesFilterRatio time_series_filter_ratio = 2;

Returns
Type	Description
TimeSeriesFilterRatio	The timeSeriesFilterRatio.

getTimeSeriesFilterRatioOrBuilder()

public abstract TimeSeriesFilterRatioOrBuilder getTimeSeriesFilterRatioOrBuilder()

Parameters to fetch a ratio between two time series filters.

.google.monitoring.dashboard.v1.TimeSeriesFilterRatio time_series_filter_ratio = 2;

Returns
Type	Description
TimeSeriesFilterRatioOrBuilder

getTimeSeriesQueryLanguage()

public abstract String getTimeSeriesQueryLanguage()

A query used to fetch time series with MQL.

string time_series_query_language = 3;

Returns
Type	Description
String	The timeSeriesQueryLanguage.

getTimeSeriesQueryLanguageBytes()

public abstract ByteString getTimeSeriesQueryLanguageBytes()

A query used to fetch time series with MQL.

string time_series_query_language = 3;

Returns
Type	Description
ByteString	The bytes for timeSeriesQueryLanguage.

getUnitOverride()

public abstract String getUnitOverride()

The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit field in MetricDescriptor.

string unit_override = 5;

Returns
Type	Description
String	The unitOverride.

getUnitOverrideBytes()

public abstract ByteString getUnitOverrideBytes()

The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit field in MetricDescriptor.

string unit_override = 5;

Returns
Type	Description
ByteString	The bytes for unitOverride.

hasPrometheusQuery()

public abstract boolean hasPrometheusQuery()

A query used to fetch time series with PromQL.

string prometheus_query = 6;

Returns
Type	Description
boolean	Whether the prometheusQuery field is set.

hasTimeSeriesFilter()

public abstract boolean hasTimeSeriesFilter()

Filter parameters to fetch time series.

.google.monitoring.dashboard.v1.TimeSeriesFilter time_series_filter = 1;

Returns
Type	Description
boolean	Whether the timeSeriesFilter field is set.

hasTimeSeriesFilterRatio()

public abstract boolean hasTimeSeriesFilterRatio()

Parameters to fetch a ratio between two time series filters.

.google.monitoring.dashboard.v1.TimeSeriesFilterRatio time_series_filter_ratio = 2;

Returns
Type	Description
boolean	Whether the timeSeriesFilterRatio field is set.

hasTimeSeriesQueryLanguage()

public abstract boolean hasTimeSeriesQueryLanguage()

A query used to fetch time series with MQL.

string time_series_query_language = 3;

Returns
Type	Description
boolean	Whether the timeSeriesQueryLanguage field is set.