-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
monitoring-gen.go
5073 lines (4733 loc) · 216 KB
/
monitoring-gen.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2024 Google LLC.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Code generated file. DO NOT EDIT.
// Package monitoring provides access to the Cloud Monitoring API.
//
// For product documentation, see: https://cloud.google.com/monitoring/api/
//
// # Library status
//
// These client libraries are officially supported by Google. However, this
// library is considered complete and is in maintenance mode. This means
// that we will address critical bugs and security issues but will not add
// any new features.
//
// When possible, we recommend using our newer
// [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go)
// that are still actively being worked and iterated on.
//
// # Creating a client
//
// Usage example:
//
// import "google.golang.org/api/monitoring/v1"
// ...
// ctx := context.Background()
// monitoringService, err := monitoring.NewService(ctx)
//
// In this example, Google Application Default Credentials are used for
// authentication. For information on how to create and obtain Application
// Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
//
// # Other authentication options
//
// By default, all available scopes (see "Constants") are used to authenticate.
// To restrict scopes, use [google.golang.org/api/option.WithScopes]:
//
// monitoringService, err := monitoring.NewService(ctx, option.WithScopes(monitoring.MonitoringWriteScope))
//
// To use an API key for authentication (note: some APIs do not support API
// keys), use [google.golang.org/api/option.WithAPIKey]:
//
// monitoringService, err := monitoring.NewService(ctx, option.WithAPIKey("AIza..."))
//
// To use an OAuth token (e.g., a user token obtained via a three-legged OAuth
// flow, use [google.golang.org/api/option.WithTokenSource]:
//
// config := &oauth2.Config{...}
// // ...
// token, err := config.Exchange(ctx, ...)
// monitoringService, err := monitoring.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See [google.golang.org/api/option.ClientOption] for details on options.
package monitoring // import "google.golang.org/api/monitoring/v1"
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"strconv"
"strings"
googleapi "google.golang.org/api/googleapi"
internal "google.golang.org/api/internal"
gensupport "google.golang.org/api/internal/gensupport"
option "google.golang.org/api/option"
internaloption "google.golang.org/api/option/internaloption"
htransport "google.golang.org/api/transport/http"
)
// Always reference these packages, just in case the auto-generated code
// below doesn't.
var _ = bytes.NewBuffer
var _ = strconv.Itoa
var _ = fmt.Sprintf
var _ = json.NewDecoder
var _ = io.Copy
var _ = url.Parse
var _ = gensupport.MarshalJSON
var _ = googleapi.Version
var _ = errors.New
var _ = strings.Replace
var _ = context.Canceled
var _ = internaloption.WithDefaultEndpoint
var _ = internal.Version
const apiId = "monitoring:v1"
const apiName = "monitoring"
const apiVersion = "v1"
const basePath = "https://monitoring.googleapis.com/"
const basePathTemplate = "https://monitoring.UNIVERSE_DOMAIN/"
const mtlsBasePath = "https://monitoring.mtls.googleapis.com/"
// OAuth2 scopes used by this API.
const (
// See, edit, configure, and delete your Google Cloud data and see the email
// address for your Google Account.
CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"
// View and write monitoring data for all of your Google and third-party Cloud
// and API projects
MonitoringScope = "https://www.googleapis.com/auth/monitoring"
// View monitoring data for all of your Google Cloud and third-party projects
MonitoringReadScope = "https://www.googleapis.com/auth/monitoring.read"
// Publish metric data to your Google Cloud projects
MonitoringWriteScope = "https://www.googleapis.com/auth/monitoring.write"
)
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
scopesOption := internaloption.WithDefaultScopes(
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/monitoring",
"https://www.googleapis.com/auth/monitoring.read",
"https://www.googleapis.com/auth/monitoring.write",
)
// NOTE: prepend, so we don't override user-specified scopes.
opts = append([]option.ClientOption{scopesOption}, opts...)
opts = append(opts, internaloption.WithDefaultEndpoint(basePath))
opts = append(opts, internaloption.WithDefaultEndpointTemplate(basePathTemplate))
opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath))
opts = append(opts, internaloption.EnableNewAuthLibrary())
client, endpoint, err := htransport.NewClient(ctx, opts...)
if err != nil {
return nil, err
}
s, err := New(client)
if err != nil {
return nil, err
}
if endpoint != "" {
s.BasePath = endpoint
}
return s, nil
}
// New creates a new Service. It uses the provided http.Client for requests.
//
// Deprecated: please use NewService instead.
// To provide a custom HTTP client, use option.WithHTTPClient.
// If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func New(client *http.Client) (*Service, error) {
if client == nil {
return nil, errors.New("client is nil")
}
s := &Service{client: client, BasePath: basePath}
s.Locations = NewLocationsService(s)
s.Operations = NewOperationsService(s)
s.Projects = NewProjectsService(s)
return s, nil
}
type Service struct {
client *http.Client
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Locations *LocationsService
Operations *OperationsService
Projects *ProjectsService
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewLocationsService(s *Service) *LocationsService {
rs := &LocationsService{s: s}
rs.Global = NewLocationsGlobalService(s)
return rs
}
type LocationsService struct {
s *Service
Global *LocationsGlobalService
}
func NewLocationsGlobalService(s *Service) *LocationsGlobalService {
rs := &LocationsGlobalService{s: s}
rs.MetricsScopes = NewLocationsGlobalMetricsScopesService(s)
return rs
}
type LocationsGlobalService struct {
s *Service
MetricsScopes *LocationsGlobalMetricsScopesService
}
func NewLocationsGlobalMetricsScopesService(s *Service) *LocationsGlobalMetricsScopesService {
rs := &LocationsGlobalMetricsScopesService{s: s}
rs.Projects = NewLocationsGlobalMetricsScopesProjectsService(s)
return rs
}
type LocationsGlobalMetricsScopesService struct {
s *Service
Projects *LocationsGlobalMetricsScopesProjectsService
}
func NewLocationsGlobalMetricsScopesProjectsService(s *Service) *LocationsGlobalMetricsScopesProjectsService {
rs := &LocationsGlobalMetricsScopesProjectsService{s: s}
return rs
}
type LocationsGlobalMetricsScopesProjectsService struct {
s *Service
}
func NewOperationsService(s *Service) *OperationsService {
rs := &OperationsService{s: s}
return rs
}
type OperationsService struct {
s *Service
}
func NewProjectsService(s *Service) *ProjectsService {
rs := &ProjectsService{s: s}
rs.Dashboards = NewProjectsDashboardsService(s)
rs.Location = NewProjectsLocationService(s)
return rs
}
type ProjectsService struct {
s *Service
Dashboards *ProjectsDashboardsService
Location *ProjectsLocationService
}
func NewProjectsDashboardsService(s *Service) *ProjectsDashboardsService {
rs := &ProjectsDashboardsService{s: s}
return rs
}
type ProjectsDashboardsService struct {
s *Service
}
func NewProjectsLocationService(s *Service) *ProjectsLocationService {
rs := &ProjectsLocationService{s: s}
rs.Prometheus = NewProjectsLocationPrometheusService(s)
return rs
}
type ProjectsLocationService struct {
s *Service
Prometheus *ProjectsLocationPrometheusService
}
func NewProjectsLocationPrometheusService(s *Service) *ProjectsLocationPrometheusService {
rs := &ProjectsLocationPrometheusService{s: s}
rs.Api = NewProjectsLocationPrometheusApiService(s)
return rs
}
type ProjectsLocationPrometheusService struct {
s *Service
Api *ProjectsLocationPrometheusApiService
}
func NewProjectsLocationPrometheusApiService(s *Service) *ProjectsLocationPrometheusApiService {
rs := &ProjectsLocationPrometheusApiService{s: s}
rs.V1 = NewProjectsLocationPrometheusApiV1Service(s)
return rs
}
type ProjectsLocationPrometheusApiService struct {
s *Service
V1 *ProjectsLocationPrometheusApiV1Service
}
func NewProjectsLocationPrometheusApiV1Service(s *Service) *ProjectsLocationPrometheusApiV1Service {
rs := &ProjectsLocationPrometheusApiV1Service{s: s}
rs.Label = NewProjectsLocationPrometheusApiV1LabelService(s)
rs.Metadata = NewProjectsLocationPrometheusApiV1MetadataService(s)
return rs
}
type ProjectsLocationPrometheusApiV1Service struct {
s *Service
Label *ProjectsLocationPrometheusApiV1LabelService
Metadata *ProjectsLocationPrometheusApiV1MetadataService
}
func NewProjectsLocationPrometheusApiV1LabelService(s *Service) *ProjectsLocationPrometheusApiV1LabelService {
rs := &ProjectsLocationPrometheusApiV1LabelService{s: s}
return rs
}
type ProjectsLocationPrometheusApiV1LabelService struct {
s *Service
}
func NewProjectsLocationPrometheusApiV1MetadataService(s *Service) *ProjectsLocationPrometheusApiV1MetadataService {
rs := &ProjectsLocationPrometheusApiV1MetadataService{s: s}
return rs
}
type ProjectsLocationPrometheusApiV1MetadataService struct {
s *Service
}
// Aggregation: Describes how to combine multiple time series to provide a
// different view of the data. Aggregation of time series is done in two steps.
// First, each time series in the set is aligned to the same time interval
// boundaries, then the set of time series is optionally reduced in
// number.Alignment consists of applying the per_series_aligner operation to
// each time series after its data has been divided into regular
// alignment_period time intervals. This process takes all of the data points
// in an alignment period, applies a mathematical transformation such as
// averaging, minimum, maximum, delta, etc., and converts them into a single
// data point per period.Reduction is when the aligned and transformed time
// series can optionally be combined, reducing the number of time series
// through similar mathematical transformations. Reduction involves applying a
// cross_series_reducer to all the time series, optionally sorting the time
// series into subsets with group_by_fields, and applying the reducer to each
// subset.The raw time series data can contain a huge amount of information
// from multiple sources. Alignment and reduction transforms this mass of data
// into a more manageable and representative collection of data, for example
// "the 95% latency across the average of all tasks in a cluster". This
// representative data can be more easily graphed and comprehended, and the
// individual time series data is still available for later drilldown. For more
// details, see Filtering and aggregation
// (https://cloud.google.com/monitoring/api/v3/aggregation).
type Aggregation struct {
// AlignmentPeriod: The alignment_period specifies a time interval, in seconds,
// that is used to divide the data in all the time series into consistent
// blocks of time. This will be done before the per-series aligner can be
// applied to the data.The value must be at least 60 seconds. If a per-series
// aligner other than ALIGN_NONE is specified, this field is required or an
// error is returned. If no per-series aligner is specified, or the aligner
// ALIGN_NONE is specified, then this field is ignored.The maximum value of the
// alignment_period is 2 years, or 104 weeks.
AlignmentPeriod string `json:"alignmentPeriod,omitempty"`
// CrossSeriesReducer: The reduction operation to be used to combine time
// series into a single time series, where the value of each data point in the
// resulting series is a function of all the already aligned values in the
// input time series.Not all reducer operations can be applied to all time
// series. The valid choices depend on the metric_kind and the value_type of
// the original time series. Reduction can yield a time series with a different
// metric_kind or value_type than the input time series.Time series data must
// first be aligned (see per_series_aligner) in order to perform cross-time
// series reduction. If cross_series_reducer is specified, then
// per_series_aligner must be specified, and must not be ALIGN_NONE. An
// alignment_period must also be specified; otherwise, an error is returned.
//
// Possible values:
// "REDUCE_NONE" - No cross-time series reduction. The output of the Aligner
// is returned.
// "REDUCE_MEAN" - Reduce by computing the mean value across time series for
// each alignment period. This reducer is valid for DELTA and GAUGE metrics
// with numeric or distribution values. The value_type of the output is DOUBLE.
// "REDUCE_MIN" - Reduce by computing the minimum value across time series
// for each alignment period. This reducer is valid for DELTA and GAUGE metrics
// with numeric values. The value_type of the output is the same as the
// value_type of the input.
// "REDUCE_MAX" - Reduce by computing the maximum value across time series
// for each alignment period. This reducer is valid for DELTA and GAUGE metrics
// with numeric values. The value_type of the output is the same as the
// value_type of the input.
// "REDUCE_SUM" - Reduce by computing the sum across time series for each
// alignment period. This reducer is valid for DELTA and GAUGE metrics with
// numeric and distribution values. The value_type of the output is the same as
// the value_type of the input.
// "REDUCE_STDDEV" - Reduce by computing the standard deviation across time
// series for each alignment period. This reducer is valid for DELTA and GAUGE
// metrics with numeric or distribution values. The value_type of the output is
// DOUBLE.
// "REDUCE_COUNT" - Reduce by computing the number of data points across time
// series for each alignment period. This reducer is valid for DELTA and GAUGE
// metrics of numeric, Boolean, distribution, and string value_type. The
// value_type of the output is INT64.
// "REDUCE_COUNT_TRUE" - Reduce by computing the number of True-valued data
// points across time series for each alignment period. This reducer is valid
// for DELTA and GAUGE metrics of Boolean value_type. The value_type of the
// output is INT64.
// "REDUCE_COUNT_FALSE" - Reduce by computing the number of False-valued data
// points across time series for each alignment period. This reducer is valid
// for DELTA and GAUGE metrics of Boolean value_type. The value_type of the
// output is INT64.
// "REDUCE_FRACTION_TRUE" - Reduce by computing the ratio of the number of
// True-valued data points to the total number of data points for each
// alignment period. This reducer is valid for DELTA and GAUGE metrics of
// Boolean value_type. The output value is in the range 0.0, 1.0 and has
// value_type DOUBLE.
// "REDUCE_PERCENTILE_99" - Reduce by computing the 99th percentile
// (https://en.wikipedia.org/wiki/Percentile) of data points across time series
// for each alignment period. This reducer is valid for GAUGE and DELTA metrics
// of numeric and distribution type. The value of the output is DOUBLE.
// "REDUCE_PERCENTILE_95" - Reduce by computing the 95th percentile
// (https://en.wikipedia.org/wiki/Percentile) of data points across time series
// for each alignment period. This reducer is valid for GAUGE and DELTA metrics
// of numeric and distribution type. The value of the output is DOUBLE.
// "REDUCE_PERCENTILE_50" - Reduce by computing the 50th percentile
// (https://en.wikipedia.org/wiki/Percentile) of data points across time series
// for each alignment period. This reducer is valid for GAUGE and DELTA metrics
// of numeric and distribution type. The value of the output is DOUBLE.
// "REDUCE_PERCENTILE_05" - Reduce by computing the 5th percentile
// (https://en.wikipedia.org/wiki/Percentile) of data points across time series
// for each alignment period. This reducer is valid for GAUGE and DELTA metrics
// of numeric and distribution type. The value of the output is DOUBLE.
CrossSeriesReducer string `json:"crossSeriesReducer,omitempty"`
// GroupByFields: The set of fields to preserve when cross_series_reducer is
// specified. The group_by_fields determine how the time series are partitioned
// into subsets prior to applying the aggregation operation. Each subset
// contains time series that have the same value for each of the grouping
// fields. Each individual time series is a member of exactly one subset. The
// cross_series_reducer is applied to each subset of time series. It is not
// possible to reduce across different resource types, so this field implicitly
// contains resource.type. Fields not specified in group_by_fields are
// aggregated away. If group_by_fields is not specified and all the time series
// have the same resource type, then the time series are aggregated into a
// single output time series. If cross_series_reducer is not defined, this
// field is ignored.
GroupByFields []string `json:"groupByFields,omitempty"`
// PerSeriesAligner: An Aligner describes how to bring the data points in a
// single time series into temporal alignment. Except for ALIGN_NONE, all
// alignments cause all the data points in an alignment_period to be
// mathematically grouped together, resulting in a single data point for each
// alignment_period with end timestamp at the end of the period.Not all
// alignment operations may be applied to all time series. The valid choices
// depend on the metric_kind and value_type of the original time series.
// Alignment can change the metric_kind or the value_type of the time
// series.Time series data must be aligned in order to perform cross-time
// series reduction. If cross_series_reducer is specified, then
// per_series_aligner must be specified and not equal to ALIGN_NONE and
// alignment_period must be specified; otherwise, an error is returned.
//
// Possible values:
// "ALIGN_NONE" - No alignment. Raw data is returned. Not valid if
// cross-series reduction is requested. The value_type of the result is the
// same as the value_type of the input.
// "ALIGN_DELTA" - Align and convert to DELTA. The output is delta = y1 -
// y0.This alignment is valid for CUMULATIVE and DELTA metrics. If the selected
// alignment period results in periods with no data, then the aligned value for
// such a period is created by interpolation. The value_type of the aligned
// result is the same as the value_type of the input.
// "ALIGN_RATE" - Align and convert to a rate. The result is computed as rate
// = (y1 - y0)/(t1 - t0), or "delta over time". Think of this aligner as
// providing the slope of the line that passes through the value at the start
// and at the end of the alignment_period.This aligner is valid for CUMULATIVE
// and DELTA metrics with numeric values. If the selected alignment period
// results in periods with no data, then the aligned value for such a period is
// created by interpolation. The output is a GAUGE metric with value_type
// DOUBLE.If, by "rate", you mean "percentage change", see the
// ALIGN_PERCENT_CHANGE aligner instead.
// "ALIGN_INTERPOLATE" - Align by interpolating between adjacent points
// around the alignment period boundary. This aligner is valid for GAUGE
// metrics with numeric values. The value_type of the aligned result is the
// same as the value_type of the input.
// "ALIGN_NEXT_OLDER" - Align by moving the most recent data point before the
// end of the alignment period to the boundary at the end of the alignment
// period. This aligner is valid for GAUGE metrics. The value_type of the
// aligned result is the same as the value_type of the input.
// "ALIGN_MIN" - Align the time series by returning the minimum value in each
// alignment period. This aligner is valid for GAUGE and DELTA metrics with
// numeric values. The value_type of the aligned result is the same as the
// value_type of the input.
// "ALIGN_MAX" - Align the time series by returning the maximum value in each
// alignment period. This aligner is valid for GAUGE and DELTA metrics with
// numeric values. The value_type of the aligned result is the same as the
// value_type of the input.
// "ALIGN_MEAN" - Align the time series by returning the mean value in each
// alignment period. This aligner is valid for GAUGE and DELTA metrics with
// numeric values. The value_type of the aligned result is DOUBLE.
// "ALIGN_COUNT" - Align the time series by returning the number of values in
// each alignment period. This aligner is valid for GAUGE and DELTA metrics
// with numeric or Boolean values. The value_type of the aligned result is
// INT64.
// "ALIGN_SUM" - Align the time series by returning the sum of the values in
// each alignment period. This aligner is valid for GAUGE and DELTA metrics
// with numeric and distribution values. The value_type of the aligned result
// is the same as the value_type of the input.
// "ALIGN_STDDEV" - Align the time series by returning the standard deviation
// of the values in each alignment period. This aligner is valid for GAUGE and
// DELTA metrics with numeric values. The value_type of the output is DOUBLE.
// "ALIGN_COUNT_TRUE" - Align the time series by returning the number of True
// values in each alignment period. This aligner is valid for GAUGE metrics
// with Boolean values. The value_type of the output is INT64.
// "ALIGN_COUNT_FALSE" - Align the time series by returning the number of
// False values in each alignment period. This aligner is valid for GAUGE
// metrics with Boolean values. The value_type of the output is INT64.
// "ALIGN_FRACTION_TRUE" - Align the time series by returning the ratio of
// the number of True values to the total number of values in each alignment
// period. This aligner is valid for GAUGE metrics with Boolean values. The
// output value is in the range 0.0, 1.0 and has value_type DOUBLE.
// "ALIGN_PERCENTILE_99" - Align the time series by using percentile
// aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data
// point in each alignment period is the 99th percentile of all data points in
// the period. This aligner is valid for GAUGE and DELTA metrics with
// distribution values. The output is a GAUGE metric with value_type DOUBLE.
// "ALIGN_PERCENTILE_95" - Align the time series by using percentile
// aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data
// point in each alignment period is the 95th percentile of all data points in
// the period. This aligner is valid for GAUGE and DELTA metrics with
// distribution values. The output is a GAUGE metric with value_type DOUBLE.
// "ALIGN_PERCENTILE_50" - Align the time series by using percentile
// aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data
// point in each alignment period is the 50th percentile of all data points in
// the period. This aligner is valid for GAUGE and DELTA metrics with
// distribution values. The output is a GAUGE metric with value_type DOUBLE.
// "ALIGN_PERCENTILE_05" - Align the time series by using percentile
// aggregation (https://en.wikipedia.org/wiki/Percentile). The resulting data
// point in each alignment period is the 5th percentile of all data points in
// the period. This aligner is valid for GAUGE and DELTA metrics with
// distribution values. The output is a GAUGE metric with value_type DOUBLE.
// "ALIGN_PERCENT_CHANGE" - Align and convert to a percentage change. This
// aligner is valid for GAUGE and DELTA metrics with numeric values. This
// alignment returns ((current - previous)/previous) * 100, where the value of
// previous is determined based on the alignment_period.If the values of
// current and previous are both 0, then the returned value is 0. If only
// previous is 0, the returned value is infinity.A 10-minute moving mean is
// computed at each point of the alignment period prior to the above
// calculation to smooth the metric and prevent false positives from very
// short-lived spikes. The moving mean is only applicable for data whose values
// are >= 0. Any values < 0 are treated as a missing datapoint, and are
// ignored. While DELTA metrics are accepted by this alignment, special care
// should be taken that the values for the metric will always be positive. The
// output is a GAUGE metric with value_type DOUBLE.
PerSeriesAligner string `json:"perSeriesAligner,omitempty"`
// ForceSendFields is a list of field names (e.g. "AlignmentPeriod") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AlignmentPeriod") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s Aggregation) MarshalJSON() ([]byte, error) {
type NoMethod Aggregation
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// AggregationFunction: Preview: An identifier for an aggregation function.
// Aggregation functions are SQL functions that group or transform data from
// multiple points to a single point. This is a preview feature and may be
// subject to change before final release.
type AggregationFunction struct {
// Parameters: Optional. Parameters applied to the aggregation function. Only
// used for functions that require them.
Parameters []*Parameter `json:"parameters,omitempty"`
// Type: Required. The type of aggregation function, must be one of the
// following: "none" - no function. "percentile" - APPROX_QUANTILES() - 1
// parameter numeric value "average" - AVG() "count" - COUNT() "count-distinct"
// - COUNT(DISTINCT) "count-distinct-approx" - APPROX_COUNT_DISTINCT() "max" -
// MAX() "min" - MIN() "sum" - SUM()
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "Parameters") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Parameters") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s AggregationFunction) MarshalJSON() ([]byte, error) {
type NoMethod AggregationFunction
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// AlertChart: A chart that displays alert policy data.
type AlertChart struct {
// Name: Required. The resource name of the alert policy. The format is:
// projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
Name string `json:"name,omitempty"`
// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Name") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s AlertChart) MarshalJSON() ([]byte, error) {
type NoMethod AlertChart
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// Axis: A chart axis.
type Axis struct {
// Label: The label of the axis.
Label string `json:"label,omitempty"`
// Scale: The axis scale. By default, a linear scale is used.
//
// Possible values:
// "SCALE_UNSPECIFIED" - Scale is unspecified. The view will default to
// LINEAR.
// "LINEAR" - Linear scale.
// "LOG10" - Logarithmic scale (base 10).
Scale string `json:"scale,omitempty"`
// ForceSendFields is a list of field names (e.g. "Label") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Label") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s Axis) MarshalJSON() ([]byte, error) {
type NoMethod Axis
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// Breakdown: Preview: A breakdown is an aggregation applied to the measures
// over a specified column. A breakdown can result in multiple series across a
// category for the provided measure. This is a preview feature and may be
// subject to change before final release.
type Breakdown struct {
// AggregationFunction: Required. The Aggregation function is applied across
// all data in each breakdown created.
AggregationFunction *AggregationFunction `json:"aggregationFunction,omitempty"`
// Column: Required. The name of the column in the dataset containing the
// breakdown values.
Column string `json:"column,omitempty"`
// Limit: Required. A limit to the number of breakdowns. If set to zero then
// all possible breakdowns are applied. The list of breakdowns is dependent on
// the value of the sort_order field.
Limit int64 `json:"limit,omitempty"`
// SortOrder: Required. The sort order is applied to the values of the
// breakdown column.
//
// Possible values:
// "SORT_ORDER_UNSPECIFIED" - An unspecified sort order. This option is
// invalid when sorting is required.
// "SORT_ORDER_NONE" - No sorting is applied.
// "SORT_ORDER_ASCENDING" - The lowest-valued entries are selected first.
// "SORT_ORDER_DESCENDING" - The highest-valued entries are selected first.
SortOrder string `json:"sortOrder,omitempty"`
// ForceSendFields is a list of field names (e.g. "AggregationFunction") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AggregationFunction") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s Breakdown) MarshalJSON() ([]byte, error) {
type NoMethod Breakdown
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// ChartOptions: Options to control visual rendering of a chart.
type ChartOptions struct {
// DisplayHorizontal: Preview: Configures whether the charted values are shown
// on the horizontal or vertical axis. By default, values are represented the
// vertical axis. This is a preview feature and may be subject to change before
// final release.
DisplayHorizontal bool `json:"displayHorizontal,omitempty"`
// Mode: The chart mode.
//
// Possible values:
// "MODE_UNSPECIFIED" - Mode is unspecified. The view will default to COLOR.
// "COLOR" - The chart distinguishes data series using different color. Line
// colors may get reused when there are many lines in the chart.
// "X_RAY" - The chart uses the Stackdriver x-ray mode, in which each data
// set is plotted using the same semi-transparent color.
// "STATS" - The chart displays statistics such as average, median, 95th
// percentile, and more.
Mode string `json:"mode,omitempty"`
// ForceSendFields is a list of field names (e.g. "DisplayHorizontal") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DisplayHorizontal") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s ChartOptions) MarshalJSON() ([]byte, error) {
type NoMethod ChartOptions
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// CollapsibleGroup: A widget that groups the other widgets. All widgets that
// are within the area spanned by the grouping widget are considered member
// widgets.
type CollapsibleGroup struct {
// Collapsed: The collapsed state of the widget on first page load.
Collapsed bool `json:"collapsed,omitempty"`
// ForceSendFields is a list of field names (e.g. "Collapsed") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Collapsed") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s CollapsibleGroup) MarshalJSON() ([]byte, error) {
type NoMethod CollapsibleGroup
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// Column: Defines the layout properties and content for a column.
type Column struct {
// Weight: The relative weight of this column. The column weight is used to
// adjust the width of columns on the screen (relative to peers). Greater the
// weight, greater the width of the column on the screen. If omitted, a value
// of 1 is used while rendering.
Weight int64 `json:"weight,omitempty,string"`
// Widgets: The display widgets arranged vertically in this column.
Widgets []*Widget `json:"widgets,omitempty"`
// ForceSendFields is a list of field names (e.g. "Weight") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Weight") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s Column) MarshalJSON() ([]byte, error) {
type NoMethod Column
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// ColumnLayout: A simplified layout that divides the available space into
// vertical columns and arranges a set of widgets vertically in each column.
type ColumnLayout struct {
// Columns: The columns of content to display.
Columns []*Column `json:"columns,omitempty"`
// ForceSendFields is a list of field names (e.g. "Columns") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Columns") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s ColumnLayout) MarshalJSON() ([]byte, error) {
type NoMethod ColumnLayout
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// ColumnSettings: The persistent settings for a table's columns.
type ColumnSettings struct {
// Alignment: Optional. Whether the column should be left / middle / right
// aligned
//
// Possible values:
// "CELL_ALIGNMENT_UNSPECIFIED" - No horizontal alignment specified; fall
// back to the default behavior. Label values are left aligned. Numeric values
// are right aligned.
// "LEFT" - Left-align
// "CENTER" - Center-align
// "RIGHT" - Right-align
Alignment string `json:"alignment,omitempty"`
// Column: Required. The id of the column.
Column string `json:"column,omitempty"`
// DisplayName: Optional. Display name of the column
DisplayName string `json:"displayName,omitempty"`
// Thresholds: Optional. The thresholds used to determine how the table cell
// should be rendered given the time series' current value.
Thresholds []*Threshold `json:"thresholds,omitempty"`
// Visible: Required. Whether the column should be visible on page load.
Visible bool `json:"visible,omitempty"`
// ForceSendFields is a list of field names (e.g. "Alignment") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Alignment") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s ColumnSettings) MarshalJSON() ([]byte, error) {
type NoMethod ColumnSettings
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// Dashboard: A Google Stackdriver dashboard. Dashboards define the content and
// layout of pages in the Stackdriver web application.
type Dashboard struct {
// Annotations: Configuration for event annotations to display on this
// dashboard.
Annotations *DashboardAnnotations `json:"annotations,omitempty"`
// ColumnLayout: The content is divided into equally spaced columns and the
// widgets are arranged vertically.
ColumnLayout *ColumnLayout `json:"columnLayout,omitempty"`
// DashboardFilters: Filters to reduce the amount of data charted based on the
// filter criteria.
DashboardFilters []*DashboardFilter `json:"dashboardFilters,omitempty"`
// DisplayName: Required. The mutable, human-readable name.
DisplayName string `json:"displayName,omitempty"`
// Etag: etag is used for optimistic concurrency control as a way to help
// prevent simultaneous updates of a policy from overwriting each other. An
// etag is returned in the response to GetDashboard, and users are expected to
// put that etag in the request to UpdateDashboard to ensure that their change
// will be applied to the same version of the Dashboard configuration. The
// field should not be passed during dashboard creation.
Etag string `json:"etag,omitempty"`
// GridLayout: Content is arranged with a basic layout that re-flows a simple
// list of informational elements like widgets or tiles.
GridLayout *GridLayout `json:"gridLayout,omitempty"`
// Labels: Labels applied to the dashboard
Labels map[string]string `json:"labels,omitempty"`
// MosaicLayout: The content is arranged as a grid of tiles, with each content
// widget occupying one or more grid blocks.
MosaicLayout *MosaicLayout `json:"mosaicLayout,omitempty"`
// Name: Identifier. The resource name of the dashboard.
Name string `json:"name,omitempty"`
// RowLayout: The content is divided into equally spaced rows and the widgets
// are arranged horizontally.
RowLayout *RowLayout `json:"rowLayout,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Annotations") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Annotations") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s Dashboard) MarshalJSON() ([]byte, error) {
type NoMethod Dashboard
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// DashboardAnnotations: Dashboard-level configuration for annotations
type DashboardAnnotations struct {
// DefaultResourceNames: Dashboard level defaults for names of logging
// resources to search for events. Currently only projects are supported. Each
// individual EventAnnotation may have its own overrides. If both this field
// and the per annotation field is empty, then the scoping project is used.
// Limit: 50 projects. For example: “projects/some-project-id”
DefaultResourceNames []string `json:"defaultResourceNames,omitempty"`
// EventAnnotations: List of annotation configurations for this dashboard. Each
// entry specifies one event type.
EventAnnotations []*EventAnnotation `json:"eventAnnotations,omitempty"`
// ForceSendFields is a list of field names (e.g. "DefaultResourceNames") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DefaultResourceNames") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s DashboardAnnotations) MarshalJSON() ([]byte, error) {
type NoMethod DashboardAnnotations
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// DashboardFilter: A filter to reduce the amount of data charted in relevant
// widgets.
type DashboardFilter struct {
// FilterType: The specified filter type
//
// Possible values:
// "FILTER_TYPE_UNSPECIFIED" - Filter type is unspecified. This is not valid
// in a well-formed request.
// "RESOURCE_LABEL" - Filter on a resource label value
// "METRIC_LABEL" - Filter on a metrics label value
// "USER_METADATA_LABEL" - Filter on a user metadata label value
// "SYSTEM_METADATA_LABEL" - Filter on a system metadata label value
// "GROUP" - Filter on a group id
// "VALUE_ONLY" - Filter that only contains a value. The label_key field must
// be unset for filters of this type.
FilterType string `json:"filterType,omitempty"`
// LabelKey: Optional. The key for the label. This must be omitted if the
// filter_type is VALUE_ONLY but is required otherwise.
LabelKey string `json:"labelKey,omitempty"`
// StringArray: A list of possible string values for the filter
StringArray *StringArray `json:"stringArray,omitempty"`
// StringArrayValue: An array of variable-length string values. If this field
// is set, value_type must be set to STRING_ARRAY or VALUE_TYPE_UNSPECIFIED
StringArrayValue *StringArray `json:"stringArrayValue,omitempty"`
// StringValue: A variable-length string value. If this field is set,
// value_type must be set to STRING or VALUE_TYPE_UNSPECIFIED
StringValue string `json:"stringValue,omitempty"`
// TemplateVariable: The placeholder text that can be referenced in a filter
// string or MQL query. If omitted, the dashboard filter will be applied to all
// relevant widgets in the dashboard.
TemplateVariable string `json:"templateVariable,omitempty"`
// TimeSeriesQuery: A query to run to fetch possible values for the filter.
// Only OpsAnalyticsQueries are supported
TimeSeriesQuery *TimeSeriesQuery `json:"timeSeriesQuery,omitempty"`
// ValueType: The type of the filter value. If value_type is not provided, it
// will be inferred from the default_value. If neither value_type nor
// default_value is provided, value_type will be set to STRING by default.
//
// Possible values:
// "VALUE_TYPE_UNSPECIFIED" - Value type is unspecified
// "STRING" - String type
// "STRING_ARRAY" - String array type
ValueType string `json:"valueType,omitempty"`
// ForceSendFields is a list of field names (e.g. "FilterType") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "FilterType") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s DashboardFilter) MarshalJSON() ([]byte, error) {
type NoMethod DashboardFilter
return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields)
}
// DataSet: Groups a time series query definition with charting options.
type DataSet struct {
// Breakdowns: Optional. The collection of breakdowns to be applied to the
// dataset.
Breakdowns []*Breakdown `json:"breakdowns,omitempty"`
// Dimensions: Optional. A collection of dimension columns.
Dimensions []*Dimension `json:"dimensions,omitempty"`
// LegendTemplate: A template string for naming TimeSeries in the resulting
// data set. This should be a string with interpolations of the form
// ${label_name}, which will resolve to the label's value.
LegendTemplate string `json:"legendTemplate,omitempty"`
// Measures: Optional. A collection of measures.
Measures []*Measure `json:"measures,omitempty"`
// MinAlignmentPeriod: Optional. The lower bound on data point frequency for