Class Scorecard.Builder (2.18.0)

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

Implements

ScorecardOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.monitoring.dashboard.v1.Threshold>
Returns
TypeDescription
Scorecard.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Scorecard.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Scorecard.Builder
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
NameDescription
valueThreshold
Returns
TypeDescription
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
NameDescription
builderForValueThreshold.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueThreshold
Returns
TypeDescription
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
NameDescription
indexint
builderForValueThreshold.Builder
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
Threshold.Builder

build()

public Scorecard build()
Returns
TypeDescription
Scorecard

buildPartial()

public Scorecard buildPartial()
Returns
TypeDescription
Scorecard

clear()

public Scorecard.Builder clear()
Returns
TypeDescription
Scorecard.Builder
Overrides

clearDataView()

public Scorecard.Builder clearDataView()
Returns
TypeDescription
Scorecard.Builder

clearField(Descriptors.FieldDescriptor field)

public Scorecard.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Scorecard.Builder
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
TypeDescription
Scorecard.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Scorecard.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Scorecard.Builder
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
TypeDescription
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
TypeDescription
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
TypeDescription
Scorecard.Builder

clone()

public Scorecard.Builder clone()
Returns
TypeDescription
Scorecard.Builder
Overrides

getDataViewCase()

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

getDefaultInstanceForType()

public Scorecard getDefaultInstanceForType()
Returns
TypeDescription
Scorecard

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
TimeSeriesQueryOrBuilder

hasGaugeView()

public 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Scorecard other)

public Scorecard.Builder mergeFrom(Scorecard other)
Parameter
NameDescription
otherScorecard
Returns
TypeDescription
Scorecard.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Scorecard.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Scorecard.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Scorecard.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Scorecard.Builder
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
NameDescription
valueScorecard.GaugeView
Returns
TypeDescription
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
NameDescription
valueScorecard.SparkChartView
Returns
TypeDescription
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
NameDescription
valueTimeSeriesQuery
Returns
TypeDescription
Scorecard.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Scorecard.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Scorecard.Builder
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
NameDescription
indexint
Returns
TypeDescription
Scorecard.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Scorecard.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Scorecard.Builder
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
NameDescription
valueScorecard.GaugeView
Returns
TypeDescription
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
NameDescription
builderForValueScorecard.GaugeView.Builder
Returns
TypeDescription
Scorecard.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Scorecard.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Scorecard.Builder
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
NameDescription
valueScorecard.SparkChartView
Returns
TypeDescription
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
NameDescription
builderForValueScorecard.SparkChartView.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueThreshold
Returns
TypeDescription
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
NameDescription
indexint
builderForValueThreshold.Builder
Returns
TypeDescription
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
NameDescription
valueTimeSeriesQuery
Returns
TypeDescription
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
NameDescription
builderForValueTimeSeriesQuery.Builder
Returns
TypeDescription
Scorecard.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Scorecard.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Scorecard.Builder
Overrides