public final class Scorecard extends GeneratedMessageV3 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
Static Fields
GAUGE_VIEW_FIELD_NUMBER
public static final int GAUGE_VIEW_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SPARK_CHART_VIEW_FIELD_NUMBER
public static final int SPARK_CHART_VIEW_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
THRESHOLDS_FIELD_NUMBER
public static final int THRESHOLDS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TIME_SERIES_QUERY_FIELD_NUMBER
public static final int TIME_SERIES_QUERY_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Scorecard getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Scorecard.Builder newBuilder()
newBuilder(Scorecard prototype)
public static Scorecard.Builder newBuilder(Scorecard prototype)
public static Scorecard parseDelimitedFrom(InputStream input)
public static Scorecard parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Scorecard parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Scorecard parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Scorecard parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Scorecard parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Scorecard parseFrom(CodedInputStream input)
public static Scorecard parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Scorecard parseFrom(InputStream input)
public static Scorecard parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Scorecard parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Scorecard parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Scorecard> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getDataViewCase()
public Scorecard.DataViewCase getDataViewCase()
getDefaultInstanceForType()
public Scorecard getDefaultInstanceForType()
getGaugeView()
public Scorecard.GaugeView getGaugeView()
Will cause the scorecard to show a gauge chart.
.google.monitoring.dashboard.v1.Scorecard.GaugeView gauge_view = 4;
getGaugeViewOrBuilder()
public Scorecard.GaugeViewOrBuilder getGaugeViewOrBuilder()
Will cause the scorecard to show a gauge chart.
.google.monitoring.dashboard.v1.Scorecard.GaugeView gauge_view = 4;
getParserForType()
public Parser<Scorecard> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getSparkChartView()
public Scorecard.SparkChartView getSparkChartView()
Will cause the scorecard to show a spark chart.
.google.monitoring.dashboard.v1.Scorecard.SparkChartView spark_chart_view = 5;
getSparkChartViewOrBuilder()
public Scorecard.SparkChartViewOrBuilder getSparkChartViewOrBuilder()
Will cause the scorecard to show a spark chart.
.google.monitoring.dashboard.v1.Scorecard.SparkChartView spark_chart_view = 5;
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
|
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;
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
|
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];
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];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Scorecard.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Scorecard.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Scorecard.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
