API documentation for monitoring_dashboard.v1.types module.
Classes
Aggregation
Describes how to combine multiple time series to provide different views
of the data. Aggregation consists of an alignment step on individual
time series (alignment_period and per_series_aligner) followed
by an optional reduction step of the data across the aligned time series
(cross_series_reducer and group_by_fields). For more details,
see Aggregation </monitoring/api/learn_more#aggregation>__.
The approach to be used to align individual time series. Not
all alignment functions may be applied to all time series,
depending on the metric type and value type of the original
time series. Alignment may change the metric type or the value
type of the time series. Time series data must be aligned in
order to perform cross-time series reduction. If
crossSeriesReducer is specified, then perSeriesAligner
must be specified and not equal ALIGN_NONE and
alignmentPeriod must be specified; otherwise, an error is
returned.
The set of fields to preserve when crossSeriesReducer is
specified. The groupByFields determine how the time series
are partitioned into subsets prior to applying the aggregation
function. Each subset contains time series that have the same
value for each of the grouping fields. Each individual time
series is a member of exactly one subset. The
crossSeriesReducer is applied to each subset of time
series. It is not possible to reduce across different resource
types, so this field implicitly contains resource.type.
Fields not specified in groupByFields are aggregated away.
If groupByFields is not specified and all the time series
have the same resource type, then the time series are
aggregated into a single output time series. If
crossSeriesReducer is not defined, this field is ignored.
ChartOptions
Options to control visual rendering of a chart.
ColumnLayout
A simplified layout that divides the available space into vertical columns and arranges a set of widgets vertically in each column.
CreateDashboardRequest
The CreateDashboard request.
Required. The initial dashboard specification.
Dashboard
A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.
The mutable, human-readable name.
A dashboard’s root container element that defines the layout style.
The content is divided into equally spaced rows and the widgets are arranged horizontally.
DeleteDashboardRequest
The DeleteDashboard request.
Duration
API documentation for monitoring_dashboard.v1.types.Duration class.
Empty
API documentation for monitoring_dashboard.v1.types.Empty class.
GetDashboardRequest
The GetDashboard request.
GridLayout
A basic layout divides the available space into vertical columns of equal width and arranges a list of widgets using a row-first strategy.
The informational elements that are arranged into the columns row-first.
ListDashboardsRequest
The ListDashboards request.
A positive number that is the maximum number of results to return. If unspecified, a default of 1000 is used.
ListDashboardsResponse
The ListDashboards request.
If there are more results than have been returned, then this
field is set to a non-empty value. To see the additional
results, use that value as pageToken in the next call to
this method.
PickTimeSeriesFilter
Describes a ranking-based time series filter. Each input
time series is ranked with an aligner. The filter lets through up to
num_time_series time series, selecting them based on the relative
ranking.
How many time series to return.
RowLayout
A simplified layout that divides the available space into rows and arranges a set of widgets horizontally in each row.
Scorecard
A widget showing the latest value of a metric, and how this value relates to one or more thresholds.
Defines the optional additional chart shown on the scorecard. If neither is included - then a default scorecard is shown.
Will cause the scorecard to show a spark chart.
StatisticalTimeSeriesFilter
A filter that ranks streams based on their statistical relation to other streams in a request.
How many time series to output.
Text
A widget that displays textual content.
How the text content is formatted.
Threshold
Defines a threshold for categorizing time series values.
The value of the threshold. The value should be defined in the native scale of the metric.
The direction for the current threshold. Direction is not allowed in a XyChart.
TimeSeriesFilter
A filter that defines a subset of time series data that is
displayed in a widget. Time series data is fetched using the
`ListTimeSeries </monitoring/api/ref_v3/rest/v3/projects.timeSeries/list>`__
method.
By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data.
Ranking based time series filter.
TimeSeriesFilterRatio
A pair of time series filters that define a ratio computation. The output time series is the pair-wise division of each aligned element from the numerator and denominator time series.
The denominator of the ratio.
Selects an optional filter that is applied to the time series after computing the ratio.
Statistics based time series filter.
TimeSeriesQuery
TimeSeriesQuery collects the set of supported methods for querying time series data from the Stackdriver metrics API.
Filter parameters to fetch time series.
The unit of data contained in fetched time series. If non-
empty, this unit will override any unit that accompanies
fetched data. The format is the same as the `unit
</monitoring/api/ref_v3/rest/v3/projects.metricDescriptors>`__
field in MetricDescriptor.
UpdateDashboardRequest
The UpdateDashboard request.
Widget
Widget contains a single dashboard component and configuration of how to present the component in the dashboard.
Content defines the component used to populate the widget.
A scorecard summarizing time series data.
A blank space.
XyChart
A chart that displays data on a 2D (X and Y axes) plane.
The duration used to display a comparison chart. A comparison chart simultaneously shows values from two similar-length time periods (e.g., week-over-week metrics). The duration must be positive, and it can only be applied to charts with data sets of LINE plot type.
The properties applied to the X axis.
Display options for the chart.