Show / Hide Table of Contents

Class Scorecard

A widget showing the latest value of a metric, and how this value relates to one or more thresholds.

Inheritance
object
Scorecard
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Monitoring.v1.Data
Assembly: Google.Apis.Monitoring.v1.dll
Syntax
public class Scorecard : IDirectResponseSchema

Properties

BlankView

Will cause the Scorecard to show only the value, with no indicator to its value relative to its thresholds.

Declaration
[JsonProperty("blankView")]
public virtual Empty BlankView { get; set; }
Property Value
Type Description
Empty

Breakdowns

Optional. The collection of breakdowns to be applied to the dataset. A breakdown is a way to slice the data. For example, you can break down the data by region.

Declaration
[JsonProperty("breakdowns")]
public virtual IList<Breakdown> Breakdowns { get; set; }
Property Value
Type Description
IList<Breakdown>

Dimensions

Optional. A dimension is a structured label, class, or category for a set of measurements in your data.

Declaration
[JsonProperty("dimensions")]
public virtual IList<Dimension> Dimensions { get; set; }
Property Value
Type Description
IList<Dimension>

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

GaugeView

Will cause the scorecard to show a gauge chart.

Declaration
[JsonProperty("gaugeView")]
public virtual GaugeView GaugeView { get; set; }
Property Value
Type Description
GaugeView

Measures

Optional. A measure is a measured value of a property in your data. For example, rainfall in inches, number of units sold, revenue gained, etc.

Declaration
[JsonProperty("measures")]
public virtual IList<Measure> Measures { get; set; }
Property Value
Type Description
IList<Measure>

SparkChartView

Will cause the scorecard to show a spark chart.

Declaration
[JsonProperty("sparkChartView")]
public virtual SparkChartView SparkChartView { get; set; }
Property Value
Type Description
SparkChartView

Thresholds

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: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, { value: 20, category: 'WARNING', trigger: 'BELOW', } 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.

Declaration
[JsonProperty("thresholds")]
public virtual IList<Threshold> Thresholds { get; set; }
Property Value
Type Description
IList<Threshold>

TimeSeriesQuery

Required. Fields for querying time series data from the Stackdriver metrics API.

Declaration
[JsonProperty("timeSeriesQuery")]
public virtual TimeSeriesQuery TimeSeriesQuery { get; set; }
Property Value
Type Description
TimeSeriesQuery

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX