Class Scorecard (2.45.0)

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

Implements

ScorecardOrBuilder

Static Fields

BLANK_VIEW_FIELD_NUMBER

public static final int BLANK_VIEW_FIELD_NUMBER
Field Value
Type Description
int

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()
Returns
Type Description
Scorecard

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Scorecard.Builder newBuilder()
Returns
Type Description
Scorecard.Builder

newBuilder(Scorecard prototype)

public static Scorecard.Builder newBuilder(Scorecard prototype)
Parameter
Name Description
prototype Scorecard
Returns
Type Description
Scorecard.Builder

parseDelimitedFrom(InputStream input)

public static Scorecard parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Scorecard
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Scorecard parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Scorecard
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Scorecard parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Scorecard
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Scorecard parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Scorecard
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Scorecard parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Scorecard
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Scorecard parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Scorecard
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Scorecard parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Scorecard
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Scorecard parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Scorecard
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Scorecard parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Scorecard
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Scorecard parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Scorecard
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Scorecard parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Scorecard
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Scorecard parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Scorecard
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Scorecard> parser()
Returns
Type Description
Parser<Scorecard>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.

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

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.

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

getParserForType()

public Parser<Scorecard> getParserForType()
Returns
Type Description
Parser<Scorecard>
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;

Returns
Type Description
Scorecard.SparkChartView

The sparkChartView.

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

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Scorecard.Builder newBuilderForType()
Returns
Type Description
Scorecard.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Scorecard.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Scorecard.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Scorecard.Builder toBuilder()
Returns
Type Description
Scorecard.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException