v1.d.ts
51.7 KB
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace monitoring_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Cloud Monitoring API
*
* Manages your Cloud Monitoring data and configurations. Most projects must be associated with a Workspace, with a few exceptions as noted on the individual method pages. The table entries below are presented in alphabetical order, not in order of common use. For explanations of the concepts found in the table entries, read the Cloud Monitoring documentation.
*
* @example
* ```js
* const {google} = require('googleapis');
* const monitoring = google.monitoring('v1');
* ```
*/
export class Monitoring {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* 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).
*/
export interface Schema$Aggregation {
/**
* 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 | null;
/**
* 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.
*/
crossSeriesReducer?: string | null;
/**
* 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[] | null;
/**
* 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.
*/
perSeriesAligner?: string | null;
}
/**
* A chart axis.
*/
export interface Schema$Axis {
/**
* The label of the axis.
*/
label?: string | null;
/**
* The axis scale. By default, a linear scale is used.
*/
scale?: string | null;
}
/**
* Options to control visual rendering of a chart.
*/
export interface Schema$ChartOptions {
/**
* The chart mode.
*/
mode?: string | null;
}
/**
* Defines the layout properties and content for a column.
*/
export interface Schema$Column {
/**
* 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?: string | null;
/**
* The display widgets arranged vertically in this column.
*/
widgets?: Schema$Widget[];
}
/**
* A simplified layout that divides the available space into vertical columns and arranges a set of widgets vertically in each column.
*/
export interface Schema$ColumnLayout {
/**
* The columns of content to display.
*/
columns?: Schema$Column[];
}
/**
* A Google Stackdriver dashboard. Dashboards define the content and layout of pages in the Stackdriver web application.
*/
export interface Schema$Dashboard {
/**
* The content is divided into equally spaced columns and the widgets are arranged vertically.
*/
columnLayout?: Schema$ColumnLayout;
/**
* Required. The mutable, human-readable name.
*/
displayName?: string | null;
/**
* 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 | null;
/**
* Content is arranged with a basic layout that re-flows a simple list of informational elements like widgets or tiles.
*/
gridLayout?: Schema$GridLayout;
/**
* The content is arranged as a grid of tiles, with each content widget occupying one or more grid blocks.
*/
mosaicLayout?: Schema$MosaicLayout;
/**
* Immutable. The resource name of the dashboard.
*/
name?: string | null;
/**
* The content is divided into equally spaced rows and the widgets are arranged horizontally.
*/
rowLayout?: Schema$RowLayout;
}
/**
* Groups a time series query definition with charting options.
*/
export interface Schema$DataSet {
/**
* 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 | null;
/**
* Optional. The lower bound on data point frequency for this data set, implemented by specifying the minimum alignment period to use in a time series query For example, if the data is published once every 10 minutes, the min_alignment_period should be at least 10 minutes. It would not make sense to fetch and align data at one minute intervals.
*/
minAlignmentPeriod?: string | null;
/**
* How this data should be plotted on the chart.
*/
plotType?: string | null;
/**
* Required. Fields for querying time series data from the Stackdriver metrics API.
*/
timeSeriesQuery?: Schema$TimeSeriesQuery;
}
/**
* A set of (label, value) pairs that were removed from a Distribution time series during aggregation and then added as an attachment to a Distribution.Exemplar.The full label set for the exemplars is constructed by using the dropped pairs in combination with the label values that remain on the aggregated Distribution time series. The constructed full label set can be used to identify the specific entity, such as the instance or job, which might be contributing to a long-tail. However, with dropped labels, the storage requirements are reduced because only the aggregated distribution values for a large group of time series are stored.Note that there are no guarantees on ordering of the labels from exemplar-to-exemplar and from distribution-to-distribution in the same stream, and there may be duplicates. It is up to clients to resolve any ambiguities.
*/
export interface Schema$DroppedLabels {
/**
* Map from label to its value, for all labels dropped in any aggregation.
*/
label?: {
[key: string]: string;
} | null;
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \} The JSON representation for Empty is empty JSON object {\}.
*/
export interface Schema$Empty {
}
/**
* A single field of a message type.
*/
export interface Schema$Field {
/**
* The field cardinality.
*/
cardinality?: string | null;
/**
* The string value of the default value of this field. Proto2 syntax only.
*/
defaultValue?: string | null;
/**
* The field JSON name.
*/
jsonName?: string | null;
/**
* The field type.
*/
kind?: string | null;
/**
* The field name.
*/
name?: string | null;
/**
* The field number.
*/
number?: number | null;
/**
* The index of the field type in Type.oneofs, for message or enumeration types. The first type has index 1; zero means the type is not in the list.
*/
oneofIndex?: number | null;
/**
* The protocol buffer options.
*/
options?: Schema$Option[];
/**
* Whether to use alternative packed wire representation.
*/
packed?: boolean | null;
/**
* The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp".
*/
typeUrl?: string | null;
}
/**
* A gauge chart shows where the current value sits within a pre-defined range. The upper and lower bounds should define the possible range of values for the scorecard's query (inclusive).
*/
export interface Schema$GaugeView {
/**
* The lower bound for this gauge chart. The value of the chart should always be greater than or equal to this.
*/
lowerBound?: number | null;
/**
* The upper bound for this gauge chart. The value of the chart should always be less than or equal to this.
*/
upperBound?: number | null;
}
/**
* A basic layout divides the available space into vertical columns of equal width and arranges a list of widgets using a row-first strategy.
*/
export interface Schema$GridLayout {
/**
* The number of columns into which the view's width is divided. If omitted or set to zero, a system default will be used while rendering.
*/
columns?: string | null;
/**
* The informational elements that are arranged into the columns row-first.
*/
widgets?: Schema$Widget[];
}
/**
* The ListDashboards request.
*/
export interface Schema$ListDashboardsResponse {
/**
* The list of requested dashboards.
*/
dashboards?: Schema$Dashboard[];
/**
* If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as page_token in the next call to this method.
*/
nextPageToken?: string | null;
}
/**
* A mosaic layout divides the available space into a grid of blocks, and overlays the grid with tiles. Unlike GridLayout, tiles may span multiple grid blocks and can be placed at arbitrary locations in the grid.
*/
export interface Schema$MosaicLayout {
/**
* The number of columns in the mosaic grid. The number of columns must be between 1 and 12, inclusive.
*/
columns?: number | null;
/**
* The tiles to display.
*/
tiles?: Schema$Tile[];
}
/**
* A protocol buffer option, which can be attached to a message, field, enumeration, etc.
*/
export interface Schema$Option {
/**
* The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, "map_entry". For custom options, it should be the fully-qualified name. For example, "google.api.http".
*/
name?: string | null;
/**
* The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.
*/
value?: {
[key: string]: any;
} | null;
}
/**
* Describes a ranking-based time series filter. Each input time series is ranked with an aligner. The filter will allow up to num_time_series time series to pass through it, selecting them based on the relative ranking.For example, if ranking_method is METHOD_MEAN,direction is BOTTOM, and num_time_series is 3, then the 3 times series with the lowest mean values will pass through the filter.
*/
export interface Schema$PickTimeSeriesFilter {
/**
* How to use the ranking to select time series that pass through the filter.
*/
direction?: string | null;
/**
* How many time series to allow to pass through the filter.
*/
numTimeSeries?: number | null;
/**
* ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series.
*/
rankingMethod?: string | null;
}
/**
* Describes a query to build the numerator or denominator of a TimeSeriesFilterRatio.
*/
export interface Schema$RatioPart {
/**
* By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data.
*/
aggregation?: Schema$Aggregation;
/**
* Required. The monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies the metric types, resources, and projects to query.
*/
filter?: string | null;
}
/**
* Defines the layout properties and content for a row.
*/
export interface Schema$Row {
/**
* The relative weight of this row. The row weight is used to adjust the height of rows on the screen (relative to peers). Greater the weight, greater the height of the row on the screen. If omitted, a value of 1 is used while rendering.
*/
weight?: string | null;
/**
* The display widgets arranged horizontally in this row.
*/
widgets?: Schema$Widget[];
}
/**
* A simplified layout that divides the available space into rows and arranges a set of widgets horizontally in each row.
*/
export interface Schema$RowLayout {
/**
* The rows of content to display.
*/
rows?: Schema$Row[];
}
/**
* A widget showing the latest value of a metric, and how this value relates to one or more thresholds.
*/
export interface Schema$Scorecard {
/**
* Will cause the scorecard to show a gauge chart.
*/
gaugeView?: Schema$GaugeView;
/**
* Will cause the scorecard to show a spark chart.
*/
sparkChartView?: Schema$SparkChartView;
/**
* The thresholds used to determine the state of the scorecard given the time series' current value. For an actual value x, the scorecard is in a danger state if x is less than or equal to a danger threshold that triggers below, or greater than or equal to a danger threshold that triggers above. Similarly, if x is above/below a warning threshold that triggers above/below, then the scorecard is in a warning state - unless x also puts it in a danger state. (Danger trumps warning.)As an example, consider a scorecard with the following four thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', \}, { value: 70, category: 'WARNING', trigger: 'ABOVE', \}, { value: 10, category: 'DANGER', trigger: 'BELOW', \}, { value: 20, category: 'WARNING', trigger: 'BELOW', \}Then: values less than or equal to 10 would put the scorecard in a DANGER state, values greater than 10 but less than or equal to 20 a WARNING state, values strictly between 20 and 70 an OK state, values greater than or equal to 70 but less than 90 a WARNING state, and values greater than or equal to 90 a DANGER state.
*/
thresholds?: Schema$Threshold[];
/**
* Required. Fields for querying time series data from the Stackdriver metrics API.
*/
timeSeriesQuery?: Schema$TimeSeriesQuery;
}
/**
* SourceContext represents information about the source of a protobuf element, like the file in which it is defined.
*/
export interface Schema$SourceContext {
/**
* The path-qualified name of the .proto file that contained the associated protobuf element. For example: "google/protobuf/source_context.proto".
*/
fileName?: string | null;
}
/**
* The context of a span. This is attached to an Exemplar in Distribution values during aggregation.It contains the name of a span with format: projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID]
*/
export interface Schema$SpanContext {
/**
* The resource name of the span. The format is: projects/[PROJECT_ID_OR_NUMBER]/traces/[TRACE_ID]/spans/[SPAN_ID] [TRACE_ID] is a unique identifier for a trace within a project; it is a 32-character hexadecimal encoding of a 16-byte array.[SPAN_ID] is a unique identifier for a span within a trace; it is a 16-character hexadecimal encoding of an 8-byte array.
*/
spanName?: string | null;
}
/**
* A sparkChart is a small chart suitable for inclusion in a table-cell or inline in text. This message contains the configuration for a sparkChart to show up on a Scorecard, showing recent trends of the scorecard's timeseries.
*/
export interface Schema$SparkChartView {
/**
* The lower bound on data point frequency in the chart implemented by specifying the minimum alignment period to use in a time series query. For example, if the data is published once every 10 minutes it would not make sense to fetch and align data at one minute intervals. This field is optional and exists only as a hint.
*/
minAlignmentPeriod?: string | null;
/**
* Required. The type of sparkchart to show in this chartView.
*/
sparkChartType?: string | null;
}
/**
* A filter that ranks streams based on their statistical relation to other streams in a request. Note: This field is deprecated and completely ignored by the API.
*/
export interface Schema$StatisticalTimeSeriesFilter {
/**
* How many time series to output.
*/
numTimeSeries?: number | null;
/**
* rankingMethod is applied to a set of time series, and then the produced value for each individual time series is used to compare a given time series to others. These are methods that cannot be applied stream-by-stream, but rather require the full context of a request to evaluate time series.
*/
rankingMethod?: string | null;
}
/**
* A widget that displays textual content.
*/
export interface Schema$Text {
/**
* The text content to be displayed.
*/
content?: string | null;
/**
* How the text content is formatted.
*/
format?: string | null;
}
/**
* Defines a threshold for categorizing time series values.
*/
export interface Schema$Threshold {
/**
* The state color for this threshold. Color is not allowed in a XyChart.
*/
color?: string | null;
/**
* The direction for the current threshold. Direction is not allowed in a XyChart.
*/
direction?: string | null;
/**
* A label for the threshold.
*/
label?: string | null;
/**
* The value of the threshold. The value should be defined in the native scale of the metric.
*/
value?: number | null;
}
/**
* A single tile in the mosaic. The placement and size of the tile are configurable.
*/
export interface Schema$Tile {
/**
* The height of the tile, measured in grid blocks. Tiles must have a minimum height of 1.
*/
height?: number | null;
/**
* The informational widget contained in the tile. For example an XyChart.
*/
widget?: Schema$Widget;
/**
* The width of the tile, measured in grid blocks. Tiles must have a minimum width of 1.
*/
width?: number | null;
/**
* The zero-indexed position of the tile in grid blocks relative to the left edge of the grid. Tiles must be contained within the specified number of columns. x_pos cannot be negative.
*/
xPos?: number | null;
/**
* The zero-indexed position of the tile in grid blocks relative to the top edge of the grid. y_pos cannot be negative.
*/
yPos?: number | null;
}
/**
* A filter that defines a subset of time series data that is displayed in a widget. Time series data is fetched using the ListTimeSeries (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) method.
*/
export interface Schema$TimeSeriesFilter {
/**
* By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data.
*/
aggregation?: Schema$Aggregation;
/**
* Required. The monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies the metric types, resources, and projects to query.
*/
filter?: string | null;
/**
* Ranking based time series filter.
*/
pickTimeSeriesFilter?: Schema$PickTimeSeriesFilter;
/**
* Apply a second aggregation after aggregation is applied.
*/
secondaryAggregation?: Schema$Aggregation;
/**
* Statistics based time series filter. Note: This field is deprecated and completely ignored by the API.
*/
statisticalTimeSeriesFilter?: Schema$StatisticalTimeSeriesFilter;
}
/**
* A pair of time series filters that define a ratio computation. The output time series is the pair-wise division of each aligned element from the numerator and denominator time series.
*/
export interface Schema$TimeSeriesFilterRatio {
/**
* The denominator of the ratio.
*/
denominator?: Schema$RatioPart;
/**
* The numerator of the ratio.
*/
numerator?: Schema$RatioPart;
/**
* Ranking based time series filter.
*/
pickTimeSeriesFilter?: Schema$PickTimeSeriesFilter;
/**
* Apply a second aggregation after the ratio is computed.
*/
secondaryAggregation?: Schema$Aggregation;
/**
* Statistics based time series filter. Note: This field is deprecated and completely ignored by the API.
*/
statisticalTimeSeriesFilter?: Schema$StatisticalTimeSeriesFilter;
}
/**
* TimeSeriesQuery collects the set of supported methods for querying time series data from the Stackdriver metrics API.
*/
export interface Schema$TimeSeriesQuery {
/**
* Filter parameters to fetch time series.
*/
timeSeriesFilter?: Schema$TimeSeriesFilter;
/**
* Parameters to fetch a ratio between two time series filters.
*/
timeSeriesFilterRatio?: Schema$TimeSeriesFilterRatio;
/**
* A query used to fetch time series.
*/
timeSeriesQueryLanguage?: string | null;
/**
* The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors) field in MetricDescriptor.
*/
unitOverride?: string | null;
}
/**
* A protocol buffer message type.
*/
export interface Schema$Type {
/**
* The list of fields.
*/
fields?: Schema$Field[];
/**
* The fully qualified message name.
*/
name?: string | null;
/**
* The list of types appearing in oneof definitions in this type.
*/
oneofs?: string[] | null;
/**
* The protocol buffer options.
*/
options?: Schema$Option[];
/**
* The source context.
*/
sourceContext?: Schema$SourceContext;
/**
* The source syntax.
*/
syntax?: string | null;
}
/**
* Widget contains a single dashboard component and configuration of how to present the component in the dashboard.
*/
export interface Schema$Widget {
/**
* A blank space.
*/
blank?: Schema$Empty;
/**
* A scorecard summarizing time series data.
*/
scorecard?: Schema$Scorecard;
/**
* A raw string or markdown displaying textual content.
*/
text?: Schema$Text;
/**
* Optional. The title of the widget.
*/
title?: string | null;
/**
* A chart of time series data.
*/
xyChart?: Schema$XyChart;
}
/**
* A chart that displays data on a 2D (X and Y axes) plane.
*/
export interface Schema$XyChart {
/**
* Display options for the chart.
*/
chartOptions?: Schema$ChartOptions;
/**
* Required. The data displayed in this chart.
*/
dataSets?: Schema$DataSet[];
/**
* Threshold lines drawn horizontally across the chart.
*/
thresholds?: Schema$Threshold[];
/**
* The duration used to display a comparison chart. A comparison chart simultaneously shows values from two similar-length time periods (e.g., week-over-week metrics). The duration must be positive, and it can only be applied to charts with data sets of LINE plot type.
*/
timeshiftDuration?: string | null;
/**
* The properties applied to the X axis.
*/
xAxis?: Schema$Axis;
/**
* The properties applied to the Y axis.
*/
yAxis?: Schema$Axis;
}
export class Resource$Projects {
context: APIRequestContext;
dashboards: Resource$Projects$Dashboards;
constructor(context: APIRequestContext);
}
export class Resource$Projects$Dashboards {
context: APIRequestContext;
constructor(context: APIRequestContext);
/**
* Creates a new custom dashboard. For examples on how you can use this API to create dashboards, see Managing dashboards by API. This method requires the monitoring.dashboards.create permission on the specified project. For more information about permissions, see Cloud Identity and Access Management.
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/monitoring.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const monitoring = google.monitoring('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/monitoring',
* 'https://www.googleapis.com/auth/monitoring.write',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await monitoring.projects.dashboards.create({
* // Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] The [PROJECT_ID_OR_NUMBER] must match the dashboard resource name.
* parent: 'projects/my-project',
* // If set, validate the request and preview the review, but do not actually save it.
* validateOnly: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "columnLayout": {},
* // "displayName": "my_displayName",
* // "etag": "my_etag",
* // "gridLayout": {},
* // "mosaicLayout": {},
* // "name": "my_name",
* // "rowLayout": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "columnLayout": {},
* // "displayName": "my_displayName",
* // "etag": "my_etag",
* // "gridLayout": {},
* // "mosaicLayout": {},
* // "name": "my_name",
* // "rowLayout": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
create(params: Params$Resource$Projects$Dashboards$Create, options: StreamMethodOptions): GaxiosPromise<Readable>;
create(params?: Params$Resource$Projects$Dashboards$Create, options?: MethodOptions): GaxiosPromise<Schema$Dashboard>;
create(params: Params$Resource$Projects$Dashboards$Create, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
create(params: Params$Resource$Projects$Dashboards$Create, options: MethodOptions | BodyResponseCallback<Schema$Dashboard>, callback: BodyResponseCallback<Schema$Dashboard>): void;
create(params: Params$Resource$Projects$Dashboards$Create, callback: BodyResponseCallback<Schema$Dashboard>): void;
create(callback: BodyResponseCallback<Schema$Dashboard>): void;
/**
* Deletes an existing custom dashboard.This method requires the monitoring.dashboards.delete permission on the specified dashboard. For more information, see Cloud Identity and Access Management (https://cloud.google.com/iam).
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/monitoring.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const monitoring = google.monitoring('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/monitoring',
* 'https://www.googleapis.com/auth/monitoring.write',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await monitoring.projects.dashboards.delete({
* // Required. The resource name of the Dashboard. The format is: projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID]
* name: 'projects/my-project/dashboards/my-dashboard',
* });
* console.log(res.data);
*
* // Example response
* // {}
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
delete(params: Params$Resource$Projects$Dashboards$Delete, options: StreamMethodOptions): GaxiosPromise<Readable>;
delete(params?: Params$Resource$Projects$Dashboards$Delete, options?: MethodOptions): GaxiosPromise<Schema$Empty>;
delete(params: Params$Resource$Projects$Dashboards$Delete, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
delete(params: Params$Resource$Projects$Dashboards$Delete, options: MethodOptions | BodyResponseCallback<Schema$Empty>, callback: BodyResponseCallback<Schema$Empty>): void;
delete(params: Params$Resource$Projects$Dashboards$Delete, callback: BodyResponseCallback<Schema$Empty>): void;
delete(callback: BodyResponseCallback<Schema$Empty>): void;
/**
* Fetches a specific dashboard.This method requires the monitoring.dashboards.get permission on the specified dashboard. For more information, see Cloud Identity and Access Management (https://cloud.google.com/iam).
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/monitoring.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const monitoring = google.monitoring('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/monitoring',
* 'https://www.googleapis.com/auth/monitoring.read',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await monitoring.projects.dashboards.get({
* // Required. The resource name of the Dashboard. The format is one of: dashboards/[DASHBOARD_ID] (for system dashboards) projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID] (for custom dashboards).
* name: 'projects/my-project/dashboards/my-dashboard',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "columnLayout": {},
* // "displayName": "my_displayName",
* // "etag": "my_etag",
* // "gridLayout": {},
* // "mosaicLayout": {},
* // "name": "my_name",
* // "rowLayout": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
get(params: Params$Resource$Projects$Dashboards$Get, options: StreamMethodOptions): GaxiosPromise<Readable>;
get(params?: Params$Resource$Projects$Dashboards$Get, options?: MethodOptions): GaxiosPromise<Schema$Dashboard>;
get(params: Params$Resource$Projects$Dashboards$Get, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
get(params: Params$Resource$Projects$Dashboards$Get, options: MethodOptions | BodyResponseCallback<Schema$Dashboard>, callback: BodyResponseCallback<Schema$Dashboard>): void;
get(params: Params$Resource$Projects$Dashboards$Get, callback: BodyResponseCallback<Schema$Dashboard>): void;
get(callback: BodyResponseCallback<Schema$Dashboard>): void;
/**
* Lists the existing dashboards.This method requires the monitoring.dashboards.list permission on the specified project. For more information, see Cloud Identity and Access Management (https://cloud.google.com/iam).
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/monitoring.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const monitoring = google.monitoring('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/monitoring',
* 'https://www.googleapis.com/auth/monitoring.read',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await monitoring.projects.dashboards.list({
* // A positive number that is the maximum number of results to return. If unspecified, a default of 1000 is used.
* pageSize: 'placeholder-value',
* // If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
* pageToken: 'placeholder-value',
* // Required. The scope of the dashboards to list. The format is: projects/[PROJECT_ID_OR_NUMBER]
* parent: 'projects/my-project',
* });
* console.log(res.data);
*
* // Example response
* // {
* // "dashboards": [],
* // "nextPageToken": "my_nextPageToken"
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
list(params: Params$Resource$Projects$Dashboards$List, options: StreamMethodOptions): GaxiosPromise<Readable>;
list(params?: Params$Resource$Projects$Dashboards$List, options?: MethodOptions): GaxiosPromise<Schema$ListDashboardsResponse>;
list(params: Params$Resource$Projects$Dashboards$List, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
list(params: Params$Resource$Projects$Dashboards$List, options: MethodOptions | BodyResponseCallback<Schema$ListDashboardsResponse>, callback: BodyResponseCallback<Schema$ListDashboardsResponse>): void;
list(params: Params$Resource$Projects$Dashboards$List, callback: BodyResponseCallback<Schema$ListDashboardsResponse>): void;
list(callback: BodyResponseCallback<Schema$ListDashboardsResponse>): void;
/**
* Replaces an existing custom dashboard with a new definition.This method requires the monitoring.dashboards.update permission on the specified dashboard. For more information, see Cloud Identity and Access Management (https://cloud.google.com/iam).
* @example
* ```js
* // Before running the sample:
* // - Enable the API at:
* // https://console.developers.google.com/apis/api/monitoring.googleapis.com
* // - Login into gcloud by running:
* // `$ gcloud auth application-default login`
* // - Install the npm module by running:
* // `$ npm install googleapis`
*
* const {google} = require('googleapis');
* const monitoring = google.monitoring('v1');
*
* async function main() {
* const auth = new google.auth.GoogleAuth({
* // Scopes can be specified either as an array or as a single, space-delimited string.
* scopes: [
* 'https://www.googleapis.com/auth/cloud-platform',
* 'https://www.googleapis.com/auth/monitoring',
* 'https://www.googleapis.com/auth/monitoring.write',
* ],
* });
*
* // Acquire an auth client, and bind it to all future calls
* const authClient = await auth.getClient();
* google.options({auth: authClient});
*
* // Do the magic
* const res = await monitoring.projects.dashboards.patch({
* // Immutable. The resource name of the dashboard.
* name: 'projects/my-project/dashboards/my-dashboard',
* // If set, validate the request and preview the review, but do not actually save it.
* validateOnly: 'placeholder-value',
*
* // Request body metadata
* requestBody: {
* // request body parameters
* // {
* // "columnLayout": {},
* // "displayName": "my_displayName",
* // "etag": "my_etag",
* // "gridLayout": {},
* // "mosaicLayout": {},
* // "name": "my_name",
* // "rowLayout": {}
* // }
* },
* });
* console.log(res.data);
*
* // Example response
* // {
* // "columnLayout": {},
* // "displayName": "my_displayName",
* // "etag": "my_etag",
* // "gridLayout": {},
* // "mosaicLayout": {},
* // "name": "my_name",
* // "rowLayout": {}
* // }
* }
*
* main().catch(e => {
* console.error(e);
* throw e;
* });
*
* ```
*
* @param params - Parameters for request
* @param options - Optionally override request options, such as `url`, `method`, and `encoding`.
* @param callback - Optional callback that handles the response.
* @returns A promise if used with async/await, or void if used with a callback.
*/
patch(params: Params$Resource$Projects$Dashboards$Patch, options: StreamMethodOptions): GaxiosPromise<Readable>;
patch(params?: Params$Resource$Projects$Dashboards$Patch, options?: MethodOptions): GaxiosPromise<Schema$Dashboard>;
patch(params: Params$Resource$Projects$Dashboards$Patch, options: StreamMethodOptions | BodyResponseCallback<Readable>, callback: BodyResponseCallback<Readable>): void;
patch(params: Params$Resource$Projects$Dashboards$Patch, options: MethodOptions | BodyResponseCallback<Schema$Dashboard>, callback: BodyResponseCallback<Schema$Dashboard>): void;
patch(params: Params$Resource$Projects$Dashboards$Patch, callback: BodyResponseCallback<Schema$Dashboard>): void;
patch(callback: BodyResponseCallback<Schema$Dashboard>): void;
}
export interface Params$Resource$Projects$Dashboards$Create extends StandardParameters {
/**
* Required. The project on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] The [PROJECT_ID_OR_NUMBER] must match the dashboard resource name.
*/
parent?: string;
/**
* If set, validate the request and preview the review, but do not actually save it.
*/
validateOnly?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$Dashboard;
}
export interface Params$Resource$Projects$Dashboards$Delete extends StandardParameters {
/**
* Required. The resource name of the Dashboard. The format is: projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID]
*/
name?: string;
}
export interface Params$Resource$Projects$Dashboards$Get extends StandardParameters {
/**
* Required. The resource name of the Dashboard. The format is one of: dashboards/[DASHBOARD_ID] (for system dashboards) projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID] (for custom dashboards).
*/
name?: string;
}
export interface Params$Resource$Projects$Dashboards$List extends StandardParameters {
/**
* A positive number that is the maximum number of results to return. If unspecified, a default of 1000 is used.
*/
pageSize?: number;
/**
* If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.
*/
pageToken?: string;
/**
* Required. The scope of the dashboards to list. The format is: projects/[PROJECT_ID_OR_NUMBER]
*/
parent?: string;
}
export interface Params$Resource$Projects$Dashboards$Patch extends StandardParameters {
/**
* Immutable. The resource name of the dashboard.
*/
name?: string;
/**
* If set, validate the request and preview the review, but do not actually save it.
*/
validateOnly?: boolean;
/**
* Request body metadata
*/
requestBody?: Schema$Dashboard;
}
export {};
}