- 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 static final class Scorecard.Builder extends GeneratedMessageV3.Builder<Scorecard.Builder> implements ScorecardOrBuilderA widget showing the latest value of a metric, and how this value relates to one or more thresholds.
Protobuf type google.monitoring.dashboard.v1.Scorecard
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Scorecard.BuilderImplements
ScorecardOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addAllThresholds(Iterable<? extends Threshold> values)
public Scorecard.Builder addAllThresholds(Iterable<? extends Threshold> values)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 |
values | Iterable<? extends com.google.monitoring.dashboard.v1.Threshold> |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Scorecard.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
addThresholds(Threshold value)
public Scorecard.Builder addThresholds(Threshold value)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 |
value | Threshold |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
addThresholds(Threshold.Builder builderForValue)
public Scorecard.Builder addThresholds(Threshold.Builder builderForValue)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 |
builderForValue | Threshold.Builder |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
addThresholds(int index, Threshold value)
public Scorecard.Builder addThresholds(int index, Threshold value)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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | Threshold |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
addThresholds(int index, Threshold.Builder builderForValue)
public Scorecard.Builder addThresholds(int index, Threshold.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | Threshold.Builder |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
addThresholdsBuilder()
public Threshold.Builder addThresholdsBuilder()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 |
Threshold.Builder | |
addThresholdsBuilder(int index)
public Threshold.Builder addThresholdsBuilder(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.Builder | |
build()
public Scorecard build()| Returns | |
|---|---|
| Type | Description |
Scorecard | |
buildPartial()
public Scorecard buildPartial()| Returns | |
|---|---|
| Type | Description |
Scorecard | |
clear()
public Scorecard.Builder clear()| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
clearBlankView()
public Scorecard.Builder clearBlankView() 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 |
Scorecard.Builder | |
clearDataView()
public Scorecard.Builder clearDataView()| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
clearField(Descriptors.FieldDescriptor field)
public Scorecard.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
clearGaugeView()
public Scorecard.Builder clearGaugeView()Will cause the scorecard to show a gauge chart.
.google.monitoring.dashboard.v1.Scorecard.GaugeView gauge_view = 4;
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
clearOneof(Descriptors.OneofDescriptor oneof)
public Scorecard.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
clearSparkChartView()
public Scorecard.Builder clearSparkChartView()Will cause the scorecard to show a spark chart.
.google.monitoring.dashboard.v1.Scorecard.SparkChartView spark_chart_view = 5;
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
clearThresholds()
public Scorecard.Builder clearThresholds()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 |
Scorecard.Builder | |
clearTimeSeriesQuery()
public Scorecard.Builder clearTimeSeriesQuery()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 |
Scorecard.Builder | |
clone()
public Scorecard.Builder clone()| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
getBlankView()
public 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. |
getBlankViewBuilder()
public Empty.Builder getBlankViewBuilder() 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 |
Builder | |
getBlankViewOrBuilder()
public 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 Scorecard.DataViewCase getDataViewCase()| Returns | |
|---|---|
| Type | Description |
Scorecard.DataViewCase | |
getDefaultInstanceForType()
public Scorecard getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
Scorecard | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
getGaugeView()
public 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. |
getGaugeViewBuilder()
public Scorecard.GaugeView.Builder getGaugeViewBuilder()Will cause the scorecard to show a gauge chart.
.google.monitoring.dashboard.v1.Scorecard.GaugeView gauge_view = 4;
| Returns | |
|---|---|
| Type | Description |
Scorecard.GaugeView.Builder | |
getGaugeViewOrBuilder()
public 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 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. |
getSparkChartViewBuilder()
public Scorecard.SparkChartView.Builder getSparkChartViewBuilder()Will cause the scorecard to show a spark chart.
.google.monitoring.dashboard.v1.Scorecard.SparkChartView spark_chart_view = 5;
| Returns | |
|---|---|
| Type | Description |
Scorecard.SparkChartView.Builder | |
getSparkChartViewOrBuilder()
public 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 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 | |
getThresholdsBuilder(int index)
public Threshold.Builder getThresholdsBuilder(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.Builder | |
getThresholdsBuilderList()
public List<Threshold.Builder> getThresholdsBuilderList()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<Builder> | |
getThresholdsCount()
public 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 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 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 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 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. |
getTimeSeriesQueryBuilder()
public TimeSeriesQuery.Builder getTimeSeriesQueryBuilder()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.Builder | |
getTimeSeriesQueryOrBuilder()
public 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 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 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeBlankView(Empty value)
public Scorecard.Builder mergeBlankView(Empty value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | Empty |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
mergeFrom(Scorecard other)
public Scorecard.Builder mergeFrom(Scorecard other)| Parameter | |
|---|---|
| Name | Description |
other | Scorecard |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Scorecard.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public Scorecard.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
mergeGaugeView(Scorecard.GaugeView value)
public Scorecard.Builder mergeGaugeView(Scorecard.GaugeView value)Will cause the scorecard to show a gauge chart.
.google.monitoring.dashboard.v1.Scorecard.GaugeView gauge_view = 4;
| Parameter | |
|---|---|
| Name | Description |
value | Scorecard.GaugeView |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
mergeSparkChartView(Scorecard.SparkChartView value)
public Scorecard.Builder mergeSparkChartView(Scorecard.SparkChartView value)Will cause the scorecard to show a spark chart.
.google.monitoring.dashboard.v1.Scorecard.SparkChartView spark_chart_view = 5;
| Parameter | |
|---|---|
| Name | Description |
value | Scorecard.SparkChartView |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
mergeTimeSeriesQuery(TimeSeriesQuery value)
public Scorecard.Builder mergeTimeSeriesQuery(TimeSeriesQuery value)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];
| Parameter | |
|---|---|
| Name | Description |
value | TimeSeriesQuery |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Scorecard.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
removeThresholds(int index)
public Scorecard.Builder removeThresholds(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 |
Scorecard.Builder | |
setBlankView(Empty value)
public Scorecard.Builder setBlankView(Empty value) 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;
| Parameter | |
|---|---|
| Name | Description |
value | Empty |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
setBlankView(Empty.Builder builderForValue)
public Scorecard.Builder setBlankView(Empty.Builder builderForValue) 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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Builder |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
setField(Descriptors.FieldDescriptor field, Object value)
public Scorecard.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
setGaugeView(Scorecard.GaugeView value)
public Scorecard.Builder setGaugeView(Scorecard.GaugeView value)Will cause the scorecard to show a gauge chart.
.google.monitoring.dashboard.v1.Scorecard.GaugeView gauge_view = 4;
| Parameter | |
|---|---|
| Name | Description |
value | Scorecard.GaugeView |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
setGaugeView(Scorecard.GaugeView.Builder builderForValue)
public Scorecard.Builder setGaugeView(Scorecard.GaugeView.Builder builderForValue)Will cause the scorecard to show a gauge chart.
.google.monitoring.dashboard.v1.Scorecard.GaugeView gauge_view = 4;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Scorecard.GaugeView.Builder |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Scorecard.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
setSparkChartView(Scorecard.SparkChartView value)
public Scorecard.Builder setSparkChartView(Scorecard.SparkChartView value)Will cause the scorecard to show a spark chart.
.google.monitoring.dashboard.v1.Scorecard.SparkChartView spark_chart_view = 5;
| Parameter | |
|---|---|
| Name | Description |
value | Scorecard.SparkChartView |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
setSparkChartView(Scorecard.SparkChartView.Builder builderForValue)
public Scorecard.Builder setSparkChartView(Scorecard.SparkChartView.Builder builderForValue)Will cause the scorecard to show a spark chart.
.google.monitoring.dashboard.v1.Scorecard.SparkChartView spark_chart_view = 5;
| Parameter | |
|---|---|
| Name | Description |
builderForValue | Scorecard.SparkChartView.Builder |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
setThresholds(int index, Threshold value)
public Scorecard.Builder setThresholds(int index, Threshold value)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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
value | Threshold |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
setThresholds(int index, Threshold.Builder builderForValue)
public Scorecard.Builder setThresholds(int index, Threshold.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index | int |
builderForValue | Threshold.Builder |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
setTimeSeriesQuery(TimeSeriesQuery value)
public Scorecard.Builder setTimeSeriesQuery(TimeSeriesQuery value)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];
| Parameter | |
|---|---|
| Name | Description |
value | TimeSeriesQuery |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
setTimeSeriesQuery(TimeSeriesQuery.Builder builderForValue)
public Scorecard.Builder setTimeSeriesQuery(TimeSeriesQuery.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue | TimeSeriesQuery.Builder |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final Scorecard.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
Scorecard.Builder | |