Class DataSet (2.11.1)

DataSet(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Groups a time series query definition with charting options.

Attributes

NameDescription
time_series_query google.cloud.monitoring_dashboard_v1.types.TimeSeriesQuery
Required. Fields for querying time series data from the Stackdriver metrics API.
plot_type google.cloud.monitoring_dashboard_v1.types.XyChart.DataSet.PlotType
How this data should be plotted on the chart.
legend_template str
A template string for naming TimeSeries in the resulting data set. This should be a string with interpolations of the form ${label_name}, which will resolve to the label's value.
min_alignment_period google.protobuf.duration_pb2.Duration
Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.
target_axis google.cloud.monitoring_dashboard_v1.types.XyChart.DataSet.TargetAxis
Optional. The target axis to use for plotting the metric.

Classes

PlotType

PlotType(value)

The types of plotting strategies for data sets.

Values: PLOT_TYPE_UNSPECIFIED (0): Plot type is unspecified. The view will default to LINE. LINE (1): The data is plotted as a set of lines (one line per series). STACKED_AREA (2): The data is plotted as a set of filled areas (one area per series), with the areas stacked vertically (the base of each area is the top of its predecessor, and the base of the first area is the X axis). Since the areas do not overlap, each is filled with a different opaque color. STACKED_BAR (3): The data is plotted as a set of rectangular boxes (one box per series), with the boxes stacked vertically (the base of each box is the top of its predecessor, and the base of the first box is the X axis). Since the boxes do not overlap, each is filled with a different opaque color. HEATMAP (4): The data is plotted as a heatmap. The series being plotted must have a DISTRIBUTION value type. The value of each bucket in the distribution is displayed as a color. This type is not currently available in the Stackdriver Monitoring application.

TargetAxis

TargetAxis(value)

An axis identifier.

Values: TARGET_AXIS_UNSPECIFIED (0): The target axis was not specified. Defaults to Y1. Y1 (1): The y_axis (the right axis of chart). Y2 (2): The y2_axis (the left axis of chart).