public static final class Scorecard.Builder extends GeneratedMessageV3.Builder<Scorecard.Builder> implements ScorecardOrBuilder
A 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
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
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Scorecard.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
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
Returns
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
Returns
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
Returns
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
Returns
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
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
Returns
build()
Returns
buildPartial()
public Scorecard buildPartial()
Returns
clear()
public Scorecard.Builder clear()
Returns
Overrides
clearDataView()
public Scorecard.Builder clearDataView()
Returns
clearField(Descriptors.FieldDescriptor field)
public Scorecard.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearGaugeView()
public Scorecard.Builder clearGaugeView()
Will cause the scorecard to show a gauge chart.
.google.monitoring.dashboard.v1.Scorecard.GaugeView gauge_view = 4;
Returns
clearOneof(Descriptors.OneofDescriptor oneof)
public Scorecard.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
Overrides
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
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
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
clone()
public Scorecard.Builder clone()
Returns
Overrides
getDataViewCase()
public Scorecard.DataViewCase getDataViewCase()
Returns
getDefaultInstanceForType()
public Scorecard getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
getGaugeView()
public Scorecard.GaugeView getGaugeView()
Will cause the scorecard to show a gauge chart.
.google.monitoring.dashboard.v1.Scorecard.GaugeView gauge_view = 4;
Returns
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
getGaugeViewOrBuilder()
public Scorecard.GaugeViewOrBuilder getGaugeViewOrBuilder()
Will cause the scorecard to show a gauge chart.
.google.monitoring.dashboard.v1.Scorecard.GaugeView gauge_view = 4;
Returns
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
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
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
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
Returns
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
Returns
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
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
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
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
Returns
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
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
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
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
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(Scorecard other)
public Scorecard.Builder mergeFrom(Scorecard other)
Parameter
Returns
public Scorecard.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public Scorecard.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
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
Returns
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
Returns
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
Returns
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Scorecard.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
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
Returns
setField(Descriptors.FieldDescriptor field, Object value)
public Scorecard.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
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
Returns
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
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Scorecard.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
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
Returns
setUnknownFields(UnknownFieldSet unknownFields)
public final Scorecard.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides