Interface ScorecardOrBuilder (2.34.0)

public interface ScorecardOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDataViewCase()

public abstract Scorecard.DataViewCase getDataViewCase()
Returns
TypeDescription
Scorecard.DataViewCase

getGaugeView()

public abstract Scorecard.GaugeView getGaugeView()

Will cause the scorecard to show a gauge chart.

.google.monitoring.dashboard.v1.Scorecard.GaugeView gauge_view = 4;

Returns
TypeDescription
Scorecard.GaugeView

The gaugeView.

getGaugeViewOrBuilder()

public abstract Scorecard.GaugeViewOrBuilder getGaugeViewOrBuilder()

Will cause the scorecard to show a gauge chart.

.google.monitoring.dashboard.v1.Scorecard.GaugeView gauge_view = 4;

Returns
TypeDescription
Scorecard.GaugeViewOrBuilder

getSparkChartView()

public abstract Scorecard.SparkChartView getSparkChartView()

Will cause the scorecard to show a spark chart.

.google.monitoring.dashboard.v1.Scorecard.SparkChartView spark_chart_view = 5;

Returns
TypeDescription
Scorecard.SparkChartView

The sparkChartView.

getSparkChartViewOrBuilder()

public abstract Scorecard.SparkChartViewOrBuilder getSparkChartViewOrBuilder()

Will cause the scorecard to show a spark chart.

.google.monitoring.dashboard.v1.Scorecard.SparkChartView spark_chart_view = 5;

Returns
TypeDescription
Scorecard.SparkChartViewOrBuilder

getThresholds(int index)

public abstract Threshold getThresholds(int index)

The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)

As an example, consider a scorecard with the following four thresholds:

<code><code> { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } </code></code>

Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state.

repeated .google.monitoring.dashboard.v1.Threshold thresholds = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
Threshold

getThresholdsCount()

public abstract int getThresholdsCount()

The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)

As an example, consider a scorecard with the following four thresholds:

<code><code> { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } </code></code>

Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state.

repeated .google.monitoring.dashboard.v1.Threshold thresholds = 6;

Returns
TypeDescription
int

getThresholdsList()

public abstract List<Threshold> getThresholdsList()

The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)

As an example, consider a scorecard with the following four thresholds:

<code><code> { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } </code></code>

Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state.

repeated .google.monitoring.dashboard.v1.Threshold thresholds = 6;

Returns
TypeDescription
List<Threshold>

getThresholdsOrBuilder(int index)

public abstract ThresholdOrBuilder getThresholdsOrBuilder(int index)

The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)

As an example, consider a scorecard with the following four thresholds:

<code><code> { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } </code></code>

Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state.

repeated .google.monitoring.dashboard.v1.Threshold thresholds = 6;

Parameter
NameDescription
indexint
Returns
TypeDescription
ThresholdOrBuilder

getThresholdsOrBuilderList()

public abstract List<? extends ThresholdOrBuilder> getThresholdsOrBuilderList()

The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)

As an example, consider a scorecard with the following four thresholds:

<code><code> { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } </code></code>

Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state.

repeated .google.monitoring.dashboard.v1.Threshold thresholds = 6;

Returns
TypeDescription
List<? extends com.google.monitoring.dashboard.v1.ThresholdOrBuilder>

getTimeSeriesQuery()

public abstract TimeSeriesQuery getTimeSeriesQuery()

Required. Fields for querying time series data from the Stackdriver metrics API.

.google.monitoring.dashboard.v1.TimeSeriesQuery time_series_query = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
TimeSeriesQuery

The timeSeriesQuery.

getTimeSeriesQueryOrBuilder()

public abstract TimeSeriesQueryOrBuilder getTimeSeriesQueryOrBuilder()

Required. Fields for querying time series data from the Stackdriver metrics API.

.google.monitoring.dashboard.v1.TimeSeriesQuery time_series_query = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
TimeSeriesQueryOrBuilder

hasGaugeView()

public abstract boolean hasGaugeView()

Will cause the scorecard to show a gauge chart.

.google.monitoring.dashboard.v1.Scorecard.GaugeView gauge_view = 4;

Returns
TypeDescription
boolean

Whether the gaugeView field is set.

hasSparkChartView()

public abstract boolean hasSparkChartView()

Will cause the scorecard to show a spark chart.

.google.monitoring.dashboard.v1.Scorecard.SparkChartView spark_chart_view = 5;

Returns
TypeDescription
boolean

Whether the sparkChartView field is set.

hasTimeSeriesQuery()

public abstract boolean hasTimeSeriesQuery()

Required. Fields for querying time series data from the Stackdriver metrics API.

.google.monitoring.dashboard.v1.TimeSeriesQuery time_series_query = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
boolean

Whether the timeSeriesQuery field is set.