1# Copyright 2020 Google LLC
2#
3# Licensed under the Apache License, Version 2.0 (the "License");
4# you may not use this file except in compliance with the License.
5# You may obtain a copy of the License at
6#
7# http://www.apache.org/licenses/LICENSE-2.0
8#
9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14
15apiVersion: apiextensions.k8s.io/v1
16kind: CustomResourceDefinition
17metadata:
18 annotations:
19 cnrm.cloud.google.com/version: 1.106.0
20 creationTimestamp: null
21 labels:
22 cnrm.cloud.google.com/dcl2crd: "true"
23 cnrm.cloud.google.com/managed-by-kcc: "true"
24 cnrm.cloud.google.com/stability-level: stable
25 cnrm.cloud.google.com/system: "true"
26 name: monitoringdashboards.monitoring.cnrm.cloud.google.com
27spec:
28 group: monitoring.cnrm.cloud.google.com
29 names:
30 categories:
31 - gcp
32 kind: MonitoringDashboard
33 plural: monitoringdashboards
34 shortNames:
35 - gcpmonitoringdashboard
36 - gcpmonitoringdashboards
37 singular: monitoringdashboard
38 scope: Namespaced
39 versions:
40 - additionalPrinterColumns:
41 - jsonPath: .metadata.creationTimestamp
42 name: Age
43 type: date
44 - description: When 'True', the most recent reconcile of the resource succeeded
45 jsonPath: .status.conditions[?(@.type=='Ready')].status
46 name: Ready
47 type: string
48 - description: The reason for the value in 'Ready'
49 jsonPath: .status.conditions[?(@.type=='Ready')].reason
50 name: Status
51 type: string
52 - description: The last transition time for the value in 'Status'
53 jsonPath: .status.conditions[?(@.type=='Ready')].lastTransitionTime
54 name: Status Age
55 type: date
56 name: v1beta1
57 schema:
58 openAPIV3Schema:
59 properties:
60 apiVersion:
61 description: 'apiVersion defines the versioned schema of this representation
62 of an object. Servers should convert recognized schemas to the latest
63 internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources'
64 type: string
65 kind:
66 description: 'kind is a string value representing the REST resource this
67 object represents. Servers may infer this from the endpoint the client
68 submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds'
69 type: string
70 metadata:
71 type: object
72 spec:
73 properties:
74 columnLayout:
75 description: The content is divided into equally spaced columns and
76 the widgets are arranged vertically.
77 properties:
78 columns:
79 description: The columns of content to display.
80 items:
81 properties:
82 weight:
83 description: The relative weight of this column. The column
84 weight is used to adjust the width of columns on the screen
85 (relative to peers). Greater the weight, greater the width
86 of the column on the screen. If omitted, a value of 1
87 is used while rendering.
88 format: int64
89 type: integer
90 widgets:
91 description: The display widgets arranged vertically in
92 this column.
93 items:
94 properties:
95 blank:
96 description: A blank space.
97 type: object
98 x-kubernetes-preserve-unknown-fields: true
99 logsPanel:
100 properties:
101 filter:
102 description: A filter that chooses which log entries
103 to return. See [Advanced Logs Queries](https://cloud.google.com/logging/docs/view/advanced-queries).
104 Only log entries that match the filter are returned.
105 An empty filter matches all log entries.
106 type: string
107 resourceNames:
108 items:
109 oneOf:
110 - not:
111 required:
112 - external
113 required:
114 - name
115 - not:
116 anyOf:
117 - required:
118 - name
119 - required:
120 - namespace
121 required:
122 - external
123 properties:
124 external:
125 description: 'Allowed value: The Google
126 Cloud resource name of a `Project` resource
127 (format: `projects/{{name}}`).'
128 type: string
129 name:
130 description: 'Name of the referent. More
131 info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
132 type: string
133 namespace:
134 description: 'Namespace of the referent.
135 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
136 type: string
137 type: object
138 type: array
139 type: object
140 scorecard:
141 description: A scorecard summarizing time series data.
142 properties:
143 gaugeView:
144 description: Will cause the scorecard to show
145 a gauge chart.
146 properties:
147 lowerBound:
148 description: The lower bound for this gauge
149 chart. The value of the chart should always
150 be greater than or equal to this.
151 format: double
152 type: number
153 upperBound:
154 description: The upper bound for this gauge
155 chart. The value of the chart should always
156 be less than or equal to this.
157 format: double
158 type: number
159 type: object
160 sparkChartView:
161 description: Will cause the scorecard to show
162 a spark chart.
163 properties:
164 minAlignmentPeriod:
165 description: The lower bound on data point
166 frequency in the chart implemented by specifying
167 the minimum alignment period to use in a
168 time series query. For example, if the data
169 is published once every 10 minutes it would
170 not make sense to fetch and align data at
171 one minute intervals. This field is optional
172 and exists only as a hint.
173 type: string
174 sparkChartType:
175 description: 'Required. The type of sparkchart
176 to show in this chartView. Possible values:
177 SPARK_CHART_TYPE_UNSPECIFIED, SPARK_LINE,
178 SPARK_BAR'
179 type: string
180 required:
181 - sparkChartType
182 type: object
183 thresholds:
184 description: 'The thresholds used to determine
185 the state of the scorecard given the time series''
186 current value. For an actual value x, the scorecard
187 is in a danger state if x is less than or equal
188 to a danger threshold that triggers below, or
189 greater than or equal to a danger threshold
190 that triggers above. Similarly, if x is above/below
191 a warning threshold that triggers above/below,
192 then the scorecard is in a warning state - unless
193 x also puts it in a danger state. (Danger trumps
194 warning.) As an example, consider a scorecard
195 with the following four thresholds: { value:
196 90, category: ''DANGER'', trigger: ''ABOVE'',
197 },: { value: 70, category: ''WARNING'', trigger:
198 ''ABOVE'', }, { value: 10, category: ''DANGER'', trigger:
199 ''BELOW'', }, { value: 20, category: ''WARNING'', trigger:
200 ''BELOW'', } Then: values less than or equal
201 to 10 would put the scorecard in a DANGER state,
202 values greater than 10 but less than or equal
203 to 20 a WARNING state, values strictly between
204 20 and 70 an OK state, values greater than or
205 equal to 70 but less than 90 a WARNING state,
206 and values greater than or equal to 90 a DANGER
207 state.'
208 items:
209 properties:
210 color:
211 description: 'The state color for this threshold.
212 Color is not allowed in a XyChart. Possible
213 values: COLOR_UNSPECIFIED, GREY, BLUE,
214 GREEN, YELLOW, ORANGE, RED'
215 type: string
216 direction:
217 description: 'The direction for the current
218 threshold. Direction is not allowed in
219 a XyChart. Possible values: DIRECTION_UNSPECIFIED,
220 ABOVE, BELOW'
221 type: string
222 label:
223 description: A label for the threshold.
224 type: string
225 value:
226 description: The value of the threshold.
227 The value should be defined in the native
228 scale of the metric.
229 format: double
230 type: number
231 type: object
232 type: array
233 timeSeriesQuery:
234 description: Required. Fields for querying time
235 series data from the Stackdriver metrics API.
236 properties:
237 timeSeriesFilter:
238 description: Filter parameters to fetch time
239 series.
240 properties:
241 aggregation:
242 description: By default, the raw time
243 series data is returned. Use this field
244 to combine multiple time series for
245 different views of the data.
246 properties:
247 alignmentPeriod:
248 description: The `alignment_period`
249 specifies a time interval, in seconds,
250 that is used to divide the data
251 in all the [time series][google.monitoring.v3.TimeSeries]
252 into consistent blocks of time.
253 This will be done before the per-series
254 aligner can be applied to the data. The
255 value must be at least 60 seconds.
256 If a per-series aligner other than
257 `ALIGN_NONE` is specified, this
258 field is required or an error is
259 returned. If no per-series aligner
260 is specified, or the aligner `ALIGN_NONE`
261 is specified, then this field is
262 ignored.
263 type: string
264 crossSeriesReducer:
265 description: 'The reduction operation
266 to be used to combine time series
267 into a single time series, where
268 the value of each data point in
269 the resulting series is a function
270 of all the already aligned values
271 in the input time series. Not all
272 reducer operations can be applied
273 to all time series. The valid choices
274 depend on the `metric_kind` and
275 the `value_type` of the original
276 time series. Reduction can yield
277 a time series with a different `metric_kind`
278 or `value_type` than the input time
279 series. Time series data must first
280 be aligned (see `per_series_aligner`)
281 in order to perform cross-time series
282 reduction. If `cross_series_reducer`
283 is specified, then `per_series_aligner`
284 must be specified, and must not
285 be `ALIGN_NONE`. An `alignment_period`
286 must also be specified; otherwise,
287 an error is returned. Possible values:
288 REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN,
289 REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV,
290 REDUCE_COUNT, REDUCE_COUNT_TRUE,
291 REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE,
292 REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95,
293 REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05,
294 REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION'
295 type: string
296 groupByFields:
297 description: The set of fields to
298 preserve when `cross_series_reducer`
299 is specified. The `group_by_fields`
300 determine how the time series are
301 partitioned into subsets prior to
302 applying the aggregation operation.
303 Each subset contains time series
304 that have the same value for each
305 of the grouping fields. Each individual
306 time series is a member of exactly
307 one subset. The `cross_series_reducer`
308 is applied to each subset of time
309 series. It is not possible to reduce
310 across different resource types,
311 so this field implicitly contains
312 `resource.type`. Fields not specified
313 in `group_by_fields` are aggregated
314 away. If `group_by_fields` is not
315 specified and all the time series
316 have the same resource type, then
317 the time series are aggregated into
318 a single output time series. If
319 `cross_series_reducer` is not defined,
320 this field is ignored.
321 items:
322 type: string
323 type: array
324 perSeriesAligner:
325 description: An `Aligner` describes
326 how to bring the data points in
327 a single time series into temporal
328 alignment. Except for `ALIGN_NONE`,
329 all alignments cause all the data
330 points in an `alignment_period`
331 to be mathematically grouped together,
332 resulting in a single data point
333 for each `alignment_period` with
334 end timestamp at the end of the
335 period. Not all alignment operations
336 may be applied to all time series.
337 The valid choices depend on the
338 `metric_kind` and `value_type` of
339 the original time series. Alignment
340 can change the `metric_kind` or
341 the `value_type` of the time series. Time
342 series data must be aligned in order
343 to perform cross-time series reduction.
344 If `cross_series_reducer` is specified,
345 then `per_series_aligner` must be
346 specified and not equal to `ALIGN_NONE`
347 and `alignment_period` must be specified;
348 otherwise, an error is returned.
349 type: string
350 type: object
351 filter:
352 description: Required. The [monitoring
353 filter](https://cloud.google.com/monitoring/api/v3/filters)
354 that identifies the metric types, resources,
355 and projects to query.
356 type: string
357 pickTimeSeriesFilter:
358 description: Ranking based time series
359 filter.
360 properties:
361 direction:
362 description: 'How to use the ranking
363 to select time series that pass
364 through the filter. Possible values:
365 DIRECTION_UNSPECIFIED, TOP, BOTTOM'
366 type: string
367 numTimeSeries:
368 description: How many time series
369 to allow to pass through the filter.
370 format: int64
371 type: integer
372 rankingMethod:
373 description: '`ranking_method` is
374 applied to each time series independently
375 to produce the value which will
376 be used to compare the time series
377 to other time series. Possible values:
378 METHOD_UNSPECIFIED, METHOD_MEAN,
379 METHOD_MAX, METHOD_MIN, METHOD_SUM,
380 METHOD_LATEST'
381 type: string
382 type: object
383 secondaryAggregation:
384 description: Apply a second aggregation
385 after `aggregation` is applied.
386 properties:
387 alignmentPeriod:
388 description: The `alignment_period`
389 specifies a time interval, in seconds,
390 that is used to divide the data
391 in all the [time series][google.monitoring.v3.TimeSeries]
392 into consistent blocks of time.
393 This will be done before the per-series
394 aligner can be applied to the data. The
395 value must be at least 60 seconds.
396 If a per-series aligner other than
397 `ALIGN_NONE` is specified, this
398 field is required or an error is
399 returned. If no per-series aligner
400 is specified, or the aligner `ALIGN_NONE`
401 is specified, then this field is
402 ignored.
403 type: string
404 crossSeriesReducer:
405 description: 'The reduction operation
406 to be used to combine time series
407 into a single time series, where
408 the value of each data point in
409 the resulting series is a function
410 of all the already aligned values
411 in the input time series. Not all
412 reducer operations can be applied
413 to all time series. The valid choices
414 depend on the `metric_kind` and
415 the `value_type` of the original
416 time series. Reduction can yield
417 a time series with a different `metric_kind`
418 or `value_type` than the input time
419 series. Time series data must first
420 be aligned (see `per_series_aligner`)
421 in order to perform cross-time series
422 reduction. If `cross_series_reducer`
423 is specified, then `per_series_aligner`
424 must be specified, and must not
425 be `ALIGN_NONE`. An `alignment_period`
426 must also be specified; otherwise,
427 an error is returned. Possible values:
428 REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN,
429 REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV,
430 REDUCE_COUNT, REDUCE_COUNT_TRUE,
431 REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE,
432 REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95,
433 REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05,
434 REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION'
435 type: string
436 groupByFields:
437 description: The set of fields to
438 preserve when `cross_series_reducer`
439 is specified. The `group_by_fields`
440 determine how the time series are
441 partitioned into subsets prior to
442 applying the aggregation operation.
443 Each subset contains time series
444 that have the same value for each
445 of the grouping fields. Each individual
446 time series is a member of exactly
447 one subset. The `cross_series_reducer`
448 is applied to each subset of time
449 series. It is not possible to reduce
450 across different resource types,
451 so this field implicitly contains
452 `resource.type`. Fields not specified
453 in `group_by_fields` are aggregated
454 away. If `group_by_fields` is not
455 specified and all the time series
456 have the same resource type, then
457 the time series are aggregated into
458 a single output time series. If
459 `cross_series_reducer` is not defined,
460 this field is ignored.
461 items:
462 type: string
463 type: array
464 perSeriesAligner:
465 description: An `Aligner` describes
466 how to bring the data points in
467 a single time series into temporal
468 alignment. Except for `ALIGN_NONE`,
469 all alignments cause all the data
470 points in an `alignment_period`
471 to be mathematically grouped together,
472 resulting in a single data point
473 for each `alignment_period` with
474 end timestamp at the end of the
475 period. Not all alignment operations
476 may be applied to all time series.
477 The valid choices depend on the
478 `metric_kind` and `value_type` of
479 the original time series. Alignment
480 can change the `metric_kind` or
481 the `value_type` of the time series. Time
482 series data must be aligned in order
483 to perform cross-time series reduction.
484 If `cross_series_reducer` is specified,
485 then `per_series_aligner` must be
486 specified and not equal to `ALIGN_NONE`
487 and `alignment_period` must be specified;
488 otherwise, an error is returned.
489 type: string
490 type: object
491 required:
492 - filter
493 type: object
494 timeSeriesFilterRatio:
495 description: Parameters to fetch a ratio between
496 two time series filters.
497 properties:
498 denominator:
499 description: The denominator of the ratio.
500 properties:
501 aggregation:
502 description: By default, the raw time
503 series data is returned. Use this
504 field to combine multiple time series
505 for different views of the data.
506 properties:
507 alignmentPeriod:
508 description: The `alignment_period`
509 specifies a time interval, in
510 seconds, that is used to divide
511 the data in all the [time series][google.monitoring.v3.TimeSeries]
512 into consistent blocks of time.
513 This will be done before the
514 per-series aligner can be applied
515 to the data. The value must
516 be at least 60 seconds. If a
517 per-series aligner other than
518 `ALIGN_NONE` is specified, this
519 field is required or an error
520 is returned. If no per-series
521 aligner is specified, or the
522 aligner `ALIGN_NONE` is specified,
523 then this field is ignored.
524 type: string
525 crossSeriesReducer:
526 description: 'The reduction operation
527 to be used to combine time series
528 into a single time series, where
529 the value of each data point
530 in the resulting series is a
531 function of all the already
532 aligned values in the input
533 time series. Not all reducer
534 operations can be applied to
535 all time series. The valid choices
536 depend on the `metric_kind`
537 and the `value_type` of the
538 original time series. Reduction
539 can yield a time series with
540 a different `metric_kind` or
541 `value_type` than the input
542 time series. Time series data
543 must first be aligned (see `per_series_aligner`)
544 in order to perform cross-time
545 series reduction. If `cross_series_reducer`
546 is specified, then `per_series_aligner`
547 must be specified, and must
548 not be `ALIGN_NONE`. An `alignment_period`
549 must also be specified; otherwise,
550 an error is returned. Possible
551 values: REDUCE_NONE, REDUCE_MEAN,
552 REDUCE_MIN, REDUCE_MAX, REDUCE_SUM,
553 REDUCE_STDDEV, REDUCE_COUNT,
554 REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE,
555 REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99,
556 REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50,
557 REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN,
558 REDUCE_MAKE_DISTRIBUTION'
559 type: string
560 groupByFields:
561 description: The set of fields
562 to preserve when `cross_series_reducer`
563 is specified. The `group_by_fields`
564 determine how the time series
565 are partitioned into subsets
566 prior to applying the aggregation
567 operation. Each subset contains
568 time series that have the same
569 value for each of the grouping
570 fields. Each individual time
571 series is a member of exactly
572 one subset. The `cross_series_reducer`
573 is applied to each subset of
574 time series. It is not possible
575 to reduce across different resource
576 types, so this field implicitly
577 contains `resource.type`. Fields
578 not specified in `group_by_fields`
579 are aggregated away. If `group_by_fields`
580 is not specified and all the
581 time series have the same resource
582 type, then the time series are
583 aggregated into a single output
584 time series. If `cross_series_reducer`
585 is not defined, this field is
586 ignored.
587 items:
588 type: string
589 type: array
590 perSeriesAligner:
591 description: An `Aligner` describes
592 how to bring the data points
593 in a single time series into
594 temporal alignment. Except for
595 `ALIGN_NONE`, all alignments
596 cause all the data points in
597 an `alignment_period` to be
598 mathematically grouped together,
599 resulting in a single data point
600 for each `alignment_period`
601 with end timestamp at the end
602 of the period. Not all alignment
603 operations may be applied to
604 all time series. The valid choices
605 depend on the `metric_kind`
606 and `value_type` of the original
607 time series. Alignment can change
608 the `metric_kind` or the `value_type`
609 of the time series. Time series
610 data must be aligned in order
611 to perform cross-time series
612 reduction. If `cross_series_reducer`
613 is specified, then `per_series_aligner`
614 must be specified and not equal
615 to `ALIGN_NONE` and `alignment_period`
616 must be specified; otherwise,
617 an error is returned.
618 type: string
619 type: object
620 filter:
621 description: Required. The [monitoring
622 filter](https://cloud.google.com/monitoring/api/v3/filters)
623 that identifies the metric types,
624 resources, and projects to query.
625 type: string
626 required:
627 - filter
628 type: object
629 numerator:
630 description: The numerator of the ratio.
631 properties:
632 aggregation:
633 description: By default, the raw time
634 series data is returned. Use this
635 field to combine multiple time series
636 for different views of the data.
637 properties:
638 alignmentPeriod:
639 description: The `alignment_period`
640 specifies a time interval, in
641 seconds, that is used to divide
642 the data in all the [time series][google.monitoring.v3.TimeSeries]
643 into consistent blocks of time.
644 This will be done before the
645 per-series aligner can be applied
646 to the data. The value must
647 be at least 60 seconds. If a
648 per-series aligner other than
649 `ALIGN_NONE` is specified, this
650 field is required or an error
651 is returned. If no per-series
652 aligner is specified, or the
653 aligner `ALIGN_NONE` is specified,
654 then this field is ignored.
655 type: string
656 crossSeriesReducer:
657 description: 'The reduction operation
658 to be used to combine time series
659 into a single time series, where
660 the value of each data point
661 in the resulting series is a
662 function of all the already
663 aligned values in the input
664 time series. Not all reducer
665 operations can be applied to
666 all time series. The valid choices
667 depend on the `metric_kind`
668 and the `value_type` of the
669 original time series. Reduction
670 can yield a time series with
671 a different `metric_kind` or
672 `value_type` than the input
673 time series. Time series data
674 must first be aligned (see `per_series_aligner`)
675 in order to perform cross-time
676 series reduction. If `cross_series_reducer`
677 is specified, then `per_series_aligner`
678 must be specified, and must
679 not be `ALIGN_NONE`. An `alignment_period`
680 must also be specified; otherwise,
681 an error is returned. Possible
682 values: REDUCE_NONE, REDUCE_MEAN,
683 REDUCE_MIN, REDUCE_MAX, REDUCE_SUM,
684 REDUCE_STDDEV, REDUCE_COUNT,
685 REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE,
686 REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99,
687 REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50,
688 REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN,
689 REDUCE_MAKE_DISTRIBUTION'
690 type: string
691 groupByFields:
692 description: The set of fields
693 to preserve when `cross_series_reducer`
694 is specified. The `group_by_fields`
695 determine how the time series
696 are partitioned into subsets
697 prior to applying the aggregation
698 operation. Each subset contains
699 time series that have the same
700 value for each of the grouping
701 fields. Each individual time
702 series is a member of exactly
703 one subset. The `cross_series_reducer`
704 is applied to each subset of
705 time series. It is not possible
706 to reduce across different resource
707 types, so this field implicitly
708 contains `resource.type`. Fields
709 not specified in `group_by_fields`
710 are aggregated away. If `group_by_fields`
711 is not specified and all the
712 time series have the same resource
713 type, then the time series are
714 aggregated into a single output
715 time series. If `cross_series_reducer`
716 is not defined, this field is
717 ignored.
718 items:
719 type: string
720 type: array
721 perSeriesAligner:
722 description: An `Aligner` describes
723 how to bring the data points
724 in a single time series into
725 temporal alignment. Except for
726 `ALIGN_NONE`, all alignments
727 cause all the data points in
728 an `alignment_period` to be
729 mathematically grouped together,
730 resulting in a single data point
731 for each `alignment_period`
732 with end timestamp at the end
733 of the period. Not all alignment
734 operations may be applied to
735 all time series. The valid choices
736 depend on the `metric_kind`
737 and `value_type` of the original
738 time series. Alignment can change
739 the `metric_kind` or the `value_type`
740 of the time series. Time series
741 data must be aligned in order
742 to perform cross-time series
743 reduction. If `cross_series_reducer`
744 is specified, then `per_series_aligner`
745 must be specified and not equal
746 to `ALIGN_NONE` and `alignment_period`
747 must be specified; otherwise,
748 an error is returned.
749 type: string
750 type: object
751 filter:
752 description: Required. The [monitoring
753 filter](https://cloud.google.com/monitoring/api/v3/filters)
754 that identifies the metric types,
755 resources, and projects to query.
756 type: string
757 required:
758 - filter
759 type: object
760 pickTimeSeriesFilter:
761 description: Ranking based time series
762 filter.
763 properties:
764 direction:
765 description: 'How to use the ranking
766 to select time series that pass
767 through the filter. Possible values:
768 DIRECTION_UNSPECIFIED, TOP, BOTTOM'
769 type: string
770 numTimeSeries:
771 description: How many time series
772 to allow to pass through the filter.
773 format: int64
774 type: integer
775 rankingMethod:
776 description: '`ranking_method` is
777 applied to each time series independently
778 to produce the value which will
779 be used to compare the time series
780 to other time series. Possible values:
781 METHOD_UNSPECIFIED, METHOD_MEAN,
782 METHOD_MAX, METHOD_MIN, METHOD_SUM,
783 METHOD_LATEST'
784 type: string
785 type: object
786 secondaryAggregation:
787 description: Apply a second aggregation
788 after the ratio is computed.
789 properties:
790 alignmentPeriod:
791 description: The `alignment_period`
792 specifies a time interval, in seconds,
793 that is used to divide the data
794 in all the [time series][google.monitoring.v3.TimeSeries]
795 into consistent blocks of time.
796 This will be done before the per-series
797 aligner can be applied to the data. The
798 value must be at least 60 seconds.
799 If a per-series aligner other than
800 `ALIGN_NONE` is specified, this
801 field is required or an error is
802 returned. If no per-series aligner
803 is specified, or the aligner `ALIGN_NONE`
804 is specified, then this field is
805 ignored.
806 type: string
807 crossSeriesReducer:
808 description: 'The reduction operation
809 to be used to combine time series
810 into a single time series, where
811 the value of each data point in
812 the resulting series is a function
813 of all the already aligned values
814 in the input time series. Not all
815 reducer operations can be applied
816 to all time series. The valid choices
817 depend on the `metric_kind` and
818 the `value_type` of the original
819 time series. Reduction can yield
820 a time series with a different `metric_kind`
821 or `value_type` than the input time
822 series. Time series data must first
823 be aligned (see `per_series_aligner`)
824 in order to perform cross-time series
825 reduction. If `cross_series_reducer`
826 is specified, then `per_series_aligner`
827 must be specified, and must not
828 be `ALIGN_NONE`. An `alignment_period`
829 must also be specified; otherwise,
830 an error is returned. Possible values:
831 REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN,
832 REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV,
833 REDUCE_COUNT, REDUCE_COUNT_TRUE,
834 REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE,
835 REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95,
836 REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05,
837 REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION'
838 type: string
839 groupByFields:
840 description: The set of fields to
841 preserve when `cross_series_reducer`
842 is specified. The `group_by_fields`
843 determine how the time series are
844 partitioned into subsets prior to
845 applying the aggregation operation.
846 Each subset contains time series
847 that have the same value for each
848 of the grouping fields. Each individual
849 time series is a member of exactly
850 one subset. The `cross_series_reducer`
851 is applied to each subset of time
852 series. It is not possible to reduce
853 across different resource types,
854 so this field implicitly contains
855 `resource.type`. Fields not specified
856 in `group_by_fields` are aggregated
857 away. If `group_by_fields` is not
858 specified and all the time series
859 have the same resource type, then
860 the time series are aggregated into
861 a single output time series. If
862 `cross_series_reducer` is not defined,
863 this field is ignored.
864 items:
865 type: string
866 type: array
867 perSeriesAligner:
868 description: An `Aligner` describes
869 how to bring the data points in
870 a single time series into temporal
871 alignment. Except for `ALIGN_NONE`,
872 all alignments cause all the data
873 points in an `alignment_period`
874 to be mathematically grouped together,
875 resulting in a single data point
876 for each `alignment_period` with
877 end timestamp at the end of the
878 period. Not all alignment operations
879 may be applied to all time series.
880 The valid choices depend on the
881 `metric_kind` and `value_type` of
882 the original time series. Alignment
883 can change the `metric_kind` or
884 the `value_type` of the time series. Time
885 series data must be aligned in order
886 to perform cross-time series reduction.
887 If `cross_series_reducer` is specified,
888 then `per_series_aligner` must be
889 specified and not equal to `ALIGN_NONE`
890 and `alignment_period` must be specified;
891 otherwise, an error is returned.
892 type: string
893 type: object
894 type: object
895 timeSeriesQueryLanguage:
896 description: A query used to fetch time series.
897 type: string
898 unitOverride:
899 description: The unit of data contained in
900 fetched time series. If non-empty, this
901 unit will override any unit that accompanies
902 fetched data. The format is the same as
903 the [`unit`](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors)
904 field in `MetricDescriptor`.
905 type: string
906 type: object
907 required:
908 - timeSeriesQuery
909 type: object
910 text:
911 description: A raw string or markdown displaying textual
912 content.
913 properties:
914 content:
915 description: The text content to be displayed.
916 type: string
917 format:
918 description: 'How the text content is formatted.
919 Possible values: FORMAT_UNSPECIFIED, MARKDOWN,
920 RAW'
921 type: string
922 type: object
923 title:
924 description: Optional. The title of the widget.
925 type: string
926 xyChart:
927 description: A chart of time series data.
928 properties:
929 chartOptions:
930 description: Display options for the chart.
931 properties:
932 mode:
933 description: 'The chart mode. Possible values:
934 MODE_UNSPECIFIED, COLOR, X_RAY, STATS'
935 type: string
936 type: object
937 dataSets:
938 description: Required. The data displayed in this
939 chart.
940 items:
941 properties:
942 legendTemplate:
943 description: 'A template string for naming
944 `TimeSeries` in the resulting data set.
945 This should be a string with interpolations
946 of the form `${label_name}`, which will
947 resolve to the label''s value. '
948 type: string
949 minAlignmentPeriod:
950 description: Optional. The lower bound on
951 data point frequency for this data set,
952 implemented by specifying the minimum
953 alignment period to use in a time series
954 query For example, if the data is published
955 once every 10 minutes, the `min_alignment_period`
956 should be at least 10 minutes. It would
957 not make sense to fetch and align data
958 at one minute intervals.
959 type: string
960 plotType:
961 description: 'How this data should be plotted
962 on the chart. Possible values: PLOT_TYPE_UNSPECIFIED,
963 LINE, STACKED_AREA, STACKED_BAR, HEATMAP'
964 type: string
965 timeSeriesQuery:
966 description: Required. Fields for querying
967 time series data from the Stackdriver
968 metrics API.
969 properties:
970 timeSeriesFilter:
971 description: Filter parameters to fetch
972 time series.
973 properties:
974 aggregation:
975 description: By default, the raw
976 time series data is returned.
977 Use this field to combine multiple
978 time series for different views
979 of the data.
980 properties:
981 alignmentPeriod:
982 description: The `alignment_period`
983 specifies a time interval,
984 in seconds, that is used to
985 divide the data in all the
986 [time series][google.monitoring.v3.TimeSeries]
987 into consistent blocks of
988 time. This will be done before
989 the per-series aligner can
990 be applied to the data. The
991 value must be at least 60
992 seconds. If a per-series aligner
993 other than `ALIGN_NONE` is
994 specified, this field is required
995 or an error is returned. If
996 no per-series aligner is specified,
997 or the aligner `ALIGN_NONE`
998 is specified, then this field
999 is ignored.
1000 type: string
1001 crossSeriesReducer:
1002 description: 'The reduction
1003 operation to be used to combine
1004 time series into a single
1005 time series, where the value
1006 of each data point in the
1007 resulting series is a function
1008 of all the already aligned
1009 values in the input time series. Not
1010 all reducer operations can
1011 be applied to all time series.
1012 The valid choices depend on
1013 the `metric_kind` and the
1014 `value_type` of the original
1015 time series. Reduction can
1016 yield a time series with a
1017 different `metric_kind` or
1018 `value_type` than the input
1019 time series. Time series
1020 data must first be aligned
1021 (see `per_series_aligner`)
1022 in order to perform cross-time
1023 series reduction. If `cross_series_reducer`
1024 is specified, then `per_series_aligner`
1025 must be specified, and must
1026 not be `ALIGN_NONE`. An `alignment_period`
1027 must also be specified; otherwise,
1028 an error is returned. Possible
1029 values: REDUCE_NONE, REDUCE_MEAN,
1030 REDUCE_MIN, REDUCE_MAX, REDUCE_SUM,
1031 REDUCE_STDDEV, REDUCE_COUNT,
1032 REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE,
1033 REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99,
1034 REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50,
1035 REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN,
1036 REDUCE_MAKE_DISTRIBUTION'
1037 type: string
1038 groupByFields:
1039 description: The set of fields
1040 to preserve when `cross_series_reducer`
1041 is specified. The `group_by_fields`
1042 determine how the time series
1043 are partitioned into subsets
1044 prior to applying the aggregation
1045 operation. Each subset contains
1046 time series that have the
1047 same value for each of the
1048 grouping fields. Each individual
1049 time series is a member of
1050 exactly one subset. The `cross_series_reducer`
1051 is applied to each subset
1052 of time series. It is not
1053 possible to reduce across
1054 different resource types,
1055 so this field implicitly contains
1056 `resource.type`. Fields not
1057 specified in `group_by_fields`
1058 are aggregated away. If `group_by_fields`
1059 is not specified and all the
1060 time series have the same
1061 resource type, then the time
1062 series are aggregated into
1063 a single output time series.
1064 If `cross_series_reducer`
1065 is not defined, this field
1066 is ignored.
1067 items:
1068 type: string
1069 type: array
1070 perSeriesAligner:
1071 description: An `Aligner` describes
1072 how to bring the data points
1073 in a single time series into
1074 temporal alignment. Except
1075 for `ALIGN_NONE`, all alignments
1076 cause all the data points
1077 in an `alignment_period` to
1078 be mathematically grouped
1079 together, resulting in a single
1080 data point for each `alignment_period`
1081 with end timestamp at the
1082 end of the period. Not all
1083 alignment operations may be
1084 applied to all time series.
1085 The valid choices depend on
1086 the `metric_kind` and `value_type`
1087 of the original time series.
1088 Alignment can change the `metric_kind`
1089 or the `value_type` of the
1090 time series. Time series
1091 data must be aligned in order
1092 to perform cross-time series
1093 reduction. If `cross_series_reducer`
1094 is specified, then `per_series_aligner`
1095 must be specified and not
1096 equal to `ALIGN_NONE` and
1097 `alignment_period` must be
1098 specified; otherwise, an error
1099 is returned.
1100 type: string
1101 type: object
1102 filter:
1103 description: Required. The [monitoring
1104 filter](https://cloud.google.com/monitoring/api/v3/filters)
1105 that identifies the metric types,
1106 resources, and projects to query.
1107 type: string
1108 pickTimeSeriesFilter:
1109 description: Ranking based time
1110 series filter.
1111 properties:
1112 direction:
1113 description: 'How to use the
1114 ranking to select time series
1115 that pass through the filter.
1116 Possible values: DIRECTION_UNSPECIFIED,
1117 TOP, BOTTOM'
1118 type: string
1119 numTimeSeries:
1120 description: How many time series
1121 to allow to pass through the
1122 filter.
1123 format: int64
1124 type: integer
1125 rankingMethod:
1126 description: '`ranking_method`
1127 is applied to each time series
1128 independently to produce the
1129 value which will be used to
1130 compare the time series to
1131 other time series. Possible
1132 values: METHOD_UNSPECIFIED,
1133 METHOD_MEAN, METHOD_MAX, METHOD_MIN,
1134 METHOD_SUM, METHOD_LATEST'
1135 type: string
1136 type: object
1137 secondaryAggregation:
1138 description: Apply a second aggregation
1139 after `aggregation` is applied.
1140 properties:
1141 alignmentPeriod:
1142 description: The `alignment_period`
1143 specifies a time interval,
1144 in seconds, that is used to
1145 divide the data in all the
1146 [time series][google.monitoring.v3.TimeSeries]
1147 into consistent blocks of
1148 time. This will be done before
1149 the per-series aligner can
1150 be applied to the data. The
1151 value must be at least 60
1152 seconds. If a per-series aligner
1153 other than `ALIGN_NONE` is
1154 specified, this field is required
1155 or an error is returned. If
1156 no per-series aligner is specified,
1157 or the aligner `ALIGN_NONE`
1158 is specified, then this field
1159 is ignored.
1160 type: string
1161 crossSeriesReducer:
1162 description: 'The reduction
1163 operation to be used to combine
1164 time series into a single
1165 time series, where the value
1166 of each data point in the
1167 resulting series is a function
1168 of all the already aligned
1169 values in the input time series. Not
1170 all reducer operations can
1171 be applied to all time series.
1172 The valid choices depend on
1173 the `metric_kind` and the
1174 `value_type` of the original
1175 time series. Reduction can
1176 yield a time series with a
1177 different `metric_kind` or
1178 `value_type` than the input
1179 time series. Time series
1180 data must first be aligned
1181 (see `per_series_aligner`)
1182 in order to perform cross-time
1183 series reduction. If `cross_series_reducer`
1184 is specified, then `per_series_aligner`
1185 must be specified, and must
1186 not be `ALIGN_NONE`. An `alignment_period`
1187 must also be specified; otherwise,
1188 an error is returned. Possible
1189 values: REDUCE_NONE, REDUCE_MEAN,
1190 REDUCE_MIN, REDUCE_MAX, REDUCE_SUM,
1191 REDUCE_STDDEV, REDUCE_COUNT,
1192 REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE,
1193 REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99,
1194 REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50,
1195 REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN,
1196 REDUCE_MAKE_DISTRIBUTION'
1197 type: string
1198 groupByFields:
1199 description: The set of fields
1200 to preserve when `cross_series_reducer`
1201 is specified. The `group_by_fields`
1202 determine how the time series
1203 are partitioned into subsets
1204 prior to applying the aggregation
1205 operation. Each subset contains
1206 time series that have the
1207 same value for each of the
1208 grouping fields. Each individual
1209 time series is a member of
1210 exactly one subset. The `cross_series_reducer`
1211 is applied to each subset
1212 of time series. It is not
1213 possible to reduce across
1214 different resource types,
1215 so this field implicitly contains
1216 `resource.type`. Fields not
1217 specified in `group_by_fields`
1218 are aggregated away. If `group_by_fields`
1219 is not specified and all the
1220 time series have the same
1221 resource type, then the time
1222 series are aggregated into
1223 a single output time series.
1224 If `cross_series_reducer`
1225 is not defined, this field
1226 is ignored.
1227 items:
1228 type: string
1229 type: array
1230 perSeriesAligner:
1231 description: An `Aligner` describes
1232 how to bring the data points
1233 in a single time series into
1234 temporal alignment. Except
1235 for `ALIGN_NONE`, all alignments
1236 cause all the data points
1237 in an `alignment_period` to
1238 be mathematically grouped
1239 together, resulting in a single
1240 data point for each `alignment_period`
1241 with end timestamp at the
1242 end of the period. Not all
1243 alignment operations may be
1244 applied to all time series.
1245 The valid choices depend on
1246 the `metric_kind` and `value_type`
1247 of the original time series.
1248 Alignment can change the `metric_kind`
1249 or the `value_type` of the
1250 time series. Time series
1251 data must be aligned in order
1252 to perform cross-time series
1253 reduction. If `cross_series_reducer`
1254 is specified, then `per_series_aligner`
1255 must be specified and not
1256 equal to `ALIGN_NONE` and
1257 `alignment_period` must be
1258 specified; otherwise, an error
1259 is returned.
1260 type: string
1261 type: object
1262 required:
1263 - filter
1264 type: object
1265 timeSeriesFilterRatio:
1266 description: Parameters to fetch a ratio
1267 between two time series filters.
1268 properties:
1269 denominator:
1270 description: The denominator of
1271 the ratio.
1272 properties:
1273 aggregation:
1274 description: By default, the
1275 raw time series data is returned.
1276 Use this field to combine
1277 multiple time series for different
1278 views of the data.
1279 properties:
1280 alignmentPeriod:
1281 description: The `alignment_period`
1282 specifies a time interval,
1283 in seconds, that is used
1284 to divide the data in
1285 all the [time series][google.monitoring.v3.TimeSeries]
1286 into consistent blocks
1287 of time. This will be
1288 done before the per-series
1289 aligner can be applied
1290 to the data. The value
1291 must be at least 60 seconds.
1292 If a per-series aligner
1293 other than `ALIGN_NONE`
1294 is specified, this field
1295 is required or an error
1296 is returned. If no per-series
1297 aligner is specified,
1298 or the aligner `ALIGN_NONE`
1299 is specified, then this
1300 field is ignored.
1301 type: string
1302 crossSeriesReducer:
1303 description: 'The reduction
1304 operation to be used to
1305 combine time series into
1306 a single time series,
1307 where the value of each
1308 data point in the resulting
1309 series is a function of
1310 all the already aligned
1311 values in the input time
1312 series. Not all reducer
1313 operations can be applied
1314 to all time series. The
1315 valid choices depend on
1316 the `metric_kind` and
1317 the `value_type` of the
1318 original time series.
1319 Reduction can yield a
1320 time series with a different
1321 `metric_kind` or `value_type`
1322 than the input time series. Time
1323 series data must first
1324 be aligned (see `per_series_aligner`)
1325 in order to perform cross-time
1326 series reduction. If `cross_series_reducer`
1327 is specified, then `per_series_aligner`
1328 must be specified, and
1329 must not be `ALIGN_NONE`.
1330 An `alignment_period`
1331 must also be specified;
1332 otherwise, an error is
1333 returned. Possible values:
1334 REDUCE_NONE, REDUCE_MEAN,
1335 REDUCE_MIN, REDUCE_MAX,
1336 REDUCE_SUM, REDUCE_STDDEV,
1337 REDUCE_COUNT, REDUCE_COUNT_TRUE,
1338 REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE,
1339 REDUCE_PERCENTILE_99,
1340 REDUCE_PERCENTILE_95,
1341 REDUCE_PERCENTILE_50,
1342 REDUCE_PERCENTILE_05,
1343 REDUCE_FRACTION_LESS_THAN,
1344 REDUCE_MAKE_DISTRIBUTION'
1345 type: string
1346 groupByFields:
1347 description: The set of
1348 fields to preserve when
1349 `cross_series_reducer`
1350 is specified. The `group_by_fields`
1351 determine how the time
1352 series are partitioned
1353 into subsets prior to
1354 applying the aggregation
1355 operation. Each subset
1356 contains time series that
1357 have the same value for
1358 each of the grouping fields.
1359 Each individual time series
1360 is a member of exactly
1361 one subset. The `cross_series_reducer`
1362 is applied to each subset
1363 of time series. It is
1364 not possible to reduce
1365 across different resource
1366 types, so this field implicitly
1367 contains `resource.type`. Fields
1368 not specified in `group_by_fields`
1369 are aggregated away. If
1370 `group_by_fields` is not
1371 specified and all the
1372 time series have the same
1373 resource type, then the
1374 time series are aggregated
1375 into a single output time
1376 series. If `cross_series_reducer`
1377 is not defined, this field
1378 is ignored.
1379 items:
1380 type: string
1381 type: array
1382 perSeriesAligner:
1383 description: An `Aligner`
1384 describes how to bring
1385 the data points in a single
1386 time series into temporal
1387 alignment. Except for
1388 `ALIGN_NONE`, all alignments
1389 cause all the data points
1390 in an `alignment_period`
1391 to be mathematically grouped
1392 together, resulting in
1393 a single data point for
1394 each `alignment_period`
1395 with end timestamp at
1396 the end of the period. Not
1397 all alignment operations
1398 may be applied to all
1399 time series. The valid
1400 choices depend on the
1401 `metric_kind` and `value_type`
1402 of the original time series.
1403 Alignment can change the
1404 `metric_kind` or the `value_type`
1405 of the time series. Time
1406 series data must be aligned
1407 in order to perform cross-time
1408 series reduction. If `cross_series_reducer`
1409 is specified, then `per_series_aligner`
1410 must be specified and
1411 not equal to `ALIGN_NONE`
1412 and `alignment_period`
1413 must be specified; otherwise,
1414 an error is returned.
1415 type: string
1416 type: object
1417 filter:
1418 description: Required. The [monitoring
1419 filter](https://cloud.google.com/monitoring/api/v3/filters)
1420 that identifies the metric
1421 types, resources, and projects
1422 to query.
1423 type: string
1424 required:
1425 - filter
1426 type: object
1427 numerator:
1428 description: The numerator of the
1429 ratio.
1430 properties:
1431 aggregation:
1432 description: By default, the
1433 raw time series data is returned.
1434 Use this field to combine
1435 multiple time series for different
1436 views of the data.
1437 properties:
1438 alignmentPeriod:
1439 description: The `alignment_period`
1440 specifies a time interval,
1441 in seconds, that is used
1442 to divide the data in
1443 all the [time series][google.monitoring.v3.TimeSeries]
1444 into consistent blocks
1445 of time. This will be
1446 done before the per-series
1447 aligner can be applied
1448 to the data. The value
1449 must be at least 60 seconds.
1450 If a per-series aligner
1451 other than `ALIGN_NONE`
1452 is specified, this field
1453 is required or an error
1454 is returned. If no per-series
1455 aligner is specified,
1456 or the aligner `ALIGN_NONE`
1457 is specified, then this
1458 field is ignored.
1459 type: string
1460 crossSeriesReducer:
1461 description: 'The reduction
1462 operation to be used to
1463 combine time series into
1464 a single time series,
1465 where the value of each
1466 data point in the resulting
1467 series is a function of
1468 all the already aligned
1469 values in the input time
1470 series. Not all reducer
1471 operations can be applied
1472 to all time series. The
1473 valid choices depend on
1474 the `metric_kind` and
1475 the `value_type` of the
1476 original time series.
1477 Reduction can yield a
1478 time series with a different
1479 `metric_kind` or `value_type`
1480 than the input time series. Time
1481 series data must first
1482 be aligned (see `per_series_aligner`)
1483 in order to perform cross-time
1484 series reduction. If `cross_series_reducer`
1485 is specified, then `per_series_aligner`
1486 must be specified, and
1487 must not be `ALIGN_NONE`.
1488 An `alignment_period`
1489 must also be specified;
1490 otherwise, an error is
1491 returned. Possible values:
1492 REDUCE_NONE, REDUCE_MEAN,
1493 REDUCE_MIN, REDUCE_MAX,
1494 REDUCE_SUM, REDUCE_STDDEV,
1495 REDUCE_COUNT, REDUCE_COUNT_TRUE,
1496 REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE,
1497 REDUCE_PERCENTILE_99,
1498 REDUCE_PERCENTILE_95,
1499 REDUCE_PERCENTILE_50,
1500 REDUCE_PERCENTILE_05,
1501 REDUCE_FRACTION_LESS_THAN,
1502 REDUCE_MAKE_DISTRIBUTION'
1503 type: string
1504 groupByFields:
1505 description: The set of
1506 fields to preserve when
1507 `cross_series_reducer`
1508 is specified. The `group_by_fields`
1509 determine how the time
1510 series are partitioned
1511 into subsets prior to
1512 applying the aggregation
1513 operation. Each subset
1514 contains time series that
1515 have the same value for
1516 each of the grouping fields.
1517 Each individual time series
1518 is a member of exactly
1519 one subset. The `cross_series_reducer`
1520 is applied to each subset
1521 of time series. It is
1522 not possible to reduce
1523 across different resource
1524 types, so this field implicitly
1525 contains `resource.type`. Fields
1526 not specified in `group_by_fields`
1527 are aggregated away. If
1528 `group_by_fields` is not
1529 specified and all the
1530 time series have the same
1531 resource type, then the
1532 time series are aggregated
1533 into a single output time
1534 series. If `cross_series_reducer`
1535 is not defined, this field
1536 is ignored.
1537 items:
1538 type: string
1539 type: array
1540 perSeriesAligner:
1541 description: An `Aligner`
1542 describes how to bring
1543 the data points in a single
1544 time series into temporal
1545 alignment. Except for
1546 `ALIGN_NONE`, all alignments
1547 cause all the data points
1548 in an `alignment_period`
1549 to be mathematically grouped
1550 together, resulting in
1551 a single data point for
1552 each `alignment_period`
1553 with end timestamp at
1554 the end of the period. Not
1555 all alignment operations
1556 may be applied to all
1557 time series. The valid
1558 choices depend on the
1559 `metric_kind` and `value_type`
1560 of the original time series.
1561 Alignment can change the
1562 `metric_kind` or the `value_type`
1563 of the time series. Time
1564 series data must be aligned
1565 in order to perform cross-time
1566 series reduction. If `cross_series_reducer`
1567 is specified, then `per_series_aligner`
1568 must be specified and
1569 not equal to `ALIGN_NONE`
1570 and `alignment_period`
1571 must be specified; otherwise,
1572 an error is returned.
1573 type: string
1574 type: object
1575 filter:
1576 description: Required. The [monitoring
1577 filter](https://cloud.google.com/monitoring/api/v3/filters)
1578 that identifies the metric
1579 types, resources, and projects
1580 to query.
1581 type: string
1582 required:
1583 - filter
1584 type: object
1585 pickTimeSeriesFilter:
1586 description: Ranking based time
1587 series filter.
1588 properties:
1589 direction:
1590 description: 'How to use the
1591 ranking to select time series
1592 that pass through the filter.
1593 Possible values: DIRECTION_UNSPECIFIED,
1594 TOP, BOTTOM'
1595 type: string
1596 numTimeSeries:
1597 description: How many time series
1598 to allow to pass through the
1599 filter.
1600 format: int64
1601 type: integer
1602 rankingMethod:
1603 description: '`ranking_method`
1604 is applied to each time series
1605 independently to produce the
1606 value which will be used to
1607 compare the time series to
1608 other time series. Possible
1609 values: METHOD_UNSPECIFIED,
1610 METHOD_MEAN, METHOD_MAX, METHOD_MIN,
1611 METHOD_SUM, METHOD_LATEST'
1612 type: string
1613 type: object
1614 secondaryAggregation:
1615 description: Apply a second aggregation
1616 after the ratio is computed.
1617 properties:
1618 alignmentPeriod:
1619 description: The `alignment_period`
1620 specifies a time interval,
1621 in seconds, that is used to
1622 divide the data in all the
1623 [time series][google.monitoring.v3.TimeSeries]
1624 into consistent blocks of
1625 time. This will be done before
1626 the per-series aligner can
1627 be applied to the data. The
1628 value must be at least 60
1629 seconds. If a per-series aligner
1630 other than `ALIGN_NONE` is
1631 specified, this field is required
1632 or an error is returned. If
1633 no per-series aligner is specified,
1634 or the aligner `ALIGN_NONE`
1635 is specified, then this field
1636 is ignored.
1637 type: string
1638 crossSeriesReducer:
1639 description: 'The reduction
1640 operation to be used to combine
1641 time series into a single
1642 time series, where the value
1643 of each data point in the
1644 resulting series is a function
1645 of all the already aligned
1646 values in the input time series. Not
1647 all reducer operations can
1648 be applied to all time series.
1649 The valid choices depend on
1650 the `metric_kind` and the
1651 `value_type` of the original
1652 time series. Reduction can
1653 yield a time series with a
1654 different `metric_kind` or
1655 `value_type` than the input
1656 time series. Time series
1657 data must first be aligned
1658 (see `per_series_aligner`)
1659 in order to perform cross-time
1660 series reduction. If `cross_series_reducer`
1661 is specified, then `per_series_aligner`
1662 must be specified, and must
1663 not be `ALIGN_NONE`. An `alignment_period`
1664 must also be specified; otherwise,
1665 an error is returned. Possible
1666 values: REDUCE_NONE, REDUCE_MEAN,
1667 REDUCE_MIN, REDUCE_MAX, REDUCE_SUM,
1668 REDUCE_STDDEV, REDUCE_COUNT,
1669 REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE,
1670 REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99,
1671 REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50,
1672 REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN,
1673 REDUCE_MAKE_DISTRIBUTION'
1674 type: string
1675 groupByFields:
1676 description: The set of fields
1677 to preserve when `cross_series_reducer`
1678 is specified. The `group_by_fields`
1679 determine how the time series
1680 are partitioned into subsets
1681 prior to applying the aggregation
1682 operation. Each subset contains
1683 time series that have the
1684 same value for each of the
1685 grouping fields. Each individual
1686 time series is a member of
1687 exactly one subset. The `cross_series_reducer`
1688 is applied to each subset
1689 of time series. It is not
1690 possible to reduce across
1691 different resource types,
1692 so this field implicitly contains
1693 `resource.type`. Fields not
1694 specified in `group_by_fields`
1695 are aggregated away. If `group_by_fields`
1696 is not specified and all the
1697 time series have the same
1698 resource type, then the time
1699 series are aggregated into
1700 a single output time series.
1701 If `cross_series_reducer`
1702 is not defined, this field
1703 is ignored.
1704 items:
1705 type: string
1706 type: array
1707 perSeriesAligner:
1708 description: An `Aligner` describes
1709 how to bring the data points
1710 in a single time series into
1711 temporal alignment. Except
1712 for `ALIGN_NONE`, all alignments
1713 cause all the data points
1714 in an `alignment_period` to
1715 be mathematically grouped
1716 together, resulting in a single
1717 data point for each `alignment_period`
1718 with end timestamp at the
1719 end of the period. Not all
1720 alignment operations may be
1721 applied to all time series.
1722 The valid choices depend on
1723 the `metric_kind` and `value_type`
1724 of the original time series.
1725 Alignment can change the `metric_kind`
1726 or the `value_type` of the
1727 time series. Time series
1728 data must be aligned in order
1729 to perform cross-time series
1730 reduction. If `cross_series_reducer`
1731 is specified, then `per_series_aligner`
1732 must be specified and not
1733 equal to `ALIGN_NONE` and
1734 `alignment_period` must be
1735 specified; otherwise, an error
1736 is returned.
1737 type: string
1738 type: object
1739 type: object
1740 timeSeriesQueryLanguage:
1741 description: A query used to fetch time
1742 series.
1743 type: string
1744 unitOverride:
1745 description: The unit of data contained
1746 in fetched time series. If non-empty,
1747 this unit will override any unit that
1748 accompanies fetched data. The format
1749 is the same as the [`unit`](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors)
1750 field in `MetricDescriptor`.
1751 type: string
1752 type: object
1753 required:
1754 - timeSeriesQuery
1755 type: object
1756 type: array
1757 thresholds:
1758 description: Threshold lines drawn horizontally
1759 across the chart.
1760 items:
1761 properties:
1762 color:
1763 description: 'The state color for this threshold.
1764 Color is not allowed in a XyChart. Possible
1765 values: COLOR_UNSPECIFIED, GREY, BLUE,
1766 GREEN, YELLOW, ORANGE, RED'
1767 type: string
1768 direction:
1769 description: 'The direction for the current
1770 threshold. Direction is not allowed in
1771 a XyChart. Possible values: DIRECTION_UNSPECIFIED,
1772 ABOVE, BELOW'
1773 type: string
1774 label:
1775 description: A label for the threshold.
1776 type: string
1777 value:
1778 description: The value of the threshold.
1779 The value should be defined in the native
1780 scale of the metric.
1781 format: double
1782 type: number
1783 type: object
1784 type: array
1785 timeshiftDuration:
1786 description: The duration used to display a comparison
1787 chart. A comparison chart simultaneously shows
1788 values from two similar-length time periods
1789 (e.g., week-over-week metrics). The duration
1790 must be positive, and it can only be applied
1791 to charts with data sets of LINE plot type.
1792 type: string
1793 xAxis:
1794 description: The properties applied to the X axis.
1795 properties:
1796 label:
1797 description: The label of the axis.
1798 type: string
1799 scale:
1800 description: 'The axis scale. By default,
1801 a linear scale is used. Possible values:
1802 SCALE_UNSPECIFIED, LINEAR, LOG10'
1803 type: string
1804 type: object
1805 yAxis:
1806 description: The properties applied to the Y axis.
1807 properties:
1808 label:
1809 description: The label of the axis.
1810 type: string
1811 scale:
1812 description: 'The axis scale. By default,
1813 a linear scale is used. Possible values:
1814 SCALE_UNSPECIFIED, LINEAR, LOG10'
1815 type: string
1816 type: object
1817 required:
1818 - dataSets
1819 type: object
1820 type: object
1821 type: array
1822 type: object
1823 type: array
1824 type: object
1825 displayName:
1826 description: Required. The mutable, human-readable name.
1827 type: string
1828 gridLayout:
1829 description: Content is arranged with a basic layout that re-flows
1830 a simple list of informational elements like widgets or tiles.
1831 properties:
1832 columns:
1833 description: The number of columns into which the view's width
1834 is divided. If omitted or set to zero, a system default will
1835 be used while rendering.
1836 format: int64
1837 type: integer
1838 widgets:
1839 description: The informational elements that are arranged into
1840 the columns row-first.
1841 items:
1842 properties:
1843 blank:
1844 description: A blank space.
1845 type: object
1846 x-kubernetes-preserve-unknown-fields: true
1847 logsPanel:
1848 properties:
1849 filter:
1850 description: A filter that chooses which log entries
1851 to return. See [Advanced Logs Queries](https://cloud.google.com/logging/docs/view/advanced-queries).
1852 Only log entries that match the filter are returned.
1853 An empty filter matches all log entries.
1854 type: string
1855 resourceNames:
1856 items:
1857 oneOf:
1858 - not:
1859 required:
1860 - external
1861 required:
1862 - name
1863 - not:
1864 anyOf:
1865 - required:
1866 - name
1867 - required:
1868 - namespace
1869 required:
1870 - external
1871 properties:
1872 external:
1873 description: 'Allowed value: The Google Cloud
1874 resource name of a `Project` resource (format:
1875 `projects/{{name}}`).'
1876 type: string
1877 name:
1878 description: 'Name of the referent. More info:
1879 https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
1880 type: string
1881 namespace:
1882 description: 'Namespace of the referent. More
1883 info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
1884 type: string
1885 type: object
1886 type: array
1887 type: object
1888 scorecard:
1889 description: A scorecard summarizing time series data.
1890 properties:
1891 gaugeView:
1892 description: Will cause the scorecard to show a gauge
1893 chart.
1894 properties:
1895 lowerBound:
1896 description: The lower bound for this gauge chart.
1897 The value of the chart should always be greater
1898 than or equal to this.
1899 format: double
1900 type: number
1901 upperBound:
1902 description: The upper bound for this gauge chart.
1903 The value of the chart should always be less than
1904 or equal to this.
1905 format: double
1906 type: number
1907 type: object
1908 sparkChartView:
1909 description: Will cause the scorecard to show a spark
1910 chart.
1911 properties:
1912 minAlignmentPeriod:
1913 description: The lower bound on data point frequency
1914 in the chart implemented by specifying the minimum
1915 alignment period to use in a time series query.
1916 For example, if the data is published once every
1917 10 minutes it would not make sense to fetch and
1918 align data at one minute intervals. This field
1919 is optional and exists only as a hint.
1920 type: string
1921 sparkChartType:
1922 description: 'Required. The type of sparkchart to
1923 show in this chartView. Possible values: SPARK_CHART_TYPE_UNSPECIFIED,
1924 SPARK_LINE, SPARK_BAR'
1925 type: string
1926 required:
1927 - sparkChartType
1928 type: object
1929 thresholds:
1930 description: 'The thresholds used to determine the state
1931 of the scorecard given the time series'' current value.
1932 For an actual value x, the scorecard is in a danger
1933 state if x is less than or equal to a danger threshold
1934 that triggers below, or greater than or equal to a
1935 danger threshold that triggers above. Similarly, if
1936 x is above/below a warning threshold that triggers
1937 above/below, then the scorecard is in a warning state
1938 - unless x also puts it in a danger state. (Danger
1939 trumps warning.) As an example, consider a scorecard
1940 with the following four thresholds: { value: 90, category:
1941 ''DANGER'', trigger: ''ABOVE'', },: { value: 70, category:
1942 ''WARNING'', trigger: ''ABOVE'', }, { value: 10, category:
1943 ''DANGER'', trigger: ''BELOW'', }, { value: 20, category:
1944 ''WARNING'', trigger: ''BELOW'', } Then: values
1945 less than or equal to 10 would put the scorecard in
1946 a DANGER state, values greater than 10 but less than
1947 or equal to 20 a WARNING state, values strictly between
1948 20 and 70 an OK state, values greater than or equal
1949 to 70 but less than 90 a WARNING state, and values
1950 greater than or equal to 90 a DANGER state.'
1951 items:
1952 properties:
1953 color:
1954 description: 'The state color for this threshold.
1955 Color is not allowed in a XyChart. Possible
1956 values: COLOR_UNSPECIFIED, GREY, BLUE, GREEN,
1957 YELLOW, ORANGE, RED'
1958 type: string
1959 direction:
1960 description: 'The direction for the current threshold.
1961 Direction is not allowed in a XyChart. Possible
1962 values: DIRECTION_UNSPECIFIED, ABOVE, BELOW'
1963 type: string
1964 label:
1965 description: A label for the threshold.
1966 type: string
1967 value:
1968 description: The value of the threshold. The value
1969 should be defined in the native scale of the
1970 metric.
1971 format: double
1972 type: number
1973 type: object
1974 type: array
1975 timeSeriesQuery:
1976 description: Required. Fields for querying time series
1977 data from the Stackdriver metrics API.
1978 properties:
1979 timeSeriesFilter:
1980 description: Filter parameters to fetch time series.
1981 properties:
1982 aggregation:
1983 description: By default, the raw time series
1984 data is returned. Use this field to combine
1985 multiple time series for different views of
1986 the data.
1987 properties:
1988 alignmentPeriod:
1989 description: The `alignment_period` specifies
1990 a time interval, in seconds, that is used
1991 to divide the data in all the [time series][google.monitoring.v3.TimeSeries]
1992 into consistent blocks of time. This will
1993 be done before the per-series aligner
1994 can be applied to the data. The value
1995 must be at least 60 seconds. If a per-series
1996 aligner other than `ALIGN_NONE` is specified,
1997 this field is required or an error is
1998 returned. If no per-series aligner is
1999 specified, or the aligner `ALIGN_NONE`
2000 is specified, then this field is ignored.
2001 type: string
2002 crossSeriesReducer:
2003 description: 'The reduction operation to
2004 be used to combine time series into a
2005 single time series, where the value of
2006 each data point in the resulting series
2007 is a function of all the already aligned
2008 values in the input time series. Not
2009 all reducer operations can be applied
2010 to all time series. The valid choices
2011 depend on the `metric_kind` and the `value_type`
2012 of the original time series. Reduction
2013 can yield a time series with a different
2014 `metric_kind` or `value_type` than the
2015 input time series. Time series data must
2016 first be aligned (see `per_series_aligner`)
2017 in order to perform cross-time series
2018 reduction. If `cross_series_reducer` is
2019 specified, then `per_series_aligner` must
2020 be specified, and must not be `ALIGN_NONE`.
2021 An `alignment_period` must also be specified;
2022 otherwise, an error is returned. Possible
2023 values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN,
2024 REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV,
2025 REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE,
2026 REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99,
2027 REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50,
2028 REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN,
2029 REDUCE_MAKE_DISTRIBUTION'
2030 type: string
2031 groupByFields:
2032 description: The set of fields to preserve
2033 when `cross_series_reducer` is specified.
2034 The `group_by_fields` determine how the
2035 time series are partitioned into subsets
2036 prior to applying the aggregation operation.
2037 Each subset contains time series that
2038 have the same value for each of the grouping
2039 fields. Each individual time series is
2040 a member of exactly one subset. The `cross_series_reducer`
2041 is applied to each subset of time series.
2042 It is not possible to reduce across different
2043 resource types, so this field implicitly
2044 contains `resource.type`. Fields not
2045 specified in `group_by_fields` are aggregated
2046 away. If `group_by_fields` is not specified
2047 and all the time series have the same
2048 resource type, then the time series are
2049 aggregated into a single output time series.
2050 If `cross_series_reducer` is not defined,
2051 this field is ignored.
2052 items:
2053 type: string
2054 type: array
2055 perSeriesAligner:
2056 description: An `Aligner` describes how
2057 to bring the data points in a single time
2058 series into temporal alignment. Except
2059 for `ALIGN_NONE`, all alignments cause
2060 all the data points in an `alignment_period`
2061 to be mathematically grouped together,
2062 resulting in a single data point for each
2063 `alignment_period` with end timestamp
2064 at the end of the period. Not all alignment
2065 operations may be applied to all time
2066 series. The valid choices depend on the
2067 `metric_kind` and `value_type` of the
2068 original time series. Alignment can change
2069 the `metric_kind` or the `value_type`
2070 of the time series. Time series data
2071 must be aligned in order to perform cross-time
2072 series reduction. If `cross_series_reducer`
2073 is specified, then `per_series_aligner`
2074 must be specified and not equal to `ALIGN_NONE`
2075 and `alignment_period` must be specified;
2076 otherwise, an error is returned.
2077 type: string
2078 type: object
2079 filter:
2080 description: Required. The [monitoring filter](https://cloud.google.com/monitoring/api/v3/filters)
2081 that identifies the metric types, resources,
2082 and projects to query.
2083 type: string
2084 pickTimeSeriesFilter:
2085 description: Ranking based time series filter.
2086 properties:
2087 direction:
2088 description: 'How to use the ranking to
2089 select time series that pass through the
2090 filter. Possible values: DIRECTION_UNSPECIFIED,
2091 TOP, BOTTOM'
2092 type: string
2093 numTimeSeries:
2094 description: How many time series to allow
2095 to pass through the filter.
2096 format: int64
2097 type: integer
2098 rankingMethod:
2099 description: '`ranking_method` is applied
2100 to each time series independently to produce
2101 the value which will be used to compare
2102 the time series to other time series.
2103 Possible values: METHOD_UNSPECIFIED, METHOD_MEAN,
2104 METHOD_MAX, METHOD_MIN, METHOD_SUM, METHOD_LATEST'
2105 type: string
2106 type: object
2107 secondaryAggregation:
2108 description: Apply a second aggregation after
2109 `aggregation` is applied.
2110 properties:
2111 alignmentPeriod:
2112 description: The `alignment_period` specifies
2113 a time interval, in seconds, that is used
2114 to divide the data in all the [time series][google.monitoring.v3.TimeSeries]
2115 into consistent blocks of time. This will
2116 be done before the per-series aligner
2117 can be applied to the data. The value
2118 must be at least 60 seconds. If a per-series
2119 aligner other than `ALIGN_NONE` is specified,
2120 this field is required or an error is
2121 returned. If no per-series aligner is
2122 specified, or the aligner `ALIGN_NONE`
2123 is specified, then this field is ignored.
2124 type: string
2125 crossSeriesReducer:
2126 description: 'The reduction operation to
2127 be used to combine time series into a
2128 single time series, where the value of
2129 each data point in the resulting series
2130 is a function of all the already aligned
2131 values in the input time series. Not
2132 all reducer operations can be applied
2133 to all time series. The valid choices
2134 depend on the `metric_kind` and the `value_type`
2135 of the original time series. Reduction
2136 can yield a time series with a different
2137 `metric_kind` or `value_type` than the
2138 input time series. Time series data must
2139 first be aligned (see `per_series_aligner`)
2140 in order to perform cross-time series
2141 reduction. If `cross_series_reducer` is
2142 specified, then `per_series_aligner` must
2143 be specified, and must not be `ALIGN_NONE`.
2144 An `alignment_period` must also be specified;
2145 otherwise, an error is returned. Possible
2146 values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN,
2147 REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV,
2148 REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE,
2149 REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99,
2150 REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50,
2151 REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN,
2152 REDUCE_MAKE_DISTRIBUTION'
2153 type: string
2154 groupByFields:
2155 description: The set of fields to preserve
2156 when `cross_series_reducer` is specified.
2157 The `group_by_fields` determine how the
2158 time series are partitioned into subsets
2159 prior to applying the aggregation operation.
2160 Each subset contains time series that
2161 have the same value for each of the grouping
2162 fields. Each individual time series is
2163 a member of exactly one subset. The `cross_series_reducer`
2164 is applied to each subset of time series.
2165 It is not possible to reduce across different
2166 resource types, so this field implicitly
2167 contains `resource.type`. Fields not
2168 specified in `group_by_fields` are aggregated
2169 away. If `group_by_fields` is not specified
2170 and all the time series have the same
2171 resource type, then the time series are
2172 aggregated into a single output time series.
2173 If `cross_series_reducer` is not defined,
2174 this field is ignored.
2175 items:
2176 type: string
2177 type: array
2178 perSeriesAligner:
2179 description: An `Aligner` describes how
2180 to bring the data points in a single time
2181 series into temporal alignment. Except
2182 for `ALIGN_NONE`, all alignments cause
2183 all the data points in an `alignment_period`
2184 to be mathematically grouped together,
2185 resulting in a single data point for each
2186 `alignment_period` with end timestamp
2187 at the end of the period. Not all alignment
2188 operations may be applied to all time
2189 series. The valid choices depend on the
2190 `metric_kind` and `value_type` of the
2191 original time series. Alignment can change
2192 the `metric_kind` or the `value_type`
2193 of the time series. Time series data
2194 must be aligned in order to perform cross-time
2195 series reduction. If `cross_series_reducer`
2196 is specified, then `per_series_aligner`
2197 must be specified and not equal to `ALIGN_NONE`
2198 and `alignment_period` must be specified;
2199 otherwise, an error is returned.
2200 type: string
2201 type: object
2202 required:
2203 - filter
2204 type: object
2205 timeSeriesFilterRatio:
2206 description: Parameters to fetch a ratio between
2207 two time series filters.
2208 properties:
2209 denominator:
2210 description: The denominator of the ratio.
2211 properties:
2212 aggregation:
2213 description: By default, the raw time series
2214 data is returned. Use this field to combine
2215 multiple time series for different views
2216 of the data.
2217 properties:
2218 alignmentPeriod:
2219 description: The `alignment_period`
2220 specifies a time interval, in seconds,
2221 that is used to divide the data in
2222 all the [time series][google.monitoring.v3.TimeSeries]
2223 into consistent blocks of time. This
2224 will be done before the per-series
2225 aligner can be applied to the data. The
2226 value must be at least 60 seconds.
2227 If a per-series aligner other than
2228 `ALIGN_NONE` is specified, this field
2229 is required or an error is returned.
2230 If no per-series aligner is specified,
2231 or the aligner `ALIGN_NONE` is specified,
2232 then this field is ignored.
2233 type: string
2234 crossSeriesReducer:
2235 description: 'The reduction operation
2236 to be used to combine time series
2237 into a single time series, where the
2238 value of each data point in the resulting
2239 series is a function of all the already
2240 aligned values in the input time series. Not
2241 all reducer operations can be applied
2242 to all time series. The valid choices
2243 depend on the `metric_kind` and the
2244 `value_type` of the original time
2245 series. Reduction can yield a time
2246 series with a different `metric_kind`
2247 or `value_type` than the input time
2248 series. Time series data must first
2249 be aligned (see `per_series_aligner`)
2250 in order to perform cross-time series
2251 reduction. If `cross_series_reducer`
2252 is specified, then `per_series_aligner`
2253 must be specified, and must not be
2254 `ALIGN_NONE`. An `alignment_period`
2255 must also be specified; otherwise,
2256 an error is returned. Possible values:
2257 REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN,
2258 REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV,
2259 REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE,
2260 REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99,
2261 REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50,
2262 REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN,
2263 REDUCE_MAKE_DISTRIBUTION'
2264 type: string
2265 groupByFields:
2266 description: The set of fields to preserve
2267 when `cross_series_reducer` is specified.
2268 The `group_by_fields` determine how
2269 the time series are partitioned into
2270 subsets prior to applying the aggregation
2271 operation. Each subset contains time
2272 series that have the same value for
2273 each of the grouping fields. Each
2274 individual time series is a member
2275 of exactly one subset. The `cross_series_reducer`
2276 is applied to each subset of time
2277 series. It is not possible to reduce
2278 across different resource types, so
2279 this field implicitly contains `resource.type`. Fields
2280 not specified in `group_by_fields`
2281 are aggregated away. If `group_by_fields`
2282 is not specified and all the time
2283 series have the same resource type,
2284 then the time series are aggregated
2285 into a single output time series.
2286 If `cross_series_reducer` is not defined,
2287 this field is ignored.
2288 items:
2289 type: string
2290 type: array
2291 perSeriesAligner:
2292 description: An `Aligner` describes
2293 how to bring the data points in a
2294 single time series into temporal alignment.
2295 Except for `ALIGN_NONE`, all alignments
2296 cause all the data points in an `alignment_period`
2297 to be mathematically grouped together,
2298 resulting in a single data point for
2299 each `alignment_period` with end timestamp
2300 at the end of the period. Not all
2301 alignment operations may be applied
2302 to all time series. The valid choices
2303 depend on the `metric_kind` and `value_type`
2304 of the original time series. Alignment
2305 can change the `metric_kind` or the
2306 `value_type` of the time series. Time
2307 series data must be aligned in order
2308 to perform cross-time series reduction.
2309 If `cross_series_reducer` is specified,
2310 then `per_series_aligner` must be
2311 specified and not equal to `ALIGN_NONE`
2312 and `alignment_period` must be specified;
2313 otherwise, an error is returned.
2314 type: string
2315 type: object
2316 filter:
2317 description: Required. The [monitoring filter](https://cloud.google.com/monitoring/api/v3/filters)
2318 that identifies the metric types, resources,
2319 and projects to query.
2320 type: string
2321 required:
2322 - filter
2323 type: object
2324 numerator:
2325 description: The numerator of the ratio.
2326 properties:
2327 aggregation:
2328 description: By default, the raw time series
2329 data is returned. Use this field to combine
2330 multiple time series for different views
2331 of the data.
2332 properties:
2333 alignmentPeriod:
2334 description: The `alignment_period`
2335 specifies a time interval, in seconds,
2336 that is used to divide the data in
2337 all the [time series][google.monitoring.v3.TimeSeries]
2338 into consistent blocks of time. This
2339 will be done before the per-series
2340 aligner can be applied to the data. The
2341 value must be at least 60 seconds.
2342 If a per-series aligner other than
2343 `ALIGN_NONE` is specified, this field
2344 is required or an error is returned.
2345 If no per-series aligner is specified,
2346 or the aligner `ALIGN_NONE` is specified,
2347 then this field is ignored.
2348 type: string
2349 crossSeriesReducer:
2350 description: 'The reduction operation
2351 to be used to combine time series
2352 into a single time series, where the
2353 value of each data point in the resulting
2354 series is a function of all the already
2355 aligned values in the input time series. Not
2356 all reducer operations can be applied
2357 to all time series. The valid choices
2358 depend on the `metric_kind` and the
2359 `value_type` of the original time
2360 series. Reduction can yield a time
2361 series with a different `metric_kind`
2362 or `value_type` than the input time
2363 series. Time series data must first
2364 be aligned (see `per_series_aligner`)
2365 in order to perform cross-time series
2366 reduction. If `cross_series_reducer`
2367 is specified, then `per_series_aligner`
2368 must be specified, and must not be
2369 `ALIGN_NONE`. An `alignment_period`
2370 must also be specified; otherwise,
2371 an error is returned. Possible values:
2372 REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN,
2373 REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV,
2374 REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE,
2375 REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99,
2376 REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50,
2377 REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN,
2378 REDUCE_MAKE_DISTRIBUTION'
2379 type: string
2380 groupByFields:
2381 description: The set of fields to preserve
2382 when `cross_series_reducer` is specified.
2383 The `group_by_fields` determine how
2384 the time series are partitioned into
2385 subsets prior to applying the aggregation
2386 operation. Each subset contains time
2387 series that have the same value for
2388 each of the grouping fields. Each
2389 individual time series is a member
2390 of exactly one subset. The `cross_series_reducer`
2391 is applied to each subset of time
2392 series. It is not possible to reduce
2393 across different resource types, so
2394 this field implicitly contains `resource.type`. Fields
2395 not specified in `group_by_fields`
2396 are aggregated away. If `group_by_fields`
2397 is not specified and all the time
2398 series have the same resource type,
2399 then the time series are aggregated
2400 into a single output time series.
2401 If `cross_series_reducer` is not defined,
2402 this field is ignored.
2403 items:
2404 type: string
2405 type: array
2406 perSeriesAligner:
2407 description: An `Aligner` describes
2408 how to bring the data points in a
2409 single time series into temporal alignment.
2410 Except for `ALIGN_NONE`, all alignments
2411 cause all the data points in an `alignment_period`
2412 to be mathematically grouped together,
2413 resulting in a single data point for
2414 each `alignment_period` with end timestamp
2415 at the end of the period. Not all
2416 alignment operations may be applied
2417 to all time series. The valid choices
2418 depend on the `metric_kind` and `value_type`
2419 of the original time series. Alignment
2420 can change the `metric_kind` or the
2421 `value_type` of the time series. Time
2422 series data must be aligned in order
2423 to perform cross-time series reduction.
2424 If `cross_series_reducer` is specified,
2425 then `per_series_aligner` must be
2426 specified and not equal to `ALIGN_NONE`
2427 and `alignment_period` must be specified;
2428 otherwise, an error is returned.
2429 type: string
2430 type: object
2431 filter:
2432 description: Required. The [monitoring filter](https://cloud.google.com/monitoring/api/v3/filters)
2433 that identifies the metric types, resources,
2434 and projects to query.
2435 type: string
2436 required:
2437 - filter
2438 type: object
2439 pickTimeSeriesFilter:
2440 description: Ranking based time series filter.
2441 properties:
2442 direction:
2443 description: 'How to use the ranking to
2444 select time series that pass through the
2445 filter. Possible values: DIRECTION_UNSPECIFIED,
2446 TOP, BOTTOM'
2447 type: string
2448 numTimeSeries:
2449 description: How many time series to allow
2450 to pass through the filter.
2451 format: int64
2452 type: integer
2453 rankingMethod:
2454 description: '`ranking_method` is applied
2455 to each time series independently to produce
2456 the value which will be used to compare
2457 the time series to other time series.
2458 Possible values: METHOD_UNSPECIFIED, METHOD_MEAN,
2459 METHOD_MAX, METHOD_MIN, METHOD_SUM, METHOD_LATEST'
2460 type: string
2461 type: object
2462 secondaryAggregation:
2463 description: Apply a second aggregation after
2464 the ratio is computed.
2465 properties:
2466 alignmentPeriod:
2467 description: The `alignment_period` specifies
2468 a time interval, in seconds, that is used
2469 to divide the data in all the [time series][google.monitoring.v3.TimeSeries]
2470 into consistent blocks of time. This will
2471 be done before the per-series aligner
2472 can be applied to the data. The value
2473 must be at least 60 seconds. If a per-series
2474 aligner other than `ALIGN_NONE` is specified,
2475 this field is required or an error is
2476 returned. If no per-series aligner is
2477 specified, or the aligner `ALIGN_NONE`
2478 is specified, then this field is ignored.
2479 type: string
2480 crossSeriesReducer:
2481 description: 'The reduction operation to
2482 be used to combine time series into a
2483 single time series, where the value of
2484 each data point in the resulting series
2485 is a function of all the already aligned
2486 values in the input time series. Not
2487 all reducer operations can be applied
2488 to all time series. The valid choices
2489 depend on the `metric_kind` and the `value_type`
2490 of the original time series. Reduction
2491 can yield a time series with a different
2492 `metric_kind` or `value_type` than the
2493 input time series. Time series data must
2494 first be aligned (see `per_series_aligner`)
2495 in order to perform cross-time series
2496 reduction. If `cross_series_reducer` is
2497 specified, then `per_series_aligner` must
2498 be specified, and must not be `ALIGN_NONE`.
2499 An `alignment_period` must also be specified;
2500 otherwise, an error is returned. Possible
2501 values: REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN,
2502 REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV,
2503 REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE,
2504 REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99,
2505 REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50,
2506 REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN,
2507 REDUCE_MAKE_DISTRIBUTION'
2508 type: string
2509 groupByFields:
2510 description: The set of fields to preserve
2511 when `cross_series_reducer` is specified.
2512 The `group_by_fields` determine how the
2513 time series are partitioned into subsets
2514 prior to applying the aggregation operation.
2515 Each subset contains time series that
2516 have the same value for each of the grouping
2517 fields. Each individual time series is
2518 a member of exactly one subset. The `cross_series_reducer`
2519 is applied to each subset of time series.
2520 It is not possible to reduce across different
2521 resource types, so this field implicitly
2522 contains `resource.type`. Fields not
2523 specified in `group_by_fields` are aggregated
2524 away. If `group_by_fields` is not specified
2525 and all the time series have the same
2526 resource type, then the time series are
2527 aggregated into a single output time series.
2528 If `cross_series_reducer` is not defined,
2529 this field is ignored.
2530 items:
2531 type: string
2532 type: array
2533 perSeriesAligner:
2534 description: An `Aligner` describes how
2535 to bring the data points in a single time
2536 series into temporal alignment. Except
2537 for `ALIGN_NONE`, all alignments cause
2538 all the data points in an `alignment_period`
2539 to be mathematically grouped together,
2540 resulting in a single data point for each
2541 `alignment_period` with end timestamp
2542 at the end of the period. Not all alignment
2543 operations may be applied to all time
2544 series. The valid choices depend on the
2545 `metric_kind` and `value_type` of the
2546 original time series. Alignment can change
2547 the `metric_kind` or the `value_type`
2548 of the time series. Time series data
2549 must be aligned in order to perform cross-time
2550 series reduction. If `cross_series_reducer`
2551 is specified, then `per_series_aligner`
2552 must be specified and not equal to `ALIGN_NONE`
2553 and `alignment_period` must be specified;
2554 otherwise, an error is returned.
2555 type: string
2556 type: object
2557 type: object
2558 timeSeriesQueryLanguage:
2559 description: A query used to fetch time series.
2560 type: string
2561 unitOverride:
2562 description: The unit of data contained in fetched
2563 time series. If non-empty, this unit will override
2564 any unit that accompanies fetched data. The format
2565 is the same as the [`unit`](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors)
2566 field in `MetricDescriptor`.
2567 type: string
2568 type: object
2569 required:
2570 - timeSeriesQuery
2571 type: object
2572 text:
2573 description: A raw string or markdown displaying textual
2574 content.
2575 properties:
2576 content:
2577 description: The text content to be displayed.
2578 type: string
2579 format:
2580 description: 'How the text content is formatted. Possible
2581 values: FORMAT_UNSPECIFIED, MARKDOWN, RAW'
2582 type: string
2583 type: object
2584 title:
2585 description: Optional. The title of the widget.
2586 type: string
2587 xyChart:
2588 description: A chart of time series data.
2589 properties:
2590 chartOptions:
2591 description: Display options for the chart.
2592 properties:
2593 mode:
2594 description: 'The chart mode. Possible values: MODE_UNSPECIFIED,
2595 COLOR, X_RAY, STATS'
2596 type: string
2597 type: object
2598 dataSets:
2599 description: Required. The data displayed in this chart.
2600 items:
2601 properties:
2602 legendTemplate:
2603 description: 'A template string for naming `TimeSeries`
2604 in the resulting data set. This should be a
2605 string with interpolations of the form `${label_name}`,
2606 which will resolve to the label''s value. '
2607 type: string
2608 minAlignmentPeriod:
2609 description: Optional. The lower bound on data
2610 point frequency for this data set, implemented
2611 by specifying the minimum alignment period to
2612 use in a time series query For example, if the
2613 data is published once every 10 minutes, the
2614 `min_alignment_period` should be at least 10
2615 minutes. It would not make sense to fetch and
2616 align data at one minute intervals.
2617 type: string
2618 plotType:
2619 description: 'How this data should be plotted
2620 on the chart. Possible values: PLOT_TYPE_UNSPECIFIED,
2621 LINE, STACKED_AREA, STACKED_BAR, HEATMAP'
2622 type: string
2623 timeSeriesQuery:
2624 description: Required. Fields for querying time
2625 series data from the Stackdriver metrics API.
2626 properties:
2627 timeSeriesFilter:
2628 description: Filter parameters to fetch time
2629 series.
2630 properties:
2631 aggregation:
2632 description: By default, the raw time
2633 series data is returned. Use this field
2634 to combine multiple time series for
2635 different views of the data.
2636 properties:
2637 alignmentPeriod:
2638 description: The `alignment_period`
2639 specifies a time interval, in seconds,
2640 that is used to divide the data
2641 in all the [time series][google.monitoring.v3.TimeSeries]
2642 into consistent blocks of time.
2643 This will be done before the per-series
2644 aligner can be applied to the data. The
2645 value must be at least 60 seconds.
2646 If a per-series aligner other than
2647 `ALIGN_NONE` is specified, this
2648 field is required or an error is
2649 returned. If no per-series aligner
2650 is specified, or the aligner `ALIGN_NONE`
2651 is specified, then this field is
2652 ignored.
2653 type: string
2654 crossSeriesReducer:
2655 description: 'The reduction operation
2656 to be used to combine time series
2657 into a single time series, where
2658 the value of each data point in
2659 the resulting series is a function
2660 of all the already aligned values
2661 in the input time series. Not all
2662 reducer operations can be applied
2663 to all time series. The valid choices
2664 depend on the `metric_kind` and
2665 the `value_type` of the original
2666 time series. Reduction can yield
2667 a time series with a different `metric_kind`
2668 or `value_type` than the input time
2669 series. Time series data must first
2670 be aligned (see `per_series_aligner`)
2671 in order to perform cross-time series
2672 reduction. If `cross_series_reducer`
2673 is specified, then `per_series_aligner`
2674 must be specified, and must not
2675 be `ALIGN_NONE`. An `alignment_period`
2676 must also be specified; otherwise,
2677 an error is returned. Possible values:
2678 REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN,
2679 REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV,
2680 REDUCE_COUNT, REDUCE_COUNT_TRUE,
2681 REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE,
2682 REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95,
2683 REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05,
2684 REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION'
2685 type: string
2686 groupByFields:
2687 description: The set of fields to
2688 preserve when `cross_series_reducer`
2689 is specified. The `group_by_fields`
2690 determine how the time series are
2691 partitioned into subsets prior to
2692 applying the aggregation operation.
2693 Each subset contains time series
2694 that have the same value for each
2695 of the grouping fields. Each individual
2696 time series is a member of exactly
2697 one subset. The `cross_series_reducer`
2698 is applied to each subset of time
2699 series. It is not possible to reduce
2700 across different resource types,
2701 so this field implicitly contains
2702 `resource.type`. Fields not specified
2703 in `group_by_fields` are aggregated
2704 away. If `group_by_fields` is not
2705 specified and all the time series
2706 have the same resource type, then
2707 the time series are aggregated into
2708 a single output time series. If
2709 `cross_series_reducer` is not defined,
2710 this field is ignored.
2711 items:
2712 type: string
2713 type: array
2714 perSeriesAligner:
2715 description: An `Aligner` describes
2716 how to bring the data points in
2717 a single time series into temporal
2718 alignment. Except for `ALIGN_NONE`,
2719 all alignments cause all the data
2720 points in an `alignment_period`
2721 to be mathematically grouped together,
2722 resulting in a single data point
2723 for each `alignment_period` with
2724 end timestamp at the end of the
2725 period. Not all alignment operations
2726 may be applied to all time series.
2727 The valid choices depend on the
2728 `metric_kind` and `value_type` of
2729 the original time series. Alignment
2730 can change the `metric_kind` or
2731 the `value_type` of the time series. Time
2732 series data must be aligned in order
2733 to perform cross-time series reduction.
2734 If `cross_series_reducer` is specified,
2735 then `per_series_aligner` must be
2736 specified and not equal to `ALIGN_NONE`
2737 and `alignment_period` must be specified;
2738 otherwise, an error is returned.
2739 type: string
2740 type: object
2741 filter:
2742 description: Required. The [monitoring
2743 filter](https://cloud.google.com/monitoring/api/v3/filters)
2744 that identifies the metric types, resources,
2745 and projects to query.
2746 type: string
2747 pickTimeSeriesFilter:
2748 description: Ranking based time series
2749 filter.
2750 properties:
2751 direction:
2752 description: 'How to use the ranking
2753 to select time series that pass
2754 through the filter. Possible values:
2755 DIRECTION_UNSPECIFIED, TOP, BOTTOM'
2756 type: string
2757 numTimeSeries:
2758 description: How many time series
2759 to allow to pass through the filter.
2760 format: int64
2761 type: integer
2762 rankingMethod:
2763 description: '`ranking_method` is
2764 applied to each time series independently
2765 to produce the value which will
2766 be used to compare the time series
2767 to other time series. Possible values:
2768 METHOD_UNSPECIFIED, METHOD_MEAN,
2769 METHOD_MAX, METHOD_MIN, METHOD_SUM,
2770 METHOD_LATEST'
2771 type: string
2772 type: object
2773 secondaryAggregation:
2774 description: Apply a second aggregation
2775 after `aggregation` is applied.
2776 properties:
2777 alignmentPeriod:
2778 description: The `alignment_period`
2779 specifies a time interval, in seconds,
2780 that is used to divide the data
2781 in all the [time series][google.monitoring.v3.TimeSeries]
2782 into consistent blocks of time.
2783 This will be done before the per-series
2784 aligner can be applied to the data. The
2785 value must be at least 60 seconds.
2786 If a per-series aligner other than
2787 `ALIGN_NONE` is specified, this
2788 field is required or an error is
2789 returned. If no per-series aligner
2790 is specified, or the aligner `ALIGN_NONE`
2791 is specified, then this field is
2792 ignored.
2793 type: string
2794 crossSeriesReducer:
2795 description: 'The reduction operation
2796 to be used to combine time series
2797 into a single time series, where
2798 the value of each data point in
2799 the resulting series is a function
2800 of all the already aligned values
2801 in the input time series. Not all
2802 reducer operations can be applied
2803 to all time series. The valid choices
2804 depend on the `metric_kind` and
2805 the `value_type` of the original
2806 time series. Reduction can yield
2807 a time series with a different `metric_kind`
2808 or `value_type` than the input time
2809 series. Time series data must first
2810 be aligned (see `per_series_aligner`)
2811 in order to perform cross-time series
2812 reduction. If `cross_series_reducer`
2813 is specified, then `per_series_aligner`
2814 must be specified, and must not
2815 be `ALIGN_NONE`. An `alignment_period`
2816 must also be specified; otherwise,
2817 an error is returned. Possible values:
2818 REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN,
2819 REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV,
2820 REDUCE_COUNT, REDUCE_COUNT_TRUE,
2821 REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE,
2822 REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95,
2823 REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05,
2824 REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION'
2825 type: string
2826 groupByFields:
2827 description: The set of fields to
2828 preserve when `cross_series_reducer`
2829 is specified. The `group_by_fields`
2830 determine how the time series are
2831 partitioned into subsets prior to
2832 applying the aggregation operation.
2833 Each subset contains time series
2834 that have the same value for each
2835 of the grouping fields. Each individual
2836 time series is a member of exactly
2837 one subset. The `cross_series_reducer`
2838 is applied to each subset of time
2839 series. It is not possible to reduce
2840 across different resource types,
2841 so this field implicitly contains
2842 `resource.type`. Fields not specified
2843 in `group_by_fields` are aggregated
2844 away. If `group_by_fields` is not
2845 specified and all the time series
2846 have the same resource type, then
2847 the time series are aggregated into
2848 a single output time series. If
2849 `cross_series_reducer` is not defined,
2850 this field is ignored.
2851 items:
2852 type: string
2853 type: array
2854 perSeriesAligner:
2855 description: An `Aligner` describes
2856 how to bring the data points in
2857 a single time series into temporal
2858 alignment. Except for `ALIGN_NONE`,
2859 all alignments cause all the data
2860 points in an `alignment_period`
2861 to be mathematically grouped together,
2862 resulting in a single data point
2863 for each `alignment_period` with
2864 end timestamp at the end of the
2865 period. Not all alignment operations
2866 may be applied to all time series.
2867 The valid choices depend on the
2868 `metric_kind` and `value_type` of
2869 the original time series. Alignment
2870 can change the `metric_kind` or
2871 the `value_type` of the time series. Time
2872 series data must be aligned in order
2873 to perform cross-time series reduction.
2874 If `cross_series_reducer` is specified,
2875 then `per_series_aligner` must be
2876 specified and not equal to `ALIGN_NONE`
2877 and `alignment_period` must be specified;
2878 otherwise, an error is returned.
2879 type: string
2880 type: object
2881 required:
2882 - filter
2883 type: object
2884 timeSeriesFilterRatio:
2885 description: Parameters to fetch a ratio between
2886 two time series filters.
2887 properties:
2888 denominator:
2889 description: The denominator of the ratio.
2890 properties:
2891 aggregation:
2892 description: By default, the raw time
2893 series data is returned. Use this
2894 field to combine multiple time series
2895 for different views of the data.
2896 properties:
2897 alignmentPeriod:
2898 description: The `alignment_period`
2899 specifies a time interval, in
2900 seconds, that is used to divide
2901 the data in all the [time series][google.monitoring.v3.TimeSeries]
2902 into consistent blocks of time.
2903 This will be done before the
2904 per-series aligner can be applied
2905 to the data. The value must
2906 be at least 60 seconds. If a
2907 per-series aligner other than
2908 `ALIGN_NONE` is specified, this
2909 field is required or an error
2910 is returned. If no per-series
2911 aligner is specified, or the
2912 aligner `ALIGN_NONE` is specified,
2913 then this field is ignored.
2914 type: string
2915 crossSeriesReducer:
2916 description: 'The reduction operation
2917 to be used to combine time series
2918 into a single time series, where
2919 the value of each data point
2920 in the resulting series is a
2921 function of all the already
2922 aligned values in the input
2923 time series. Not all reducer
2924 operations can be applied to
2925 all time series. The valid choices
2926 depend on the `metric_kind`
2927 and the `value_type` of the
2928 original time series. Reduction
2929 can yield a time series with
2930 a different `metric_kind` or
2931 `value_type` than the input
2932 time series. Time series data
2933 must first be aligned (see `per_series_aligner`)
2934 in order to perform cross-time
2935 series reduction. If `cross_series_reducer`
2936 is specified, then `per_series_aligner`
2937 must be specified, and must
2938 not be `ALIGN_NONE`. An `alignment_period`
2939 must also be specified; otherwise,
2940 an error is returned. Possible
2941 values: REDUCE_NONE, REDUCE_MEAN,
2942 REDUCE_MIN, REDUCE_MAX, REDUCE_SUM,
2943 REDUCE_STDDEV, REDUCE_COUNT,
2944 REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE,
2945 REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99,
2946 REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50,
2947 REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN,
2948 REDUCE_MAKE_DISTRIBUTION'
2949 type: string
2950 groupByFields:
2951 description: The set of fields
2952 to preserve when `cross_series_reducer`
2953 is specified. The `group_by_fields`
2954 determine how the time series
2955 are partitioned into subsets
2956 prior to applying the aggregation
2957 operation. Each subset contains
2958 time series that have the same
2959 value for each of the grouping
2960 fields. Each individual time
2961 series is a member of exactly
2962 one subset. The `cross_series_reducer`
2963 is applied to each subset of
2964 time series. It is not possible
2965 to reduce across different resource
2966 types, so this field implicitly
2967 contains `resource.type`. Fields
2968 not specified in `group_by_fields`
2969 are aggregated away. If `group_by_fields`
2970 is not specified and all the
2971 time series have the same resource
2972 type, then the time series are
2973 aggregated into a single output
2974 time series. If `cross_series_reducer`
2975 is not defined, this field is
2976 ignored.
2977 items:
2978 type: string
2979 type: array
2980 perSeriesAligner:
2981 description: An `Aligner` describes
2982 how to bring the data points
2983 in a single time series into
2984 temporal alignment. Except for
2985 `ALIGN_NONE`, all alignments
2986 cause all the data points in
2987 an `alignment_period` to be
2988 mathematically grouped together,
2989 resulting in a single data point
2990 for each `alignment_period`
2991 with end timestamp at the end
2992 of the period. Not all alignment
2993 operations may be applied to
2994 all time series. The valid choices
2995 depend on the `metric_kind`
2996 and `value_type` of the original
2997 time series. Alignment can change
2998 the `metric_kind` or the `value_type`
2999 of the time series. Time series
3000 data must be aligned in order
3001 to perform cross-time series
3002 reduction. If `cross_series_reducer`
3003 is specified, then `per_series_aligner`
3004 must be specified and not equal
3005 to `ALIGN_NONE` and `alignment_period`
3006 must be specified; otherwise,
3007 an error is returned.
3008 type: string
3009 type: object
3010 filter:
3011 description: Required. The [monitoring
3012 filter](https://cloud.google.com/monitoring/api/v3/filters)
3013 that identifies the metric types,
3014 resources, and projects to query.
3015 type: string
3016 required:
3017 - filter
3018 type: object
3019 numerator:
3020 description: The numerator of the ratio.
3021 properties:
3022 aggregation:
3023 description: By default, the raw time
3024 series data is returned. Use this
3025 field to combine multiple time series
3026 for different views of the data.
3027 properties:
3028 alignmentPeriod:
3029 description: The `alignment_period`
3030 specifies a time interval, in
3031 seconds, that is used to divide
3032 the data in all the [time series][google.monitoring.v3.TimeSeries]
3033 into consistent blocks of time.
3034 This will be done before the
3035 per-series aligner can be applied
3036 to the data. The value must
3037 be at least 60 seconds. If a
3038 per-series aligner other than
3039 `ALIGN_NONE` is specified, this
3040 field is required or an error
3041 is returned. If no per-series
3042 aligner is specified, or the
3043 aligner `ALIGN_NONE` is specified,
3044 then this field is ignored.
3045 type: string
3046 crossSeriesReducer:
3047 description: 'The reduction operation
3048 to be used to combine time series
3049 into a single time series, where
3050 the value of each data point
3051 in the resulting series is a
3052 function of all the already
3053 aligned values in the input
3054 time series. Not all reducer
3055 operations can be applied to
3056 all time series. The valid choices
3057 depend on the `metric_kind`
3058 and the `value_type` of the
3059 original time series. Reduction
3060 can yield a time series with
3061 a different `metric_kind` or
3062 `value_type` than the input
3063 time series. Time series data
3064 must first be aligned (see `per_series_aligner`)
3065 in order to perform cross-time
3066 series reduction. If `cross_series_reducer`
3067 is specified, then `per_series_aligner`
3068 must be specified, and must
3069 not be `ALIGN_NONE`. An `alignment_period`
3070 must also be specified; otherwise,
3071 an error is returned. Possible
3072 values: REDUCE_NONE, REDUCE_MEAN,
3073 REDUCE_MIN, REDUCE_MAX, REDUCE_SUM,
3074 REDUCE_STDDEV, REDUCE_COUNT,
3075 REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE,
3076 REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99,
3077 REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50,
3078 REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN,
3079 REDUCE_MAKE_DISTRIBUTION'
3080 type: string
3081 groupByFields:
3082 description: The set of fields
3083 to preserve when `cross_series_reducer`
3084 is specified. The `group_by_fields`
3085 determine how the time series
3086 are partitioned into subsets
3087 prior to applying the aggregation
3088 operation. Each subset contains
3089 time series that have the same
3090 value for each of the grouping
3091 fields. Each individual time
3092 series is a member of exactly
3093 one subset. The `cross_series_reducer`
3094 is applied to each subset of
3095 time series. It is not possible
3096 to reduce across different resource
3097 types, so this field implicitly
3098 contains `resource.type`. Fields
3099 not specified in `group_by_fields`
3100 are aggregated away. If `group_by_fields`
3101 is not specified and all the
3102 time series have the same resource
3103 type, then the time series are
3104 aggregated into a single output
3105 time series. If `cross_series_reducer`
3106 is not defined, this field is
3107 ignored.
3108 items:
3109 type: string
3110 type: array
3111 perSeriesAligner:
3112 description: An `Aligner` describes
3113 how to bring the data points
3114 in a single time series into
3115 temporal alignment. Except for
3116 `ALIGN_NONE`, all alignments
3117 cause all the data points in
3118 an `alignment_period` to be
3119 mathematically grouped together,
3120 resulting in a single data point
3121 for each `alignment_period`
3122 with end timestamp at the end
3123 of the period. Not all alignment
3124 operations may be applied to
3125 all time series. The valid choices
3126 depend on the `metric_kind`
3127 and `value_type` of the original
3128 time series. Alignment can change
3129 the `metric_kind` or the `value_type`
3130 of the time series. Time series
3131 data must be aligned in order
3132 to perform cross-time series
3133 reduction. If `cross_series_reducer`
3134 is specified, then `per_series_aligner`
3135 must be specified and not equal
3136 to `ALIGN_NONE` and `alignment_period`
3137 must be specified; otherwise,
3138 an error is returned.
3139 type: string
3140 type: object
3141 filter:
3142 description: Required. The [monitoring
3143 filter](https://cloud.google.com/monitoring/api/v3/filters)
3144 that identifies the metric types,
3145 resources, and projects to query.
3146 type: string
3147 required:
3148 - filter
3149 type: object
3150 pickTimeSeriesFilter:
3151 description: Ranking based time series
3152 filter.
3153 properties:
3154 direction:
3155 description: 'How to use the ranking
3156 to select time series that pass
3157 through the filter. Possible values:
3158 DIRECTION_UNSPECIFIED, TOP, BOTTOM'
3159 type: string
3160 numTimeSeries:
3161 description: How many time series
3162 to allow to pass through the filter.
3163 format: int64
3164 type: integer
3165 rankingMethod:
3166 description: '`ranking_method` is
3167 applied to each time series independently
3168 to produce the value which will
3169 be used to compare the time series
3170 to other time series. Possible values:
3171 METHOD_UNSPECIFIED, METHOD_MEAN,
3172 METHOD_MAX, METHOD_MIN, METHOD_SUM,
3173 METHOD_LATEST'
3174 type: string
3175 type: object
3176 secondaryAggregation:
3177 description: Apply a second aggregation
3178 after the ratio is computed.
3179 properties:
3180 alignmentPeriod:
3181 description: The `alignment_period`
3182 specifies a time interval, in seconds,
3183 that is used to divide the data
3184 in all the [time series][google.monitoring.v3.TimeSeries]
3185 into consistent blocks of time.
3186 This will be done before the per-series
3187 aligner can be applied to the data. The
3188 value must be at least 60 seconds.
3189 If a per-series aligner other than
3190 `ALIGN_NONE` is specified, this
3191 field is required or an error is
3192 returned. If no per-series aligner
3193 is specified, or the aligner `ALIGN_NONE`
3194 is specified, then this field is
3195 ignored.
3196 type: string
3197 crossSeriesReducer:
3198 description: 'The reduction operation
3199 to be used to combine time series
3200 into a single time series, where
3201 the value of each data point in
3202 the resulting series is a function
3203 of all the already aligned values
3204 in the input time series. Not all
3205 reducer operations can be applied
3206 to all time series. The valid choices
3207 depend on the `metric_kind` and
3208 the `value_type` of the original
3209 time series. Reduction can yield
3210 a time series with a different `metric_kind`
3211 or `value_type` than the input time
3212 series. Time series data must first
3213 be aligned (see `per_series_aligner`)
3214 in order to perform cross-time series
3215 reduction. If `cross_series_reducer`
3216 is specified, then `per_series_aligner`
3217 must be specified, and must not
3218 be `ALIGN_NONE`. An `alignment_period`
3219 must also be specified; otherwise,
3220 an error is returned. Possible values:
3221 REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN,
3222 REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV,
3223 REDUCE_COUNT, REDUCE_COUNT_TRUE,
3224 REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE,
3225 REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95,
3226 REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05,
3227 REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION'
3228 type: string
3229 groupByFields:
3230 description: The set of fields to
3231 preserve when `cross_series_reducer`
3232 is specified. The `group_by_fields`
3233 determine how the time series are
3234 partitioned into subsets prior to
3235 applying the aggregation operation.
3236 Each subset contains time series
3237 that have the same value for each
3238 of the grouping fields. Each individual
3239 time series is a member of exactly
3240 one subset. The `cross_series_reducer`
3241 is applied to each subset of time
3242 series. It is not possible to reduce
3243 across different resource types,
3244 so this field implicitly contains
3245 `resource.type`. Fields not specified
3246 in `group_by_fields` are aggregated
3247 away. If `group_by_fields` is not
3248 specified and all the time series
3249 have the same resource type, then
3250 the time series are aggregated into
3251 a single output time series. If
3252 `cross_series_reducer` is not defined,
3253 this field is ignored.
3254 items:
3255 type: string
3256 type: array
3257 perSeriesAligner:
3258 description: An `Aligner` describes
3259 how to bring the data points in
3260 a single time series into temporal
3261 alignment. Except for `ALIGN_NONE`,
3262 all alignments cause all the data
3263 points in an `alignment_period`
3264 to be mathematically grouped together,
3265 resulting in a single data point
3266 for each `alignment_period` with
3267 end timestamp at the end of the
3268 period. Not all alignment operations
3269 may be applied to all time series.
3270 The valid choices depend on the
3271 `metric_kind` and `value_type` of
3272 the original time series. Alignment
3273 can change the `metric_kind` or
3274 the `value_type` of the time series. Time
3275 series data must be aligned in order
3276 to perform cross-time series reduction.
3277 If `cross_series_reducer` is specified,
3278 then `per_series_aligner` must be
3279 specified and not equal to `ALIGN_NONE`
3280 and `alignment_period` must be specified;
3281 otherwise, an error is returned.
3282 type: string
3283 type: object
3284 type: object
3285 timeSeriesQueryLanguage:
3286 description: A query used to fetch time series.
3287 type: string
3288 unitOverride:
3289 description: The unit of data contained in
3290 fetched time series. If non-empty, this
3291 unit will override any unit that accompanies
3292 fetched data. The format is the same as
3293 the [`unit`](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors)
3294 field in `MetricDescriptor`.
3295 type: string
3296 type: object
3297 required:
3298 - timeSeriesQuery
3299 type: object
3300 type: array
3301 thresholds:
3302 description: Threshold lines drawn horizontally across
3303 the chart.
3304 items:
3305 properties:
3306 color:
3307 description: 'The state color for this threshold.
3308 Color is not allowed in a XyChart. Possible
3309 values: COLOR_UNSPECIFIED, GREY, BLUE, GREEN,
3310 YELLOW, ORANGE, RED'
3311 type: string
3312 direction:
3313 description: 'The direction for the current threshold.
3314 Direction is not allowed in a XyChart. Possible
3315 values: DIRECTION_UNSPECIFIED, ABOVE, BELOW'
3316 type: string
3317 label:
3318 description: A label for the threshold.
3319 type: string
3320 value:
3321 description: The value of the threshold. The value
3322 should be defined in the native scale of the
3323 metric.
3324 format: double
3325 type: number
3326 type: object
3327 type: array
3328 timeshiftDuration:
3329 description: The duration used to display a comparison
3330 chart. A comparison chart simultaneously shows values
3331 from two similar-length time periods (e.g., week-over-week
3332 metrics). The duration must be positive, and it can
3333 only be applied to charts with data sets of LINE plot
3334 type.
3335 type: string
3336 xAxis:
3337 description: The properties applied to the X axis.
3338 properties:
3339 label:
3340 description: The label of the axis.
3341 type: string
3342 scale:
3343 description: 'The axis scale. By default, a linear
3344 scale is used. Possible values: SCALE_UNSPECIFIED,
3345 LINEAR, LOG10'
3346 type: string
3347 type: object
3348 yAxis:
3349 description: The properties applied to the Y axis.
3350 properties:
3351 label:
3352 description: The label of the axis.
3353 type: string
3354 scale:
3355 description: 'The axis scale. By default, a linear
3356 scale is used. Possible values: SCALE_UNSPECIFIED,
3357 LINEAR, LOG10'
3358 type: string
3359 type: object
3360 required:
3361 - dataSets
3362 type: object
3363 type: object
3364 type: array
3365 type: object
3366 mosaicLayout:
3367 description: The content is arranged as a grid of tiles, with each
3368 content widget occupying one or more tiles.
3369 properties:
3370 columns:
3371 description: The number of columns in the mosaic grid.
3372 format: int64
3373 type: integer
3374 tiles:
3375 description: The tiles to display.
3376 items:
3377 properties:
3378 height:
3379 description: The height of the tile, measured in grid squares.
3380 format: int64
3381 type: integer
3382 widget:
3383 description: The informational widget contained in the tile.
3384 properties:
3385 blank:
3386 description: A blank space.
3387 type: object
3388 x-kubernetes-preserve-unknown-fields: true
3389 logsPanel:
3390 properties:
3391 filter:
3392 description: A filter that chooses which log entries
3393 to return. See [Advanced Logs Queries](https://cloud.google.com/logging/docs/view/advanced-queries).
3394 Only log entries that match the filter are returned.
3395 An empty filter matches all log entries.
3396 type: string
3397 resourceNames:
3398 items:
3399 oneOf:
3400 - not:
3401 required:
3402 - external
3403 required:
3404 - name
3405 - not:
3406 anyOf:
3407 - required:
3408 - name
3409 - required:
3410 - namespace
3411 required:
3412 - external
3413 properties:
3414 external:
3415 description: 'Allowed value: The Google Cloud
3416 resource name of a `Project` resource (format:
3417 `projects/{{name}}`).'
3418 type: string
3419 name:
3420 description: 'Name of the referent. More info:
3421 https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
3422 type: string
3423 namespace:
3424 description: 'Namespace of the referent. More
3425 info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
3426 type: string
3427 type: object
3428 type: array
3429 type: object
3430 scorecard:
3431 description: A scorecard summarizing time series data.
3432 properties:
3433 gaugeView:
3434 description: Will cause the scorecard to show a
3435 gauge chart.
3436 properties:
3437 lowerBound:
3438 description: The lower bound for this gauge
3439 chart. The value of the chart should always
3440 be greater than or equal to this.
3441 format: double
3442 type: number
3443 upperBound:
3444 description: The upper bound for this gauge
3445 chart. The value of the chart should always
3446 be less than or equal to this.
3447 format: double
3448 type: number
3449 type: object
3450 sparkChartView:
3451 description: Will cause the scorecard to show a
3452 spark chart.
3453 properties:
3454 minAlignmentPeriod:
3455 description: The lower bound on data point frequency
3456 in the chart implemented by specifying the
3457 minimum alignment period to use in a time
3458 series query. For example, if the data is
3459 published once every 10 minutes it would not
3460 make sense to fetch and align data at one
3461 minute intervals. This field is optional and
3462 exists only as a hint.
3463 type: string
3464 sparkChartType:
3465 description: 'Required. The type of sparkchart
3466 to show in this chartView. Possible values:
3467 SPARK_CHART_TYPE_UNSPECIFIED, SPARK_LINE,
3468 SPARK_BAR'
3469 type: string
3470 required:
3471 - sparkChartType
3472 type: object
3473 thresholds:
3474 description: 'The thresholds used to determine the
3475 state of the scorecard given the time series''
3476 current value. For an actual value x, the scorecard
3477 is in a danger state if x is less than or equal
3478 to a danger threshold that triggers below, or
3479 greater than or equal to a danger threshold that
3480 triggers above. Similarly, if x is above/below
3481 a warning threshold that triggers above/below,
3482 then the scorecard is in a warning state - unless
3483 x also puts it in a danger state. (Danger trumps
3484 warning.) As an example, consider a scorecard
3485 with the following four thresholds: { value:
3486 90, category: ''DANGER'', trigger: ''ABOVE'',
3487 },: { value: 70, category: ''WARNING'', trigger:
3488 ''ABOVE'', }, { value: 10, category: ''DANGER'', trigger:
3489 ''BELOW'', }, { value: 20, category: ''WARNING'', trigger:
3490 ''BELOW'', } Then: values less than or equal
3491 to 10 would put the scorecard in a DANGER state,
3492 values greater than 10 but less than or equal
3493 to 20 a WARNING state, values strictly between
3494 20 and 70 an OK state, values greater than or
3495 equal to 70 but less than 90 a WARNING state,
3496 and values greater than or equal to 90 a DANGER
3497 state.'
3498 items:
3499 properties:
3500 color:
3501 description: 'The state color for this threshold.
3502 Color is not allowed in a XyChart. Possible
3503 values: COLOR_UNSPECIFIED, GREY, BLUE, GREEN,
3504 YELLOW, ORANGE, RED'
3505 type: string
3506 direction:
3507 description: 'The direction for the current
3508 threshold. Direction is not allowed in a
3509 XyChart. Possible values: DIRECTION_UNSPECIFIED,
3510 ABOVE, BELOW'
3511 type: string
3512 label:
3513 description: A label for the threshold.
3514 type: string
3515 value:
3516 description: The value of the threshold. The
3517 value should be defined in the native scale
3518 of the metric.
3519 format: double
3520 type: number
3521 type: object
3522 type: array
3523 timeSeriesQuery:
3524 description: Required. Fields for querying time
3525 series data from the Stackdriver metrics API.
3526 properties:
3527 timeSeriesFilter:
3528 description: Filter parameters to fetch time
3529 series.
3530 properties:
3531 aggregation:
3532 description: By default, the raw time series
3533 data is returned. Use this field to combine
3534 multiple time series for different views
3535 of the data.
3536 properties:
3537 alignmentPeriod:
3538 description: The `alignment_period`
3539 specifies a time interval, in seconds,
3540 that is used to divide the data in
3541 all the [time series][google.monitoring.v3.TimeSeries]
3542 into consistent blocks of time. This
3543 will be done before the per-series
3544 aligner can be applied to the data. The
3545 value must be at least 60 seconds.
3546 If a per-series aligner other than
3547 `ALIGN_NONE` is specified, this field
3548 is required or an error is returned.
3549 If no per-series aligner is specified,
3550 or the aligner `ALIGN_NONE` is specified,
3551 then this field is ignored.
3552 type: string
3553 crossSeriesReducer:
3554 description: 'The reduction operation
3555 to be used to combine time series
3556 into a single time series, where the
3557 value of each data point in the resulting
3558 series is a function of all the already
3559 aligned values in the input time series. Not
3560 all reducer operations can be applied
3561 to all time series. The valid choices
3562 depend on the `metric_kind` and the
3563 `value_type` of the original time
3564 series. Reduction can yield a time
3565 series with a different `metric_kind`
3566 or `value_type` than the input time
3567 series. Time series data must first
3568 be aligned (see `per_series_aligner`)
3569 in order to perform cross-time series
3570 reduction. If `cross_series_reducer`
3571 is specified, then `per_series_aligner`
3572 must be specified, and must not be
3573 `ALIGN_NONE`. An `alignment_period`
3574 must also be specified; otherwise,
3575 an error is returned. Possible values:
3576 REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN,
3577 REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV,
3578 REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE,
3579 REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99,
3580 REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50,
3581 REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN,
3582 REDUCE_MAKE_DISTRIBUTION'
3583 type: string
3584 groupByFields:
3585 description: The set of fields to preserve
3586 when `cross_series_reducer` is specified.
3587 The `group_by_fields` determine how
3588 the time series are partitioned into
3589 subsets prior to applying the aggregation
3590 operation. Each subset contains time
3591 series that have the same value for
3592 each of the grouping fields. Each
3593 individual time series is a member
3594 of exactly one subset. The `cross_series_reducer`
3595 is applied to each subset of time
3596 series. It is not possible to reduce
3597 across different resource types, so
3598 this field implicitly contains `resource.type`. Fields
3599 not specified in `group_by_fields`
3600 are aggregated away. If `group_by_fields`
3601 is not specified and all the time
3602 series have the same resource type,
3603 then the time series are aggregated
3604 into a single output time series.
3605 If `cross_series_reducer` is not defined,
3606 this field is ignored.
3607 items:
3608 type: string
3609 type: array
3610 perSeriesAligner:
3611 description: An `Aligner` describes
3612 how to bring the data points in a
3613 single time series into temporal alignment.
3614 Except for `ALIGN_NONE`, all alignments
3615 cause all the data points in an `alignment_period`
3616 to be mathematically grouped together,
3617 resulting in a single data point for
3618 each `alignment_period` with end timestamp
3619 at the end of the period. Not all
3620 alignment operations may be applied
3621 to all time series. The valid choices
3622 depend on the `metric_kind` and `value_type`
3623 of the original time series. Alignment
3624 can change the `metric_kind` or the
3625 `value_type` of the time series. Time
3626 series data must be aligned in order
3627 to perform cross-time series reduction.
3628 If `cross_series_reducer` is specified,
3629 then `per_series_aligner` must be
3630 specified and not equal to `ALIGN_NONE`
3631 and `alignment_period` must be specified;
3632 otherwise, an error is returned.
3633 type: string
3634 type: object
3635 filter:
3636 description: Required. The [monitoring filter](https://cloud.google.com/monitoring/api/v3/filters)
3637 that identifies the metric types, resources,
3638 and projects to query.
3639 type: string
3640 pickTimeSeriesFilter:
3641 description: Ranking based time series filter.
3642 properties:
3643 direction:
3644 description: 'How to use the ranking
3645 to select time series that pass through
3646 the filter. Possible values: DIRECTION_UNSPECIFIED,
3647 TOP, BOTTOM'
3648 type: string
3649 numTimeSeries:
3650 description: How many time series to
3651 allow to pass through the filter.
3652 format: int64
3653 type: integer
3654 rankingMethod:
3655 description: '`ranking_method` is applied
3656 to each time series independently
3657 to produce the value which will be
3658 used to compare the time series to
3659 other time series. Possible values:
3660 METHOD_UNSPECIFIED, METHOD_MEAN, METHOD_MAX,
3661 METHOD_MIN, METHOD_SUM, METHOD_LATEST'
3662 type: string
3663 type: object
3664 secondaryAggregation:
3665 description: Apply a second aggregation
3666 after `aggregation` is applied.
3667 properties:
3668 alignmentPeriod:
3669 description: The `alignment_period`
3670 specifies a time interval, in seconds,
3671 that is used to divide the data in
3672 all the [time series][google.monitoring.v3.TimeSeries]
3673 into consistent blocks of time. This
3674 will be done before the per-series
3675 aligner can be applied to the data. The
3676 value must be at least 60 seconds.
3677 If a per-series aligner other than
3678 `ALIGN_NONE` is specified, this field
3679 is required or an error is returned.
3680 If no per-series aligner is specified,
3681 or the aligner `ALIGN_NONE` is specified,
3682 then this field is ignored.
3683 type: string
3684 crossSeriesReducer:
3685 description: 'The reduction operation
3686 to be used to combine time series
3687 into a single time series, where the
3688 value of each data point in the resulting
3689 series is a function of all the already
3690 aligned values in the input time series. Not
3691 all reducer operations can be applied
3692 to all time series. The valid choices
3693 depend on the `metric_kind` and the
3694 `value_type` of the original time
3695 series. Reduction can yield a time
3696 series with a different `metric_kind`
3697 or `value_type` than the input time
3698 series. Time series data must first
3699 be aligned (see `per_series_aligner`)
3700 in order to perform cross-time series
3701 reduction. If `cross_series_reducer`
3702 is specified, then `per_series_aligner`
3703 must be specified, and must not be
3704 `ALIGN_NONE`. An `alignment_period`
3705 must also be specified; otherwise,
3706 an error is returned. Possible values:
3707 REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN,
3708 REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV,
3709 REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE,
3710 REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99,
3711 REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50,
3712 REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN,
3713 REDUCE_MAKE_DISTRIBUTION'
3714 type: string
3715 groupByFields:
3716 description: The set of fields to preserve
3717 when `cross_series_reducer` is specified.
3718 The `group_by_fields` determine how
3719 the time series are partitioned into
3720 subsets prior to applying the aggregation
3721 operation. Each subset contains time
3722 series that have the same value for
3723 each of the grouping fields. Each
3724 individual time series is a member
3725 of exactly one subset. The `cross_series_reducer`
3726 is applied to each subset of time
3727 series. It is not possible to reduce
3728 across different resource types, so
3729 this field implicitly contains `resource.type`. Fields
3730 not specified in `group_by_fields`
3731 are aggregated away. If `group_by_fields`
3732 is not specified and all the time
3733 series have the same resource type,
3734 then the time series are aggregated
3735 into a single output time series.
3736 If `cross_series_reducer` is not defined,
3737 this field is ignored.
3738 items:
3739 type: string
3740 type: array
3741 perSeriesAligner:
3742 description: An `Aligner` describes
3743 how to bring the data points in a
3744 single time series into temporal alignment.
3745 Except for `ALIGN_NONE`, all alignments
3746 cause all the data points in an `alignment_period`
3747 to be mathematically grouped together,
3748 resulting in a single data point for
3749 each `alignment_period` with end timestamp
3750 at the end of the period. Not all
3751 alignment operations may be applied
3752 to all time series. The valid choices
3753 depend on the `metric_kind` and `value_type`
3754 of the original time series. Alignment
3755 can change the `metric_kind` or the
3756 `value_type` of the time series. Time
3757 series data must be aligned in order
3758 to perform cross-time series reduction.
3759 If `cross_series_reducer` is specified,
3760 then `per_series_aligner` must be
3761 specified and not equal to `ALIGN_NONE`
3762 and `alignment_period` must be specified;
3763 otherwise, an error is returned.
3764 type: string
3765 type: object
3766 required:
3767 - filter
3768 type: object
3769 timeSeriesFilterRatio:
3770 description: Parameters to fetch a ratio between
3771 two time series filters.
3772 properties:
3773 denominator:
3774 description: The denominator of the ratio.
3775 properties:
3776 aggregation:
3777 description: By default, the raw time
3778 series data is returned. Use this
3779 field to combine multiple time series
3780 for different views of the data.
3781 properties:
3782 alignmentPeriod:
3783 description: The `alignment_period`
3784 specifies a time interval, in
3785 seconds, that is used to divide
3786 the data in all the [time series][google.monitoring.v3.TimeSeries]
3787 into consistent blocks of time.
3788 This will be done before the per-series
3789 aligner can be applied to the
3790 data. The value must be at least
3791 60 seconds. If a per-series aligner
3792 other than `ALIGN_NONE` is specified,
3793 this field is required or an error
3794 is returned. If no per-series
3795 aligner is specified, or the aligner
3796 `ALIGN_NONE` is specified, then
3797 this field is ignored.
3798 type: string
3799 crossSeriesReducer:
3800 description: 'The reduction operation
3801 to be used to combine time series
3802 into a single time series, where
3803 the value of each data point in
3804 the resulting series is a function
3805 of all the already aligned values
3806 in the input time series. Not
3807 all reducer operations can be
3808 applied to all time series. The
3809 valid choices depend on the `metric_kind`
3810 and the `value_type` of the original
3811 time series. Reduction can yield
3812 a time series with a different
3813 `metric_kind` or `value_type`
3814 than the input time series. Time
3815 series data must first be aligned
3816 (see `per_series_aligner`) in
3817 order to perform cross-time series
3818 reduction. If `cross_series_reducer`
3819 is specified, then `per_series_aligner`
3820 must be specified, and must not
3821 be `ALIGN_NONE`. An `alignment_period`
3822 must also be specified; otherwise,
3823 an error is returned. Possible
3824 values: REDUCE_NONE, REDUCE_MEAN,
3825 REDUCE_MIN, REDUCE_MAX, REDUCE_SUM,
3826 REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE,
3827 REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE,
3828 REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95,
3829 REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05,
3830 REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION'
3831 type: string
3832 groupByFields:
3833 description: The set of fields to
3834 preserve when `cross_series_reducer`
3835 is specified. The `group_by_fields`
3836 determine how the time series
3837 are partitioned into subsets prior
3838 to applying the aggregation operation.
3839 Each subset contains time series
3840 that have the same value for each
3841 of the grouping fields. Each individual
3842 time series is a member of exactly
3843 one subset. The `cross_series_reducer`
3844 is applied to each subset of time
3845 series. It is not possible to
3846 reduce across different resource
3847 types, so this field implicitly
3848 contains `resource.type`. Fields
3849 not specified in `group_by_fields`
3850 are aggregated away. If `group_by_fields`
3851 is not specified and all the time
3852 series have the same resource
3853 type, then the time series are
3854 aggregated into a single output
3855 time series. If `cross_series_reducer`
3856 is not defined, this field is
3857 ignored.
3858 items:
3859 type: string
3860 type: array
3861 perSeriesAligner:
3862 description: An `Aligner` describes
3863 how to bring the data points in
3864 a single time series into temporal
3865 alignment. Except for `ALIGN_NONE`,
3866 all alignments cause all the data
3867 points in an `alignment_period`
3868 to be mathematically grouped together,
3869 resulting in a single data point
3870 for each `alignment_period` with
3871 end timestamp at the end of the
3872 period. Not all alignment operations
3873 may be applied to all time series.
3874 The valid choices depend on the
3875 `metric_kind` and `value_type`
3876 of the original time series. Alignment
3877 can change the `metric_kind` or
3878 the `value_type` of the time series. Time
3879 series data must be aligned in
3880 order to perform cross-time series
3881 reduction. If `cross_series_reducer`
3882 is specified, then `per_series_aligner`
3883 must be specified and not equal
3884 to `ALIGN_NONE` and `alignment_period`
3885 must be specified; otherwise,
3886 an error is returned.
3887 type: string
3888 type: object
3889 filter:
3890 description: Required. The [monitoring
3891 filter](https://cloud.google.com/monitoring/api/v3/filters)
3892 that identifies the metric types,
3893 resources, and projects to query.
3894 type: string
3895 required:
3896 - filter
3897 type: object
3898 numerator:
3899 description: The numerator of the ratio.
3900 properties:
3901 aggregation:
3902 description: By default, the raw time
3903 series data is returned. Use this
3904 field to combine multiple time series
3905 for different views of the data.
3906 properties:
3907 alignmentPeriod:
3908 description: The `alignment_period`
3909 specifies a time interval, in
3910 seconds, that is used to divide
3911 the data in all the [time series][google.monitoring.v3.TimeSeries]
3912 into consistent blocks of time.
3913 This will be done before the per-series
3914 aligner can be applied to the
3915 data. The value must be at least
3916 60 seconds. If a per-series aligner
3917 other than `ALIGN_NONE` is specified,
3918 this field is required or an error
3919 is returned. If no per-series
3920 aligner is specified, or the aligner
3921 `ALIGN_NONE` is specified, then
3922 this field is ignored.
3923 type: string
3924 crossSeriesReducer:
3925 description: 'The reduction operation
3926 to be used to combine time series
3927 into a single time series, where
3928 the value of each data point in
3929 the resulting series is a function
3930 of all the already aligned values
3931 in the input time series. Not
3932 all reducer operations can be
3933 applied to all time series. The
3934 valid choices depend on the `metric_kind`
3935 and the `value_type` of the original
3936 time series. Reduction can yield
3937 a time series with a different
3938 `metric_kind` or `value_type`
3939 than the input time series. Time
3940 series data must first be aligned
3941 (see `per_series_aligner`) in
3942 order to perform cross-time series
3943 reduction. If `cross_series_reducer`
3944 is specified, then `per_series_aligner`
3945 must be specified, and must not
3946 be `ALIGN_NONE`. An `alignment_period`
3947 must also be specified; otherwise,
3948 an error is returned. Possible
3949 values: REDUCE_NONE, REDUCE_MEAN,
3950 REDUCE_MIN, REDUCE_MAX, REDUCE_SUM,
3951 REDUCE_STDDEV, REDUCE_COUNT, REDUCE_COUNT_TRUE,
3952 REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE,
3953 REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95,
3954 REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05,
3955 REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION'
3956 type: string
3957 groupByFields:
3958 description: The set of fields to
3959 preserve when `cross_series_reducer`
3960 is specified. The `group_by_fields`
3961 determine how the time series
3962 are partitioned into subsets prior
3963 to applying the aggregation operation.
3964 Each subset contains time series
3965 that have the same value for each
3966 of the grouping fields. Each individual
3967 time series is a member of exactly
3968 one subset. The `cross_series_reducer`
3969 is applied to each subset of time
3970 series. It is not possible to
3971 reduce across different resource
3972 types, so this field implicitly
3973 contains `resource.type`. Fields
3974 not specified in `group_by_fields`
3975 are aggregated away. If `group_by_fields`
3976 is not specified and all the time
3977 series have the same resource
3978 type, then the time series are
3979 aggregated into a single output
3980 time series. If `cross_series_reducer`
3981 is not defined, this field is
3982 ignored.
3983 items:
3984 type: string
3985 type: array
3986 perSeriesAligner:
3987 description: An `Aligner` describes
3988 how to bring the data points in
3989 a single time series into temporal
3990 alignment. Except for `ALIGN_NONE`,
3991 all alignments cause all the data
3992 points in an `alignment_period`
3993 to be mathematically grouped together,
3994 resulting in a single data point
3995 for each `alignment_period` with
3996 end timestamp at the end of the
3997 period. Not all alignment operations
3998 may be applied to all time series.
3999 The valid choices depend on the
4000 `metric_kind` and `value_type`
4001 of the original time series. Alignment
4002 can change the `metric_kind` or
4003 the `value_type` of the time series. Time
4004 series data must be aligned in
4005 order to perform cross-time series
4006 reduction. If `cross_series_reducer`
4007 is specified, then `per_series_aligner`
4008 must be specified and not equal
4009 to `ALIGN_NONE` and `alignment_period`
4010 must be specified; otherwise,
4011 an error is returned.
4012 type: string
4013 type: object
4014 filter:
4015 description: Required. The [monitoring
4016 filter](https://cloud.google.com/monitoring/api/v3/filters)
4017 that identifies the metric types,
4018 resources, and projects to query.
4019 type: string
4020 required:
4021 - filter
4022 type: object
4023 pickTimeSeriesFilter:
4024 description: Ranking based time series filter.
4025 properties:
4026 direction:
4027 description: 'How to use the ranking
4028 to select time series that pass through
4029 the filter. Possible values: DIRECTION_UNSPECIFIED,
4030 TOP, BOTTOM'
4031 type: string
4032 numTimeSeries:
4033 description: How many time series to
4034 allow to pass through the filter.
4035 format: int64
4036 type: integer
4037 rankingMethod:
4038 description: '`ranking_method` is applied
4039 to each time series independently
4040 to produce the value which will be
4041 used to compare the time series to
4042 other time series. Possible values:
4043 METHOD_UNSPECIFIED, METHOD_MEAN, METHOD_MAX,
4044 METHOD_MIN, METHOD_SUM, METHOD_LATEST'
4045 type: string
4046 type: object
4047 secondaryAggregation:
4048 description: Apply a second aggregation
4049 after the ratio is computed.
4050 properties:
4051 alignmentPeriod:
4052 description: The `alignment_period`
4053 specifies a time interval, in seconds,
4054 that is used to divide the data in
4055 all the [time series][google.monitoring.v3.TimeSeries]
4056 into consistent blocks of time. This
4057 will be done before the per-series
4058 aligner can be applied to the data. The
4059 value must be at least 60 seconds.
4060 If a per-series aligner other than
4061 `ALIGN_NONE` is specified, this field
4062 is required or an error is returned.
4063 If no per-series aligner is specified,
4064 or the aligner `ALIGN_NONE` is specified,
4065 then this field is ignored.
4066 type: string
4067 crossSeriesReducer:
4068 description: 'The reduction operation
4069 to be used to combine time series
4070 into a single time series, where the
4071 value of each data point in the resulting
4072 series is a function of all the already
4073 aligned values in the input time series. Not
4074 all reducer operations can be applied
4075 to all time series. The valid choices
4076 depend on the `metric_kind` and the
4077 `value_type` of the original time
4078 series. Reduction can yield a time
4079 series with a different `metric_kind`
4080 or `value_type` than the input time
4081 series. Time series data must first
4082 be aligned (see `per_series_aligner`)
4083 in order to perform cross-time series
4084 reduction. If `cross_series_reducer`
4085 is specified, then `per_series_aligner`
4086 must be specified, and must not be
4087 `ALIGN_NONE`. An `alignment_period`
4088 must also be specified; otherwise,
4089 an error is returned. Possible values:
4090 REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN,
4091 REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV,
4092 REDUCE_COUNT, REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE,
4093 REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99,
4094 REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50,
4095 REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN,
4096 REDUCE_MAKE_DISTRIBUTION'
4097 type: string
4098 groupByFields:
4099 description: The set of fields to preserve
4100 when `cross_series_reducer` is specified.
4101 The `group_by_fields` determine how
4102 the time series are partitioned into
4103 subsets prior to applying the aggregation
4104 operation. Each subset contains time
4105 series that have the same value for
4106 each of the grouping fields. Each
4107 individual time series is a member
4108 of exactly one subset. The `cross_series_reducer`
4109 is applied to each subset of time
4110 series. It is not possible to reduce
4111 across different resource types, so
4112 this field implicitly contains `resource.type`. Fields
4113 not specified in `group_by_fields`
4114 are aggregated away. If `group_by_fields`
4115 is not specified and all the time
4116 series have the same resource type,
4117 then the time series are aggregated
4118 into a single output time series.
4119 If `cross_series_reducer` is not defined,
4120 this field is ignored.
4121 items:
4122 type: string
4123 type: array
4124 perSeriesAligner:
4125 description: An `Aligner` describes
4126 how to bring the data points in a
4127 single time series into temporal alignment.
4128 Except for `ALIGN_NONE`, all alignments
4129 cause all the data points in an `alignment_period`
4130 to be mathematically grouped together,
4131 resulting in a single data point for
4132 each `alignment_period` with end timestamp
4133 at the end of the period. Not all
4134 alignment operations may be applied
4135 to all time series. The valid choices
4136 depend on the `metric_kind` and `value_type`
4137 of the original time series. Alignment
4138 can change the `metric_kind` or the
4139 `value_type` of the time series. Time
4140 series data must be aligned in order
4141 to perform cross-time series reduction.
4142 If `cross_series_reducer` is specified,
4143 then `per_series_aligner` must be
4144 specified and not equal to `ALIGN_NONE`
4145 and `alignment_period` must be specified;
4146 otherwise, an error is returned.
4147 type: string
4148 type: object
4149 type: object
4150 timeSeriesQueryLanguage:
4151 description: A query used to fetch time series.
4152 type: string
4153 unitOverride:
4154 description: The unit of data contained in fetched
4155 time series. If non-empty, this unit will
4156 override any unit that accompanies fetched
4157 data. The format is the same as the [`unit`](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors)
4158 field in `MetricDescriptor`.
4159 type: string
4160 type: object
4161 required:
4162 - timeSeriesQuery
4163 type: object
4164 text:
4165 description: A raw string or markdown displaying textual
4166 content.
4167 properties:
4168 content:
4169 description: The text content to be displayed.
4170 type: string
4171 format:
4172 description: 'How the text content is formatted.
4173 Possible values: FORMAT_UNSPECIFIED, MARKDOWN,
4174 RAW'
4175 type: string
4176 type: object
4177 title:
4178 description: Optional. The title of the widget.
4179 type: string
4180 xyChart:
4181 description: A chart of time series data.
4182 properties:
4183 chartOptions:
4184 description: Display options for the chart.
4185 properties:
4186 mode:
4187 description: 'The chart mode. Possible values:
4188 MODE_UNSPECIFIED, COLOR, X_RAY, STATS'
4189 type: string
4190 type: object
4191 dataSets:
4192 description: Required. The data displayed in this
4193 chart.
4194 items:
4195 properties:
4196 legendTemplate:
4197 description: 'A template string for naming
4198 `TimeSeries` in the resulting data set.
4199 This should be a string with interpolations
4200 of the form `${label_name}`, which will
4201 resolve to the label''s value. '
4202 type: string
4203 minAlignmentPeriod:
4204 description: Optional. The lower bound on
4205 data point frequency for this data set,
4206 implemented by specifying the minimum alignment
4207 period to use in a time series query For
4208 example, if the data is published once every
4209 10 minutes, the `min_alignment_period` should
4210 be at least 10 minutes. It would not make
4211 sense to fetch and align data at one minute
4212 intervals.
4213 type: string
4214 plotType:
4215 description: 'How this data should be plotted
4216 on the chart. Possible values: PLOT_TYPE_UNSPECIFIED,
4217 LINE, STACKED_AREA, STACKED_BAR, HEATMAP'
4218 type: string
4219 timeSeriesQuery:
4220 description: Required. Fields for querying
4221 time series data from the Stackdriver metrics
4222 API.
4223 properties:
4224 timeSeriesFilter:
4225 description: Filter parameters to fetch
4226 time series.
4227 properties:
4228 aggregation:
4229 description: By default, the raw time
4230 series data is returned. Use this
4231 field to combine multiple time series
4232 for different views of the data.
4233 properties:
4234 alignmentPeriod:
4235 description: The `alignment_period`
4236 specifies a time interval, in
4237 seconds, that is used to divide
4238 the data in all the [time series][google.monitoring.v3.TimeSeries]
4239 into consistent blocks of time.
4240 This will be done before the
4241 per-series aligner can be applied
4242 to the data. The value must
4243 be at least 60 seconds. If a
4244 per-series aligner other than
4245 `ALIGN_NONE` is specified, this
4246 field is required or an error
4247 is returned. If no per-series
4248 aligner is specified, or the
4249 aligner `ALIGN_NONE` is specified,
4250 then this field is ignored.
4251 type: string
4252 crossSeriesReducer:
4253 description: 'The reduction operation
4254 to be used to combine time series
4255 into a single time series, where
4256 the value of each data point
4257 in the resulting series is a
4258 function of all the already
4259 aligned values in the input
4260 time series. Not all reducer
4261 operations can be applied to
4262 all time series. The valid choices
4263 depend on the `metric_kind`
4264 and the `value_type` of the
4265 original time series. Reduction
4266 can yield a time series with
4267 a different `metric_kind` or
4268 `value_type` than the input
4269 time series. Time series data
4270 must first be aligned (see `per_series_aligner`)
4271 in order to perform cross-time
4272 series reduction. If `cross_series_reducer`
4273 is specified, then `per_series_aligner`
4274 must be specified, and must
4275 not be `ALIGN_NONE`. An `alignment_period`
4276 must also be specified; otherwise,
4277 an error is returned. Possible
4278 values: REDUCE_NONE, REDUCE_MEAN,
4279 REDUCE_MIN, REDUCE_MAX, REDUCE_SUM,
4280 REDUCE_STDDEV, REDUCE_COUNT,
4281 REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE,
4282 REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99,
4283 REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50,
4284 REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN,
4285 REDUCE_MAKE_DISTRIBUTION'
4286 type: string
4287 groupByFields:
4288 description: The set of fields
4289 to preserve when `cross_series_reducer`
4290 is specified. The `group_by_fields`
4291 determine how the time series
4292 are partitioned into subsets
4293 prior to applying the aggregation
4294 operation. Each subset contains
4295 time series that have the same
4296 value for each of the grouping
4297 fields. Each individual time
4298 series is a member of exactly
4299 one subset. The `cross_series_reducer`
4300 is applied to each subset of
4301 time series. It is not possible
4302 to reduce across different resource
4303 types, so this field implicitly
4304 contains `resource.type`. Fields
4305 not specified in `group_by_fields`
4306 are aggregated away. If `group_by_fields`
4307 is not specified and all the
4308 time series have the same resource
4309 type, then the time series are
4310 aggregated into a single output
4311 time series. If `cross_series_reducer`
4312 is not defined, this field is
4313 ignored.
4314 items:
4315 type: string
4316 type: array
4317 perSeriesAligner:
4318 description: An `Aligner` describes
4319 how to bring the data points
4320 in a single time series into
4321 temporal alignment. Except for
4322 `ALIGN_NONE`, all alignments
4323 cause all the data points in
4324 an `alignment_period` to be
4325 mathematically grouped together,
4326 resulting in a single data point
4327 for each `alignment_period`
4328 with end timestamp at the end
4329 of the period. Not all alignment
4330 operations may be applied to
4331 all time series. The valid choices
4332 depend on the `metric_kind`
4333 and `value_type` of the original
4334 time series. Alignment can change
4335 the `metric_kind` or the `value_type`
4336 of the time series. Time series
4337 data must be aligned in order
4338 to perform cross-time series
4339 reduction. If `cross_series_reducer`
4340 is specified, then `per_series_aligner`
4341 must be specified and not equal
4342 to `ALIGN_NONE` and `alignment_period`
4343 must be specified; otherwise,
4344 an error is returned.
4345 type: string
4346 type: object
4347 filter:
4348 description: Required. The [monitoring
4349 filter](https://cloud.google.com/monitoring/api/v3/filters)
4350 that identifies the metric types,
4351 resources, and projects to query.
4352 type: string
4353 pickTimeSeriesFilter:
4354 description: Ranking based time series
4355 filter.
4356 properties:
4357 direction:
4358 description: 'How to use the ranking
4359 to select time series that pass
4360 through the filter. Possible
4361 values: DIRECTION_UNSPECIFIED,
4362 TOP, BOTTOM'
4363 type: string
4364 numTimeSeries:
4365 description: How many time series
4366 to allow to pass through the
4367 filter.
4368 format: int64
4369 type: integer
4370 rankingMethod:
4371 description: '`ranking_method`
4372 is applied to each time series
4373 independently to produce the
4374 value which will be used to
4375 compare the time series to other
4376 time series. Possible values:
4377 METHOD_UNSPECIFIED, METHOD_MEAN,
4378 METHOD_MAX, METHOD_MIN, METHOD_SUM,
4379 METHOD_LATEST'
4380 type: string
4381 type: object
4382 secondaryAggregation:
4383 description: Apply a second aggregation
4384 after `aggregation` is applied.
4385 properties:
4386 alignmentPeriod:
4387 description: The `alignment_period`
4388 specifies a time interval, in
4389 seconds, that is used to divide
4390 the data in all the [time series][google.monitoring.v3.TimeSeries]
4391 into consistent blocks of time.
4392 This will be done before the
4393 per-series aligner can be applied
4394 to the data. The value must
4395 be at least 60 seconds. If a
4396 per-series aligner other than
4397 `ALIGN_NONE` is specified, this
4398 field is required or an error
4399 is returned. If no per-series
4400 aligner is specified, or the
4401 aligner `ALIGN_NONE` is specified,
4402 then this field is ignored.
4403 type: string
4404 crossSeriesReducer:
4405 description: 'The reduction operation
4406 to be used to combine time series
4407 into a single time series, where
4408 the value of each data point
4409 in the resulting series is a
4410 function of all the already
4411 aligned values in the input
4412 time series. Not all reducer
4413 operations can be applied to
4414 all time series. The valid choices
4415 depend on the `metric_kind`
4416 and the `value_type` of the
4417 original time series. Reduction
4418 can yield a time series with
4419 a different `metric_kind` or
4420 `value_type` than the input
4421 time series. Time series data
4422 must first be aligned (see `per_series_aligner`)
4423 in order to perform cross-time
4424 series reduction. If `cross_series_reducer`
4425 is specified, then `per_series_aligner`
4426 must be specified, and must
4427 not be `ALIGN_NONE`. An `alignment_period`
4428 must also be specified; otherwise,
4429 an error is returned. Possible
4430 values: REDUCE_NONE, REDUCE_MEAN,
4431 REDUCE_MIN, REDUCE_MAX, REDUCE_SUM,
4432 REDUCE_STDDEV, REDUCE_COUNT,
4433 REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE,
4434 REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99,
4435 REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50,
4436 REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN,
4437 REDUCE_MAKE_DISTRIBUTION'
4438 type: string
4439 groupByFields:
4440 description: The set of fields
4441 to preserve when `cross_series_reducer`
4442 is specified. The `group_by_fields`
4443 determine how the time series
4444 are partitioned into subsets
4445 prior to applying the aggregation
4446 operation. Each subset contains
4447 time series that have the same
4448 value for each of the grouping
4449 fields. Each individual time
4450 series is a member of exactly
4451 one subset. The `cross_series_reducer`
4452 is applied to each subset of
4453 time series. It is not possible
4454 to reduce across different resource
4455 types, so this field implicitly
4456 contains `resource.type`. Fields
4457 not specified in `group_by_fields`
4458 are aggregated away. If `group_by_fields`
4459 is not specified and all the
4460 time series have the same resource
4461 type, then the time series are
4462 aggregated into a single output
4463 time series. If `cross_series_reducer`
4464 is not defined, this field is
4465 ignored.
4466 items:
4467 type: string
4468 type: array
4469 perSeriesAligner:
4470 description: An `Aligner` describes
4471 how to bring the data points
4472 in a single time series into
4473 temporal alignment. Except for
4474 `ALIGN_NONE`, all alignments
4475 cause all the data points in
4476 an `alignment_period` to be
4477 mathematically grouped together,
4478 resulting in a single data point
4479 for each `alignment_period`
4480 with end timestamp at the end
4481 of the period. Not all alignment
4482 operations may be applied to
4483 all time series. The valid choices
4484 depend on the `metric_kind`
4485 and `value_type` of the original
4486 time series. Alignment can change
4487 the `metric_kind` or the `value_type`
4488 of the time series. Time series
4489 data must be aligned in order
4490 to perform cross-time series
4491 reduction. If `cross_series_reducer`
4492 is specified, then `per_series_aligner`
4493 must be specified and not equal
4494 to `ALIGN_NONE` and `alignment_period`
4495 must be specified; otherwise,
4496 an error is returned.
4497 type: string
4498 type: object
4499 required:
4500 - filter
4501 type: object
4502 timeSeriesFilterRatio:
4503 description: Parameters to fetch a ratio
4504 between two time series filters.
4505 properties:
4506 denominator:
4507 description: The denominator of the
4508 ratio.
4509 properties:
4510 aggregation:
4511 description: By default, the raw
4512 time series data is returned.
4513 Use this field to combine multiple
4514 time series for different views
4515 of the data.
4516 properties:
4517 alignmentPeriod:
4518 description: The `alignment_period`
4519 specifies a time interval,
4520 in seconds, that is used
4521 to divide the data in all
4522 the [time series][google.monitoring.v3.TimeSeries]
4523 into consistent blocks of
4524 time. This will be done
4525 before the per-series aligner
4526 can be applied to the data. The
4527 value must be at least 60
4528 seconds. If a per-series
4529 aligner other than `ALIGN_NONE`
4530 is specified, this field
4531 is required or an error
4532 is returned. If no per-series
4533 aligner is specified, or
4534 the aligner `ALIGN_NONE`
4535 is specified, then this
4536 field is ignored.
4537 type: string
4538 crossSeriesReducer:
4539 description: 'The reduction
4540 operation to be used to
4541 combine time series into
4542 a single time series, where
4543 the value of each data point
4544 in the resulting series
4545 is a function of all the
4546 already aligned values in
4547 the input time series. Not
4548 all reducer operations can
4549 be applied to all time series.
4550 The valid choices depend
4551 on the `metric_kind` and
4552 the `value_type` of the
4553 original time series. Reduction
4554 can yield a time series
4555 with a different `metric_kind`
4556 or `value_type` than the
4557 input time series. Time
4558 series data must first be
4559 aligned (see `per_series_aligner`)
4560 in order to perform cross-time
4561 series reduction. If `cross_series_reducer`
4562 is specified, then `per_series_aligner`
4563 must be specified, and must
4564 not be `ALIGN_NONE`. An
4565 `alignment_period` must
4566 also be specified; otherwise,
4567 an error is returned. Possible
4568 values: REDUCE_NONE, REDUCE_MEAN,
4569 REDUCE_MIN, REDUCE_MAX,
4570 REDUCE_SUM, REDUCE_STDDEV,
4571 REDUCE_COUNT, REDUCE_COUNT_TRUE,
4572 REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE,
4573 REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95,
4574 REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05,
4575 REDUCE_FRACTION_LESS_THAN,
4576 REDUCE_MAKE_DISTRIBUTION'
4577 type: string
4578 groupByFields:
4579 description: The set of fields
4580 to preserve when `cross_series_reducer`
4581 is specified. The `group_by_fields`
4582 determine how the time series
4583 are partitioned into subsets
4584 prior to applying the aggregation
4585 operation. Each subset contains
4586 time series that have the
4587 same value for each of the
4588 grouping fields. Each individual
4589 time series is a member
4590 of exactly one subset. The
4591 `cross_series_reducer` is
4592 applied to each subset of
4593 time series. It is not possible
4594 to reduce across different
4595 resource types, so this
4596 field implicitly contains
4597 `resource.type`. Fields
4598 not specified in `group_by_fields`
4599 are aggregated away. If
4600 `group_by_fields` is not
4601 specified and all the time
4602 series have the same resource
4603 type, then the time series
4604 are aggregated into a single
4605 output time series. If `cross_series_reducer`
4606 is not defined, this field
4607 is ignored.
4608 items:
4609 type: string
4610 type: array
4611 perSeriesAligner:
4612 description: An `Aligner`
4613 describes how to bring the
4614 data points in a single
4615 time series into temporal
4616 alignment. Except for `ALIGN_NONE`,
4617 all alignments cause all
4618 the data points in an `alignment_period`
4619 to be mathematically grouped
4620 together, resulting in a
4621 single data point for each
4622 `alignment_period` with
4623 end timestamp at the end
4624 of the period. Not all
4625 alignment operations may
4626 be applied to all time series.
4627 The valid choices depend
4628 on the `metric_kind` and
4629 `value_type` of the original
4630 time series. Alignment can
4631 change the `metric_kind`
4632 or the `value_type` of the
4633 time series. Time series
4634 data must be aligned in
4635 order to perform cross-time
4636 series reduction. If `cross_series_reducer`
4637 is specified, then `per_series_aligner`
4638 must be specified and not
4639 equal to `ALIGN_NONE` and
4640 `alignment_period` must
4641 be specified; otherwise,
4642 an error is returned.
4643 type: string
4644 type: object
4645 filter:
4646 description: Required. The [monitoring
4647 filter](https://cloud.google.com/monitoring/api/v3/filters)
4648 that identifies the metric types,
4649 resources, and projects to query.
4650 type: string
4651 required:
4652 - filter
4653 type: object
4654 numerator:
4655 description: The numerator of the
4656 ratio.
4657 properties:
4658 aggregation:
4659 description: By default, the raw
4660 time series data is returned.
4661 Use this field to combine multiple
4662 time series for different views
4663 of the data.
4664 properties:
4665 alignmentPeriod:
4666 description: The `alignment_period`
4667 specifies a time interval,
4668 in seconds, that is used
4669 to divide the data in all
4670 the [time series][google.monitoring.v3.TimeSeries]
4671 into consistent blocks of
4672 time. This will be done
4673 before the per-series aligner
4674 can be applied to the data. The
4675 value must be at least 60
4676 seconds. If a per-series
4677 aligner other than `ALIGN_NONE`
4678 is specified, this field
4679 is required or an error
4680 is returned. If no per-series
4681 aligner is specified, or
4682 the aligner `ALIGN_NONE`
4683 is specified, then this
4684 field is ignored.
4685 type: string
4686 crossSeriesReducer:
4687 description: 'The reduction
4688 operation to be used to
4689 combine time series into
4690 a single time series, where
4691 the value of each data point
4692 in the resulting series
4693 is a function of all the
4694 already aligned values in
4695 the input time series. Not
4696 all reducer operations can
4697 be applied to all time series.
4698 The valid choices depend
4699 on the `metric_kind` and
4700 the `value_type` of the
4701 original time series. Reduction
4702 can yield a time series
4703 with a different `metric_kind`
4704 or `value_type` than the
4705 input time series. Time
4706 series data must first be
4707 aligned (see `per_series_aligner`)
4708 in order to perform cross-time
4709 series reduction. If `cross_series_reducer`
4710 is specified, then `per_series_aligner`
4711 must be specified, and must
4712 not be `ALIGN_NONE`. An
4713 `alignment_period` must
4714 also be specified; otherwise,
4715 an error is returned. Possible
4716 values: REDUCE_NONE, REDUCE_MEAN,
4717 REDUCE_MIN, REDUCE_MAX,
4718 REDUCE_SUM, REDUCE_STDDEV,
4719 REDUCE_COUNT, REDUCE_COUNT_TRUE,
4720 REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE,
4721 REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95,
4722 REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05,
4723 REDUCE_FRACTION_LESS_THAN,
4724 REDUCE_MAKE_DISTRIBUTION'
4725 type: string
4726 groupByFields:
4727 description: The set of fields
4728 to preserve when `cross_series_reducer`
4729 is specified. The `group_by_fields`
4730 determine how the time series
4731 are partitioned into subsets
4732 prior to applying the aggregation
4733 operation. Each subset contains
4734 time series that have the
4735 same value for each of the
4736 grouping fields. Each individual
4737 time series is a member
4738 of exactly one subset. The
4739 `cross_series_reducer` is
4740 applied to each subset of
4741 time series. It is not possible
4742 to reduce across different
4743 resource types, so this
4744 field implicitly contains
4745 `resource.type`. Fields
4746 not specified in `group_by_fields`
4747 are aggregated away. If
4748 `group_by_fields` is not
4749 specified and all the time
4750 series have the same resource
4751 type, then the time series
4752 are aggregated into a single
4753 output time series. If `cross_series_reducer`
4754 is not defined, this field
4755 is ignored.
4756 items:
4757 type: string
4758 type: array
4759 perSeriesAligner:
4760 description: An `Aligner`
4761 describes how to bring the
4762 data points in a single
4763 time series into temporal
4764 alignment. Except for `ALIGN_NONE`,
4765 all alignments cause all
4766 the data points in an `alignment_period`
4767 to be mathematically grouped
4768 together, resulting in a
4769 single data point for each
4770 `alignment_period` with
4771 end timestamp at the end
4772 of the period. Not all
4773 alignment operations may
4774 be applied to all time series.
4775 The valid choices depend
4776 on the `metric_kind` and
4777 `value_type` of the original
4778 time series. Alignment can
4779 change the `metric_kind`
4780 or the `value_type` of the
4781 time series. Time series
4782 data must be aligned in
4783 order to perform cross-time
4784 series reduction. If `cross_series_reducer`
4785 is specified, then `per_series_aligner`
4786 must be specified and not
4787 equal to `ALIGN_NONE` and
4788 `alignment_period` must
4789 be specified; otherwise,
4790 an error is returned.
4791 type: string
4792 type: object
4793 filter:
4794 description: Required. The [monitoring
4795 filter](https://cloud.google.com/monitoring/api/v3/filters)
4796 that identifies the metric types,
4797 resources, and projects to query.
4798 type: string
4799 required:
4800 - filter
4801 type: object
4802 pickTimeSeriesFilter:
4803 description: Ranking based time series
4804 filter.
4805 properties:
4806 direction:
4807 description: 'How to use the ranking
4808 to select time series that pass
4809 through the filter. Possible
4810 values: DIRECTION_UNSPECIFIED,
4811 TOP, BOTTOM'
4812 type: string
4813 numTimeSeries:
4814 description: How many time series
4815 to allow to pass through the
4816 filter.
4817 format: int64
4818 type: integer
4819 rankingMethod:
4820 description: '`ranking_method`
4821 is applied to each time series
4822 independently to produce the
4823 value which will be used to
4824 compare the time series to other
4825 time series. Possible values:
4826 METHOD_UNSPECIFIED, METHOD_MEAN,
4827 METHOD_MAX, METHOD_MIN, METHOD_SUM,
4828 METHOD_LATEST'
4829 type: string
4830 type: object
4831 secondaryAggregation:
4832 description: Apply a second aggregation
4833 after the ratio is computed.
4834 properties:
4835 alignmentPeriod:
4836 description: The `alignment_period`
4837 specifies a time interval, in
4838 seconds, that is used to divide
4839 the data in all the [time series][google.monitoring.v3.TimeSeries]
4840 into consistent blocks of time.
4841 This will be done before the
4842 per-series aligner can be applied
4843 to the data. The value must
4844 be at least 60 seconds. If a
4845 per-series aligner other than
4846 `ALIGN_NONE` is specified, this
4847 field is required or an error
4848 is returned. If no per-series
4849 aligner is specified, or the
4850 aligner `ALIGN_NONE` is specified,
4851 then this field is ignored.
4852 type: string
4853 crossSeriesReducer:
4854 description: 'The reduction operation
4855 to be used to combine time series
4856 into a single time series, where
4857 the value of each data point
4858 in the resulting series is a
4859 function of all the already
4860 aligned values in the input
4861 time series. Not all reducer
4862 operations can be applied to
4863 all time series. The valid choices
4864 depend on the `metric_kind`
4865 and the `value_type` of the
4866 original time series. Reduction
4867 can yield a time series with
4868 a different `metric_kind` or
4869 `value_type` than the input
4870 time series. Time series data
4871 must first be aligned (see `per_series_aligner`)
4872 in order to perform cross-time
4873 series reduction. If `cross_series_reducer`
4874 is specified, then `per_series_aligner`
4875 must be specified, and must
4876 not be `ALIGN_NONE`. An `alignment_period`
4877 must also be specified; otherwise,
4878 an error is returned. Possible
4879 values: REDUCE_NONE, REDUCE_MEAN,
4880 REDUCE_MIN, REDUCE_MAX, REDUCE_SUM,
4881 REDUCE_STDDEV, REDUCE_COUNT,
4882 REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE,
4883 REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99,
4884 REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50,
4885 REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN,
4886 REDUCE_MAKE_DISTRIBUTION'
4887 type: string
4888 groupByFields:
4889 description: The set of fields
4890 to preserve when `cross_series_reducer`
4891 is specified. The `group_by_fields`
4892 determine how the time series
4893 are partitioned into subsets
4894 prior to applying the aggregation
4895 operation. Each subset contains
4896 time series that have the same
4897 value for each of the grouping
4898 fields. Each individual time
4899 series is a member of exactly
4900 one subset. The `cross_series_reducer`
4901 is applied to each subset of
4902 time series. It is not possible
4903 to reduce across different resource
4904 types, so this field implicitly
4905 contains `resource.type`. Fields
4906 not specified in `group_by_fields`
4907 are aggregated away. If `group_by_fields`
4908 is not specified and all the
4909 time series have the same resource
4910 type, then the time series are
4911 aggregated into a single output
4912 time series. If `cross_series_reducer`
4913 is not defined, this field is
4914 ignored.
4915 items:
4916 type: string
4917 type: array
4918 perSeriesAligner:
4919 description: An `Aligner` describes
4920 how to bring the data points
4921 in a single time series into
4922 temporal alignment. Except for
4923 `ALIGN_NONE`, all alignments
4924 cause all the data points in
4925 an `alignment_period` to be
4926 mathematically grouped together,
4927 resulting in a single data point
4928 for each `alignment_period`
4929 with end timestamp at the end
4930 of the period. Not all alignment
4931 operations may be applied to
4932 all time series. The valid choices
4933 depend on the `metric_kind`
4934 and `value_type` of the original
4935 time series. Alignment can change
4936 the `metric_kind` or the `value_type`
4937 of the time series. Time series
4938 data must be aligned in order
4939 to perform cross-time series
4940 reduction. If `cross_series_reducer`
4941 is specified, then `per_series_aligner`
4942 must be specified and not equal
4943 to `ALIGN_NONE` and `alignment_period`
4944 must be specified; otherwise,
4945 an error is returned.
4946 type: string
4947 type: object
4948 type: object
4949 timeSeriesQueryLanguage:
4950 description: A query used to fetch time
4951 series.
4952 type: string
4953 unitOverride:
4954 description: The unit of data contained
4955 in fetched time series. If non-empty,
4956 this unit will override any unit that
4957 accompanies fetched data. The format
4958 is the same as the [`unit`](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors)
4959 field in `MetricDescriptor`.
4960 type: string
4961 type: object
4962 required:
4963 - timeSeriesQuery
4964 type: object
4965 type: array
4966 thresholds:
4967 description: Threshold lines drawn horizontally
4968 across the chart.
4969 items:
4970 properties:
4971 color:
4972 description: 'The state color for this threshold.
4973 Color is not allowed in a XyChart. Possible
4974 values: COLOR_UNSPECIFIED, GREY, BLUE, GREEN,
4975 YELLOW, ORANGE, RED'
4976 type: string
4977 direction:
4978 description: 'The direction for the current
4979 threshold. Direction is not allowed in a
4980 XyChart. Possible values: DIRECTION_UNSPECIFIED,
4981 ABOVE, BELOW'
4982 type: string
4983 label:
4984 description: A label for the threshold.
4985 type: string
4986 value:
4987 description: The value of the threshold. The
4988 value should be defined in the native scale
4989 of the metric.
4990 format: double
4991 type: number
4992 type: object
4993 type: array
4994 timeshiftDuration:
4995 description: The duration used to display a comparison
4996 chart. A comparison chart simultaneously shows
4997 values from two similar-length time periods (e.g.,
4998 week-over-week metrics). The duration must be
4999 positive, and it can only be applied to charts
5000 with data sets of LINE plot type.
5001 type: string
5002 xAxis:
5003 description: The properties applied to the X axis.
5004 properties:
5005 label:
5006 description: The label of the axis.
5007 type: string
5008 scale:
5009 description: 'The axis scale. By default, a
5010 linear scale is used. Possible values: SCALE_UNSPECIFIED,
5011 LINEAR, LOG10'
5012 type: string
5013 type: object
5014 yAxis:
5015 description: The properties applied to the Y axis.
5016 properties:
5017 label:
5018 description: The label of the axis.
5019 type: string
5020 scale:
5021 description: 'The axis scale. By default, a
5022 linear scale is used. Possible values: SCALE_UNSPECIFIED,
5023 LINEAR, LOG10'
5024 type: string
5025 type: object
5026 required:
5027 - dataSets
5028 type: object
5029 type: object
5030 width:
5031 description: The width of the tile, measured in grid squares.
5032 format: int64
5033 type: integer
5034 xPos:
5035 description: The zero-indexed position of the tile in grid
5036 squares relative to the left edge of the grid.
5037 format: int64
5038 type: integer
5039 yPos:
5040 description: The zero-indexed position of the tile in grid
5041 squares relative to the top edge of the grid.
5042 format: int64
5043 type: integer
5044 type: object
5045 type: array
5046 type: object
5047 projectRef:
5048 description: Immutable. The Project that this resource belongs to.
5049 oneOf:
5050 - not:
5051 required:
5052 - external
5053 required:
5054 - name
5055 - not:
5056 anyOf:
5057 - required:
5058 - name
5059 - required:
5060 - namespace
5061 required:
5062 - external
5063 properties:
5064 external:
5065 description: |-
5066 The project id of the resource.
5067
5068 Allowed value: The Google Cloud resource name of a `Project` resource (format: `projects/{{name}}`).
5069 type: string
5070 name:
5071 description: 'Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
5072 type: string
5073 namespace:
5074 description: 'Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
5075 type: string
5076 type: object
5077 resourceID:
5078 description: Immutable. Optional. The name of the resource. Used for
5079 creation and acquisition. When unset, the value of `metadata.name`
5080 is used as the default.
5081 type: string
5082 rowLayout:
5083 description: The content is divided into equally spaced rows and the
5084 widgets are arranged horizontally.
5085 properties:
5086 rows:
5087 description: The rows of content to display.
5088 items:
5089 properties:
5090 weight:
5091 description: The relative weight of this row. The row weight
5092 is used to adjust the height of rows on the screen (relative
5093 to peers). Greater the weight, greater the height of the
5094 row on the screen. If omitted, a value of 1 is used while
5095 rendering.
5096 format: int64
5097 type: integer
5098 widgets:
5099 description: The display widgets arranged horizontally in
5100 this row.
5101 items:
5102 properties:
5103 blank:
5104 description: A blank space.
5105 type: object
5106 x-kubernetes-preserve-unknown-fields: true
5107 logsPanel:
5108 properties:
5109 filter:
5110 description: A filter that chooses which log entries
5111 to return. See [Advanced Logs Queries](https://cloud.google.com/logging/docs/view/advanced-queries).
5112 Only log entries that match the filter are returned.
5113 An empty filter matches all log entries.
5114 type: string
5115 resourceNames:
5116 items:
5117 oneOf:
5118 - not:
5119 required:
5120 - external
5121 required:
5122 - name
5123 - not:
5124 anyOf:
5125 - required:
5126 - name
5127 - required:
5128 - namespace
5129 required:
5130 - external
5131 properties:
5132 external:
5133 description: 'Allowed value: The Google
5134 Cloud resource name of a `Project` resource
5135 (format: `projects/{{name}}`).'
5136 type: string
5137 name:
5138 description: 'Name of the referent. More
5139 info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names'
5140 type: string
5141 namespace:
5142 description: 'Namespace of the referent.
5143 More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/'
5144 type: string
5145 type: object
5146 type: array
5147 type: object
5148 scorecard:
5149 description: A scorecard summarizing time series data.
5150 properties:
5151 gaugeView:
5152 description: Will cause the scorecard to show
5153 a gauge chart.
5154 properties:
5155 lowerBound:
5156 description: The lower bound for this gauge
5157 chart. The value of the chart should always
5158 be greater than or equal to this.
5159 format: double
5160 type: number
5161 upperBound:
5162 description: The upper bound for this gauge
5163 chart. The value of the chart should always
5164 be less than or equal to this.
5165 format: double
5166 type: number
5167 type: object
5168 sparkChartView:
5169 description: Will cause the scorecard to show
5170 a spark chart.
5171 properties:
5172 minAlignmentPeriod:
5173 description: The lower bound on data point
5174 frequency in the chart implemented by specifying
5175 the minimum alignment period to use in a
5176 time series query. For example, if the data
5177 is published once every 10 minutes it would
5178 not make sense to fetch and align data at
5179 one minute intervals. This field is optional
5180 and exists only as a hint.
5181 type: string
5182 sparkChartType:
5183 description: 'Required. The type of sparkchart
5184 to show in this chartView. Possible values:
5185 SPARK_CHART_TYPE_UNSPECIFIED, SPARK_LINE,
5186 SPARK_BAR'
5187 type: string
5188 required:
5189 - sparkChartType
5190 type: object
5191 thresholds:
5192 description: 'The thresholds used to determine
5193 the state of the scorecard given the time series''
5194 current value. For an actual value x, the scorecard
5195 is in a danger state if x is less than or equal
5196 to a danger threshold that triggers below, or
5197 greater than or equal to a danger threshold
5198 that triggers above. Similarly, if x is above/below
5199 a warning threshold that triggers above/below,
5200 then the scorecard is in a warning state - unless
5201 x also puts it in a danger state. (Danger trumps
5202 warning.) As an example, consider a scorecard
5203 with the following four thresholds: { value:
5204 90, category: ''DANGER'', trigger: ''ABOVE'',
5205 },: { value: 70, category: ''WARNING'', trigger:
5206 ''ABOVE'', }, { value: 10, category: ''DANGER'', trigger:
5207 ''BELOW'', }, { value: 20, category: ''WARNING'', trigger:
5208 ''BELOW'', } Then: values less than or equal
5209 to 10 would put the scorecard in a DANGER state,
5210 values greater than 10 but less than or equal
5211 to 20 a WARNING state, values strictly between
5212 20 and 70 an OK state, values greater than or
5213 equal to 70 but less than 90 a WARNING state,
5214 and values greater than or equal to 90 a DANGER
5215 state.'
5216 items:
5217 properties:
5218 color:
5219 description: 'The state color for this threshold.
5220 Color is not allowed in a XyChart. Possible
5221 values: COLOR_UNSPECIFIED, GREY, BLUE,
5222 GREEN, YELLOW, ORANGE, RED'
5223 type: string
5224 direction:
5225 description: 'The direction for the current
5226 threshold. Direction is not allowed in
5227 a XyChart. Possible values: DIRECTION_UNSPECIFIED,
5228 ABOVE, BELOW'
5229 type: string
5230 label:
5231 description: A label for the threshold.
5232 type: string
5233 value:
5234 description: The value of the threshold.
5235 The value should be defined in the native
5236 scale of the metric.
5237 format: double
5238 type: number
5239 type: object
5240 type: array
5241 timeSeriesQuery:
5242 description: Required. Fields for querying time
5243 series data from the Stackdriver metrics API.
5244 properties:
5245 timeSeriesFilter:
5246 description: Filter parameters to fetch time
5247 series.
5248 properties:
5249 aggregation:
5250 description: By default, the raw time
5251 series data is returned. Use this field
5252 to combine multiple time series for
5253 different views of the data.
5254 properties:
5255 alignmentPeriod:
5256 description: The `alignment_period`
5257 specifies a time interval, in seconds,
5258 that is used to divide the data
5259 in all the [time series][google.monitoring.v3.TimeSeries]
5260 into consistent blocks of time.
5261 This will be done before the per-series
5262 aligner can be applied to the data. The
5263 value must be at least 60 seconds.
5264 If a per-series aligner other than
5265 `ALIGN_NONE` is specified, this
5266 field is required or an error is
5267 returned. If no per-series aligner
5268 is specified, or the aligner `ALIGN_NONE`
5269 is specified, then this field is
5270 ignored.
5271 type: string
5272 crossSeriesReducer:
5273 description: 'The reduction operation
5274 to be used to combine time series
5275 into a single time series, where
5276 the value of each data point in
5277 the resulting series is a function
5278 of all the already aligned values
5279 in the input time series. Not all
5280 reducer operations can be applied
5281 to all time series. The valid choices
5282 depend on the `metric_kind` and
5283 the `value_type` of the original
5284 time series. Reduction can yield
5285 a time series with a different `metric_kind`
5286 or `value_type` than the input time
5287 series. Time series data must first
5288 be aligned (see `per_series_aligner`)
5289 in order to perform cross-time series
5290 reduction. If `cross_series_reducer`
5291 is specified, then `per_series_aligner`
5292 must be specified, and must not
5293 be `ALIGN_NONE`. An `alignment_period`
5294 must also be specified; otherwise,
5295 an error is returned. Possible values:
5296 REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN,
5297 REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV,
5298 REDUCE_COUNT, REDUCE_COUNT_TRUE,
5299 REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE,
5300 REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95,
5301 REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05,
5302 REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION'
5303 type: string
5304 groupByFields:
5305 description: The set of fields to
5306 preserve when `cross_series_reducer`
5307 is specified. The `group_by_fields`
5308 determine how the time series are
5309 partitioned into subsets prior to
5310 applying the aggregation operation.
5311 Each subset contains time series
5312 that have the same value for each
5313 of the grouping fields. Each individual
5314 time series is a member of exactly
5315 one subset. The `cross_series_reducer`
5316 is applied to each subset of time
5317 series. It is not possible to reduce
5318 across different resource types,
5319 so this field implicitly contains
5320 `resource.type`. Fields not specified
5321 in `group_by_fields` are aggregated
5322 away. If `group_by_fields` is not
5323 specified and all the time series
5324 have the same resource type, then
5325 the time series are aggregated into
5326 a single output time series. If
5327 `cross_series_reducer` is not defined,
5328 this field is ignored.
5329 items:
5330 type: string
5331 type: array
5332 perSeriesAligner:
5333 description: An `Aligner` describes
5334 how to bring the data points in
5335 a single time series into temporal
5336 alignment. Except for `ALIGN_NONE`,
5337 all alignments cause all the data
5338 points in an `alignment_period`
5339 to be mathematically grouped together,
5340 resulting in a single data point
5341 for each `alignment_period` with
5342 end timestamp at the end of the
5343 period. Not all alignment operations
5344 may be applied to all time series.
5345 The valid choices depend on the
5346 `metric_kind` and `value_type` of
5347 the original time series. Alignment
5348 can change the `metric_kind` or
5349 the `value_type` of the time series. Time
5350 series data must be aligned in order
5351 to perform cross-time series reduction.
5352 If `cross_series_reducer` is specified,
5353 then `per_series_aligner` must be
5354 specified and not equal to `ALIGN_NONE`
5355 and `alignment_period` must be specified;
5356 otherwise, an error is returned.
5357 type: string
5358 type: object
5359 filter:
5360 description: Required. The [monitoring
5361 filter](https://cloud.google.com/monitoring/api/v3/filters)
5362 that identifies the metric types, resources,
5363 and projects to query.
5364 type: string
5365 pickTimeSeriesFilter:
5366 description: Ranking based time series
5367 filter.
5368 properties:
5369 direction:
5370 description: 'How to use the ranking
5371 to select time series that pass
5372 through the filter. Possible values:
5373 DIRECTION_UNSPECIFIED, TOP, BOTTOM'
5374 type: string
5375 numTimeSeries:
5376 description: How many time series
5377 to allow to pass through the filter.
5378 format: int64
5379 type: integer
5380 rankingMethod:
5381 description: '`ranking_method` is
5382 applied to each time series independently
5383 to produce the value which will
5384 be used to compare the time series
5385 to other time series. Possible values:
5386 METHOD_UNSPECIFIED, METHOD_MEAN,
5387 METHOD_MAX, METHOD_MIN, METHOD_SUM,
5388 METHOD_LATEST'
5389 type: string
5390 type: object
5391 secondaryAggregation:
5392 description: Apply a second aggregation
5393 after `aggregation` is applied.
5394 properties:
5395 alignmentPeriod:
5396 description: The `alignment_period`
5397 specifies a time interval, in seconds,
5398 that is used to divide the data
5399 in all the [time series][google.monitoring.v3.TimeSeries]
5400 into consistent blocks of time.
5401 This will be done before the per-series
5402 aligner can be applied to the data. The
5403 value must be at least 60 seconds.
5404 If a per-series aligner other than
5405 `ALIGN_NONE` is specified, this
5406 field is required or an error is
5407 returned. If no per-series aligner
5408 is specified, or the aligner `ALIGN_NONE`
5409 is specified, then this field is
5410 ignored.
5411 type: string
5412 crossSeriesReducer:
5413 description: 'The reduction operation
5414 to be used to combine time series
5415 into a single time series, where
5416 the value of each data point in
5417 the resulting series is a function
5418 of all the already aligned values
5419 in the input time series. Not all
5420 reducer operations can be applied
5421 to all time series. The valid choices
5422 depend on the `metric_kind` and
5423 the `value_type` of the original
5424 time series. Reduction can yield
5425 a time series with a different `metric_kind`
5426 or `value_type` than the input time
5427 series. Time series data must first
5428 be aligned (see `per_series_aligner`)
5429 in order to perform cross-time series
5430 reduction. If `cross_series_reducer`
5431 is specified, then `per_series_aligner`
5432 must be specified, and must not
5433 be `ALIGN_NONE`. An `alignment_period`
5434 must also be specified; otherwise,
5435 an error is returned. Possible values:
5436 REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN,
5437 REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV,
5438 REDUCE_COUNT, REDUCE_COUNT_TRUE,
5439 REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE,
5440 REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95,
5441 REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05,
5442 REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION'
5443 type: string
5444 groupByFields:
5445 description: The set of fields to
5446 preserve when `cross_series_reducer`
5447 is specified. The `group_by_fields`
5448 determine how the time series are
5449 partitioned into subsets prior to
5450 applying the aggregation operation.
5451 Each subset contains time series
5452 that have the same value for each
5453 of the grouping fields. Each individual
5454 time series is a member of exactly
5455 one subset. The `cross_series_reducer`
5456 is applied to each subset of time
5457 series. It is not possible to reduce
5458 across different resource types,
5459 so this field implicitly contains
5460 `resource.type`. Fields not specified
5461 in `group_by_fields` are aggregated
5462 away. If `group_by_fields` is not
5463 specified and all the time series
5464 have the same resource type, then
5465 the time series are aggregated into
5466 a single output time series. If
5467 `cross_series_reducer` is not defined,
5468 this field is ignored.
5469 items:
5470 type: string
5471 type: array
5472 perSeriesAligner:
5473 description: An `Aligner` describes
5474 how to bring the data points in
5475 a single time series into temporal
5476 alignment. Except for `ALIGN_NONE`,
5477 all alignments cause all the data
5478 points in an `alignment_period`
5479 to be mathematically grouped together,
5480 resulting in a single data point
5481 for each `alignment_period` with
5482 end timestamp at the end of the
5483 period. Not all alignment operations
5484 may be applied to all time series.
5485 The valid choices depend on the
5486 `metric_kind` and `value_type` of
5487 the original time series. Alignment
5488 can change the `metric_kind` or
5489 the `value_type` of the time series. Time
5490 series data must be aligned in order
5491 to perform cross-time series reduction.
5492 If `cross_series_reducer` is specified,
5493 then `per_series_aligner` must be
5494 specified and not equal to `ALIGN_NONE`
5495 and `alignment_period` must be specified;
5496 otherwise, an error is returned.
5497 type: string
5498 type: object
5499 required:
5500 - filter
5501 type: object
5502 timeSeriesFilterRatio:
5503 description: Parameters to fetch a ratio between
5504 two time series filters.
5505 properties:
5506 denominator:
5507 description: The denominator of the ratio.
5508 properties:
5509 aggregation:
5510 description: By default, the raw time
5511 series data is returned. Use this
5512 field to combine multiple time series
5513 for different views of the data.
5514 properties:
5515 alignmentPeriod:
5516 description: The `alignment_period`
5517 specifies a time interval, in
5518 seconds, that is used to divide
5519 the data in all the [time series][google.monitoring.v3.TimeSeries]
5520 into consistent blocks of time.
5521 This will be done before the
5522 per-series aligner can be applied
5523 to the data. The value must
5524 be at least 60 seconds. If a
5525 per-series aligner other than
5526 `ALIGN_NONE` is specified, this
5527 field is required or an error
5528 is returned. If no per-series
5529 aligner is specified, or the
5530 aligner `ALIGN_NONE` is specified,
5531 then this field is ignored.
5532 type: string
5533 crossSeriesReducer:
5534 description: 'The reduction operation
5535 to be used to combine time series
5536 into a single time series, where
5537 the value of each data point
5538 in the resulting series is a
5539 function of all the already
5540 aligned values in the input
5541 time series. Not all reducer
5542 operations can be applied to
5543 all time series. The valid choices
5544 depend on the `metric_kind`
5545 and the `value_type` of the
5546 original time series. Reduction
5547 can yield a time series with
5548 a different `metric_kind` or
5549 `value_type` than the input
5550 time series. Time series data
5551 must first be aligned (see `per_series_aligner`)
5552 in order to perform cross-time
5553 series reduction. If `cross_series_reducer`
5554 is specified, then `per_series_aligner`
5555 must be specified, and must
5556 not be `ALIGN_NONE`. An `alignment_period`
5557 must also be specified; otherwise,
5558 an error is returned. Possible
5559 values: REDUCE_NONE, REDUCE_MEAN,
5560 REDUCE_MIN, REDUCE_MAX, REDUCE_SUM,
5561 REDUCE_STDDEV, REDUCE_COUNT,
5562 REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE,
5563 REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99,
5564 REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50,
5565 REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN,
5566 REDUCE_MAKE_DISTRIBUTION'
5567 type: string
5568 groupByFields:
5569 description: The set of fields
5570 to preserve when `cross_series_reducer`
5571 is specified. The `group_by_fields`
5572 determine how the time series
5573 are partitioned into subsets
5574 prior to applying the aggregation
5575 operation. Each subset contains
5576 time series that have the same
5577 value for each of the grouping
5578 fields. Each individual time
5579 series is a member of exactly
5580 one subset. The `cross_series_reducer`
5581 is applied to each subset of
5582 time series. It is not possible
5583 to reduce across different resource
5584 types, so this field implicitly
5585 contains `resource.type`. Fields
5586 not specified in `group_by_fields`
5587 are aggregated away. If `group_by_fields`
5588 is not specified and all the
5589 time series have the same resource
5590 type, then the time series are
5591 aggregated into a single output
5592 time series. If `cross_series_reducer`
5593 is not defined, this field is
5594 ignored.
5595 items:
5596 type: string
5597 type: array
5598 perSeriesAligner:
5599 description: An `Aligner` describes
5600 how to bring the data points
5601 in a single time series into
5602 temporal alignment. Except for
5603 `ALIGN_NONE`, all alignments
5604 cause all the data points in
5605 an `alignment_period` to be
5606 mathematically grouped together,
5607 resulting in a single data point
5608 for each `alignment_period`
5609 with end timestamp at the end
5610 of the period. Not all alignment
5611 operations may be applied to
5612 all time series. The valid choices
5613 depend on the `metric_kind`
5614 and `value_type` of the original
5615 time series. Alignment can change
5616 the `metric_kind` or the `value_type`
5617 of the time series. Time series
5618 data must be aligned in order
5619 to perform cross-time series
5620 reduction. If `cross_series_reducer`
5621 is specified, then `per_series_aligner`
5622 must be specified and not equal
5623 to `ALIGN_NONE` and `alignment_period`
5624 must be specified; otherwise,
5625 an error is returned.
5626 type: string
5627 type: object
5628 filter:
5629 description: Required. The [monitoring
5630 filter](https://cloud.google.com/monitoring/api/v3/filters)
5631 that identifies the metric types,
5632 resources, and projects to query.
5633 type: string
5634 required:
5635 - filter
5636 type: object
5637 numerator:
5638 description: The numerator of the ratio.
5639 properties:
5640 aggregation:
5641 description: By default, the raw time
5642 series data is returned. Use this
5643 field to combine multiple time series
5644 for different views of the data.
5645 properties:
5646 alignmentPeriod:
5647 description: The `alignment_period`
5648 specifies a time interval, in
5649 seconds, that is used to divide
5650 the data in all the [time series][google.monitoring.v3.TimeSeries]
5651 into consistent blocks of time.
5652 This will be done before the
5653 per-series aligner can be applied
5654 to the data. The value must
5655 be at least 60 seconds. If a
5656 per-series aligner other than
5657 `ALIGN_NONE` is specified, this
5658 field is required or an error
5659 is returned. If no per-series
5660 aligner is specified, or the
5661 aligner `ALIGN_NONE` is specified,
5662 then this field is ignored.
5663 type: string
5664 crossSeriesReducer:
5665 description: 'The reduction operation
5666 to be used to combine time series
5667 into a single time series, where
5668 the value of each data point
5669 in the resulting series is a
5670 function of all the already
5671 aligned values in the input
5672 time series. Not all reducer
5673 operations can be applied to
5674 all time series. The valid choices
5675 depend on the `metric_kind`
5676 and the `value_type` of the
5677 original time series. Reduction
5678 can yield a time series with
5679 a different `metric_kind` or
5680 `value_type` than the input
5681 time series. Time series data
5682 must first be aligned (see `per_series_aligner`)
5683 in order to perform cross-time
5684 series reduction. If `cross_series_reducer`
5685 is specified, then `per_series_aligner`
5686 must be specified, and must
5687 not be `ALIGN_NONE`. An `alignment_period`
5688 must also be specified; otherwise,
5689 an error is returned. Possible
5690 values: REDUCE_NONE, REDUCE_MEAN,
5691 REDUCE_MIN, REDUCE_MAX, REDUCE_SUM,
5692 REDUCE_STDDEV, REDUCE_COUNT,
5693 REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE,
5694 REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99,
5695 REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50,
5696 REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN,
5697 REDUCE_MAKE_DISTRIBUTION'
5698 type: string
5699 groupByFields:
5700 description: The set of fields
5701 to preserve when `cross_series_reducer`
5702 is specified. The `group_by_fields`
5703 determine how the time series
5704 are partitioned into subsets
5705 prior to applying the aggregation
5706 operation. Each subset contains
5707 time series that have the same
5708 value for each of the grouping
5709 fields. Each individual time
5710 series is a member of exactly
5711 one subset. The `cross_series_reducer`
5712 is applied to each subset of
5713 time series. It is not possible
5714 to reduce across different resource
5715 types, so this field implicitly
5716 contains `resource.type`. Fields
5717 not specified in `group_by_fields`
5718 are aggregated away. If `group_by_fields`
5719 is not specified and all the
5720 time series have the same resource
5721 type, then the time series are
5722 aggregated into a single output
5723 time series. If `cross_series_reducer`
5724 is not defined, this field is
5725 ignored.
5726 items:
5727 type: string
5728 type: array
5729 perSeriesAligner:
5730 description: An `Aligner` describes
5731 how to bring the data points
5732 in a single time series into
5733 temporal alignment. Except for
5734 `ALIGN_NONE`, all alignments
5735 cause all the data points in
5736 an `alignment_period` to be
5737 mathematically grouped together,
5738 resulting in a single data point
5739 for each `alignment_period`
5740 with end timestamp at the end
5741 of the period. Not all alignment
5742 operations may be applied to
5743 all time series. The valid choices
5744 depend on the `metric_kind`
5745 and `value_type` of the original
5746 time series. Alignment can change
5747 the `metric_kind` or the `value_type`
5748 of the time series. Time series
5749 data must be aligned in order
5750 to perform cross-time series
5751 reduction. If `cross_series_reducer`
5752 is specified, then `per_series_aligner`
5753 must be specified and not equal
5754 to `ALIGN_NONE` and `alignment_period`
5755 must be specified; otherwise,
5756 an error is returned.
5757 type: string
5758 type: object
5759 filter:
5760 description: Required. The [monitoring
5761 filter](https://cloud.google.com/monitoring/api/v3/filters)
5762 that identifies the metric types,
5763 resources, and projects to query.
5764 type: string
5765 required:
5766 - filter
5767 type: object
5768 pickTimeSeriesFilter:
5769 description: Ranking based time series
5770 filter.
5771 properties:
5772 direction:
5773 description: 'How to use the ranking
5774 to select time series that pass
5775 through the filter. Possible values:
5776 DIRECTION_UNSPECIFIED, TOP, BOTTOM'
5777 type: string
5778 numTimeSeries:
5779 description: How many time series
5780 to allow to pass through the filter.
5781 format: int64
5782 type: integer
5783 rankingMethod:
5784 description: '`ranking_method` is
5785 applied to each time series independently
5786 to produce the value which will
5787 be used to compare the time series
5788 to other time series. Possible values:
5789 METHOD_UNSPECIFIED, METHOD_MEAN,
5790 METHOD_MAX, METHOD_MIN, METHOD_SUM,
5791 METHOD_LATEST'
5792 type: string
5793 type: object
5794 secondaryAggregation:
5795 description: Apply a second aggregation
5796 after the ratio is computed.
5797 properties:
5798 alignmentPeriod:
5799 description: The `alignment_period`
5800 specifies a time interval, in seconds,
5801 that is used to divide the data
5802 in all the [time series][google.monitoring.v3.TimeSeries]
5803 into consistent blocks of time.
5804 This will be done before the per-series
5805 aligner can be applied to the data. The
5806 value must be at least 60 seconds.
5807 If a per-series aligner other than
5808 `ALIGN_NONE` is specified, this
5809 field is required or an error is
5810 returned. If no per-series aligner
5811 is specified, or the aligner `ALIGN_NONE`
5812 is specified, then this field is
5813 ignored.
5814 type: string
5815 crossSeriesReducer:
5816 description: 'The reduction operation
5817 to be used to combine time series
5818 into a single time series, where
5819 the value of each data point in
5820 the resulting series is a function
5821 of all the already aligned values
5822 in the input time series. Not all
5823 reducer operations can be applied
5824 to all time series. The valid choices
5825 depend on the `metric_kind` and
5826 the `value_type` of the original
5827 time series. Reduction can yield
5828 a time series with a different `metric_kind`
5829 or `value_type` than the input time
5830 series. Time series data must first
5831 be aligned (see `per_series_aligner`)
5832 in order to perform cross-time series
5833 reduction. If `cross_series_reducer`
5834 is specified, then `per_series_aligner`
5835 must be specified, and must not
5836 be `ALIGN_NONE`. An `alignment_period`
5837 must also be specified; otherwise,
5838 an error is returned. Possible values:
5839 REDUCE_NONE, REDUCE_MEAN, REDUCE_MIN,
5840 REDUCE_MAX, REDUCE_SUM, REDUCE_STDDEV,
5841 REDUCE_COUNT, REDUCE_COUNT_TRUE,
5842 REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE,
5843 REDUCE_PERCENTILE_99, REDUCE_PERCENTILE_95,
5844 REDUCE_PERCENTILE_50, REDUCE_PERCENTILE_05,
5845 REDUCE_FRACTION_LESS_THAN, REDUCE_MAKE_DISTRIBUTION'
5846 type: string
5847 groupByFields:
5848 description: The set of fields to
5849 preserve when `cross_series_reducer`
5850 is specified. The `group_by_fields`
5851 determine how the time series are
5852 partitioned into subsets prior to
5853 applying the aggregation operation.
5854 Each subset contains time series
5855 that have the same value for each
5856 of the grouping fields. Each individual
5857 time series is a member of exactly
5858 one subset. The `cross_series_reducer`
5859 is applied to each subset of time
5860 series. It is not possible to reduce
5861 across different resource types,
5862 so this field implicitly contains
5863 `resource.type`. Fields not specified
5864 in `group_by_fields` are aggregated
5865 away. If `group_by_fields` is not
5866 specified and all the time series
5867 have the same resource type, then
5868 the time series are aggregated into
5869 a single output time series. If
5870 `cross_series_reducer` is not defined,
5871 this field is ignored.
5872 items:
5873 type: string
5874 type: array
5875 perSeriesAligner:
5876 description: An `Aligner` describes
5877 how to bring the data points in
5878 a single time series into temporal
5879 alignment. Except for `ALIGN_NONE`,
5880 all alignments cause all the data
5881 points in an `alignment_period`
5882 to be mathematically grouped together,
5883 resulting in a single data point
5884 for each `alignment_period` with
5885 end timestamp at the end of the
5886 period. Not all alignment operations
5887 may be applied to all time series.
5888 The valid choices depend on the
5889 `metric_kind` and `value_type` of
5890 the original time series. Alignment
5891 can change the `metric_kind` or
5892 the `value_type` of the time series. Time
5893 series data must be aligned in order
5894 to perform cross-time series reduction.
5895 If `cross_series_reducer` is specified,
5896 then `per_series_aligner` must be
5897 specified and not equal to `ALIGN_NONE`
5898 and `alignment_period` must be specified;
5899 otherwise, an error is returned.
5900 type: string
5901 type: object
5902 type: object
5903 timeSeriesQueryLanguage:
5904 description: A query used to fetch time series.
5905 type: string
5906 unitOverride:
5907 description: The unit of data contained in
5908 fetched time series. If non-empty, this
5909 unit will override any unit that accompanies
5910 fetched data. The format is the same as
5911 the [`unit`](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors)
5912 field in `MetricDescriptor`.
5913 type: string
5914 type: object
5915 required:
5916 - timeSeriesQuery
5917 type: object
5918 text:
5919 description: A raw string or markdown displaying textual
5920 content.
5921 properties:
5922 content:
5923 description: The text content to be displayed.
5924 type: string
5925 format:
5926 description: 'How the text content is formatted.
5927 Possible values: FORMAT_UNSPECIFIED, MARKDOWN,
5928 RAW'
5929 type: string
5930 type: object
5931 title:
5932 description: Optional. The title of the widget.
5933 type: string
5934 xyChart:
5935 description: A chart of time series data.
5936 properties:
5937 chartOptions:
5938 description: Display options for the chart.
5939 properties:
5940 mode:
5941 description: 'The chart mode. Possible values:
5942 MODE_UNSPECIFIED, COLOR, X_RAY, STATS'
5943 type: string
5944 type: object
5945 dataSets:
5946 description: Required. The data displayed in this
5947 chart.
5948 items:
5949 properties:
5950 legendTemplate:
5951 description: 'A template string for naming
5952 `TimeSeries` in the resulting data set.
5953 This should be a string with interpolations
5954 of the form `${label_name}`, which will
5955 resolve to the label''s value. '
5956 type: string
5957 minAlignmentPeriod:
5958 description: Optional. The lower bound on
5959 data point frequency for this data set,
5960 implemented by specifying the minimum
5961 alignment period to use in a time series
5962 query For example, if the data is published
5963 once every 10 minutes, the `min_alignment_period`
5964 should be at least 10 minutes. It would
5965 not make sense to fetch and align data
5966 at one minute intervals.
5967 type: string
5968 plotType:
5969 description: 'How this data should be plotted
5970 on the chart. Possible values: PLOT_TYPE_UNSPECIFIED,
5971 LINE, STACKED_AREA, STACKED_BAR, HEATMAP'
5972 type: string
5973 timeSeriesQuery:
5974 description: Required. Fields for querying
5975 time series data from the Stackdriver
5976 metrics API.
5977 properties:
5978 timeSeriesFilter:
5979 description: Filter parameters to fetch
5980 time series.
5981 properties:
5982 aggregation:
5983 description: By default, the raw
5984 time series data is returned.
5985 Use this field to combine multiple
5986 time series for different views
5987 of the data.
5988 properties:
5989 alignmentPeriod:
5990 description: The `alignment_period`
5991 specifies a time interval,
5992 in seconds, that is used to
5993 divide the data in all the
5994 [time series][google.monitoring.v3.TimeSeries]
5995 into consistent blocks of
5996 time. This will be done before
5997 the per-series aligner can
5998 be applied to the data. The
5999 value must be at least 60
6000 seconds. If a per-series aligner
6001 other than `ALIGN_NONE` is
6002 specified, this field is required
6003 or an error is returned. If
6004 no per-series aligner is specified,
6005 or the aligner `ALIGN_NONE`
6006 is specified, then this field
6007 is ignored.
6008 type: string
6009 crossSeriesReducer:
6010 description: 'The reduction
6011 operation to be used to combine
6012 time series into a single
6013 time series, where the value
6014 of each data point in the
6015 resulting series is a function
6016 of all the already aligned
6017 values in the input time series. Not
6018 all reducer operations can
6019 be applied to all time series.
6020 The valid choices depend on
6021 the `metric_kind` and the
6022 `value_type` of the original
6023 time series. Reduction can
6024 yield a time series with a
6025 different `metric_kind` or
6026 `value_type` than the input
6027 time series. Time series
6028 data must first be aligned
6029 (see `per_series_aligner`)
6030 in order to perform cross-time
6031 series reduction. If `cross_series_reducer`
6032 is specified, then `per_series_aligner`
6033 must be specified, and must
6034 not be `ALIGN_NONE`. An `alignment_period`
6035 must also be specified; otherwise,
6036 an error is returned. Possible
6037 values: REDUCE_NONE, REDUCE_MEAN,
6038 REDUCE_MIN, REDUCE_MAX, REDUCE_SUM,
6039 REDUCE_STDDEV, REDUCE_COUNT,
6040 REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE,
6041 REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99,
6042 REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50,
6043 REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN,
6044 REDUCE_MAKE_DISTRIBUTION'
6045 type: string
6046 groupByFields:
6047 description: The set of fields
6048 to preserve when `cross_series_reducer`
6049 is specified. The `group_by_fields`
6050 determine how the time series
6051 are partitioned into subsets
6052 prior to applying the aggregation
6053 operation. Each subset contains
6054 time series that have the
6055 same value for each of the
6056 grouping fields. Each individual
6057 time series is a member of
6058 exactly one subset. The `cross_series_reducer`
6059 is applied to each subset
6060 of time series. It is not
6061 possible to reduce across
6062 different resource types,
6063 so this field implicitly contains
6064 `resource.type`. Fields not
6065 specified in `group_by_fields`
6066 are aggregated away. If `group_by_fields`
6067 is not specified and all the
6068 time series have the same
6069 resource type, then the time
6070 series are aggregated into
6071 a single output time series.
6072 If `cross_series_reducer`
6073 is not defined, this field
6074 is ignored.
6075 items:
6076 type: string
6077 type: array
6078 perSeriesAligner:
6079 description: An `Aligner` describes
6080 how to bring the data points
6081 in a single time series into
6082 temporal alignment. Except
6083 for `ALIGN_NONE`, all alignments
6084 cause all the data points
6085 in an `alignment_period` to
6086 be mathematically grouped
6087 together, resulting in a single
6088 data point for each `alignment_period`
6089 with end timestamp at the
6090 end of the period. Not all
6091 alignment operations may be
6092 applied to all time series.
6093 The valid choices depend on
6094 the `metric_kind` and `value_type`
6095 of the original time series.
6096 Alignment can change the `metric_kind`
6097 or the `value_type` of the
6098 time series. Time series
6099 data must be aligned in order
6100 to perform cross-time series
6101 reduction. If `cross_series_reducer`
6102 is specified, then `per_series_aligner`
6103 must be specified and not
6104 equal to `ALIGN_NONE` and
6105 `alignment_period` must be
6106 specified; otherwise, an error
6107 is returned.
6108 type: string
6109 type: object
6110 filter:
6111 description: Required. The [monitoring
6112 filter](https://cloud.google.com/monitoring/api/v3/filters)
6113 that identifies the metric types,
6114 resources, and projects to query.
6115 type: string
6116 pickTimeSeriesFilter:
6117 description: Ranking based time
6118 series filter.
6119 properties:
6120 direction:
6121 description: 'How to use the
6122 ranking to select time series
6123 that pass through the filter.
6124 Possible values: DIRECTION_UNSPECIFIED,
6125 TOP, BOTTOM'
6126 type: string
6127 numTimeSeries:
6128 description: How many time series
6129 to allow to pass through the
6130 filter.
6131 format: int64
6132 type: integer
6133 rankingMethod:
6134 description: '`ranking_method`
6135 is applied to each time series
6136 independently to produce the
6137 value which will be used to
6138 compare the time series to
6139 other time series. Possible
6140 values: METHOD_UNSPECIFIED,
6141 METHOD_MEAN, METHOD_MAX, METHOD_MIN,
6142 METHOD_SUM, METHOD_LATEST'
6143 type: string
6144 type: object
6145 secondaryAggregation:
6146 description: Apply a second aggregation
6147 after `aggregation` is applied.
6148 properties:
6149 alignmentPeriod:
6150 description: The `alignment_period`
6151 specifies a time interval,
6152 in seconds, that is used to
6153 divide the data in all the
6154 [time series][google.monitoring.v3.TimeSeries]
6155 into consistent blocks of
6156 time. This will be done before
6157 the per-series aligner can
6158 be applied to the data. The
6159 value must be at least 60
6160 seconds. If a per-series aligner
6161 other than `ALIGN_NONE` is
6162 specified, this field is required
6163 or an error is returned. If
6164 no per-series aligner is specified,
6165 or the aligner `ALIGN_NONE`
6166 is specified, then this field
6167 is ignored.
6168 type: string
6169 crossSeriesReducer:
6170 description: 'The reduction
6171 operation to be used to combine
6172 time series into a single
6173 time series, where the value
6174 of each data point in the
6175 resulting series is a function
6176 of all the already aligned
6177 values in the input time series. Not
6178 all reducer operations can
6179 be applied to all time series.
6180 The valid choices depend on
6181 the `metric_kind` and the
6182 `value_type` of the original
6183 time series. Reduction can
6184 yield a time series with a
6185 different `metric_kind` or
6186 `value_type` than the input
6187 time series. Time series
6188 data must first be aligned
6189 (see `per_series_aligner`)
6190 in order to perform cross-time
6191 series reduction. If `cross_series_reducer`
6192 is specified, then `per_series_aligner`
6193 must be specified, and must
6194 not be `ALIGN_NONE`. An `alignment_period`
6195 must also be specified; otherwise,
6196 an error is returned. Possible
6197 values: REDUCE_NONE, REDUCE_MEAN,
6198 REDUCE_MIN, REDUCE_MAX, REDUCE_SUM,
6199 REDUCE_STDDEV, REDUCE_COUNT,
6200 REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE,
6201 REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99,
6202 REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50,
6203 REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN,
6204 REDUCE_MAKE_DISTRIBUTION'
6205 type: string
6206 groupByFields:
6207 description: The set of fields
6208 to preserve when `cross_series_reducer`
6209 is specified. The `group_by_fields`
6210 determine how the time series
6211 are partitioned into subsets
6212 prior to applying the aggregation
6213 operation. Each subset contains
6214 time series that have the
6215 same value for each of the
6216 grouping fields. Each individual
6217 time series is a member of
6218 exactly one subset. The `cross_series_reducer`
6219 is applied to each subset
6220 of time series. It is not
6221 possible to reduce across
6222 different resource types,
6223 so this field implicitly contains
6224 `resource.type`. Fields not
6225 specified in `group_by_fields`
6226 are aggregated away. If `group_by_fields`
6227 is not specified and all the
6228 time series have the same
6229 resource type, then the time
6230 series are aggregated into
6231 a single output time series.
6232 If `cross_series_reducer`
6233 is not defined, this field
6234 is ignored.
6235 items:
6236 type: string
6237 type: array
6238 perSeriesAligner:
6239 description: An `Aligner` describes
6240 how to bring the data points
6241 in a single time series into
6242 temporal alignment. Except
6243 for `ALIGN_NONE`, all alignments
6244 cause all the data points
6245 in an `alignment_period` to
6246 be mathematically grouped
6247 together, resulting in a single
6248 data point for each `alignment_period`
6249 with end timestamp at the
6250 end of the period. Not all
6251 alignment operations may be
6252 applied to all time series.
6253 The valid choices depend on
6254 the `metric_kind` and `value_type`
6255 of the original time series.
6256 Alignment can change the `metric_kind`
6257 or the `value_type` of the
6258 time series. Time series
6259 data must be aligned in order
6260 to perform cross-time series
6261 reduction. If `cross_series_reducer`
6262 is specified, then `per_series_aligner`
6263 must be specified and not
6264 equal to `ALIGN_NONE` and
6265 `alignment_period` must be
6266 specified; otherwise, an error
6267 is returned.
6268 type: string
6269 type: object
6270 required:
6271 - filter
6272 type: object
6273 timeSeriesFilterRatio:
6274 description: Parameters to fetch a ratio
6275 between two time series filters.
6276 properties:
6277 denominator:
6278 description: The denominator of
6279 the ratio.
6280 properties:
6281 aggregation:
6282 description: By default, the
6283 raw time series data is returned.
6284 Use this field to combine
6285 multiple time series for different
6286 views of the data.
6287 properties:
6288 alignmentPeriod:
6289 description: The `alignment_period`
6290 specifies a time interval,
6291 in seconds, that is used
6292 to divide the data in
6293 all the [time series][google.monitoring.v3.TimeSeries]
6294 into consistent blocks
6295 of time. This will be
6296 done before the per-series
6297 aligner can be applied
6298 to the data. The value
6299 must be at least 60 seconds.
6300 If a per-series aligner
6301 other than `ALIGN_NONE`
6302 is specified, this field
6303 is required or an error
6304 is returned. If no per-series
6305 aligner is specified,
6306 or the aligner `ALIGN_NONE`
6307 is specified, then this
6308 field is ignored.
6309 type: string
6310 crossSeriesReducer:
6311 description: 'The reduction
6312 operation to be used to
6313 combine time series into
6314 a single time series,
6315 where the value of each
6316 data point in the resulting
6317 series is a function of
6318 all the already aligned
6319 values in the input time
6320 series. Not all reducer
6321 operations can be applied
6322 to all time series. The
6323 valid choices depend on
6324 the `metric_kind` and
6325 the `value_type` of the
6326 original time series.
6327 Reduction can yield a
6328 time series with a different
6329 `metric_kind` or `value_type`
6330 than the input time series. Time
6331 series data must first
6332 be aligned (see `per_series_aligner`)
6333 in order to perform cross-time
6334 series reduction. If `cross_series_reducer`
6335 is specified, then `per_series_aligner`
6336 must be specified, and
6337 must not be `ALIGN_NONE`.
6338 An `alignment_period`
6339 must also be specified;
6340 otherwise, an error is
6341 returned. Possible values:
6342 REDUCE_NONE, REDUCE_MEAN,
6343 REDUCE_MIN, REDUCE_MAX,
6344 REDUCE_SUM, REDUCE_STDDEV,
6345 REDUCE_COUNT, REDUCE_COUNT_TRUE,
6346 REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE,
6347 REDUCE_PERCENTILE_99,
6348 REDUCE_PERCENTILE_95,
6349 REDUCE_PERCENTILE_50,
6350 REDUCE_PERCENTILE_05,
6351 REDUCE_FRACTION_LESS_THAN,
6352 REDUCE_MAKE_DISTRIBUTION'
6353 type: string
6354 groupByFields:
6355 description: The set of
6356 fields to preserve when
6357 `cross_series_reducer`
6358 is specified. The `group_by_fields`
6359 determine how the time
6360 series are partitioned
6361 into subsets prior to
6362 applying the aggregation
6363 operation. Each subset
6364 contains time series that
6365 have the same value for
6366 each of the grouping fields.
6367 Each individual time series
6368 is a member of exactly
6369 one subset. The `cross_series_reducer`
6370 is applied to each subset
6371 of time series. It is
6372 not possible to reduce
6373 across different resource
6374 types, so this field implicitly
6375 contains `resource.type`. Fields
6376 not specified in `group_by_fields`
6377 are aggregated away. If
6378 `group_by_fields` is not
6379 specified and all the
6380 time series have the same
6381 resource type, then the
6382 time series are aggregated
6383 into a single output time
6384 series. If `cross_series_reducer`
6385 is not defined, this field
6386 is ignored.
6387 items:
6388 type: string
6389 type: array
6390 perSeriesAligner:
6391 description: An `Aligner`
6392 describes how to bring
6393 the data points in a single
6394 time series into temporal
6395 alignment. Except for
6396 `ALIGN_NONE`, all alignments
6397 cause all the data points
6398 in an `alignment_period`
6399 to be mathematically grouped
6400 together, resulting in
6401 a single data point for
6402 each `alignment_period`
6403 with end timestamp at
6404 the end of the period. Not
6405 all alignment operations
6406 may be applied to all
6407 time series. The valid
6408 choices depend on the
6409 `metric_kind` and `value_type`
6410 of the original time series.
6411 Alignment can change the
6412 `metric_kind` or the `value_type`
6413 of the time series. Time
6414 series data must be aligned
6415 in order to perform cross-time
6416 series reduction. If `cross_series_reducer`
6417 is specified, then `per_series_aligner`
6418 must be specified and
6419 not equal to `ALIGN_NONE`
6420 and `alignment_period`
6421 must be specified; otherwise,
6422 an error is returned.
6423 type: string
6424 type: object
6425 filter:
6426 description: Required. The [monitoring
6427 filter](https://cloud.google.com/monitoring/api/v3/filters)
6428 that identifies the metric
6429 types, resources, and projects
6430 to query.
6431 type: string
6432 required:
6433 - filter
6434 type: object
6435 numerator:
6436 description: The numerator of the
6437 ratio.
6438 properties:
6439 aggregation:
6440 description: By default, the
6441 raw time series data is returned.
6442 Use this field to combine
6443 multiple time series for different
6444 views of the data.
6445 properties:
6446 alignmentPeriod:
6447 description: The `alignment_period`
6448 specifies a time interval,
6449 in seconds, that is used
6450 to divide the data in
6451 all the [time series][google.monitoring.v3.TimeSeries]
6452 into consistent blocks
6453 of time. This will be
6454 done before the per-series
6455 aligner can be applied
6456 to the data. The value
6457 must be at least 60 seconds.
6458 If a per-series aligner
6459 other than `ALIGN_NONE`
6460 is specified, this field
6461 is required or an error
6462 is returned. If no per-series
6463 aligner is specified,
6464 or the aligner `ALIGN_NONE`
6465 is specified, then this
6466 field is ignored.
6467 type: string
6468 crossSeriesReducer:
6469 description: 'The reduction
6470 operation to be used to
6471 combine time series into
6472 a single time series,
6473 where the value of each
6474 data point in the resulting
6475 series is a function of
6476 all the already aligned
6477 values in the input time
6478 series. Not all reducer
6479 operations can be applied
6480 to all time series. The
6481 valid choices depend on
6482 the `metric_kind` and
6483 the `value_type` of the
6484 original time series.
6485 Reduction can yield a
6486 time series with a different
6487 `metric_kind` or `value_type`
6488 than the input time series. Time
6489 series data must first
6490 be aligned (see `per_series_aligner`)
6491 in order to perform cross-time
6492 series reduction. If `cross_series_reducer`
6493 is specified, then `per_series_aligner`
6494 must be specified, and
6495 must not be `ALIGN_NONE`.
6496 An `alignment_period`
6497 must also be specified;
6498 otherwise, an error is
6499 returned. Possible values:
6500 REDUCE_NONE, REDUCE_MEAN,
6501 REDUCE_MIN, REDUCE_MAX,
6502 REDUCE_SUM, REDUCE_STDDEV,
6503 REDUCE_COUNT, REDUCE_COUNT_TRUE,
6504 REDUCE_COUNT_FALSE, REDUCE_FRACTION_TRUE,
6505 REDUCE_PERCENTILE_99,
6506 REDUCE_PERCENTILE_95,
6507 REDUCE_PERCENTILE_50,
6508 REDUCE_PERCENTILE_05,
6509 REDUCE_FRACTION_LESS_THAN,
6510 REDUCE_MAKE_DISTRIBUTION'
6511 type: string
6512 groupByFields:
6513 description: The set of
6514 fields to preserve when
6515 `cross_series_reducer`
6516 is specified. The `group_by_fields`
6517 determine how the time
6518 series are partitioned
6519 into subsets prior to
6520 applying the aggregation
6521 operation. Each subset
6522 contains time series that
6523 have the same value for
6524 each of the grouping fields.
6525 Each individual time series
6526 is a member of exactly
6527 one subset. The `cross_series_reducer`
6528 is applied to each subset
6529 of time series. It is
6530 not possible to reduce
6531 across different resource
6532 types, so this field implicitly
6533 contains `resource.type`. Fields
6534 not specified in `group_by_fields`
6535 are aggregated away. If
6536 `group_by_fields` is not
6537 specified and all the
6538 time series have the same
6539 resource type, then the
6540 time series are aggregated
6541 into a single output time
6542 series. If `cross_series_reducer`
6543 is not defined, this field
6544 is ignored.
6545 items:
6546 type: string
6547 type: array
6548 perSeriesAligner:
6549 description: An `Aligner`
6550 describes how to bring
6551 the data points in a single
6552 time series into temporal
6553 alignment. Except for
6554 `ALIGN_NONE`, all alignments
6555 cause all the data points
6556 in an `alignment_period`
6557 to be mathematically grouped
6558 together, resulting in
6559 a single data point for
6560 each `alignment_period`
6561 with end timestamp at
6562 the end of the period. Not
6563 all alignment operations
6564 may be applied to all
6565 time series. The valid
6566 choices depend on the
6567 `metric_kind` and `value_type`
6568 of the original time series.
6569 Alignment can change the
6570 `metric_kind` or the `value_type`
6571 of the time series. Time
6572 series data must be aligned
6573 in order to perform cross-time
6574 series reduction. If `cross_series_reducer`
6575 is specified, then `per_series_aligner`
6576 must be specified and
6577 not equal to `ALIGN_NONE`
6578 and `alignment_period`
6579 must be specified; otherwise,
6580 an error is returned.
6581 type: string
6582 type: object
6583 filter:
6584 description: Required. The [monitoring
6585 filter](https://cloud.google.com/monitoring/api/v3/filters)
6586 that identifies the metric
6587 types, resources, and projects
6588 to query.
6589 type: string
6590 required:
6591 - filter
6592 type: object
6593 pickTimeSeriesFilter:
6594 description: Ranking based time
6595 series filter.
6596 properties:
6597 direction:
6598 description: 'How to use the
6599 ranking to select time series
6600 that pass through the filter.
6601 Possible values: DIRECTION_UNSPECIFIED,
6602 TOP, BOTTOM'
6603 type: string
6604 numTimeSeries:
6605 description: How many time series
6606 to allow to pass through the
6607 filter.
6608 format: int64
6609 type: integer
6610 rankingMethod:
6611 description: '`ranking_method`
6612 is applied to each time series
6613 independently to produce the
6614 value which will be used to
6615 compare the time series to
6616 other time series. Possible
6617 values: METHOD_UNSPECIFIED,
6618 METHOD_MEAN, METHOD_MAX, METHOD_MIN,
6619 METHOD_SUM, METHOD_LATEST'
6620 type: string
6621 type: object
6622 secondaryAggregation:
6623 description: Apply a second aggregation
6624 after the ratio is computed.
6625 properties:
6626 alignmentPeriod:
6627 description: The `alignment_period`
6628 specifies a time interval,
6629 in seconds, that is used to
6630 divide the data in all the
6631 [time series][google.monitoring.v3.TimeSeries]
6632 into consistent blocks of
6633 time. This will be done before
6634 the per-series aligner can
6635 be applied to the data. The
6636 value must be at least 60
6637 seconds. If a per-series aligner
6638 other than `ALIGN_NONE` is
6639 specified, this field is required
6640 or an error is returned. If
6641 no per-series aligner is specified,
6642 or the aligner `ALIGN_NONE`
6643 is specified, then this field
6644 is ignored.
6645 type: string
6646 crossSeriesReducer:
6647 description: 'The reduction
6648 operation to be used to combine
6649 time series into a single
6650 time series, where the value
6651 of each data point in the
6652 resulting series is a function
6653 of all the already aligned
6654 values in the input time series. Not
6655 all reducer operations can
6656 be applied to all time series.
6657 The valid choices depend on
6658 the `metric_kind` and the
6659 `value_type` of the original
6660 time series. Reduction can
6661 yield a time series with a
6662 different `metric_kind` or
6663 `value_type` than the input
6664 time series. Time series
6665 data must first be aligned
6666 (see `per_series_aligner`)
6667 in order to perform cross-time
6668 series reduction. If `cross_series_reducer`
6669 is specified, then `per_series_aligner`
6670 must be specified, and must
6671 not be `ALIGN_NONE`. An `alignment_period`
6672 must also be specified; otherwise,
6673 an error is returned. Possible
6674 values: REDUCE_NONE, REDUCE_MEAN,
6675 REDUCE_MIN, REDUCE_MAX, REDUCE_SUM,
6676 REDUCE_STDDEV, REDUCE_COUNT,
6677 REDUCE_COUNT_TRUE, REDUCE_COUNT_FALSE,
6678 REDUCE_FRACTION_TRUE, REDUCE_PERCENTILE_99,
6679 REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_50,
6680 REDUCE_PERCENTILE_05, REDUCE_FRACTION_LESS_THAN,
6681 REDUCE_MAKE_DISTRIBUTION'
6682 type: string
6683 groupByFields:
6684 description: The set of fields
6685 to preserve when `cross_series_reducer`
6686 is specified. The `group_by_fields`
6687 determine how the time series
6688 are partitioned into subsets
6689 prior to applying the aggregation
6690 operation. Each subset contains
6691 time series that have the
6692 same value for each of the
6693 grouping fields. Each individual
6694 time series is a member of
6695 exactly one subset. The `cross_series_reducer`
6696 is applied to each subset
6697 of time series. It is not
6698 possible to reduce across
6699 different resource types,
6700 so this field implicitly contains
6701 `resource.type`. Fields not
6702 specified in `group_by_fields`
6703 are aggregated away. If `group_by_fields`
6704 is not specified and all the
6705 time series have the same
6706 resource type, then the time
6707 series are aggregated into
6708 a single output time series.
6709 If `cross_series_reducer`
6710 is not defined, this field
6711 is ignored.
6712 items:
6713 type: string
6714 type: array
6715 perSeriesAligner:
6716 description: An `Aligner` describes
6717 how to bring the data points
6718 in a single time series into
6719 temporal alignment. Except
6720 for `ALIGN_NONE`, all alignments
6721 cause all the data points
6722 in an `alignment_period` to
6723 be mathematically grouped
6724 together, resulting in a single
6725 data point for each `alignment_period`
6726 with end timestamp at the
6727 end of the period. Not all
6728 alignment operations may be
6729 applied to all time series.
6730 The valid choices depend on
6731 the `metric_kind` and `value_type`
6732 of the original time series.
6733 Alignment can change the `metric_kind`
6734 or the `value_type` of the
6735 time series. Time series
6736 data must be aligned in order
6737 to perform cross-time series
6738 reduction. If `cross_series_reducer`
6739 is specified, then `per_series_aligner`
6740 must be specified and not
6741 equal to `ALIGN_NONE` and
6742 `alignment_period` must be
6743 specified; otherwise, an error
6744 is returned.
6745 type: string
6746 type: object
6747 type: object
6748 timeSeriesQueryLanguage:
6749 description: A query used to fetch time
6750 series.
6751 type: string
6752 unitOverride:
6753 description: The unit of data contained
6754 in fetched time series. If non-empty,
6755 this unit will override any unit that
6756 accompanies fetched data. The format
6757 is the same as the [`unit`](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors)
6758 field in `MetricDescriptor`.
6759 type: string
6760 type: object
6761 required:
6762 - timeSeriesQuery
6763 type: object
6764 type: array
6765 thresholds:
6766 description: Threshold lines drawn horizontally
6767 across the chart.
6768 items:
6769 properties:
6770 color:
6771 description: 'The state color for this threshold.
6772 Color is not allowed in a XyChart. Possible
6773 values: COLOR_UNSPECIFIED, GREY, BLUE,
6774 GREEN, YELLOW, ORANGE, RED'
6775 type: string
6776 direction:
6777 description: 'The direction for the current
6778 threshold. Direction is not allowed in
6779 a XyChart. Possible values: DIRECTION_UNSPECIFIED,
6780 ABOVE, BELOW'
6781 type: string
6782 label:
6783 description: A label for the threshold.
6784 type: string
6785 value:
6786 description: The value of the threshold.
6787 The value should be defined in the native
6788 scale of the metric.
6789 format: double
6790 type: number
6791 type: object
6792 type: array
6793 timeshiftDuration:
6794 description: The duration used to display a comparison
6795 chart. A comparison chart simultaneously shows
6796 values from two similar-length time periods
6797 (e.g., week-over-week metrics). The duration
6798 must be positive, and it can only be applied
6799 to charts with data sets of LINE plot type.
6800 type: string
6801 xAxis:
6802 description: The properties applied to the X axis.
6803 properties:
6804 label:
6805 description: The label of the axis.
6806 type: string
6807 scale:
6808 description: 'The axis scale. By default,
6809 a linear scale is used. Possible values:
6810 SCALE_UNSPECIFIED, LINEAR, LOG10'
6811 type: string
6812 type: object
6813 yAxis:
6814 description: The properties applied to the Y axis.
6815 properties:
6816 label:
6817 description: The label of the axis.
6818 type: string
6819 scale:
6820 description: 'The axis scale. By default,
6821 a linear scale is used. Possible values:
6822 SCALE_UNSPECIFIED, LINEAR, LOG10'
6823 type: string
6824 type: object
6825 required:
6826 - dataSets
6827 type: object
6828 type: object
6829 type: array
6830 type: object
6831 type: array
6832 type: object
6833 required:
6834 - displayName
6835 - projectRef
6836 type: object
6837 status:
6838 properties:
6839 conditions:
6840 description: Conditions represent the latest available observation
6841 of the resource's current state.
6842 items:
6843 properties:
6844 lastTransitionTime:
6845 description: Last time the condition transitioned from one status
6846 to another.
6847 type: string
6848 message:
6849 description: Human-readable message indicating details about
6850 last transition.
6851 type: string
6852 reason:
6853 description: Unique, one-word, CamelCase reason for the condition's
6854 last transition.
6855 type: string
6856 status:
6857 description: Status is the status of the condition. Can be True,
6858 False, Unknown.
6859 type: string
6860 type:
6861 description: Type is the type of the condition.
6862 type: string
6863 type: object
6864 type: array
6865 etag:
6866 description: \`etag\` is used for optimistic concurrency control as
6867 a way to help prevent simultaneous updates of a policy from overwriting
6868 each other. An \`etag\` is returned in the response to \`GetDashboard\`,
6869 and users are expected to put that etag in the request to \`UpdateDashboard\`
6870 to ensure that their change will be applied to the same version
6871 of the Dashboard configuration. The field should not be passed during
6872 dashboard creation.
6873 type: string
6874 observedGeneration:
6875 description: ObservedGeneration is the generation of the resource
6876 that was most recently observed by the Config Connector controller.
6877 If this is equal to metadata.generation, then that means that the
6878 current reported status reflects the most recent desired state of
6879 the resource.
6880 type: integer
6881 type: object
6882 required:
6883 - spec
6884 type: object
6885 served: true
6886 storage: true
6887 subresources:
6888 status: {}
6889status:
6890 acceptedNames:
6891 kind: ""
6892 plural: ""
6893 conditions: []
6894 storedVersions: []
View as plain text