@maxim_mazurok/gapi.client.monitoring-v1 0.1.20260309 → 0.1.20260528

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/index.d.ts +244 -89
  2. package/package.json +1 -1
  3. package/readme.md +12 -0
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://monitoring.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20260309
12
+ // Revision: 20260528
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -28,11 +28,44 @@ declare namespace gapi.client {
28
28
  /** 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. */
29
29
  alignmentPeriod?: string;
30
30
  /** 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. */
31
- crossSeriesReducer?: string;
31
+ crossSeriesReducer?:
32
+ | 'REDUCE_NONE'
33
+ | 'REDUCE_MEAN'
34
+ | 'REDUCE_MIN'
35
+ | 'REDUCE_MAX'
36
+ | 'REDUCE_SUM'
37
+ | 'REDUCE_STDDEV'
38
+ | 'REDUCE_COUNT'
39
+ | 'REDUCE_COUNT_TRUE'
40
+ | 'REDUCE_COUNT_FALSE'
41
+ | 'REDUCE_FRACTION_TRUE'
42
+ | 'REDUCE_PERCENTILE_99'
43
+ | 'REDUCE_PERCENTILE_95'
44
+ | 'REDUCE_PERCENTILE_50'
45
+ | 'REDUCE_PERCENTILE_05';
32
46
  /** 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. */
33
47
  groupByFields?: string[];
34
48
  /** 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. */
35
- perSeriesAligner?: string;
49
+ perSeriesAligner?:
50
+ | 'ALIGN_NONE'
51
+ | 'ALIGN_DELTA'
52
+ | 'ALIGN_RATE'
53
+ | 'ALIGN_INTERPOLATE'
54
+ | 'ALIGN_NEXT_OLDER'
55
+ | 'ALIGN_MIN'
56
+ | 'ALIGN_MAX'
57
+ | 'ALIGN_MEAN'
58
+ | 'ALIGN_COUNT'
59
+ | 'ALIGN_SUM'
60
+ | 'ALIGN_STDDEV'
61
+ | 'ALIGN_COUNT_TRUE'
62
+ | 'ALIGN_COUNT_FALSE'
63
+ | 'ALIGN_FRACTION_TRUE'
64
+ | 'ALIGN_PERCENTILE_99'
65
+ | 'ALIGN_PERCENTILE_95'
66
+ | 'ALIGN_PERCENTILE_50'
67
+ | 'ALIGN_PERCENTILE_05'
68
+ | 'ALIGN_PERCENT_CHANGE';
36
69
  }
37
70
  interface AggregationFunction {
38
71
  /** Optional. Parameters applied to the aggregation function. Only used for functions that require them. */
@@ -48,7 +81,7 @@ declare namespace gapi.client {
48
81
  /** The label of the axis. */
49
82
  label?: string;
50
83
  /** The axis scale. By default, a linear scale is used. */
51
- scale?: string;
84
+ scale?: 'SCALE_UNSPECIFIED' | 'LINEAR' | 'LOG10';
52
85
  }
53
86
  interface Breakdown {
54
87
  /** Required. The Aggregation function is applied across all data in each breakdown created. */
@@ -58,13 +91,17 @@ declare namespace gapi.client {
58
91
  /** 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. */
59
92
  limit?: number;
60
93
  /** Required. The sort order is applied to the values of the breakdown column. */
61
- sortOrder?: string;
94
+ sortOrder?:
95
+ | 'SORT_ORDER_UNSPECIFIED'
96
+ | 'SORT_ORDER_NONE'
97
+ | 'SORT_ORDER_ASCENDING'
98
+ | 'SORT_ORDER_DESCENDING';
62
99
  }
63
100
  interface ChartOptions {
64
101
  /** 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. */
65
102
  displayHorizontal?: boolean;
66
103
  /** The chart mode. */
67
- mode?: string;
104
+ mode?: 'MODE_UNSPECIFIED' | 'COLOR' | 'X_RAY' | 'STATS';
68
105
  }
69
106
  interface CollapsibleGroup {
70
107
  /** The collapsed state of the widget on first page load. */
@@ -82,7 +119,7 @@ declare namespace gapi.client {
82
119
  }
83
120
  interface ColumnSettings {
84
121
  /** Optional. Whether the column should be left / middle / right aligned */
85
- alignment?: string;
122
+ alignment?: 'CELL_ALIGNMENT_UNSPECIFIED' | 'LEFT' | 'CENTER' | 'RIGHT';
86
123
  /** Required. The id of the column. */
87
124
  column?: string;
88
125
  /** Optional. Display name of the column */
@@ -96,7 +133,11 @@ declare namespace gapi.client {
96
133
  /** Optional. Column name to sort data by */
97
134
  column?: string;
98
135
  /** Optional. A sorting direction that determines ascending or descending order. This is a legacy field kept for backwards compatibility with table. */
99
- direction?: string;
136
+ direction?:
137
+ | 'SORT_ORDER_UNSPECIFIED'
138
+ | 'SORT_ORDER_NONE'
139
+ | 'SORT_ORDER_ASCENDING'
140
+ | 'SORT_ORDER_DESCENDING';
100
141
  }
101
142
  interface Dashboard {
102
143
  /** Configuration for event annotations to display on this dashboard. */
@@ -128,7 +169,14 @@ declare namespace gapi.client {
128
169
  }
129
170
  interface DashboardFilter {
130
171
  /** The specified filter type */
131
- filterType?: string;
172
+ filterType?:
173
+ | 'FILTER_TYPE_UNSPECIFIED'
174
+ | 'RESOURCE_LABEL'
175
+ | 'METRIC_LABEL'
176
+ | 'USER_METADATA_LABEL'
177
+ | 'SYSTEM_METADATA_LABEL'
178
+ | 'GROUP'
179
+ | 'VALUE_ONLY';
132
180
  /** Optional. The key for the label. This must be omitted if the filter_type is VALUE_ONLY but is required otherwise. */
133
181
  labelKey?: string;
134
182
  /** A list of possible string values for the filter */
@@ -142,7 +190,7 @@ declare namespace gapi.client {
142
190
  /** A query to run to fetch possible values for the filter. Only OpsAnalyticsQueries are supported */
143
191
  timeSeriesQuery?: TimeSeriesQuery;
144
192
  /** 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. */
145
- valueType?: string;
193
+ valueType?: 'VALUE_TYPE_UNSPECIFIED' | 'STRING' | 'STRING_ARRAY';
146
194
  }
147
195
  interface DataSet {
148
196
  /** Optional. The collection of breakdowns to be applied to the dataset. */
@@ -153,14 +201,19 @@ declare namespace gapi.client {
153
201
  legendTemplate?: string;
154
202
  /** Optional. A collection of measures. */
155
203
  measures?: Measure[];
156
- /** 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. */
204
+ /** 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.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. */
157
205
  minAlignmentPeriod?: string;
158
206
  /** How this data should be plotted on the chart. */
159
- plotType?: string;
207
+ plotType?:
208
+ | 'PLOT_TYPE_UNSPECIFIED'
209
+ | 'LINE'
210
+ | 'STACKED_AREA'
211
+ | 'STACKED_BAR'
212
+ | 'HEATMAP';
160
213
  /** Optional. A collection of sort options, affects the order of the data and legend. */
161
214
  sort?: ColumnSortingOptions[];
162
215
  /** Optional. The target axis to use for plotting the metric. */
163
- targetAxis?: string;
216
+ targetAxis?: 'TARGET_AXIS_UNSPECIFIED' | 'Y1' | 'Y2';
164
217
  /** Required. Fields for querying time series data from the Stackdriver metrics API. */
165
218
  timeSeriesQuery?: TimeSeriesQuery;
166
219
  }
@@ -178,7 +231,11 @@ declare namespace gapi.client {
178
231
  /** The column name to sort on for binning. This column can be the same column as this dimension or any other column used as a measure in the results. If sort_order is set to NONE, then this value is not used. */
179
232
  sortColumn?: string;
180
233
  /** The sort order applied to the sort column. */
181
- sortOrder?: string;
234
+ sortOrder?:
235
+ | 'SORT_ORDER_UNSPECIFIED'
236
+ | 'SORT_ORDER_NONE'
237
+ | 'SORT_ORDER_ASCENDING'
238
+ | 'SORT_ORDER_DESCENDING';
182
239
  /** time_bin_size is used when the data type of the specified dimension is a time type and the bin size is determined by a time duration. If column_type is DATE, this must be a whole value multiple of 1 day. If column_type is TIME, this must be less than or equal to 24 hours. */
183
240
  timeBinSize?: string;
184
241
  }
@@ -201,7 +258,32 @@ declare namespace gapi.client {
201
258
  /** Whether or not to show the events on the dashboard by default */
202
259
  enabled?: boolean;
203
260
  /** The type of event to display. */
204
- eventType?: string;
261
+ eventType?:
262
+ | 'EVENT_TYPE_UNSPECIFIED'
263
+ | 'GKE_WORKLOAD_DEPLOYMENT'
264
+ | 'GKE_POD_CRASH'
265
+ | 'GKE_POD_UNSCHEDULABLE'
266
+ | 'GKE_CONTAINER_CREATION_FAILED'
267
+ | 'GKE_CLUSTER_CREATE_DELETE'
268
+ | 'GKE_CLUSTER_UPDATE'
269
+ | 'GKE_NODE_POOL_UPDATE'
270
+ | 'GKE_CLUSTER_AUTOSCALER'
271
+ | 'GKE_POD_AUTOSCALER'
272
+ | 'VM_TERMINATION'
273
+ | 'VM_GUEST_OS_ERROR'
274
+ | 'VM_START_FAILED'
275
+ | 'MIG_UPDATE'
276
+ | 'MIG_AUTOSCALER'
277
+ | 'CLOUD_RUN_DEPLOYMENT'
278
+ | 'CLOUD_SQL_FAILOVER'
279
+ | 'CLOUD_SQL_START_STOP'
280
+ | 'CLOUD_SQL_STORAGE'
281
+ | 'UPTIME_CHECK_FAILURE'
282
+ | 'CLOUD_ALERTING_ALERT'
283
+ | 'SERVICE_HEALTH_INCIDENT'
284
+ | 'SAP_BACKINT'
285
+ | 'SAP_AVAILABILITY'
286
+ | 'SAP_OPERATIONS';
205
287
  /** string filtering the events - event dependant. Example values: "resource.labels.pod_name = 'pod-1'" "protoPayload.authenticationInfo.principalEmail='user@example.com'" */
206
288
  filter?: string;
207
289
  /** Per annotation level override for the names of logging resources to search for events. Currently only projects are supported. If both this field and the per annotation field is empty, it will default to the host project. Limit: 50 projects. For example: “projects/another-project-id” */
@@ -209,13 +291,36 @@ declare namespace gapi.client {
209
291
  }
210
292
  interface Field {
211
293
  /** The field cardinality. */
212
- cardinality?: string;
294
+ cardinality?:
295
+ | 'CARDINALITY_UNKNOWN'
296
+ | 'CARDINALITY_OPTIONAL'
297
+ | 'CARDINALITY_REQUIRED'
298
+ | 'CARDINALITY_REPEATED';
213
299
  /** The string value of the default value of this field. Proto2 syntax only. */
214
300
  defaultValue?: string;
215
301
  /** The field JSON name. */
216
302
  jsonName?: string;
217
303
  /** The field type. */
218
- kind?: string;
304
+ kind?:
305
+ | 'TYPE_UNKNOWN'
306
+ | 'TYPE_DOUBLE'
307
+ | 'TYPE_FLOAT'
308
+ | 'TYPE_INT64'
309
+ | 'TYPE_UINT64'
310
+ | 'TYPE_INT32'
311
+ | 'TYPE_FIXED64'
312
+ | 'TYPE_FIXED32'
313
+ | 'TYPE_BOOL'
314
+ | 'TYPE_STRING'
315
+ | 'TYPE_GROUP'
316
+ | 'TYPE_MESSAGE'
317
+ | 'TYPE_BYTES'
318
+ | 'TYPE_UINT32'
319
+ | 'TYPE_ENUM'
320
+ | 'TYPE_SFIXED32'
321
+ | 'TYPE_SFIXED64'
322
+ | 'TYPE_SINT32'
323
+ | 'TYPE_SINT64';
219
324
  /** The field name. */
220
325
  name?: string;
221
326
  /** The field number. */
@@ -251,7 +356,7 @@ declare namespace gapi.client {
251
356
  /** The HTTP request/response body as raw binary. */
252
357
  data?: string;
253
358
  /** Application specific response metadata. Must be set in the first response for streaming APIs. */
254
- extensions?: Array<{[P in string]: any}>;
359
+ extensions?: {[P in string]: any}[];
255
360
  }
256
361
  interface IncidentList {
257
362
  /** Optional. The monitored resource for which incidents are listed. The resource doesn't need to be fully specified. That is, you can specify the resource type but not the values of the resource labels. The resource type and labels are used for filtering. */
@@ -333,7 +438,12 @@ declare namespace gapi.client {
333
438
  /** The time when the batch request was received. */
334
439
  createTime?: string;
335
440
  /** Current state of the batch operation. */
336
- state?: string;
441
+ state?:
442
+ | 'STATE_UNSPECIFIED'
443
+ | 'CREATED'
444
+ | 'RUNNING'
445
+ | 'DONE'
446
+ | 'CANCELLED';
337
447
  /** The time when the operation result was last updated. */
338
448
  updateTime?: string;
339
449
  }
@@ -355,17 +465,23 @@ declare namespace gapi.client {
355
465
  }
356
466
  interface PickTimeSeriesFilter {
357
467
  /** How to use the ranking to select time series that pass through the filter. */
358
- direction?: string;
468
+ direction?: 'DIRECTION_UNSPECIFIED' | 'TOP' | 'BOTTOM';
359
469
  /** Select the top N streams/time series within this time interval */
360
470
  interval?: Interval;
361
471
  /** How many time series to allow to pass through the filter. */
362
472
  numTimeSeries?: number;
363
473
  /** 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. */
364
- rankingMethod?: string;
474
+ rankingMethod?:
475
+ | 'METHOD_UNSPECIFIED'
476
+ | 'METHOD_MEAN'
477
+ | 'METHOD_MAX'
478
+ | 'METHOD_MIN'
479
+ | 'METHOD_SUM'
480
+ | 'METHOD_LATEST';
365
481
  }
366
482
  interface PieChart {
367
483
  /** Required. Indicates the visualization type for the PieChart. */
368
- chartType?: string;
484
+ chartType?: 'PIE_CHART_TYPE_UNSPECIFIED' | 'PIE' | 'DONUT';
369
485
  /** Required. The queries for the chart's data. */
370
486
  dataSets?: PieChartDataSet[];
371
487
  /** Optional. Indicates whether or not the pie chart should show slices' labels */
@@ -467,7 +583,7 @@ declare namespace gapi.client {
467
583
  }
468
584
  interface SingleViewGroup {
469
585
  /** Optional. Determines how the widget selector will be displayed. */
470
- displayType?: string;
586
+ displayType?: 'DISPLAY_TYPE_UNSPECIFIED' | 'DROPDOWN' | 'TAB';
471
587
  }
472
588
  interface SourceContext {
473
589
  /** The path-qualified name of the .proto file that contained the associated protobuf element. For example: "google/protobuf/source_context.proto". */
@@ -478,22 +594,25 @@ declare namespace gapi.client {
478
594
  spanName?: string;
479
595
  }
480
596
  interface SparkChartView {
481
- /** 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. */
597
+ /** 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.For PromQL queries, this field is used to set the minimum interval for the query step, controlling data granularity. Larger values can improve performance on long time ranges. See Querying Basics and Range Queries for more details on the PromQL step. */
482
598
  minAlignmentPeriod?: string;
483
599
  /** Required. The type of sparkchart to show in this chartView. */
484
- sparkChartType?: string;
600
+ sparkChartType?:
601
+ | 'SPARK_CHART_TYPE_UNSPECIFIED'
602
+ | 'SPARK_LINE'
603
+ | 'SPARK_BAR';
485
604
  }
486
605
  interface StatisticalTimeSeriesFilter {
487
606
  /** How many time series to output. */
488
607
  numTimeSeries?: number;
489
608
  /** 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. */
490
- rankingMethod?: string;
609
+ rankingMethod?: 'METHOD_UNSPECIFIED' | 'METHOD_CLUSTER_OUTLIER';
491
610
  }
492
611
  interface Status {
493
612
  /** The status code, which should be an enum value of google.rpc.Code. */
494
613
  code?: number;
495
614
  /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
496
- details?: Array<{[P in string]: any}>;
615
+ details?: {[P in string]: any}[];
497
616
  /** A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. */
498
617
  message?: string;
499
618
  }
@@ -517,7 +636,7 @@ declare namespace gapi.client {
517
636
  }
518
637
  interface TemplateVariableCondition {
519
638
  /** Comparator to use to evaluate whether the value of the template variable matches the template_variable_value. For example, if the comparator is REGEX_FULL_MATCH, template_variable_value would contain a regex that is matched against the value of the template variable. */
520
- comparator?: string;
639
+ comparator?: 'COMPARATOR_UNSPECIFIED' | 'REGEX_FULL_MATCH';
521
640
  /** The template variable whose value is evaluated. */
522
641
  templateVariable?: string;
523
642
  /** The value to compare the template variable to. For example, if the comparator is REGEX_FULL_MATCH, this field should contain a regex. */
@@ -527,7 +646,7 @@ declare namespace gapi.client {
527
646
  /** The text content to be displayed. */
528
647
  content?: string;
529
648
  /** How the text content is formatted. */
530
- format?: string;
649
+ format?: 'FORMAT_UNSPECIFIED' | 'MARKDOWN' | 'RAW';
531
650
  /** How the text is styled */
532
651
  style?: TextStyle;
533
652
  }
@@ -535,27 +654,60 @@ declare namespace gapi.client {
535
654
  /** The background color as a hex string. "#RRGGBB" or "#RGB" */
536
655
  backgroundColor?: string;
537
656
  /** Font sizes for both the title and content. The title will still be larger relative to the content. */
538
- fontSize?: string;
657
+ fontSize?:
658
+ | 'FONT_SIZE_UNSPECIFIED'
659
+ | 'FS_EXTRA_SMALL'
660
+ | 'FS_SMALL'
661
+ | 'FS_MEDIUM'
662
+ | 'FS_LARGE'
663
+ | 'FS_EXTRA_LARGE';
539
664
  /** The horizontal alignment of both the title and content */
540
- horizontalAlignment?: string;
665
+ horizontalAlignment?:
666
+ | 'HORIZONTAL_ALIGNMENT_UNSPECIFIED'
667
+ | 'H_LEFT'
668
+ | 'H_CENTER'
669
+ | 'H_RIGHT';
541
670
  /** The amount of padding around the widget */
542
- padding?: string;
671
+ padding?:
672
+ | 'PADDING_SIZE_UNSPECIFIED'
673
+ | 'P_EXTRA_SMALL'
674
+ | 'P_SMALL'
675
+ | 'P_MEDIUM'
676
+ | 'P_LARGE'
677
+ | 'P_EXTRA_LARGE';
543
678
  /** The pointer location for this widget (also sometimes called a "tail") */
544
- pointerLocation?: string;
679
+ pointerLocation?:
680
+ | 'POINTER_LOCATION_UNSPECIFIED'
681
+ | 'PL_TOP'
682
+ | 'PL_RIGHT'
683
+ | 'PL_BOTTOM'
684
+ | 'PL_LEFT'
685
+ | 'PL_TOP_LEFT'
686
+ | 'PL_TOP_RIGHT'
687
+ | 'PL_RIGHT_TOP'
688
+ | 'PL_RIGHT_BOTTOM'
689
+ | 'PL_BOTTOM_RIGHT'
690
+ | 'PL_BOTTOM_LEFT'
691
+ | 'PL_LEFT_BOTTOM'
692
+ | 'PL_LEFT_TOP';
545
693
  /** The text color as a hex string. "#RRGGBB" or "#RGB" */
546
694
  textColor?: string;
547
695
  /** The vertical alignment of both the title and content */
548
- verticalAlignment?: string;
696
+ verticalAlignment?:
697
+ | 'VERTICAL_ALIGNMENT_UNSPECIFIED'
698
+ | 'V_TOP'
699
+ | 'V_CENTER'
700
+ | 'V_BOTTOM';
549
701
  }
550
702
  interface Threshold {
551
703
  /** The state color for this threshold. Color is not allowed in a XyChart. */
552
- color?: string;
704
+ color?: 'COLOR_UNSPECIFIED' | 'YELLOW' | 'RED';
553
705
  /** The direction for the current threshold. Direction is not allowed in a XyChart. */
554
- direction?: string;
706
+ direction?: 'DIRECTION_UNSPECIFIED' | 'ABOVE' | 'BELOW';
555
707
  /** A label for the threshold. */
556
708
  label?: string;
557
709
  /** The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. */
558
- targetAxis?: string;
710
+ targetAxis?: 'TARGET_AXIS_UNSPECIFIED' | 'Y1' | 'Y2';
559
711
  /** The value of the threshold. The value should be defined in the native scale of the metric. */
560
712
  value?: number;
561
713
  }
@@ -617,7 +769,10 @@ declare namespace gapi.client {
617
769
  /** Required. The data displayed in this table. */
618
770
  dataSets?: TableDataSet[];
619
771
  /** Optional. Store rendering strategy */
620
- metricVisualization?: string;
772
+ metricVisualization?:
773
+ | 'METRIC_VISUALIZATION_UNSPECIFIED'
774
+ | 'NUMBER'
775
+ | 'BAR';
621
776
  }
622
777
  interface Treemap {
623
778
  /** Required. The collection of datasets used to construct and populate the treemap. For the rendered treemap rectangles: Color is determined by the aggregated value for each grouping. Size is proportional to the count of time series aggregated within that rectangle's segment. */
@@ -647,7 +802,7 @@ declare namespace gapi.client {
647
802
  /** The source context. */
648
803
  sourceContext?: SourceContext;
649
804
  /** The source syntax. */
650
- syntax?: string;
805
+ syntax?: 'SYNTAX_PROTO2' | 'SYNTAX_PROTO3' | 'SYNTAX_EDITIONS';
651
806
  }
652
807
  interface VisibilityCondition {
653
808
  /** A condition whose evaluation is based on the value of a template variable. */
@@ -711,11 +866,11 @@ declare namespace gapi.client {
711
866
  /** Adds a MonitoredProject with the given project ID to the specified Metrics Scope. */
712
867
  create(request: {
713
868
  /** V1 error format. */
714
- '$.xgafv'?: string;
869
+ '$.xgafv'?: '1' | '2';
715
870
  /** OAuth access token. */
716
871
  access_token?: string;
717
872
  /** Data format for response. */
718
- alt?: string;
873
+ alt?: 'json' | 'media' | 'proto';
719
874
  /** JSONP */
720
875
  callback?: string;
721
876
  /** Selector specifying which fields to include in a partial response. */
@@ -740,11 +895,11 @@ declare namespace gapi.client {
740
895
  create(
741
896
  request: {
742
897
  /** V1 error format. */
743
- '$.xgafv'?: string;
898
+ '$.xgafv'?: '1' | '2';
744
899
  /** OAuth access token. */
745
900
  access_token?: string;
746
901
  /** Data format for response. */
747
- alt?: string;
902
+ alt?: 'json' | 'media' | 'proto';
748
903
  /** JSONP */
749
904
  callback?: string;
750
905
  /** Selector specifying which fields to include in a partial response. */
@@ -769,11 +924,11 @@ declare namespace gapi.client {
769
924
  /** Deletes a MonitoredProject from the specified Metrics Scope. */
770
925
  delete(request?: {
771
926
  /** V1 error format. */
772
- '$.xgafv'?: string;
927
+ '$.xgafv'?: '1' | '2';
773
928
  /** OAuth access token. */
774
929
  access_token?: string;
775
930
  /** Data format for response. */
776
- alt?: string;
931
+ alt?: 'json' | 'media' | 'proto';
777
932
  /** JSONP */
778
933
  callback?: string;
779
934
  /** Selector specifying which fields to include in a partial response. */
@@ -798,11 +953,11 @@ declare namespace gapi.client {
798
953
  /** Returns a specific Metrics Scope, including the list of projects monitored by the specified Metrics Scope. */
799
954
  get(request?: {
800
955
  /** V1 error format. */
801
- '$.xgafv'?: string;
956
+ '$.xgafv'?: '1' | '2';
802
957
  /** OAuth access token. */
803
958
  access_token?: string;
804
959
  /** Data format for response. */
805
- alt?: string;
960
+ alt?: 'json' | 'media' | 'proto';
806
961
  /** JSONP */
807
962
  callback?: string;
808
963
  /** Selector specifying which fields to include in a partial response. */
@@ -825,11 +980,11 @@ declare namespace gapi.client {
825
980
  /** Returns a list of every Metrics Scope that a specific MonitoredProject has been added to. The metrics scope representing the specified monitored project will always be the first entry in the response. */
826
981
  listMetricsScopesByMonitoredProject(request?: {
827
982
  /** V1 error format. */
828
- '$.xgafv'?: string;
983
+ '$.xgafv'?: '1' | '2';
829
984
  /** OAuth access token. */
830
985
  access_token?: string;
831
986
  /** Data format for response. */
832
- alt?: string;
987
+ alt?: 'json' | 'media' | 'proto';
833
988
  /** JSONP */
834
989
  callback?: string;
835
990
  /** Selector specifying which fields to include in a partial response. */
@@ -861,11 +1016,11 @@ declare namespace gapi.client {
861
1016
  /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
862
1017
  get(request?: {
863
1018
  /** V1 error format. */
864
- '$.xgafv'?: string;
1019
+ '$.xgafv'?: '1' | '2';
865
1020
  /** OAuth access token. */
866
1021
  access_token?: string;
867
1022
  /** Data format for response. */
868
- alt?: string;
1023
+ alt?: 'json' | 'media' | 'proto';
869
1024
  /** JSONP */
870
1025
  callback?: string;
871
1026
  /** Selector specifying which fields to include in a partial response. */
@@ -890,11 +1045,11 @@ declare namespace gapi.client {
890
1045
  /** Creates a new custom dashboard. For examples on how you can use this API to create dashboards, see Managing dashboards by API (https://cloud.google.com/monitoring/dashboards/api-dashboard). This method requires the monitoring.dashboards.create permission on the specified project. For more information about permissions, see Cloud Identity and Access Management (https://cloud.google.com/iam). */
891
1046
  create(request: {
892
1047
  /** V1 error format. */
893
- '$.xgafv'?: string;
1048
+ '$.xgafv'?: '1' | '2';
894
1049
  /** OAuth access token. */
895
1050
  access_token?: string;
896
1051
  /** Data format for response. */
897
- alt?: string;
1052
+ alt?: 'json' | 'media' | 'proto';
898
1053
  /** JSONP */
899
1054
  callback?: string;
900
1055
  /** Selector specifying which fields to include in a partial response. */
@@ -921,11 +1076,11 @@ declare namespace gapi.client {
921
1076
  create(
922
1077
  request: {
923
1078
  /** V1 error format. */
924
- '$.xgafv'?: string;
1079
+ '$.xgafv'?: '1' | '2';
925
1080
  /** OAuth access token. */
926
1081
  access_token?: string;
927
1082
  /** Data format for response. */
928
- alt?: string;
1083
+ alt?: 'json' | 'media' | 'proto';
929
1084
  /** JSONP */
930
1085
  callback?: string;
931
1086
  /** Selector specifying which fields to include in a partial response. */
@@ -952,11 +1107,11 @@ declare namespace gapi.client {
952
1107
  /** 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). */
953
1108
  delete(request?: {
954
1109
  /** V1 error format. */
955
- '$.xgafv'?: string;
1110
+ '$.xgafv'?: '1' | '2';
956
1111
  /** OAuth access token. */
957
1112
  access_token?: string;
958
1113
  /** Data format for response. */
959
- alt?: string;
1114
+ alt?: 'json' | 'media' | 'proto';
960
1115
  /** JSONP */
961
1116
  callback?: string;
962
1117
  /** Selector specifying which fields to include in a partial response. */
@@ -979,11 +1134,11 @@ declare namespace gapi.client {
979
1134
  /** 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). */
980
1135
  get(request?: {
981
1136
  /** V1 error format. */
982
- '$.xgafv'?: string;
1137
+ '$.xgafv'?: '1' | '2';
983
1138
  /** OAuth access token. */
984
1139
  access_token?: string;
985
1140
  /** Data format for response. */
986
- alt?: string;
1141
+ alt?: 'json' | 'media' | 'proto';
987
1142
  /** JSONP */
988
1143
  callback?: string;
989
1144
  /** Selector specifying which fields to include in a partial response. */
@@ -1006,11 +1161,11 @@ declare namespace gapi.client {
1006
1161
  /** 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). */
1007
1162
  list(request?: {
1008
1163
  /** V1 error format. */
1009
- '$.xgafv'?: string;
1164
+ '$.xgafv'?: '1' | '2';
1010
1165
  /** OAuth access token. */
1011
1166
  access_token?: string;
1012
1167
  /** Data format for response. */
1013
- alt?: string;
1168
+ alt?: 'json' | 'media' | 'proto';
1014
1169
  /** JSONP */
1015
1170
  callback?: string;
1016
1171
  /** Selector specifying which fields to include in a partial response. */
@@ -1037,11 +1192,11 @@ declare namespace gapi.client {
1037
1192
  /** 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). */
1038
1193
  patch(request: {
1039
1194
  /** V1 error format. */
1040
- '$.xgafv'?: string;
1195
+ '$.xgafv'?: '1' | '2';
1041
1196
  /** OAuth access token. */
1042
1197
  access_token?: string;
1043
1198
  /** Data format for response. */
1044
- alt?: string;
1199
+ alt?: 'json' | 'media' | 'proto';
1045
1200
  /** JSONP */
1046
1201
  callback?: string;
1047
1202
  /** Selector specifying which fields to include in a partial response. */
@@ -1068,11 +1223,11 @@ declare namespace gapi.client {
1068
1223
  patch(
1069
1224
  request: {
1070
1225
  /** V1 error format. */
1071
- '$.xgafv'?: string;
1226
+ '$.xgafv'?: '1' | '2';
1072
1227
  /** OAuth access token. */
1073
1228
  access_token?: string;
1074
1229
  /** Data format for response. */
1075
- alt?: string;
1230
+ alt?: 'json' | 'media' | 'proto';
1076
1231
  /** JSONP */
1077
1232
  callback?: string;
1078
1233
  /** Selector specifying which fields to include in a partial response. */
@@ -1101,11 +1256,11 @@ declare namespace gapi.client {
1101
1256
  /** Lists possible values for a given label name. */
1102
1257
  values(request?: {
1103
1258
  /** V1 error format. */
1104
- '$.xgafv'?: string;
1259
+ '$.xgafv'?: '1' | '2';
1105
1260
  /** OAuth access token. */
1106
1261
  access_token?: string;
1107
1262
  /** Data format for response. */
1108
- alt?: string;
1263
+ alt?: 'json' | 'media' | 'proto';
1109
1264
  /** JSONP */
1110
1265
  callback?: string;
1111
1266
  /** The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. */
@@ -1140,11 +1295,11 @@ declare namespace gapi.client {
1140
1295
  /** Lists metadata for metrics. */
1141
1296
  list(request?: {
1142
1297
  /** V1 error format. */
1143
- '$.xgafv'?: string;
1298
+ '$.xgafv'?: '1' | '2';
1144
1299
  /** OAuth access token. */
1145
1300
  access_token?: string;
1146
1301
  /** Data format for response. */
1147
- alt?: string;
1302
+ alt?: 'json' | 'media' | 'proto';
1148
1303
  /** JSONP */
1149
1304
  callback?: string;
1150
1305
  /** Selector specifying which fields to include in a partial response. */
@@ -1175,11 +1330,11 @@ declare namespace gapi.client {
1175
1330
  /** Lists labels for metrics. */
1176
1331
  labels(request: {
1177
1332
  /** V1 error format. */
1178
- '$.xgafv'?: string;
1333
+ '$.xgafv'?: '1' | '2';
1179
1334
  /** OAuth access token. */
1180
1335
  access_token?: string;
1181
1336
  /** Data format for response. */
1182
- alt?: string;
1337
+ alt?: 'json' | 'media' | 'proto';
1183
1338
  /** JSONP */
1184
1339
  callback?: string;
1185
1340
  /** Selector specifying which fields to include in a partial response. */
@@ -1206,11 +1361,11 @@ declare namespace gapi.client {
1206
1361
  labels(
1207
1362
  request: {
1208
1363
  /** V1 error format. */
1209
- '$.xgafv'?: string;
1364
+ '$.xgafv'?: '1' | '2';
1210
1365
  /** OAuth access token. */
1211
1366
  access_token?: string;
1212
1367
  /** Data format for response. */
1213
- alt?: string;
1368
+ alt?: 'json' | 'media' | 'proto';
1214
1369
  /** JSONP */
1215
1370
  callback?: string;
1216
1371
  /** Selector specifying which fields to include in a partial response. */
@@ -1237,11 +1392,11 @@ declare namespace gapi.client {
1237
1392
  /** Evaluate a PromQL query at a single point in time. */
1238
1393
  query(request: {
1239
1394
  /** V1 error format. */
1240
- '$.xgafv'?: string;
1395
+ '$.xgafv'?: '1' | '2';
1241
1396
  /** OAuth access token. */
1242
1397
  access_token?: string;
1243
1398
  /** Data format for response. */
1244
- alt?: string;
1399
+ alt?: 'json' | 'media' | 'proto';
1245
1400
  /** JSONP */
1246
1401
  callback?: string;
1247
1402
  /** Selector specifying which fields to include in a partial response. */
@@ -1268,11 +1423,11 @@ declare namespace gapi.client {
1268
1423
  query(
1269
1424
  request: {
1270
1425
  /** V1 error format. */
1271
- '$.xgafv'?: string;
1426
+ '$.xgafv'?: '1' | '2';
1272
1427
  /** OAuth access token. */
1273
1428
  access_token?: string;
1274
1429
  /** Data format for response. */
1275
- alt?: string;
1430
+ alt?: 'json' | 'media' | 'proto';
1276
1431
  /** JSONP */
1277
1432
  callback?: string;
1278
1433
  /** Selector specifying which fields to include in a partial response. */
@@ -1299,11 +1454,11 @@ declare namespace gapi.client {
1299
1454
  /** Lists exemplars relevant to a given PromQL query, */
1300
1455
  query_exemplars(request: {
1301
1456
  /** V1 error format. */
1302
- '$.xgafv'?: string;
1457
+ '$.xgafv'?: '1' | '2';
1303
1458
  /** OAuth access token. */
1304
1459
  access_token?: string;
1305
1460
  /** Data format for response. */
1306
- alt?: string;
1461
+ alt?: 'json' | 'media' | 'proto';
1307
1462
  /** JSONP */
1308
1463
  callback?: string;
1309
1464
  /** Selector specifying which fields to include in a partial response. */
@@ -1330,11 +1485,11 @@ declare namespace gapi.client {
1330
1485
  query_exemplars(
1331
1486
  request: {
1332
1487
  /** V1 error format. */
1333
- '$.xgafv'?: string;
1488
+ '$.xgafv'?: '1' | '2';
1334
1489
  /** OAuth access token. */
1335
1490
  access_token?: string;
1336
1491
  /** Data format for response. */
1337
- alt?: string;
1492
+ alt?: 'json' | 'media' | 'proto';
1338
1493
  /** JSONP */
1339
1494
  callback?: string;
1340
1495
  /** Selector specifying which fields to include in a partial response. */
@@ -1361,11 +1516,11 @@ declare namespace gapi.client {
1361
1516
  /** Evaluate a PromQL query with start, end time range. */
1362
1517
  query_range(request: {
1363
1518
  /** V1 error format. */
1364
- '$.xgafv'?: string;
1519
+ '$.xgafv'?: '1' | '2';
1365
1520
  /** OAuth access token. */
1366
1521
  access_token?: string;
1367
1522
  /** Data format for response. */
1368
- alt?: string;
1523
+ alt?: 'json' | 'media' | 'proto';
1369
1524
  /** JSONP */
1370
1525
  callback?: string;
1371
1526
  /** Selector specifying which fields to include in a partial response. */
@@ -1392,11 +1547,11 @@ declare namespace gapi.client {
1392
1547
  query_range(
1393
1548
  request: {
1394
1549
  /** V1 error format. */
1395
- '$.xgafv'?: string;
1550
+ '$.xgafv'?: '1' | '2';
1396
1551
  /** OAuth access token. */
1397
1552
  access_token?: string;
1398
1553
  /** Data format for response. */
1399
- alt?: string;
1554
+ alt?: 'json' | 'media' | 'proto';
1400
1555
  /** JSONP */
1401
1556
  callback?: string;
1402
1557
  /** Selector specifying which fields to include in a partial response. */
@@ -1423,11 +1578,11 @@ declare namespace gapi.client {
1423
1578
  /** Lists metadata for metrics. */
1424
1579
  series(request: {
1425
1580
  /** V1 error format. */
1426
- '$.xgafv'?: string;
1581
+ '$.xgafv'?: '1' | '2';
1427
1582
  /** OAuth access token. */
1428
1583
  access_token?: string;
1429
1584
  /** Data format for response. */
1430
- alt?: string;
1585
+ alt?: 'json' | 'media' | 'proto';
1431
1586
  /** JSONP */
1432
1587
  callback?: string;
1433
1588
  /** Selector specifying which fields to include in a partial response. */
@@ -1454,11 +1609,11 @@ declare namespace gapi.client {
1454
1609
  series(
1455
1610
  request: {
1456
1611
  /** V1 error format. */
1457
- '$.xgafv'?: string;
1612
+ '$.xgafv'?: '1' | '2';
1458
1613
  /** OAuth access token. */
1459
1614
  access_token?: string;
1460
1615
  /** Data format for response. */
1461
- alt?: string;
1616
+ alt?: 'json' | 'media' | 'proto';
1462
1617
  /** JSONP */
1463
1618
  callback?: string;
1464
1619
  /** Selector specifying which fields to include in a partial response. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.monitoring-v1",
3
- "version": "0.1.20260309",
3
+ "version": "0.1.20260528",
4
4
  "description": "TypeScript typings for Cloud Monitoring API v1",
5
5
  "repository": {
6
6
  "type": "git",
package/readme.md CHANGED
@@ -11,6 +11,18 @@ Install typings for Cloud Monitoring API:
11
11
  npm install @types/gapi.client.monitoring-v1 --save-dev
12
12
  ```
13
13
 
14
+ ## TypeScript 6.0+
15
+
16
+ TypeScript 6.0 changed `types` to default to `[]`. You must now explicitly list type packages in `tsconfig.json`:
17
+
18
+ ```json
19
+ {
20
+ "compilerOptions": {
21
+ "types": ["gapi", "gapi.auth2", "gapi.client", "gapi.client.monitoring-v1"]
22
+ }
23
+ }
24
+ ```
25
+
14
26
  ## Usage
15
27
 
16
28
  You need to initialize Google API client in your code: