- 2.56.0 (latest)
- 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 ScorecardOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getBlankView()
public abstract Empty getBlankView() Will cause the Scorecard to show only the value, with no indicator to
its value relative to its thresholds.
.google.protobuf.Empty blank_view = 7;
| Returns | |
|---|---|
| Type | Description |
Empty |
The blankView. |
getBlankViewOrBuilder()
public abstract EmptyOrBuilder getBlankViewOrBuilder() Will cause the Scorecard to show only the value, with no indicator to
its value relative to its thresholds.
.google.protobuf.Empty blank_view = 7;
| Returns | |
|---|---|
| Type | Description |
EmptyOrBuilder |
|
getDataViewCase()
public abstract Scorecard.DataViewCase getDataViewCase()| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
TimeSeriesQueryOrBuilder |
|
hasBlankView()
public abstract boolean hasBlankView() Will cause the Scorecard to show only the value, with no indicator to
its value relative to its thresholds.
.google.protobuf.Empty blank_view = 7;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the blankView field is set. |
hasGaugeView()
public abstract boolean hasGaugeView()Will cause the scorecard to show a gauge chart.
.google.monitoring.dashboard.v1.Scorecard.GaugeView gauge_view = 4;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
boolean |
Whether the timeSeriesQuery field is set. |