Variables
Aggregation_Aligner_name, Aggregation_Aligner_value
var (
Aggregation_Aligner_name = map[int32]string{
0: "ALIGN_NONE",
1: "ALIGN_DELTA",
2: "ALIGN_RATE",
3: "ALIGN_INTERPOLATE",
4: "ALIGN_NEXT_OLDER",
10: "ALIGN_MIN",
11: "ALIGN_MAX",
12: "ALIGN_MEAN",
13: "ALIGN_COUNT",
14: "ALIGN_SUM",
15: "ALIGN_STDDEV",
16: "ALIGN_COUNT_TRUE",
24: "ALIGN_COUNT_FALSE",
17: "ALIGN_FRACTION_TRUE",
18: "ALIGN_PERCENTILE_99",
19: "ALIGN_PERCENTILE_95",
20: "ALIGN_PERCENTILE_50",
21: "ALIGN_PERCENTILE_05",
23: "ALIGN_PERCENT_CHANGE",
}
Aggregation_Aligner_value = map[string]int32{
"ALIGN_NONE": 0,
"ALIGN_DELTA": 1,
"ALIGN_RATE": 2,
"ALIGN_INTERPOLATE": 3,
"ALIGN_NEXT_OLDER": 4,
"ALIGN_MIN": 10,
"ALIGN_MAX": 11,
"ALIGN_MEAN": 12,
"ALIGN_COUNT": 13,
"ALIGN_SUM": 14,
"ALIGN_STDDEV": 15,
"ALIGN_COUNT_TRUE": 16,
"ALIGN_COUNT_FALSE": 24,
"ALIGN_FRACTION_TRUE": 17,
"ALIGN_PERCENTILE_99": 18,
"ALIGN_PERCENTILE_95": 19,
"ALIGN_PERCENTILE_50": 20,
"ALIGN_PERCENTILE_05": 21,
"ALIGN_PERCENT_CHANGE": 23,
}
)Enum value maps for Aggregation_Aligner.
Aggregation_Reducer_name, Aggregation_Reducer_value
var (
Aggregation_Reducer_name = map[int32]string{
0: "REDUCE_NONE",
1: "REDUCE_MEAN",
2: "REDUCE_MIN",
3: "REDUCE_MAX",
4: "REDUCE_SUM",
5: "REDUCE_STDDEV",
6: "REDUCE_COUNT",
7: "REDUCE_COUNT_TRUE",
15: "REDUCE_COUNT_FALSE",
8: "REDUCE_FRACTION_TRUE",
9: "REDUCE_PERCENTILE_99",
10: "REDUCE_PERCENTILE_95",
11: "REDUCE_PERCENTILE_50",
12: "REDUCE_PERCENTILE_05",
}
Aggregation_Reducer_value = map[string]int32{
"REDUCE_NONE": 0,
"REDUCE_MEAN": 1,
"REDUCE_MIN": 2,
"REDUCE_MAX": 3,
"REDUCE_SUM": 4,
"REDUCE_STDDEV": 5,
"REDUCE_COUNT": 6,
"REDUCE_COUNT_TRUE": 7,
"REDUCE_COUNT_FALSE": 15,
"REDUCE_FRACTION_TRUE": 8,
"REDUCE_PERCENTILE_99": 9,
"REDUCE_PERCENTILE_95": 10,
"REDUCE_PERCENTILE_50": 11,
"REDUCE_PERCENTILE_05": 12,
}
)Enum value maps for Aggregation_Reducer.
PickTimeSeriesFilter_Method_name, PickTimeSeriesFilter_Method_value
var (
PickTimeSeriesFilter_Method_name = map[int32]string{
0: "METHOD_UNSPECIFIED",
1: "METHOD_MEAN",
2: "METHOD_MAX",
3: "METHOD_MIN",
4: "METHOD_SUM",
5: "METHOD_LATEST",
}
PickTimeSeriesFilter_Method_value = map[string]int32{
"METHOD_UNSPECIFIED": 0,
"METHOD_MEAN": 1,
"METHOD_MAX": 2,
"METHOD_MIN": 3,
"METHOD_SUM": 4,
"METHOD_LATEST": 5,
}
)Enum value maps for PickTimeSeriesFilter_Method.
PickTimeSeriesFilter_Direction_name, PickTimeSeriesFilter_Direction_value
var (
PickTimeSeriesFilter_Direction_name = map[int32]string{
0: "DIRECTION_UNSPECIFIED",
1: "TOP",
2: "BOTTOM",
}
PickTimeSeriesFilter_Direction_value = map[string]int32{
"DIRECTION_UNSPECIFIED": 0,
"TOP": 1,
"BOTTOM": 2,
}
)Enum value maps for PickTimeSeriesFilter_Direction.
StatisticalTimeSeriesFilter_Method_name, StatisticalTimeSeriesFilter_Method_value
var (
StatisticalTimeSeriesFilter_Method_name = map[int32]string{
0: "METHOD_UNSPECIFIED",
1: "METHOD_CLUSTER_OUTLIER",
}
StatisticalTimeSeriesFilter_Method_value = map[string]int32{
"METHOD_UNSPECIFIED": 0,
"METHOD_CLUSTER_OUTLIER": 1,
}
)Enum value maps for StatisticalTimeSeriesFilter_Method.
DashboardFilter_FilterType_name, DashboardFilter_FilterType_value
var (
DashboardFilter_FilterType_name = map[int32]string{
0: "FILTER_TYPE_UNSPECIFIED",
1: "RESOURCE_LABEL",
2: "METRIC_LABEL",
3: "USER_METADATA_LABEL",
4: "SYSTEM_METADATA_LABEL",
5: "GROUP",
}
DashboardFilter_FilterType_value = map[string]int32{
"FILTER_TYPE_UNSPECIFIED": 0,
"RESOURCE_LABEL": 1,
"METRIC_LABEL": 2,
"USER_METADATA_LABEL": 3,
"SYSTEM_METADATA_LABEL": 4,
"GROUP": 5,
}
)Enum value maps for DashboardFilter_FilterType.
SparkChartType_name, SparkChartType_value
var (
SparkChartType_name = map[int32]string{
0: "SPARK_CHART_TYPE_UNSPECIFIED",
1: "SPARK_LINE",
2: "SPARK_BAR",
}
SparkChartType_value = map[string]int32{
"SPARK_CHART_TYPE_UNSPECIFIED": 0,
"SPARK_LINE": 1,
"SPARK_BAR": 2,
}
)Enum value maps for SparkChartType.
Threshold_Color_name, Threshold_Color_value
var (
Threshold_Color_name = map[int32]string{
0: "COLOR_UNSPECIFIED",
4: "YELLOW",
6: "RED",
}
Threshold_Color_value = map[string]int32{
"COLOR_UNSPECIFIED": 0,
"YELLOW": 4,
"RED": 6,
}
)Enum value maps for Threshold_Color.
Threshold_Direction_name, Threshold_Direction_value
var (
Threshold_Direction_name = map[int32]string{
0: "DIRECTION_UNSPECIFIED",
1: "ABOVE",
2: "BELOW",
}
Threshold_Direction_value = map[string]int32{
"DIRECTION_UNSPECIFIED": 0,
"ABOVE": 1,
"BELOW": 2,
}
)Enum value maps for Threshold_Direction.
Threshold_TargetAxis_name, Threshold_TargetAxis_value
var (
Threshold_TargetAxis_name = map[int32]string{
0: "TARGET_AXIS_UNSPECIFIED",
1: "Y1",
2: "Y2",
}
Threshold_TargetAxis_value = map[string]int32{
"TARGET_AXIS_UNSPECIFIED": 0,
"Y1": 1,
"Y2": 2,
}
)Enum value maps for Threshold_TargetAxis.
Text_Format_name, Text_Format_value
var (
Text_Format_name = map[int32]string{
0: "FORMAT_UNSPECIFIED",
1: "MARKDOWN",
2: "RAW",
}
Text_Format_value = map[string]int32{
"FORMAT_UNSPECIFIED": 0,
"MARKDOWN": 1,
"RAW": 2,
}
)Enum value maps for Text_Format.
XyChart_DataSet_PlotType_name, XyChart_DataSet_PlotType_value
var (
XyChart_DataSet_PlotType_name = map[int32]string{
0: "PLOT_TYPE_UNSPECIFIED",
1: "LINE",
2: "STACKED_AREA",
3: "STACKED_BAR",
4: "HEATMAP",
}
XyChart_DataSet_PlotType_value = map[string]int32{
"PLOT_TYPE_UNSPECIFIED": 0,
"LINE": 1,
"STACKED_AREA": 2,
"STACKED_BAR": 3,
"HEATMAP": 4,
}
)Enum value maps for XyChart_DataSet_PlotType.
XyChart_DataSet_TargetAxis_name, XyChart_DataSet_TargetAxis_value
var (
XyChart_DataSet_TargetAxis_name = map[int32]string{
0: "TARGET_AXIS_UNSPECIFIED",
1: "Y1",
2: "Y2",
}
XyChart_DataSet_TargetAxis_value = map[string]int32{
"TARGET_AXIS_UNSPECIFIED": 0,
"Y1": 1,
"Y2": 2,
}
)Enum value maps for XyChart_DataSet_TargetAxis.
XyChart_Axis_Scale_name, XyChart_Axis_Scale_value
var (
XyChart_Axis_Scale_name = map[int32]string{
0: "SCALE_UNSPECIFIED",
1: "LINEAR",
2: "LOG10",
}
XyChart_Axis_Scale_value = map[string]int32{
"SCALE_UNSPECIFIED": 0,
"LINEAR": 1,
"LOG10": 2,
}
)Enum value maps for XyChart_Axis_Scale.
ChartOptions_Mode_name, ChartOptions_Mode_value
var (
ChartOptions_Mode_name = map[int32]string{
0: "MODE_UNSPECIFIED",
1: "COLOR",
2: "X_RAY",
3: "STATS",
}
ChartOptions_Mode_value = map[string]int32{
"MODE_UNSPECIFIED": 0,
"COLOR": 1,
"X_RAY": 2,
"STATS": 3,
}
)Enum value maps for ChartOptions_Mode.
File_google_monitoring_dashboard_v1_alertchart_proto
var File_google_monitoring_dashboard_v1_alertchart_proto protoreflect.FileDescriptorFile_google_monitoring_dashboard_v1_collapsible_group_proto
var File_google_monitoring_dashboard_v1_collapsible_group_proto protoreflect.FileDescriptorFile_google_monitoring_dashboard_v1_common_proto
var File_google_monitoring_dashboard_v1_common_proto protoreflect.FileDescriptorFile_google_monitoring_dashboard_v1_dashboard_filter_proto
var File_google_monitoring_dashboard_v1_dashboard_filter_proto protoreflect.FileDescriptorFile_google_monitoring_dashboard_v1_dashboard_proto
var File_google_monitoring_dashboard_v1_dashboard_proto protoreflect.FileDescriptorFile_google_monitoring_dashboard_v1_dashboards_service_proto
var File_google_monitoring_dashboard_v1_dashboards_service_proto protoreflect.FileDescriptorFile_google_monitoring_dashboard_v1_drilldowns_proto
var File_google_monitoring_dashboard_v1_drilldowns_proto protoreflect.FileDescriptorFile_google_monitoring_dashboard_v1_layouts_proto
var File_google_monitoring_dashboard_v1_layouts_proto protoreflect.FileDescriptorFile_google_monitoring_dashboard_v1_logs_panel_proto
var File_google_monitoring_dashboard_v1_logs_panel_proto protoreflect.FileDescriptorFile_google_monitoring_dashboard_v1_metrics_proto
var File_google_monitoring_dashboard_v1_metrics_proto protoreflect.FileDescriptorFile_google_monitoring_dashboard_v1_scorecard_proto
var File_google_monitoring_dashboard_v1_scorecard_proto protoreflect.FileDescriptorFile_google_monitoring_dashboard_v1_service_proto
var File_google_monitoring_dashboard_v1_service_proto protoreflect.FileDescriptorFile_google_monitoring_dashboard_v1_table_display_options_proto
var File_google_monitoring_dashboard_v1_table_display_options_proto protoreflect.FileDescriptorFile_google_monitoring_dashboard_v1_table_proto
var File_google_monitoring_dashboard_v1_table_proto protoreflect.FileDescriptorFile_google_monitoring_dashboard_v1_text_proto
var File_google_monitoring_dashboard_v1_text_proto protoreflect.FileDescriptorFile_google_monitoring_dashboard_v1_widget_proto
var File_google_monitoring_dashboard_v1_widget_proto protoreflect.FileDescriptorFile_google_monitoring_dashboard_v1_xychart_proto
var File_google_monitoring_dashboard_v1_xychart_proto protoreflect.FileDescriptorFunctions
func RegisterDashboardsServiceServer
func RegisterDashboardsServiceServer(s *grpc.Server, srv DashboardsServiceServer)Aggregation
type Aggregation struct {
AlignmentPeriod *durationpb.Duration `protobuf:"bytes,1,opt,name=alignment_period,json=alignmentPeriod,proto3" json:"alignment_period,omitempty"`
PerSeriesAligner Aggregation_Aligner "" /* 168 byte string literal not displayed */
CrossSeriesReducer Aggregation_Reducer "" /* 174 byte string literal not displayed */
GroupByFields []string `protobuf:"bytes,5,rep,name=group_by_fields,json=groupByFields,proto3" json:"group_by_fields,omitempty"`
}Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.
Alignment consists of applying the per_series_aligner operation
to each time series after its data has been divided into regular
alignment_period time intervals. This process takes all of the data
points in an alignment period, applies a mathematical transformation such as
averaging, minimum, maximum, delta, etc., and converts them into a single
data point per period.
Reduction is when the aligned and transformed time series can optionally be
combined, reducing the number of time series through similar mathematical
transformations. Reduction involves applying a cross_series_reducer to
all the time series, optionally sorting the time series into subsets with
group_by_fields, and applying the reducer to each subset.
The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation.
func (*Aggregation) Descriptor
func (*Aggregation) Descriptor() ([]byte, []int)Deprecated: Use Aggregation.ProtoReflect.Descriptor instead.
func (*Aggregation) GetAlignmentPeriod
func (x *Aggregation) GetAlignmentPeriod() *durationpb.Durationfunc (*Aggregation) GetCrossSeriesReducer
func (x *Aggregation) GetCrossSeriesReducer() Aggregation_Reducerfunc (*Aggregation) GetGroupByFields
func (x *Aggregation) GetGroupByFields() []stringfunc (*Aggregation) GetPerSeriesAligner
func (x *Aggregation) GetPerSeriesAligner() Aggregation_Alignerfunc (*Aggregation) ProtoMessage
func (*Aggregation) ProtoMessage()func (*Aggregation) ProtoReflect
func (x *Aggregation) ProtoReflect() protoreflect.Messagefunc (*Aggregation) Reset
func (x *Aggregation) Reset()func (*Aggregation) String
func (x *Aggregation) String() stringAggregation_Aligner
type Aggregation_Aligner int32The Aligner specifies the operation that will be applied to the data
points in each alignment period in a time series. Except for
ALIGN_NONE, which specifies that no operation be applied, each alignment
operation replaces the set of data values in each alignment period with
a single value: the result of applying the operation to the data values.
An aligned time series has a single data value at the end of each
alignment_period.
An alignment operation can change the data type of the values, too. For
example, if you apply a counting operation to boolean values, the data
value_type in the original time series is BOOLEAN, but the value_type
in the aligned result is INT64.
Aggregation_ALIGN_NONE, Aggregation_ALIGN_DELTA, Aggregation_ALIGN_RATE, Aggregation_ALIGN_INTERPOLATE, Aggregation_ALIGN_NEXT_OLDER, Aggregation_ALIGN_MIN, Aggregation_ALIGN_MAX, Aggregation_ALIGN_MEAN, Aggregation_ALIGN_COUNT, Aggregation_ALIGN_SUM, Aggregation_ALIGN_STDDEV, Aggregation_ALIGN_COUNT_TRUE, Aggregation_ALIGN_COUNT_FALSE, Aggregation_ALIGN_FRACTION_TRUE, Aggregation_ALIGN_PERCENTILE_99, Aggregation_ALIGN_PERCENTILE_95, Aggregation_ALIGN_PERCENTILE_50, Aggregation_ALIGN_PERCENTILE_05, Aggregation_ALIGN_PERCENT_CHANGE
const (
// No alignment. Raw data is returned. Not valid if cross-series reduction
// is requested. The `value_type` of the result is the same as the
// `value_type` of the input.
Aggregation_ALIGN_NONE Aggregation_Aligner = 0
// Align and convert to
// [DELTA][google.api.MetricDescriptor.MetricKind.DELTA].
// The output is `delta = y1 - y0`.
//
// This alignment is valid for
// [CUMULATIVE][google.api.MetricDescriptor.MetricKind.CUMULATIVE] and
// `DELTA` metrics. If the selected alignment period results in periods
// with no data, then the aligned value for such a period is created by
// interpolation. The `value_type` of the aligned result is the same as
// the `value_type` of the input.
Aggregation_ALIGN_DELTA Aggregation_Aligner = 1
// Align and convert to a rate. The result is computed as
// `rate = (y1 - y0)/(t1 - t0)`, or "delta over time".
// Think of this aligner as providing the slope of the line that passes
// through the value at the start and at the end of the `alignment_period`.
//
// This aligner is valid for `CUMULATIVE`
// and `DELTA` metrics with numeric values. If the selected alignment
// period results in periods with no data, then the aligned value for
// such a period is created by interpolation. The output is a `GAUGE`
// metric with `value_type` `DOUBLE`.
//
// If, by "rate", you mean "percentage change", see the
// `ALIGN_PERCENT_CHANGE` aligner instead.
Aggregation_ALIGN_RATE Aggregation_Aligner = 2
// Align by interpolating between adjacent points around the alignment
// period boundary. This aligner is valid for `GAUGE` metrics with
// numeric values. The `value_type` of the aligned result is the same as the
// `value_type` of the input.
Aggregation_ALIGN_INTERPOLATE Aggregation_Aligner = 3
// Align by moving the most recent data point before the end of the
// alignment period to the boundary at the end of the alignment
// period. This aligner is valid for `GAUGE` metrics. The `value_type` of
// the aligned result is the same as the `value_type` of the input.
Aggregation_ALIGN_NEXT_OLDER Aggregation_Aligner = 4
// Align the time series by returning the minimum value in each alignment
// period. This aligner is valid for `GAUGE` and `DELTA` metrics with
// numeric values. The `value_type` of the aligned result is the same as
// the `value_type` of the input.
Aggregation_ALIGN_MIN Aggregation_Aligner = 10
// Align the time series by returning the maximum value in each alignment
// period. This aligner is valid for `GAUGE` and `DELTA` metrics with
// numeric values. The `value_type` of the aligned result is the same as
// the `value_type` of the input.
Aggregation_ALIGN_MAX Aggregation_Aligner = 11
// Align the time series by returning the mean value in each alignment
// period. This aligner is valid for `GAUGE` and `DELTA` metrics with
// numeric values. The `value_type` of the aligned result is `DOUBLE`.
Aggregation_ALIGN_MEAN Aggregation_Aligner = 12
// Align the time series by returning the number of values in each alignment
// period. This aligner is valid for `GAUGE` and `DELTA` metrics with
// numeric or Boolean values. The `value_type` of the aligned result is
// `INT64`.
Aggregation_ALIGN_COUNT Aggregation_Aligner = 13
// Align the time series by returning the sum of the values in each
// alignment period. This aligner is valid for `GAUGE` and `DELTA`
// metrics with numeric and distribution values. The `value_type` of the
// aligned result is the same as the `value_type` of the input.
Aggregation_ALIGN_SUM Aggregation_Aligner = 14
// Align the time series by returning the standard deviation of the values
// in each alignment period. This aligner is valid for `GAUGE` and
// `DELTA` metrics with numeric values. The `value_type` of the output is
// `DOUBLE`.
Aggregation_ALIGN_STDDEV Aggregation_Aligner = 15
// Align the time series by returning the number of `True` values in
// each alignment period. This aligner is valid for `GAUGE` metrics with
// Boolean values. The `value_type` of the output is `INT64`.
Aggregation_ALIGN_COUNT_TRUE Aggregation_Aligner = 16
// Align the time series by returning the number of `False` values in
// each alignment period. This aligner is valid for `GAUGE` metrics with
// Boolean values. The `value_type` of the output is `INT64`.
Aggregation_ALIGN_COUNT_FALSE Aggregation_Aligner = 24
// Align the time series by returning the ratio of the number of `True`
// values to the total number of values in each alignment period. This
// aligner is valid for `GAUGE` metrics with Boolean values. The output
// value is in the range [0.0, 1.0] and has `value_type` `DOUBLE`.
Aggregation_ALIGN_FRACTION_TRUE Aggregation_Aligner = 17
// Align the time series by using [percentile
// aggregation](https://en.wikipedia.org/wiki/Percentile). The resulting
// data point in each alignment period is the 99th percentile of all data
// points in the period. This aligner is valid for `GAUGE` and `DELTA`
// metrics with distribution values. The output is a `GAUGE` metric with
// `value_type` `DOUBLE`.
Aggregation_ALIGN_PERCENTILE_99 Aggregation_Aligner = 18
// Align the time series by using [percentile
// aggregation](https://en.wikipedia.org/wiki/Percentile). The resulting
// data point in each alignment period is the 95th percentile of all data
// points in the period. This aligner is valid for `GAUGE` and `DELTA`
// metrics with distribution values. The output is a `GAUGE` metric with
// `value_type` `DOUBLE`.
Aggregation_ALIGN_PERCENTILE_95 Aggregation_Aligner = 19
// Align the time series by using [percentile
// aggregation](https://en.wikipedia.org/wiki/Percentile). The resulting
// data point in each alignment period is the 50th percentile of all data
// points in the period. This aligner is valid for `GAUGE` and `DELTA`
// metrics with distribution values. The output is a `GAUGE` metric with
// `value_type` `DOUBLE`.
Aggregation_ALIGN_PERCENTILE_50 Aggregation_Aligner = 20
// Align the time series by using [percentile
// aggregation](https://en.wikipedia.org/wiki/Percentile). The resulting
// data point in each alignment period is the 5th percentile of all data
// points in the period. This aligner is valid for `GAUGE` and `DELTA`
// metrics with distribution values. The output is a `GAUGE` metric with
// `value_type` `DOUBLE`.
Aggregation_ALIGN_PERCENTILE_05 Aggregation_Aligner = 21
// Align and convert to a percentage change. This aligner is valid for
// `GAUGE` and `DELTA` metrics with numeric values. This alignment returns
// `((current - previous)/previous) * 100`, where the value of `previous` is
// determined based on the `alignment_period`.
//
// If the values of `current` and `previous` are both 0, then the returned
// value is 0. If only `previous` is 0, the returned value is infinity.
//
// A 10-minute moving mean is computed at each point of the alignment period
// prior to the above calculation to smooth the metric and prevent false
// positives from very short-lived spikes. The moving mean is only
// applicable for data whose values are `>= 0`. Any values `< 0`="" are="" treated="" as="" a="" missing="" datapoint,="" and="" are="" ignored.="" while="" `delta`="" metrics="" are="" accepted="" by="" this="" alignment,="" special="" care="" should="" be="" taken="" that="" the="" values="" for="" the="" metric="" will="" always="" be="" positive.="" the="" output="" is="" a="" `gauge`="" metric="" with="" `value_type`="" `double`.="" aggregation_align_percent_change="">Aggregation_Aligner = 23
)func (Aggregation_Aligner) Descriptor
func (Aggregation_Aligner) Descriptor() protoreflect.EnumDescriptorfunc (Aggregation_Aligner) Enum
func (x Aggregation_Aligner) Enum() *Aggregation_Alignerfunc (Aggregation_Aligner) EnumDescriptor
func (Aggregation_Aligner) EnumDescriptor() ([]byte, []int)Deprecated: Use Aggregation_Aligner.Descriptor instead.
func (Aggregation_Aligner) Number
func (x Aggregation_Aligner) Number() protoreflect.EnumNumberfunc (Aggregation_Aligner) String
func (x Aggregation_Aligner) String() stringfunc (Aggregation_Aligner) Type
func (Aggregation_Aligner) Type() protoreflect.EnumTypeAggregation_Reducer
type Aggregation_Reducer int32A Reducer operation describes how to aggregate data points from multiple time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.
Aggregation_REDUCE_NONE, Aggregation_REDUCE_MEAN, Aggregation_REDUCE_MIN, Aggregation_REDUCE_MAX, Aggregation_REDUCE_SUM, Aggregation_REDUCE_STDDEV, Aggregation_REDUCE_COUNT, Aggregation_REDUCE_COUNT_TRUE, Aggregation_REDUCE_COUNT_FALSE, Aggregation_REDUCE_FRACTION_TRUE, Aggregation_REDUCE_PERCENTILE_99, Aggregation_REDUCE_PERCENTILE_95, Aggregation_REDUCE_PERCENTILE_50, Aggregation_REDUCE_PERCENTILE_05
const (
// No cross-time series reduction. The output of the `Aligner` is
// returned.
Aggregation_REDUCE_NONE Aggregation_Reducer = 0
// Reduce by computing the mean value across time series for each
// alignment period. This reducer is valid for
// [DELTA][google.api.MetricDescriptor.MetricKind.DELTA] and
// [GAUGE][google.api.MetricDescriptor.MetricKind.GAUGE] metrics with
// numeric or distribution values. The `value_type` of the output is
// [DOUBLE][google.api.MetricDescriptor.ValueType.DOUBLE].
Aggregation_REDUCE_MEAN Aggregation_Reducer = 1
// Reduce by computing the minimum value across time series for each
// alignment period. This reducer is valid for `DELTA` and `GAUGE` metrics
// with numeric values. The `value_type` of the output is the same as the
// `value_type` of the input.
Aggregation_REDUCE_MIN Aggregation_Reducer = 2
// Reduce by computing the maximum value across time series for each
// alignment period. This reducer is valid for `DELTA` and `GAUGE` metrics
// with numeric values. The `value_type` of the output is the same as the
// `value_type` of the input.
Aggregation_REDUCE_MAX Aggregation_Reducer = 3
// Reduce by computing the sum across time series for each
// alignment period. This reducer is valid for `DELTA` and `GAUGE` metrics
// with numeric and distribution values. The `value_type` of the output is
// the same as the `value_type` of the input.
Aggregation_REDUCE_SUM Aggregation_Reducer = 4
// Reduce by computing the standard deviation across time series
// for each alignment period. This reducer is valid for `DELTA` and
// `GAUGE` metrics with numeric or distribution values. The `value_type`
// of the output is `DOUBLE`.
Aggregation_REDUCE_STDDEV Aggregation_Reducer = 5
// Reduce by computing the number of data points across time series
// for each alignment period. This reducer is valid for `DELTA` and
// `GAUGE` metrics of numeric, Boolean, distribution, and string
// `value_type`. The `value_type` of the output is `INT64`.
Aggregation_REDUCE_COUNT Aggregation_Reducer = 6
// Reduce by computing the number of `True`-valued data points across time
// series for each alignment period. This reducer is valid for `DELTA` and
// `GAUGE` metrics of Boolean `value_type`. The `value_type` of the output
// is `INT64`.
Aggregation_REDUCE_COUNT_TRUE Aggregation_Reducer = 7
// Reduce by computing the number of `False`-valued data points across time
// series for each alignment period. This reducer is valid for `DELTA` and
// `GAUGE` metrics of Boolean `value_type`. The `value_type` of the output
// is `INT64`.
Aggregation_REDUCE_COUNT_FALSE Aggregation_Reducer = 15
// Reduce by computing the ratio of the number of `True`-valued data points
// to the total number of data points for each alignment period. This
// reducer is valid for `DELTA` and `GAUGE` metrics of Boolean `value_type`.
// The output value is in the range [0.0, 1.0] and has `value_type`
// `DOUBLE`.
Aggregation_REDUCE_FRACTION_TRUE Aggregation_Reducer = 8
// Reduce by computing the [99th
// percentile](https://en.wikipedia.org/wiki/Percentile) of data points
// across time series for each alignment period. This reducer is valid for
// `GAUGE` and `DELTA` metrics of numeric and distribution type. The value
// of the output is `DOUBLE`.
Aggregation_REDUCE_PERCENTILE_99 Aggregation_Reducer = 9
// Reduce by computing the [95th
// percentile](https://en.wikipedia.org/wiki/Percentile) of data points
// across time series for each alignment period. This reducer is valid for
// `GAUGE` and `DELTA` metrics of numeric and distribution type. The value
// of the output is `DOUBLE`.
Aggregation_REDUCE_PERCENTILE_95 Aggregation_Reducer = 10
// Reduce by computing the [50th
// percentile](https://en.wikipedia.org/wiki/Percentile) of data points
// across time series for each alignment period. This reducer is valid for
// `GAUGE` and `DELTA` metrics of numeric and distribution type. The value
// of the output is `DOUBLE`.
Aggregation_REDUCE_PERCENTILE_50 Aggregation_Reducer = 11
// Reduce by computing the [5th
// percentile](https://en.wikipedia.org/wiki/Percentile) of data points
// across time series for each alignment period. This reducer is valid for
// `GAUGE` and `DELTA` metrics of numeric and distribution type. The value
// of the output is `DOUBLE`.
Aggregation_REDUCE_PERCENTILE_05 Aggregation_Reducer = 12
)func (Aggregation_Reducer) Descriptor
func (Aggregation_Reducer) Descriptor() protoreflect.EnumDescriptorfunc (Aggregation_Reducer) Enum
func (x Aggregation_Reducer) Enum() *Aggregation_Reducerfunc (Aggregation_Reducer) EnumDescriptor
func (Aggregation_Reducer) EnumDescriptor() ([]byte, []int)Deprecated: Use Aggregation_Reducer.Descriptor instead.
func (Aggregation_Reducer) Number
func (x Aggregation_Reducer) Number() protoreflect.EnumNumberfunc (Aggregation_Reducer) String
func (x Aggregation_Reducer) String() stringfunc (Aggregation_Reducer) Type
func (Aggregation_Reducer) Type() protoreflect.EnumTypeAlertChart
type AlertChart struct {
// Required. The resource name of the alert policy. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}A chart that displays alert policy data.
func (*AlertChart) Descriptor
func (*AlertChart) Descriptor() ([]byte, []int)Deprecated: Use AlertChart.ProtoReflect.Descriptor instead.
func (*AlertChart) GetName
func (x *AlertChart) GetName() stringfunc (*AlertChart) ProtoMessage
func (*AlertChart) ProtoMessage()func (*AlertChart) ProtoReflect
func (x *AlertChart) ProtoReflect() protoreflect.Messagefunc (*AlertChart) Reset
func (x *AlertChart) Reset()func (*AlertChart) String
func (x *AlertChart) String() stringChartOptions
type ChartOptions struct {
// The chart mode.
Mode ChartOptions_Mode `protobuf:"varint,1,opt,name=mode,proto3,enum=google.monitoring.dashboard.v1.ChartOptions_Mode" json:"mode,omitempty"`
// contains filtered or unexported fields
}Options to control visual rendering of a chart.
func (*ChartOptions) Descriptor
func (*ChartOptions) Descriptor() ([]byte, []int)Deprecated: Use ChartOptions.ProtoReflect.Descriptor instead.
func (*ChartOptions) GetMode
func (x *ChartOptions) GetMode() ChartOptions_Modefunc (*ChartOptions) ProtoMessage
func (*ChartOptions) ProtoMessage()func (*ChartOptions) ProtoReflect
func (x *ChartOptions) ProtoReflect() protoreflect.Messagefunc (*ChartOptions) Reset
func (x *ChartOptions) Reset()func (*ChartOptions) String
func (x *ChartOptions) String() stringChartOptions_Mode
type ChartOptions_Mode int32Chart mode options.
ChartOptions_MODE_UNSPECIFIED, ChartOptions_COLOR, ChartOptions_X_RAY, ChartOptions_STATS
const (
// Mode is unspecified. The view will default to `COLOR`.
ChartOptions_MODE_UNSPECIFIED ChartOptions_Mode = 0
// The chart distinguishes data series using different color. Line
// colors may get reused when there are many lines in the chart.
ChartOptions_COLOR ChartOptions_Mode = 1
// The chart uses the Stackdriver x-ray mode, in which each
// data set is plotted using the same semi-transparent color.
ChartOptions_X_RAY ChartOptions_Mode = 2
// The chart displays statistics such as average, median, 95th percentile,
// and more.
ChartOptions_STATS ChartOptions_Mode = 3
)func (ChartOptions_Mode) Descriptor
func (ChartOptions_Mode) Descriptor() protoreflect.EnumDescriptorfunc (ChartOptions_Mode) Enum
func (x ChartOptions_Mode) Enum() *ChartOptions_Modefunc (ChartOptions_Mode) EnumDescriptor
func (ChartOptions_Mode) EnumDescriptor() ([]byte, []int)Deprecated: Use ChartOptions_Mode.Descriptor instead.
func (ChartOptions_Mode) Number
func (x ChartOptions_Mode) Number() protoreflect.EnumNumberfunc (ChartOptions_Mode) String
func (x ChartOptions_Mode) String() stringfunc (ChartOptions_Mode) Type
func (ChartOptions_Mode) Type() protoreflect.EnumTypeCollapsibleGroup
type CollapsibleGroup struct {
// The collapsed state of the widget on first page load.
Collapsed bool `protobuf:"varint,1,opt,name=collapsed,proto3" json:"collapsed,omitempty"`
// contains filtered or unexported fields
}A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets.
func (*CollapsibleGroup) Descriptor
func (*CollapsibleGroup) Descriptor() ([]byte, []int)Deprecated: Use CollapsibleGroup.ProtoReflect.Descriptor instead.
func (*CollapsibleGroup) GetCollapsed
func (x *CollapsibleGroup) GetCollapsed() boolfunc (*CollapsibleGroup) ProtoMessage
func (*CollapsibleGroup) ProtoMessage()func (*CollapsibleGroup) ProtoReflect
func (x *CollapsibleGroup) ProtoReflect() protoreflect.Messagefunc (*CollapsibleGroup) Reset
func (x *CollapsibleGroup) Reset()func (*CollapsibleGroup) String
func (x *CollapsibleGroup) String() stringColumnLayout
type ColumnLayout struct {
// The columns of content to display.
Columns []*ColumnLayout_Column `protobuf:"bytes,1,rep,name=columns,proto3" json:"columns,omitempty"`
// contains filtered or unexported fields
}A simplified layout that divides the available space into vertical columns and arranges a set of widgets vertically in each column.
func (*ColumnLayout) Descriptor
func (*ColumnLayout) Descriptor() ([]byte, []int)Deprecated: Use ColumnLayout.ProtoReflect.Descriptor instead.
func (*ColumnLayout) GetColumns
func (x *ColumnLayout) GetColumns() []*ColumnLayout_Columnfunc (*ColumnLayout) ProtoMessage
func (*ColumnLayout) ProtoMessage()func (*ColumnLayout) ProtoReflect
func (x *ColumnLayout) ProtoReflect() protoreflect.Messagefunc (*ColumnLayout) Reset
func (x *ColumnLayout) Reset()func (*ColumnLayout) String
func (x *ColumnLayout) String() stringColumnLayout_Column
type ColumnLayout_Column struct {
// The relative weight of this column. The column weight is used to adjust
// the width of columns on the screen (relative to peers).
// Greater the weight, greater the width of the column on the screen.
// If omitted, a value of 1 is used while rendering.
Weight int64 `protobuf:"varint,1,opt,name=weight,proto3" json:"weight,omitempty"`
// The display widgets arranged vertically in this column.
Widgets []*Widget `protobuf:"bytes,2,rep,name=widgets,proto3" json:"widgets,omitempty"`
// contains filtered or unexported fields
}Defines the layout properties and content for a column.
func (*ColumnLayout_Column) Descriptor
func (*ColumnLayout_Column) Descriptor() ([]byte, []int)Deprecated: Use ColumnLayout_Column.ProtoReflect.Descriptor instead.
func (*ColumnLayout_Column) GetWeight
func (x *ColumnLayout_Column) GetWeight() int64func (*ColumnLayout_Column) GetWidgets
func (x *ColumnLayout_Column) GetWidgets() []*Widgetfunc (*ColumnLayout_Column) ProtoMessage
func (*ColumnLayout_Column) ProtoMessage()func (*ColumnLayout_Column) ProtoReflect
func (x *ColumnLayout_Column) ProtoReflect() protoreflect.Messagefunc (*ColumnLayout_Column) Reset
func (x *ColumnLayout_Column) Reset()func (*ColumnLayout_Column) String
func (x *ColumnLayout_Column) String() stringCreateDashboardRequest
type CreateDashboardRequest struct {
// Required. The project on which to execute the request. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]
//
// The `[PROJECT_ID_OR_NUMBER]` must match the dashboard resource name.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The initial dashboard specification.
Dashboard *Dashboard `protobuf:"bytes,2,opt,name=dashboard,proto3" json:"dashboard,omitempty"`
// If set, validate the request and preview the review, but do not actually
// save it.
ValidateOnly bool `protobuf:"varint,3,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
// contains filtered or unexported fields
}The CreateDashboard request.
func (*CreateDashboardRequest) Descriptor
func (*CreateDashboardRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateDashboardRequest.ProtoReflect.Descriptor instead.
func (*CreateDashboardRequest) GetDashboard
func (x *CreateDashboardRequest) GetDashboard() *Dashboardfunc (*CreateDashboardRequest) GetParent
func (x *CreateDashboardRequest) GetParent() stringfunc (*CreateDashboardRequest) GetValidateOnly
func (x *CreateDashboardRequest) GetValidateOnly() boolfunc (*CreateDashboardRequest) ProtoMessage
func (*CreateDashboardRequest) ProtoMessage()func (*CreateDashboardRequest) ProtoReflect
func (x *CreateDashboardRequest) ProtoReflect() protoreflect.Messagefunc (*CreateDashboardRequest) Reset
func (x *CreateDashboardRequest) Reset()func (*CreateDashboardRequest) String
func (x *CreateDashboardRequest) String() stringDashboard
type Dashboard struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
Etag string `protobuf:"bytes,4,opt,name=etag,proto3" json:"etag,omitempty"`
Layout isDashboard_Layout `protobuf_oneof:"layout"`
DashboardFilters []*DashboardFilter `protobuf:"bytes,11,rep,name=dashboard_filters,json=dashboardFilters,proto3" json:"dashboard_filters,omitempty"`
Labels map[string]string "" /* 154 byte string literal not displayed */
}A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.
func (*Dashboard) Descriptor
Deprecated: Use Dashboard.ProtoReflect.Descriptor instead.
func (*Dashboard) GetColumnLayout
func (x *Dashboard) GetColumnLayout() *ColumnLayoutfunc (*Dashboard) GetDashboardFilters
func (x *Dashboard) GetDashboardFilters() []*DashboardFilterfunc (*Dashboard) GetDisplayName
func (*Dashboard) GetEtag
func (*Dashboard) GetGridLayout
func (x *Dashboard) GetGridLayout() *GridLayoutfunc (*Dashboard) GetLabels
func (*Dashboard) GetLayout
func (m *Dashboard) GetLayout() isDashboard_Layoutfunc (*Dashboard) GetMosaicLayout
func (x *Dashboard) GetMosaicLayout() *MosaicLayoutfunc (*Dashboard) GetName
func (*Dashboard) GetRowLayout
func (*Dashboard) ProtoMessage
func (*Dashboard) ProtoMessage()func (*Dashboard) ProtoReflect
func (x *Dashboard) ProtoReflect() protoreflect.Messagefunc (*Dashboard) Reset
func (x *Dashboard) Reset()func (*Dashboard) String
DashboardFilter
type DashboardFilter struct {
LabelKey string `protobuf:"bytes,1,opt,name=label_key,json=labelKey,proto3" json:"label_key,omitempty"`
TemplateVariable string `protobuf:"bytes,3,opt,name=template_variable,json=templateVariable,proto3" json:"template_variable,omitempty"`
DefaultValue isDashboardFilter_DefaultValue `protobuf_oneof:"default_value"`
FilterType DashboardFilter_FilterType "" /* 155 byte string literal not displayed */
}A filter to reduce the amount of data charted in relevant widgets.
func (*DashboardFilter) Descriptor
func (*DashboardFilter) Descriptor() ([]byte, []int)Deprecated: Use DashboardFilter.ProtoReflect.Descriptor instead.
func (*DashboardFilter) GetDefaultValue
func (m *DashboardFilter) GetDefaultValue() isDashboardFilter_DefaultValuefunc (*DashboardFilter) GetFilterType
func (x *DashboardFilter) GetFilterType() DashboardFilter_FilterTypefunc (*DashboardFilter) GetLabelKey
func (x *DashboardFilter) GetLabelKey() stringfunc (*DashboardFilter) GetStringValue
func (x *DashboardFilter) GetStringValue() stringfunc (*DashboardFilter) GetTemplateVariable
func (x *DashboardFilter) GetTemplateVariable() stringfunc (*DashboardFilter) ProtoMessage
func (*DashboardFilter) ProtoMessage()func (*DashboardFilter) ProtoReflect
func (x *DashboardFilter) ProtoReflect() protoreflect.Messagefunc (*DashboardFilter) Reset
func (x *DashboardFilter) Reset()func (*DashboardFilter) String
func (x *DashboardFilter) String() stringDashboardFilter_FilterType
type DashboardFilter_FilterType int32The type for the dashboard filter
DashboardFilter_FILTER_TYPE_UNSPECIFIED, DashboardFilter_RESOURCE_LABEL, DashboardFilter_METRIC_LABEL, DashboardFilter_USER_METADATA_LABEL, DashboardFilter_SYSTEM_METADATA_LABEL, DashboardFilter_GROUP
const (
// Filter type is unspecified. This is not valid in a well-formed request.
DashboardFilter_FILTER_TYPE_UNSPECIFIED DashboardFilter_FilterType = 0
// Filter on a resource label value
DashboardFilter_RESOURCE_LABEL DashboardFilter_FilterType = 1
// Filter on a metrics label value
DashboardFilter_METRIC_LABEL DashboardFilter_FilterType = 2
// Filter on a user metadata label value
DashboardFilter_USER_METADATA_LABEL DashboardFilter_FilterType = 3
// Filter on a system metadata label value
DashboardFilter_SYSTEM_METADATA_LABEL DashboardFilter_FilterType = 4
// Filter on a group id
DashboardFilter_GROUP DashboardFilter_FilterType = 5
)func (DashboardFilter_FilterType) Descriptor
func (DashboardFilter_FilterType) Descriptor() protoreflect.EnumDescriptorfunc (DashboardFilter_FilterType) Enum
func (x DashboardFilter_FilterType) Enum() *DashboardFilter_FilterTypefunc (DashboardFilter_FilterType) EnumDescriptor
func (DashboardFilter_FilterType) EnumDescriptor() ([]byte, []int)Deprecated: Use DashboardFilter_FilterType.Descriptor instead.
func (DashboardFilter_FilterType) Number
func (x DashboardFilter_FilterType) Number() protoreflect.EnumNumberfunc (DashboardFilter_FilterType) String
func (x DashboardFilter_FilterType) String() stringfunc (DashboardFilter_FilterType) Type
func (DashboardFilter_FilterType) Type() protoreflect.EnumTypeDashboardFilter_StringValue
type DashboardFilter_StringValue struct {
// A variable-length string value.
StringValue string `protobuf:"bytes,4,opt,name=string_value,json=stringValue,proto3,oneof"`
}Dashboard_ColumnLayout
type Dashboard_ColumnLayout struct {
// The content is divided into equally spaced columns and the widgets are
// arranged vertically.
ColumnLayout *ColumnLayout `protobuf:"bytes,9,opt,name=column_layout,json=columnLayout,proto3,oneof"`
}Dashboard_GridLayout
type Dashboard_GridLayout struct {
// Content is arranged with a basic layout that re-flows a simple list of
// informational elements like widgets or tiles.
GridLayout *GridLayout `protobuf:"bytes,5,opt,name=grid_layout,json=gridLayout,proto3,oneof"`
}Dashboard_MosaicLayout
type Dashboard_MosaicLayout struct {
// The content is arranged as a grid of tiles, with each content widget
// occupying one or more grid blocks.
MosaicLayout *MosaicLayout `protobuf:"bytes,6,opt,name=mosaic_layout,json=mosaicLayout,proto3,oneof"`
}Dashboard_RowLayout
type Dashboard_RowLayout struct {
// The content is divided into equally spaced rows and the widgets are
// arranged horizontally.
RowLayout *RowLayout `protobuf:"bytes,8,opt,name=row_layout,json=rowLayout,proto3,oneof"`
}DashboardsServiceClient
type DashboardsServiceClient interface {
// Creates a new custom dashboard. For examples on how you can use this API to create dashboards, see [Managing dashboards by API](https://cloud.google.com/monitoring/dashboards/api-dashboard).
// This method requires the `monitoring.dashboards.create` permission on the specified project. For more information about permissions, see [Cloud Identity and Access Management](https://cloud.google.com/iam).
CreateDashboard(ctx context.Context, in *CreateDashboardRequest, opts ...grpc.CallOption) (*Dashboard, error)
// Lists the existing dashboards.
//
// This method requires the `monitoring.dashboards.list` permission
// on the specified project. For more information, see
// [Cloud Identity and Access Management](https://cloud.google.com/iam).
ListDashboards(ctx context.Context, in *ListDashboardsRequest, opts ...grpc.CallOption) (*ListDashboardsResponse, error)
// Fetches a specific dashboard.
//
// This method requires the `monitoring.dashboards.get` permission
// on the specified dashboard. For more information, see
// [Cloud Identity and Access Management](https://cloud.google.com/iam).
GetDashboard(ctx context.Context, in *GetDashboardRequest, opts ...grpc.CallOption) (*Dashboard, error)
// Deletes an existing custom dashboard.
//
// This method requires the `monitoring.dashboards.delete` permission
// on the specified dashboard. For more information, see
// [Cloud Identity and Access Management](https://cloud.google.com/iam).
DeleteDashboard(ctx context.Context, in *DeleteDashboardRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
// Replaces an existing custom dashboard with a new definition.
//
// This method requires the `monitoring.dashboards.update` permission
// on the specified dashboard. For more information, see
// [Cloud Identity and Access Management](https://cloud.google.com/iam).
UpdateDashboard(ctx context.Context, in *UpdateDashboardRequest, opts ...grpc.CallOption) (*Dashboard, error)
}DashboardsServiceClient is the client API for DashboardsService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewDashboardsServiceClient
func NewDashboardsServiceClient(cc grpc.ClientConnInterface) DashboardsServiceClientDashboardsServiceServer
type DashboardsServiceServer interface {
// Creates a new custom dashboard. For examples on how you can use this API to create dashboards, see [Managing dashboards by API](https://cloud.google.com/monitoring/dashboards/api-dashboard).
// This method requires the `monitoring.dashboards.create` permission on the specified project. For more information about permissions, see [Cloud Identity and Access Management](https://cloud.google.com/iam).
CreateDashboard(context.Context, *CreateDashboardRequest) (*Dashboard, error)
// Lists the existing dashboards.
//
// This method requires the `monitoring.dashboards.list` permission
// on the specified project. For more information, see
// [Cloud Identity and Access Management](https://cloud.google.com/iam).
ListDashboards(context.Context, *ListDashboardsRequest) (*ListDashboardsResponse, error)
// Fetches a specific dashboard.
//
// This method requires the `monitoring.dashboards.get` permission
// on the specified dashboard. For more information, see
// [Cloud Identity and Access Management](https://cloud.google.com/iam).
GetDashboard(context.Context, *GetDashboardRequest) (*Dashboard, error)
// Deletes an existing custom dashboard.
//
// This method requires the `monitoring.dashboards.delete` permission
// on the specified dashboard. For more information, see
// [Cloud Identity and Access Management](https://cloud.google.com/iam).
DeleteDashboard(context.Context, *DeleteDashboardRequest) (*emptypb.Empty, error)
// Replaces an existing custom dashboard with a new definition.
//
// This method requires the `monitoring.dashboards.update` permission
// on the specified dashboard. For more information, see
// [Cloud Identity and Access Management](https://cloud.google.com/iam).
UpdateDashboard(context.Context, *UpdateDashboardRequest) (*Dashboard, error)
}DashboardsServiceServer is the server API for DashboardsService service.
DeleteDashboardRequest
type DeleteDashboardRequest struct {
// Required. The resource name of the Dashboard. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID]
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}The DeleteDashboard request.
func (*DeleteDashboardRequest) Descriptor
func (*DeleteDashboardRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteDashboardRequest.ProtoReflect.Descriptor instead.
func (*DeleteDashboardRequest) GetName
func (x *DeleteDashboardRequest) GetName() stringfunc (*DeleteDashboardRequest) ProtoMessage
func (*DeleteDashboardRequest) ProtoMessage()func (*DeleteDashboardRequest) ProtoReflect
func (x *DeleteDashboardRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteDashboardRequest) Reset
func (x *DeleteDashboardRequest) Reset()func (*DeleteDashboardRequest) String
func (x *DeleteDashboardRequest) String() stringGetDashboardRequest
type GetDashboardRequest struct {
// Required. The resource name of the Dashboard. The format is one of:
//
// - `dashboards/[DASHBOARD_ID]` (for system dashboards)
// - `projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID]`
// (for custom dashboards).
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}The GetDashboard request.
func (*GetDashboardRequest) Descriptor
func (*GetDashboardRequest) Descriptor() ([]byte, []int)Deprecated: Use GetDashboardRequest.ProtoReflect.Descriptor instead.
func (*GetDashboardRequest) GetName
func (x *GetDashboardRequest) GetName() stringfunc (*GetDashboardRequest) ProtoMessage
func (*GetDashboardRequest) ProtoMessage()func (*GetDashboardRequest) ProtoReflect
func (x *GetDashboardRequest) ProtoReflect() protoreflect.Messagefunc (*GetDashboardRequest) Reset
func (x *GetDashboardRequest) Reset()func (*GetDashboardRequest) String
func (x *GetDashboardRequest) String() stringGridLayout
type GridLayout struct {
// The number of columns into which the view's width is divided. If omitted
// or set to zero, a system default will be used while rendering.
Columns int64 `protobuf:"varint,1,opt,name=columns,proto3" json:"columns,omitempty"`
// The informational elements that are arranged into the columns row-first.
Widgets []*Widget `protobuf:"bytes,2,rep,name=widgets,proto3" json:"widgets,omitempty"`
// contains filtered or unexported fields
}A basic layout divides the available space into vertical columns of equal width and arranges a list of widgets using a row-first strategy.
func (*GridLayout) Descriptor
func (*GridLayout) Descriptor() ([]byte, []int)Deprecated: Use GridLayout.ProtoReflect.Descriptor instead.
func (*GridLayout) GetColumns
func (x *GridLayout) GetColumns() int64func (*GridLayout) GetWidgets
func (x *GridLayout) GetWidgets() []*Widgetfunc (*GridLayout) ProtoMessage
func (*GridLayout) ProtoMessage()func (*GridLayout) ProtoReflect
func (x *GridLayout) ProtoReflect() protoreflect.Messagefunc (*GridLayout) Reset
func (x *GridLayout) Reset()func (*GridLayout) String
func (x *GridLayout) String() stringListDashboardsRequest
type ListDashboardsRequest struct {
// Required. The scope of the dashboards to list. The format is:
//
// projects/[PROJECT_ID_OR_NUMBER]
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// A positive number that is the maximum number of results to return.
// If unspecified, a default of 1000 is used.
PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
// If this field is not empty then it must contain the `nextPageToken` value
// returned by a previous call to this method. Using this field causes the
// method to return additional results from the previous method call.
PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
// contains filtered or unexported fields
}The ListDashboards request.
func (*ListDashboardsRequest) Descriptor
func (*ListDashboardsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListDashboardsRequest.ProtoReflect.Descriptor instead.
func (*ListDashboardsRequest) GetPageSize
func (x *ListDashboardsRequest) GetPageSize() int32func (*ListDashboardsRequest) GetPageToken
func (x *ListDashboardsRequest) GetPageToken() stringfunc (*ListDashboardsRequest) GetParent
func (x *ListDashboardsRequest) GetParent() stringfunc (*ListDashboardsRequest) ProtoMessage
func (*ListDashboardsRequest) ProtoMessage()func (*ListDashboardsRequest) ProtoReflect
func (x *ListDashboardsRequest) ProtoReflect() protoreflect.Messagefunc (*ListDashboardsRequest) Reset
func (x *ListDashboardsRequest) Reset()func (*ListDashboardsRequest) String
func (x *ListDashboardsRequest) String() stringListDashboardsResponse
type ListDashboardsResponse struct {
// The list of requested dashboards.
Dashboards []*Dashboard `protobuf:"bytes,1,rep,name=dashboards,proto3" json:"dashboards,omitempty"`
// 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 `page_token` in the next call to this method.
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
// contains filtered or unexported fields
}The ListDashboards request.
func (*ListDashboardsResponse) Descriptor
func (*ListDashboardsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListDashboardsResponse.ProtoReflect.Descriptor instead.
func (*ListDashboardsResponse) GetDashboards
func (x *ListDashboardsResponse) GetDashboards() []*Dashboardfunc (*ListDashboardsResponse) GetNextPageToken
func (x *ListDashboardsResponse) GetNextPageToken() stringfunc (*ListDashboardsResponse) ProtoMessage
func (*ListDashboardsResponse) ProtoMessage()func (*ListDashboardsResponse) ProtoReflect
func (x *ListDashboardsResponse) ProtoReflect() protoreflect.Messagefunc (*ListDashboardsResponse) Reset
func (x *ListDashboardsResponse) Reset()func (*ListDashboardsResponse) String
func (x *ListDashboardsResponse) String() stringLogsPanel
type LogsPanel struct {
// A filter that chooses which log entries to return. See [Advanced Logs
// Queries](https://cloud.google.com/logging/docs/view/advanced-queries).
// Only log entries that match the filter are returned. An empty filter
// matches all log entries.
Filter string `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
// The names of logging resources to collect logs for. Currently only projects
// are supported. If empty, the widget will default to the host project.
ResourceNames []string `protobuf:"bytes,2,rep,name=resource_names,json=resourceNames,proto3" json:"resource_names,omitempty"`
// contains filtered or unexported fields
}A widget that displays a stream of log.
func (*LogsPanel) Descriptor
Deprecated: Use LogsPanel.ProtoReflect.Descriptor instead.
func (*LogsPanel) GetFilter
func (*LogsPanel) GetResourceNames
func (*LogsPanel) ProtoMessage
func (*LogsPanel) ProtoMessage()func (*LogsPanel) ProtoReflect
func (x *LogsPanel) ProtoReflect() protoreflect.Messagefunc (*LogsPanel) Reset
func (x *LogsPanel) Reset()func (*LogsPanel) String
MosaicLayout
type MosaicLayout struct {
// The number of columns in the mosaic grid. The number of columns must be
// between 1 and 12, inclusive.
Columns int32 `protobuf:"varint,1,opt,name=columns,proto3" json:"columns,omitempty"`
// The tiles to display.
Tiles []*MosaicLayout_Tile `protobuf:"bytes,3,rep,name=tiles,proto3" json:"tiles,omitempty"`
// contains filtered or unexported fields
}A mosaic layout divides the available space into a grid of blocks, and
overlays the grid with tiles. Unlike GridLayout, tiles may span multiple
grid blocks and can be placed at arbitrary locations in the grid.
func (*MosaicLayout) Descriptor
func (*MosaicLayout) Descriptor() ([]byte, []int)Deprecated: Use MosaicLayout.ProtoReflect.Descriptor instead.
func (*MosaicLayout) GetColumns
func (x *MosaicLayout) GetColumns() int32func (*MosaicLayout) GetTiles
func (x *MosaicLayout) GetTiles() []*MosaicLayout_Tilefunc (*MosaicLayout) ProtoMessage
func (*MosaicLayout) ProtoMessage()func (*MosaicLayout) ProtoReflect
func (x *MosaicLayout) ProtoReflect() protoreflect.Messagefunc (*MosaicLayout) Reset
func (x *MosaicLayout) Reset()func (*MosaicLayout) String
func (x *MosaicLayout) String() stringMosaicLayout_Tile
type MosaicLayout_Tile struct {
// The zero-indexed position of the tile in grid blocks relative to the
// left edge of the grid. Tiles must be contained within the specified
// number of columns. `x_pos` cannot be negative.
XPos int32 `protobuf:"varint,1,opt,name=x_pos,json=xPos,proto3" json:"x_pos,omitempty"`
// The zero-indexed position of the tile in grid blocks relative to the
// top edge of the grid. `y_pos` cannot be negative.
YPos int32 `protobuf:"varint,2,opt,name=y_pos,json=yPos,proto3" json:"y_pos,omitempty"`
// The width of the tile, measured in grid blocks. Tiles must have a
// minimum width of 1.
Width int32 `protobuf:"varint,3,opt,name=width,proto3" json:"width,omitempty"`
// The height of the tile, measured in grid blocks. Tiles must have a
// minimum height of 1.
Height int32 `protobuf:"varint,4,opt,name=height,proto3" json:"height,omitempty"`
// The informational widget contained in the tile. For example an `XyChart`.
Widget *Widget `protobuf:"bytes,5,opt,name=widget,proto3" json:"widget,omitempty"`
// contains filtered or unexported fields
}A single tile in the mosaic. The placement and size of the tile are configurable.
func (*MosaicLayout_Tile) Descriptor
func (*MosaicLayout_Tile) Descriptor() ([]byte, []int)Deprecated: Use MosaicLayout_Tile.ProtoReflect.Descriptor instead.
func (*MosaicLayout_Tile) GetHeight
func (x *MosaicLayout_Tile) GetHeight() int32func (*MosaicLayout_Tile) GetWidget
func (x *MosaicLayout_Tile) GetWidget() *Widgetfunc (*MosaicLayout_Tile) GetWidth
func (x *MosaicLayout_Tile) GetWidth() int32func (*MosaicLayout_Tile) GetXPos
func (x *MosaicLayout_Tile) GetXPos() int32func (*MosaicLayout_Tile) GetYPos
func (x *MosaicLayout_Tile) GetYPos() int32func (*MosaicLayout_Tile) ProtoMessage
func (*MosaicLayout_Tile) ProtoMessage()func (*MosaicLayout_Tile) ProtoReflect
func (x *MosaicLayout_Tile) ProtoReflect() protoreflect.Messagefunc (*MosaicLayout_Tile) Reset
func (x *MosaicLayout_Tile) Reset()func (*MosaicLayout_Tile) String
func (x *MosaicLayout_Tile) String() stringPickTimeSeriesFilter
type PickTimeSeriesFilter struct {
RankingMethod PickTimeSeriesFilter_Method "" /* 165 byte string literal not displayed */
NumTimeSeries int32 `protobuf:"varint,2,opt,name=num_time_series,json=numTimeSeries,proto3" json:"num_time_series,omitempty"`
Direction PickTimeSeriesFilter_Direction "" /* 139 byte string literal not displayed */
}Describes a ranking-based time series filter. Each input time series is
ranked with an aligner. The filter will allow up to num_time_series time
series to pass through it, selecting them based on the relative ranking.
For example, if ranking_method is METHOD_MEAN,direction is BOTTOM,
and num_time_series is 3, then the 3 times series with the lowest mean
values will pass through the filter.
func (*PickTimeSeriesFilter) Descriptor
func (*PickTimeSeriesFilter) Descriptor() ([]byte, []int)Deprecated: Use PickTimeSeriesFilter.ProtoReflect.Descriptor instead.
func (*PickTimeSeriesFilter) GetDirection
func (x *PickTimeSeriesFilter) GetDirection() PickTimeSeriesFilter_Directionfunc (*PickTimeSeriesFilter) GetNumTimeSeries
func (x *PickTimeSeriesFilter) GetNumTimeSeries() int32func (*PickTimeSeriesFilter) GetRankingMethod
func (x *PickTimeSeriesFilter) GetRankingMethod() PickTimeSeriesFilter_Methodfunc (*PickTimeSeriesFilter) ProtoMessage
func (*PickTimeSeriesFilter) ProtoMessage()func (*PickTimeSeriesFilter) ProtoReflect
func (x *PickTimeSeriesFilter) ProtoReflect() protoreflect.Messagefunc (*PickTimeSeriesFilter) Reset
func (x *PickTimeSeriesFilter) Reset()func (*PickTimeSeriesFilter) String
func (x *PickTimeSeriesFilter) String() stringPickTimeSeriesFilter_Direction
type PickTimeSeriesFilter_Direction int32Describes the ranking directions.
PickTimeSeriesFilter_DIRECTION_UNSPECIFIED, PickTimeSeriesFilter_TOP, PickTimeSeriesFilter_BOTTOM
const (
// Not allowed. You must specify a different `Direction` if you specify a
// `PickTimeSeriesFilter`.
PickTimeSeriesFilter_DIRECTION_UNSPECIFIED PickTimeSeriesFilter_Direction = 0
// Pass the highest `num_time_series` ranking inputs.
PickTimeSeriesFilter_TOP PickTimeSeriesFilter_Direction = 1
// Pass the lowest `num_time_series` ranking inputs.
PickTimeSeriesFilter_BOTTOM PickTimeSeriesFilter_Direction = 2
)func (PickTimeSeriesFilter_Direction) Descriptor
func (PickTimeSeriesFilter_Direction) Descriptor() protoreflect.EnumDescriptorfunc (PickTimeSeriesFilter_Direction) Enum
func (x PickTimeSeriesFilter_Direction) Enum() *PickTimeSeriesFilter_Directionfunc (PickTimeSeriesFilter_Direction) EnumDescriptor
func (PickTimeSeriesFilter_Direction) EnumDescriptor() ([]byte, []int)Deprecated: Use PickTimeSeriesFilter_Direction.Descriptor instead.
func (PickTimeSeriesFilter_Direction) Number
func (x PickTimeSeriesFilter_Direction) Number() protoreflect.EnumNumberfunc (PickTimeSeriesFilter_Direction) String
func (x PickTimeSeriesFilter_Direction) String() stringfunc (PickTimeSeriesFilter_Direction) Type
func (PickTimeSeriesFilter_Direction) Type() protoreflect.EnumTypePickTimeSeriesFilter_Method
type PickTimeSeriesFilter_Method int32The value reducers that can be applied to a PickTimeSeriesFilter.
PickTimeSeriesFilter_METHOD_UNSPECIFIED, PickTimeSeriesFilter_METHOD_MEAN, PickTimeSeriesFilter_METHOD_MAX, PickTimeSeriesFilter_METHOD_MIN, PickTimeSeriesFilter_METHOD_SUM, PickTimeSeriesFilter_METHOD_LATEST
const (
// Not allowed. You must specify a different `Method` if you specify a
// `PickTimeSeriesFilter`.
PickTimeSeriesFilter_METHOD_UNSPECIFIED PickTimeSeriesFilter_Method = 0
// Select the mean of all values.
PickTimeSeriesFilter_METHOD_MEAN PickTimeSeriesFilter_Method = 1
// Select the maximum value.
PickTimeSeriesFilter_METHOD_MAX PickTimeSeriesFilter_Method = 2
// Select the minimum value.
PickTimeSeriesFilter_METHOD_MIN PickTimeSeriesFilter_Method = 3
// Compute the sum of all values.
PickTimeSeriesFilter_METHOD_SUM PickTimeSeriesFilter_Method = 4
// Select the most recent value.
PickTimeSeriesFilter_METHOD_LATEST PickTimeSeriesFilter_Method = 5
)func (PickTimeSeriesFilter_Method) Descriptor
func (PickTimeSeriesFilter_Method) Descriptor() protoreflect.EnumDescriptorfunc (PickTimeSeriesFilter_Method) Enum
func (x PickTimeSeriesFilter_Method) Enum() *PickTimeSeriesFilter_Methodfunc (PickTimeSeriesFilter_Method) EnumDescriptor
func (PickTimeSeriesFilter_Method) EnumDescriptor() ([]byte, []int)Deprecated: Use PickTimeSeriesFilter_Method.Descriptor instead.
func (PickTimeSeriesFilter_Method) Number
func (x PickTimeSeriesFilter_Method) Number() protoreflect.EnumNumberfunc (PickTimeSeriesFilter_Method) String
func (x PickTimeSeriesFilter_Method) String() stringfunc (PickTimeSeriesFilter_Method) Type
func (PickTimeSeriesFilter_Method) Type() protoreflect.EnumTypeRowLayout
type RowLayout struct {
// The rows of content to display.
Rows []*RowLayout_Row `protobuf:"bytes,1,rep,name=rows,proto3" json:"rows,omitempty"`
// contains filtered or unexported fields
}A simplified layout that divides the available space into rows and arranges a set of widgets horizontally in each row.
func (*RowLayout) Descriptor
Deprecated: Use RowLayout.ProtoReflect.Descriptor instead.
func (*RowLayout) GetRows
func (x *RowLayout) GetRows() []*RowLayout_Rowfunc (*RowLayout) ProtoMessage
func (*RowLayout) ProtoMessage()func (*RowLayout) ProtoReflect
func (x *RowLayout) ProtoReflect() protoreflect.Messagefunc (*RowLayout) Reset
func (x *RowLayout) Reset()func (*RowLayout) String
RowLayout_Row
type RowLayout_Row struct {
// The relative weight of this row. The row weight is used to adjust the
// height of rows on the screen (relative to peers). Greater the weight,
// greater the height of the row on the screen. If omitted, a value
// of 1 is used while rendering.
Weight int64 `protobuf:"varint,1,opt,name=weight,proto3" json:"weight,omitempty"`
// The display widgets arranged horizontally in this row.
Widgets []*Widget `protobuf:"bytes,2,rep,name=widgets,proto3" json:"widgets,omitempty"`
// contains filtered or unexported fields
}Defines the layout properties and content for a row.
func (*RowLayout_Row) Descriptor
func (*RowLayout_Row) Descriptor() ([]byte, []int)Deprecated: Use RowLayout_Row.ProtoReflect.Descriptor instead.
func (*RowLayout_Row) GetWeight
func (x *RowLayout_Row) GetWeight() int64func (*RowLayout_Row) GetWidgets
func (x *RowLayout_Row) GetWidgets() []*Widgetfunc (*RowLayout_Row) ProtoMessage
func (*RowLayout_Row) ProtoMessage()func (*RowLayout_Row) ProtoReflect
func (x *RowLayout_Row) ProtoReflect() protoreflect.Messagefunc (*RowLayout_Row) Reset
func (x *RowLayout_Row) Reset()func (*RowLayout_Row) String
func (x *RowLayout_Row) String() stringScorecard
type Scorecard struct {
// Required. Fields for querying time series data from the
// Stackdriver metrics API.
TimeSeriesQuery *TimeSeriesQuery `protobuf:"bytes,1,opt,name=time_series_query,json=timeSeriesQuery,proto3" json:"time_series_query,omitempty"`
// Defines the optional additional chart shown on the scorecard. If
// neither is included - then a default scorecard is shown.
//
// Types that are assignable to DataView:
//
// *Scorecard_GaugeView_
// *Scorecard_SparkChartView_
DataView isScorecard_DataView `protobuf_oneof:"data_view"`
// 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.
Thresholds []*Threshold `protobuf:"bytes,6,rep,name=thresholds,proto3" json:"thresholds,omitempty"`
// contains filtered or unexported fields
}A widget showing the latest value of a metric, and how this value relates to one or more thresholds.
func (*Scorecard) Descriptor
Deprecated: Use Scorecard.ProtoReflect.Descriptor instead.
func (*Scorecard) GetDataView
func (m *Scorecard) GetDataView() isScorecard_DataViewfunc (*Scorecard) GetGaugeView
func (x *Scorecard) GetGaugeView() *Scorecard_GaugeViewfunc (*Scorecard) GetSparkChartView
func (x *Scorecard) GetSparkChartView() *Scorecard_SparkChartViewfunc (*Scorecard) GetThresholds
func (*Scorecard) GetTimeSeriesQuery
func (x *Scorecard) GetTimeSeriesQuery() *TimeSeriesQueryfunc (*Scorecard) ProtoMessage
func (*Scorecard) ProtoMessage()func (*Scorecard) ProtoReflect
func (x *Scorecard) ProtoReflect() protoreflect.Messagefunc (*Scorecard) Reset
func (x *Scorecard) Reset()func (*Scorecard) String
Scorecard_GaugeView
type Scorecard_GaugeView struct {
// The lower bound for this gauge chart. The value of the chart should
// always be greater than or equal to this.
LowerBound float64 `protobuf:"fixed64,1,opt,name=lower_bound,json=lowerBound,proto3" json:"lower_bound,omitempty"`
// The upper bound for this gauge chart. The value of the chart should
// always be less than or equal to this.
UpperBound float64 `protobuf:"fixed64,2,opt,name=upper_bound,json=upperBound,proto3" json:"upper_bound,omitempty"`
// contains filtered or unexported fields
}A gauge chart shows where the current value sits within a pre-defined range. The upper and lower bounds should define the possible range of values for the scorecard's query (inclusive).
func (*Scorecard_GaugeView) Descriptor
func (*Scorecard_GaugeView) Descriptor() ([]byte, []int)Deprecated: Use Scorecard_GaugeView.ProtoReflect.Descriptor instead.
func (*Scorecard_GaugeView) GetLowerBound
func (x *Scorecard_GaugeView) GetLowerBound() float64func (*Scorecard_GaugeView) GetUpperBound
func (x *Scorecard_GaugeView) GetUpperBound() float64func (*Scorecard_GaugeView) ProtoMessage
func (*Scorecard_GaugeView) ProtoMessage()func (*Scorecard_GaugeView) ProtoReflect
func (x *Scorecard_GaugeView) ProtoReflect() protoreflect.Messagefunc (*Scorecard_GaugeView) Reset
func (x *Scorecard_GaugeView) Reset()func (*Scorecard_GaugeView) String
func (x *Scorecard_GaugeView) String() stringScorecard_GaugeView_
type Scorecard_GaugeView_ struct {
// Will cause the scorecard to show a gauge chart.
GaugeView *Scorecard_GaugeView `protobuf:"bytes,4,opt,name=gauge_view,json=gaugeView,proto3,oneof"`
}Scorecard_SparkChartView
type Scorecard_SparkChartView struct {
SparkChartType SparkChartType "" /* 157 byte string literal not displayed */
MinAlignmentPeriod *durationpb.Duration `protobuf:"bytes,2,opt,name=min_alignment_period,json=minAlignmentPeriod,proto3" json:"min_alignment_period,omitempty"`
}A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries.
func (*Scorecard_SparkChartView) Descriptor
func (*Scorecard_SparkChartView) Descriptor() ([]byte, []int)Deprecated: Use Scorecard_SparkChartView.ProtoReflect.Descriptor instead.
func (*Scorecard_SparkChartView) GetMinAlignmentPeriod
func (x *Scorecard_SparkChartView) GetMinAlignmentPeriod() *durationpb.Durationfunc (*Scorecard_SparkChartView) GetSparkChartType
func (x *Scorecard_SparkChartView) GetSparkChartType() SparkChartTypefunc (*Scorecard_SparkChartView) ProtoMessage
func (*Scorecard_SparkChartView) ProtoMessage()func (*Scorecard_SparkChartView) ProtoReflect
func (x *Scorecard_SparkChartView) ProtoReflect() protoreflect.Messagefunc (*Scorecard_SparkChartView) Reset
func (x *Scorecard_SparkChartView) Reset()func (*Scorecard_SparkChartView) String
func (x *Scorecard_SparkChartView) String() stringScorecard_SparkChartView_
type Scorecard_SparkChartView_ struct {
// Will cause the scorecard to show a spark chart.
SparkChartView *Scorecard_SparkChartView `protobuf:"bytes,5,opt,name=spark_chart_view,json=sparkChartView,proto3,oneof"`
}SparkChartType
type SparkChartType int32Defines the possible types of spark chart supported by the Scorecard.
SparkChartType_SPARK_CHART_TYPE_UNSPECIFIED, SparkChartType_SPARK_LINE, SparkChartType_SPARK_BAR
const (
// Not allowed in well-formed requests.
SparkChartType_SPARK_CHART_TYPE_UNSPECIFIED SparkChartType = 0
// The sparkline will be rendered as a small line chart.
SparkChartType_SPARK_LINE SparkChartType = 1
// The sparkbar will be rendered as a small bar chart.
SparkChartType_SPARK_BAR SparkChartType = 2
)func (SparkChartType) Descriptor
func (SparkChartType) Descriptor() protoreflect.EnumDescriptorfunc (SparkChartType) Enum
func (x SparkChartType) Enum() *SparkChartTypefunc (SparkChartType) EnumDescriptor
func (SparkChartType) EnumDescriptor() ([]byte, []int)Deprecated: Use SparkChartType.Descriptor instead.
func (SparkChartType) Number
func (x SparkChartType) Number() protoreflect.EnumNumberfunc (SparkChartType) String
func (x SparkChartType) String() stringfunc (SparkChartType) Type
func (SparkChartType) Type() protoreflect.EnumTypeStatisticalTimeSeriesFilter
type StatisticalTimeSeriesFilter struct {
RankingMethod StatisticalTimeSeriesFilter_Method "" /* 172 byte string literal not displayed */
NumTimeSeries int32 `protobuf:"varint,2,opt,name=num_time_series,json=numTimeSeries,proto3" json:"num_time_series,omitempty"`
}A filter that ranks streams based on their statistical relation to other streams in a request. Note: This field is deprecated and completely ignored by the API.
func (*StatisticalTimeSeriesFilter) Descriptor
func (*StatisticalTimeSeriesFilter) Descriptor() ([]byte, []int)Deprecated: Use StatisticalTimeSeriesFilter.ProtoReflect.Descriptor instead.
func (*StatisticalTimeSeriesFilter) GetNumTimeSeries
func (x *StatisticalTimeSeriesFilter) GetNumTimeSeries() int32func (*StatisticalTimeSeriesFilter) GetRankingMethod
func (x *StatisticalTimeSeriesFilter) GetRankingMethod() StatisticalTimeSeriesFilter_Methodfunc (*StatisticalTimeSeriesFilter) ProtoMessage
func (*StatisticalTimeSeriesFilter) ProtoMessage()func (*StatisticalTimeSeriesFilter) ProtoReflect
func (x *StatisticalTimeSeriesFilter) ProtoReflect() protoreflect.Messagefunc (*StatisticalTimeSeriesFilter) Reset
func (x *StatisticalTimeSeriesFilter) Reset()func (*StatisticalTimeSeriesFilter) String
func (x *StatisticalTimeSeriesFilter) String() stringStatisticalTimeSeriesFilter_Method
type StatisticalTimeSeriesFilter_Method int32The filter methods that can be applied to a stream.
StatisticalTimeSeriesFilter_METHOD_UNSPECIFIED, StatisticalTimeSeriesFilter_METHOD_CLUSTER_OUTLIER
const (
// Not allowed in well-formed requests.
StatisticalTimeSeriesFilter_METHOD_UNSPECIFIED StatisticalTimeSeriesFilter_Method = 0
// Compute the outlier score of each stream.
StatisticalTimeSeriesFilter_METHOD_CLUSTER_OUTLIER StatisticalTimeSeriesFilter_Method = 1
)func (StatisticalTimeSeriesFilter_Method) Descriptor
func (StatisticalTimeSeriesFilter_Method) Descriptor() protoreflect.EnumDescriptorfunc (StatisticalTimeSeriesFilter_Method) Enum
func (x StatisticalTimeSeriesFilter_Method) Enum() *StatisticalTimeSeriesFilter_Methodfunc (StatisticalTimeSeriesFilter_Method) EnumDescriptor
func (StatisticalTimeSeriesFilter_Method) EnumDescriptor() ([]byte, []int)Deprecated: Use StatisticalTimeSeriesFilter_Method.Descriptor instead.
func (StatisticalTimeSeriesFilter_Method) Number
func (x StatisticalTimeSeriesFilter_Method) Number() protoreflect.EnumNumberfunc (StatisticalTimeSeriesFilter_Method) String
func (x StatisticalTimeSeriesFilter_Method) String() stringfunc (StatisticalTimeSeriesFilter_Method) Type
func (StatisticalTimeSeriesFilter_Method) Type() protoreflect.EnumTypeTableDisplayOptions
type TableDisplayOptions struct {
// Optional. This field is unused and has been replaced by
// TimeSeriesTable.column_settings
//
// Deprecated: Do not use.
ShownColumns []string `protobuf:"bytes,1,rep,name=shown_columns,json=shownColumns,proto3" json:"shown_columns,omitempty"`
// contains filtered or unexported fields
}Table display options that can be reused.
func (*TableDisplayOptions) Descriptor
func (*TableDisplayOptions) Descriptor() ([]byte, []int)Deprecated: Use TableDisplayOptions.ProtoReflect.Descriptor instead.
func (*TableDisplayOptions) GetShownColumns
func (x *TableDisplayOptions) GetShownColumns() []stringDeprecated: Do not use.
func (*TableDisplayOptions) ProtoMessage
func (*TableDisplayOptions) ProtoMessage()func (*TableDisplayOptions) ProtoReflect
func (x *TableDisplayOptions) ProtoReflect() protoreflect.Messagefunc (*TableDisplayOptions) Reset
func (x *TableDisplayOptions) Reset()func (*TableDisplayOptions) String
func (x *TableDisplayOptions) String() stringText
type Text struct {
// The text content to be displayed.
Content string `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
// How the text content is formatted.
Format Text_Format `protobuf:"varint,2,opt,name=format,proto3,enum=google.monitoring.dashboard.v1.Text_Format" json:"format,omitempty"`
// contains filtered or unexported fields
}A widget that displays textual content.
func (*Text) Descriptor
Deprecated: Use Text.ProtoReflect.Descriptor instead.
func (*Text) GetContent
func (*Text) GetFormat
func (x *Text) GetFormat() Text_Formatfunc (*Text) ProtoMessage
func (*Text) ProtoMessage()func (*Text) ProtoReflect
func (x *Text) ProtoReflect() protoreflect.Messagefunc (*Text) Reset
func (x *Text) Reset()func (*Text) String
Text_Format
type Text_Format int32The format type of the text content.
Text_FORMAT_UNSPECIFIED, Text_MARKDOWN, Text_RAW
const (
// Format is unspecified. Defaults to MARKDOWN.
Text_FORMAT_UNSPECIFIED Text_Format = 0
// The text contains Markdown formatting.
Text_MARKDOWN Text_Format = 1
// The text contains no special formatting.
Text_RAW Text_Format = 2
)func (Text_Format) Descriptor
func (Text_Format) Descriptor() protoreflect.EnumDescriptorfunc (Text_Format) Enum
func (x