@maxim_mazurok/gapi.client.monitoring-v1 0.1.20260310 → 0.1.20260604

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 +253 -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: 20260310
12
+ // Revision: 20260604
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,9 +231,17 @@ 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;
241
+ /** The maximum value for the x-axis. */
242
+ xMax?: number;
243
+ /** The minimum value for the x-axis. */
244
+ xMin?: number;
184
245
  }
185
246
  interface DroppedLabels {
186
247
  /** Map from label to its value, for all labels dropped in any aggregation. */
@@ -201,7 +262,34 @@ declare namespace gapi.client {
201
262
  /** Whether or not to show the events on the dashboard by default */
202
263
  enabled?: boolean;
203
264
  /** The type of event to display. */
204
- eventType?: string;
265
+ eventType?:
266
+ | 'EVENT_TYPE_UNSPECIFIED'
267
+ | 'GKE_WORKLOAD_DEPLOYMENT'
268
+ | 'GKE_POD_CRASH'
269
+ | 'GKE_POD_UNSCHEDULABLE'
270
+ | 'GKE_CONTAINER_CREATION_FAILED'
271
+ | 'GKE_CLUSTER_CREATE_DELETE'
272
+ | 'GKE_CLUSTER_UPDATE'
273
+ | 'GKE_NODE_POOL_UPDATE'
274
+ | 'GKE_CLUSTER_AUTOSCALER'
275
+ | 'GKE_POD_AUTOSCALER'
276
+ | 'VM_TERMINATION'
277
+ | 'VM_GUEST_OS_ERROR'
278
+ | 'VM_START_FAILED'
279
+ | 'MIG_UPDATE'
280
+ | 'MIG_AUTOSCALER'
281
+ | 'CLOUD_RUN_DEPLOYMENT'
282
+ | 'CLOUD_SQL_FAILOVER'
283
+ | 'CLOUD_SQL_START_STOP'
284
+ | 'CLOUD_SQL_STORAGE'
285
+ | 'UPTIME_CHECK_FAILURE'
286
+ | 'CLOUD_ALERTING_ALERT'
287
+ | 'SERVICE_HEALTH_INCIDENT'
288
+ | 'SAP_BACKINT'
289
+ | 'SAP_AVAILABILITY'
290
+ | 'SAP_OPERATIONS'
291
+ | 'INTERCONNECT_MAINTENANCE_STARTED'
292
+ | 'INTERCONNECT_MAINTENANCE_COMPLETED';
205
293
  /** string filtering the events - event dependant. Example values: "resource.labels.pod_name = 'pod-1'" "protoPayload.authenticationInfo.principalEmail='user@example.com'" */
206
294
  filter?: string;
207
295
  /** 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 +297,36 @@ declare namespace gapi.client {
209
297
  }
210
298
  interface Field {
211
299
  /** The field cardinality. */
212
- cardinality?: string;
300
+ cardinality?:
301
+ | 'CARDINALITY_UNKNOWN'
302
+ | 'CARDINALITY_OPTIONAL'
303
+ | 'CARDINALITY_REQUIRED'
304
+ | 'CARDINALITY_REPEATED';
213
305
  /** The string value of the default value of this field. Proto2 syntax only. */
214
306
  defaultValue?: string;
215
307
  /** The field JSON name. */
216
308
  jsonName?: string;
217
309
  /** The field type. */
218
- kind?: string;
310
+ kind?:
311
+ | 'TYPE_UNKNOWN'
312
+ | 'TYPE_DOUBLE'
313
+ | 'TYPE_FLOAT'
314
+ | 'TYPE_INT64'
315
+ | 'TYPE_UINT64'
316
+ | 'TYPE_INT32'
317
+ | 'TYPE_FIXED64'
318
+ | 'TYPE_FIXED32'
319
+ | 'TYPE_BOOL'
320
+ | 'TYPE_STRING'
321
+ | 'TYPE_GROUP'
322
+ | 'TYPE_MESSAGE'
323
+ | 'TYPE_BYTES'
324
+ | 'TYPE_UINT32'
325
+ | 'TYPE_ENUM'
326
+ | 'TYPE_SFIXED32'
327
+ | 'TYPE_SFIXED64'
328
+ | 'TYPE_SINT32'
329
+ | 'TYPE_SINT64';
219
330
  /** The field name. */
220
331
  name?: string;
221
332
  /** The field number. */
@@ -251,7 +362,7 @@ declare namespace gapi.client {
251
362
  /** The HTTP request/response body as raw binary. */
252
363
  data?: string;
253
364
  /** Application specific response metadata. Must be set in the first response for streaming APIs. */
254
- extensions?: Array<{[P in string]: any}>;
365
+ extensions?: {[P in string]: any}[];
255
366
  }
256
367
  interface IncidentList {
257
368
  /** 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 +444,12 @@ declare namespace gapi.client {
333
444
  /** The time when the batch request was received. */
334
445
  createTime?: string;
335
446
  /** Current state of the batch operation. */
336
- state?: string;
447
+ state?:
448
+ | 'STATE_UNSPECIFIED'
449
+ | 'CREATED'
450
+ | 'RUNNING'
451
+ | 'DONE'
452
+ | 'CANCELLED';
337
453
  /** The time when the operation result was last updated. */
338
454
  updateTime?: string;
339
455
  }
@@ -355,17 +471,23 @@ declare namespace gapi.client {
355
471
  }
356
472
  interface PickTimeSeriesFilter {
357
473
  /** How to use the ranking to select time series that pass through the filter. */
358
- direction?: string;
474
+ direction?: 'DIRECTION_UNSPECIFIED' | 'TOP' | 'BOTTOM';
359
475
  /** Select the top N streams/time series within this time interval */
360
476
  interval?: Interval;
361
477
  /** How many time series to allow to pass through the filter. */
362
478
  numTimeSeries?: number;
363
479
  /** 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;
480
+ rankingMethod?:
481
+ | 'METHOD_UNSPECIFIED'
482
+ | 'METHOD_MEAN'
483
+ | 'METHOD_MAX'
484
+ | 'METHOD_MIN'
485
+ | 'METHOD_SUM'
486
+ | 'METHOD_LATEST';
365
487
  }
366
488
  interface PieChart {
367
489
  /** Required. Indicates the visualization type for the PieChart. */
368
- chartType?: string;
490
+ chartType?: 'PIE_CHART_TYPE_UNSPECIFIED' | 'PIE' | 'DONUT';
369
491
  /** Required. The queries for the chart's data. */
370
492
  dataSets?: PieChartDataSet[];
371
493
  /** Optional. Indicates whether or not the pie chart should show slices' labels */
@@ -467,7 +589,7 @@ declare namespace gapi.client {
467
589
  }
468
590
  interface SingleViewGroup {
469
591
  /** Optional. Determines how the widget selector will be displayed. */
470
- displayType?: string;
592
+ displayType?: 'DISPLAY_TYPE_UNSPECIFIED' | 'DROPDOWN' | 'TAB';
471
593
  }
472
594
  interface SourceContext {
473
595
  /** The path-qualified name of the .proto file that contained the associated protobuf element. For example: "google/protobuf/source_context.proto". */
@@ -478,22 +600,25 @@ declare namespace gapi.client {
478
600
  spanName?: string;
479
601
  }
480
602
  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. */
603
+ /** 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
604
  minAlignmentPeriod?: string;
483
605
  /** Required. The type of sparkchart to show in this chartView. */
484
- sparkChartType?: string;
606
+ sparkChartType?:
607
+ | 'SPARK_CHART_TYPE_UNSPECIFIED'
608
+ | 'SPARK_LINE'
609
+ | 'SPARK_BAR';
485
610
  }
486
611
  interface StatisticalTimeSeriesFilter {
487
612
  /** How many time series to output. */
488
613
  numTimeSeries?: number;
489
614
  /** 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;
615
+ rankingMethod?: 'METHOD_UNSPECIFIED' | 'METHOD_CLUSTER_OUTLIER';
491
616
  }
492
617
  interface Status {
493
618
  /** The status code, which should be an enum value of google.rpc.Code. */
494
619
  code?: number;
495
620
  /** 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}>;
621
+ details?: {[P in string]: any}[];
497
622
  /** 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
623
  message?: string;
499
624
  }
@@ -517,7 +642,7 @@ declare namespace gapi.client {
517
642
  }
518
643
  interface TemplateVariableCondition {
519
644
  /** 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;
645
+ comparator?: 'COMPARATOR_UNSPECIFIED' | 'REGEX_FULL_MATCH';
521
646
  /** The template variable whose value is evaluated. */
522
647
  templateVariable?: string;
523
648
  /** 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 +652,7 @@ declare namespace gapi.client {
527
652
  /** The text content to be displayed. */
528
653
  content?: string;
529
654
  /** How the text content is formatted. */
530
- format?: string;
655
+ format?: 'FORMAT_UNSPECIFIED' | 'MARKDOWN' | 'RAW';
531
656
  /** How the text is styled */
532
657
  style?: TextStyle;
533
658
  }
@@ -535,27 +660,60 @@ declare namespace gapi.client {
535
660
  /** The background color as a hex string. "#RRGGBB" or "#RGB" */
536
661
  backgroundColor?: string;
537
662
  /** Font sizes for both the title and content. The title will still be larger relative to the content. */
538
- fontSize?: string;
663
+ fontSize?:
664
+ | 'FONT_SIZE_UNSPECIFIED'
665
+ | 'FS_EXTRA_SMALL'
666
+ | 'FS_SMALL'
667
+ | 'FS_MEDIUM'
668
+ | 'FS_LARGE'
669
+ | 'FS_EXTRA_LARGE';
539
670
  /** The horizontal alignment of both the title and content */
540
- horizontalAlignment?: string;
671
+ horizontalAlignment?:
672
+ | 'HORIZONTAL_ALIGNMENT_UNSPECIFIED'
673
+ | 'H_LEFT'
674
+ | 'H_CENTER'
675
+ | 'H_RIGHT';
541
676
  /** The amount of padding around the widget */
542
- padding?: string;
677
+ padding?:
678
+ | 'PADDING_SIZE_UNSPECIFIED'
679
+ | 'P_EXTRA_SMALL'
680
+ | 'P_SMALL'
681
+ | 'P_MEDIUM'
682
+ | 'P_LARGE'
683
+ | 'P_EXTRA_LARGE';
543
684
  /** The pointer location for this widget (also sometimes called a "tail") */
544
- pointerLocation?: string;
685
+ pointerLocation?:
686
+ | 'POINTER_LOCATION_UNSPECIFIED'
687
+ | 'PL_TOP'
688
+ | 'PL_RIGHT'
689
+ | 'PL_BOTTOM'
690
+ | 'PL_LEFT'
691
+ | 'PL_TOP_LEFT'
692
+ | 'PL_TOP_RIGHT'
693
+ | 'PL_RIGHT_TOP'
694
+ | 'PL_RIGHT_BOTTOM'
695
+ | 'PL_BOTTOM_RIGHT'
696
+ | 'PL_BOTTOM_LEFT'
697
+ | 'PL_LEFT_BOTTOM'
698
+ | 'PL_LEFT_TOP';
545
699
  /** The text color as a hex string. "#RRGGBB" or "#RGB" */
546
700
  textColor?: string;
547
701
  /** The vertical alignment of both the title and content */
548
- verticalAlignment?: string;
702
+ verticalAlignment?:
703
+ | 'VERTICAL_ALIGNMENT_UNSPECIFIED'
704
+ | 'V_TOP'
705
+ | 'V_CENTER'
706
+ | 'V_BOTTOM';
549
707
  }
550
708
  interface Threshold {
551
709
  /** The state color for this threshold. Color is not allowed in a XyChart. */
552
- color?: string;
710
+ color?: 'COLOR_UNSPECIFIED' | 'YELLOW' | 'RED';
553
711
  /** The direction for the current threshold. Direction is not allowed in a XyChart. */
554
- direction?: string;
712
+ direction?: 'DIRECTION_UNSPECIFIED' | 'ABOVE' | 'BELOW';
555
713
  /** A label for the threshold. */
556
714
  label?: string;
557
715
  /** The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. */
558
- targetAxis?: string;
716
+ targetAxis?: 'TARGET_AXIS_UNSPECIFIED' | 'Y1' | 'Y2';
559
717
  /** The value of the threshold. The value should be defined in the native scale of the metric. */
560
718
  value?: number;
561
719
  }
@@ -608,6 +766,8 @@ declare namespace gapi.client {
608
766
  timeSeriesFilterRatio?: TimeSeriesFilterRatio;
609
767
  /** A query used to fetch time series with MQL. */
610
768
  timeSeriesQueryLanguage?: string;
769
+ /** Optional. Preview: Query for traces. This is a preview feature and may be subject to change before final release. */
770
+ traceQuery?: any;
611
771
  /** 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. */
612
772
  unitOverride?: string;
613
773
  }
@@ -617,8 +777,12 @@ declare namespace gapi.client {
617
777
  /** Required. The data displayed in this table. */
618
778
  dataSets?: TableDataSet[];
619
779
  /** Optional. Store rendering strategy */
620
- metricVisualization?: string;
780
+ metricVisualization?:
781
+ | 'METRIC_VISUALIZATION_UNSPECIFIED'
782
+ | 'NUMBER'
783
+ | 'BAR';
621
784
  }
785
+ interface TraceQuery {}
622
786
  interface Treemap {
623
787
  /** 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. */
624
788
  dataSets?: TreemapDataSet[];
@@ -647,7 +811,7 @@ declare namespace gapi.client {
647
811
  /** The source context. */
648
812
  sourceContext?: SourceContext;
649
813
  /** The source syntax. */
650
- syntax?: string;
814
+ syntax?: 'SYNTAX_PROTO2' | 'SYNTAX_PROTO3' | 'SYNTAX_EDITIONS';
651
815
  }
652
816
  interface VisibilityCondition {
653
817
  /** A condition whose evaluation is based on the value of a template variable. */
@@ -711,11 +875,11 @@ declare namespace gapi.client {
711
875
  /** Adds a MonitoredProject with the given project ID to the specified Metrics Scope. */
712
876
  create(request: {
713
877
  /** V1 error format. */
714
- '$.xgafv'?: string;
878
+ '$.xgafv'?: '1' | '2';
715
879
  /** OAuth access token. */
716
880
  access_token?: string;
717
881
  /** Data format for response. */
718
- alt?: string;
882
+ alt?: 'json' | 'media' | 'proto';
719
883
  /** JSONP */
720
884
  callback?: string;
721
885
  /** Selector specifying which fields to include in a partial response. */
@@ -740,11 +904,11 @@ declare namespace gapi.client {
740
904
  create(
741
905
  request: {
742
906
  /** V1 error format. */
743
- '$.xgafv'?: string;
907
+ '$.xgafv'?: '1' | '2';
744
908
  /** OAuth access token. */
745
909
  access_token?: string;
746
910
  /** Data format for response. */
747
- alt?: string;
911
+ alt?: 'json' | 'media' | 'proto';
748
912
  /** JSONP */
749
913
  callback?: string;
750
914
  /** Selector specifying which fields to include in a partial response. */
@@ -769,11 +933,11 @@ declare namespace gapi.client {
769
933
  /** Deletes a MonitoredProject from the specified Metrics Scope. */
770
934
  delete(request?: {
771
935
  /** V1 error format. */
772
- '$.xgafv'?: string;
936
+ '$.xgafv'?: '1' | '2';
773
937
  /** OAuth access token. */
774
938
  access_token?: string;
775
939
  /** Data format for response. */
776
- alt?: string;
940
+ alt?: 'json' | 'media' | 'proto';
777
941
  /** JSONP */
778
942
  callback?: string;
779
943
  /** Selector specifying which fields to include in a partial response. */
@@ -798,11 +962,11 @@ declare namespace gapi.client {
798
962
  /** Returns a specific Metrics Scope, including the list of projects monitored by the specified Metrics Scope. */
799
963
  get(request?: {
800
964
  /** V1 error format. */
801
- '$.xgafv'?: string;
965
+ '$.xgafv'?: '1' | '2';
802
966
  /** OAuth access token. */
803
967
  access_token?: string;
804
968
  /** Data format for response. */
805
- alt?: string;
969
+ alt?: 'json' | 'media' | 'proto';
806
970
  /** JSONP */
807
971
  callback?: string;
808
972
  /** Selector specifying which fields to include in a partial response. */
@@ -825,11 +989,11 @@ declare namespace gapi.client {
825
989
  /** 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
990
  listMetricsScopesByMonitoredProject(request?: {
827
991
  /** V1 error format. */
828
- '$.xgafv'?: string;
992
+ '$.xgafv'?: '1' | '2';
829
993
  /** OAuth access token. */
830
994
  access_token?: string;
831
995
  /** Data format for response. */
832
- alt?: string;
996
+ alt?: 'json' | 'media' | 'proto';
833
997
  /** JSONP */
834
998
  callback?: string;
835
999
  /** Selector specifying which fields to include in a partial response. */
@@ -861,11 +1025,11 @@ declare namespace gapi.client {
861
1025
  /** 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
1026
  get(request?: {
863
1027
  /** V1 error format. */
864
- '$.xgafv'?: string;
1028
+ '$.xgafv'?: '1' | '2';
865
1029
  /** OAuth access token. */
866
1030
  access_token?: string;
867
1031
  /** Data format for response. */
868
- alt?: string;
1032
+ alt?: 'json' | 'media' | 'proto';
869
1033
  /** JSONP */
870
1034
  callback?: string;
871
1035
  /** Selector specifying which fields to include in a partial response. */
@@ -890,11 +1054,11 @@ declare namespace gapi.client {
890
1054
  /** 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
1055
  create(request: {
892
1056
  /** V1 error format. */
893
- '$.xgafv'?: string;
1057
+ '$.xgafv'?: '1' | '2';
894
1058
  /** OAuth access token. */
895
1059
  access_token?: string;
896
1060
  /** Data format for response. */
897
- alt?: string;
1061
+ alt?: 'json' | 'media' | 'proto';
898
1062
  /** JSONP */
899
1063
  callback?: string;
900
1064
  /** Selector specifying which fields to include in a partial response. */
@@ -921,11 +1085,11 @@ declare namespace gapi.client {
921
1085
  create(
922
1086
  request: {
923
1087
  /** V1 error format. */
924
- '$.xgafv'?: string;
1088
+ '$.xgafv'?: '1' | '2';
925
1089
  /** OAuth access token. */
926
1090
  access_token?: string;
927
1091
  /** Data format for response. */
928
- alt?: string;
1092
+ alt?: 'json' | 'media' | 'proto';
929
1093
  /** JSONP */
930
1094
  callback?: string;
931
1095
  /** Selector specifying which fields to include in a partial response. */
@@ -952,11 +1116,11 @@ declare namespace gapi.client {
952
1116
  /** 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
1117
  delete(request?: {
954
1118
  /** V1 error format. */
955
- '$.xgafv'?: string;
1119
+ '$.xgafv'?: '1' | '2';
956
1120
  /** OAuth access token. */
957
1121
  access_token?: string;
958
1122
  /** Data format for response. */
959
- alt?: string;
1123
+ alt?: 'json' | 'media' | 'proto';
960
1124
  /** JSONP */
961
1125
  callback?: string;
962
1126
  /** Selector specifying which fields to include in a partial response. */
@@ -979,11 +1143,11 @@ declare namespace gapi.client {
979
1143
  /** 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
1144
  get(request?: {
981
1145
  /** V1 error format. */
982
- '$.xgafv'?: string;
1146
+ '$.xgafv'?: '1' | '2';
983
1147
  /** OAuth access token. */
984
1148
  access_token?: string;
985
1149
  /** Data format for response. */
986
- alt?: string;
1150
+ alt?: 'json' | 'media' | 'proto';
987
1151
  /** JSONP */
988
1152
  callback?: string;
989
1153
  /** Selector specifying which fields to include in a partial response. */
@@ -1006,11 +1170,11 @@ declare namespace gapi.client {
1006
1170
  /** 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
1171
  list(request?: {
1008
1172
  /** V1 error format. */
1009
- '$.xgafv'?: string;
1173
+ '$.xgafv'?: '1' | '2';
1010
1174
  /** OAuth access token. */
1011
1175
  access_token?: string;
1012
1176
  /** Data format for response. */
1013
- alt?: string;
1177
+ alt?: 'json' | 'media' | 'proto';
1014
1178
  /** JSONP */
1015
1179
  callback?: string;
1016
1180
  /** Selector specifying which fields to include in a partial response. */
@@ -1037,11 +1201,11 @@ declare namespace gapi.client {
1037
1201
  /** 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
1202
  patch(request: {
1039
1203
  /** V1 error format. */
1040
- '$.xgafv'?: string;
1204
+ '$.xgafv'?: '1' | '2';
1041
1205
  /** OAuth access token. */
1042
1206
  access_token?: string;
1043
1207
  /** Data format for response. */
1044
- alt?: string;
1208
+ alt?: 'json' | 'media' | 'proto';
1045
1209
  /** JSONP */
1046
1210
  callback?: string;
1047
1211
  /** Selector specifying which fields to include in a partial response. */
@@ -1068,11 +1232,11 @@ declare namespace gapi.client {
1068
1232
  patch(
1069
1233
  request: {
1070
1234
  /** V1 error format. */
1071
- '$.xgafv'?: string;
1235
+ '$.xgafv'?: '1' | '2';
1072
1236
  /** OAuth access token. */
1073
1237
  access_token?: string;
1074
1238
  /** Data format for response. */
1075
- alt?: string;
1239
+ alt?: 'json' | 'media' | 'proto';
1076
1240
  /** JSONP */
1077
1241
  callback?: string;
1078
1242
  /** Selector specifying which fields to include in a partial response. */
@@ -1101,11 +1265,11 @@ declare namespace gapi.client {
1101
1265
  /** Lists possible values for a given label name. */
1102
1266
  values(request?: {
1103
1267
  /** V1 error format. */
1104
- '$.xgafv'?: string;
1268
+ '$.xgafv'?: '1' | '2';
1105
1269
  /** OAuth access token. */
1106
1270
  access_token?: string;
1107
1271
  /** Data format for response. */
1108
- alt?: string;
1272
+ alt?: 'json' | 'media' | 'proto';
1109
1273
  /** JSONP */
1110
1274
  callback?: string;
1111
1275
  /** The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. */
@@ -1140,11 +1304,11 @@ declare namespace gapi.client {
1140
1304
  /** Lists metadata for metrics. */
1141
1305
  list(request?: {
1142
1306
  /** V1 error format. */
1143
- '$.xgafv'?: string;
1307
+ '$.xgafv'?: '1' | '2';
1144
1308
  /** OAuth access token. */
1145
1309
  access_token?: string;
1146
1310
  /** Data format for response. */
1147
- alt?: string;
1311
+ alt?: 'json' | 'media' | 'proto';
1148
1312
  /** JSONP */
1149
1313
  callback?: string;
1150
1314
  /** Selector specifying which fields to include in a partial response. */
@@ -1175,11 +1339,11 @@ declare namespace gapi.client {
1175
1339
  /** Lists labels for metrics. */
1176
1340
  labels(request: {
1177
1341
  /** V1 error format. */
1178
- '$.xgafv'?: string;
1342
+ '$.xgafv'?: '1' | '2';
1179
1343
  /** OAuth access token. */
1180
1344
  access_token?: string;
1181
1345
  /** Data format for response. */
1182
- alt?: string;
1346
+ alt?: 'json' | 'media' | 'proto';
1183
1347
  /** JSONP */
1184
1348
  callback?: string;
1185
1349
  /** Selector specifying which fields to include in a partial response. */
@@ -1206,11 +1370,11 @@ declare namespace gapi.client {
1206
1370
  labels(
1207
1371
  request: {
1208
1372
  /** V1 error format. */
1209
- '$.xgafv'?: string;
1373
+ '$.xgafv'?: '1' | '2';
1210
1374
  /** OAuth access token. */
1211
1375
  access_token?: string;
1212
1376
  /** Data format for response. */
1213
- alt?: string;
1377
+ alt?: 'json' | 'media' | 'proto';
1214
1378
  /** JSONP */
1215
1379
  callback?: string;
1216
1380
  /** Selector specifying which fields to include in a partial response. */
@@ -1237,11 +1401,11 @@ declare namespace gapi.client {
1237
1401
  /** Evaluate a PromQL query at a single point in time. */
1238
1402
  query(request: {
1239
1403
  /** V1 error format. */
1240
- '$.xgafv'?: string;
1404
+ '$.xgafv'?: '1' | '2';
1241
1405
  /** OAuth access token. */
1242
1406
  access_token?: string;
1243
1407
  /** Data format for response. */
1244
- alt?: string;
1408
+ alt?: 'json' | 'media' | 'proto';
1245
1409
  /** JSONP */
1246
1410
  callback?: string;
1247
1411
  /** Selector specifying which fields to include in a partial response. */
@@ -1268,11 +1432,11 @@ declare namespace gapi.client {
1268
1432
  query(
1269
1433
  request: {
1270
1434
  /** V1 error format. */
1271
- '$.xgafv'?: string;
1435
+ '$.xgafv'?: '1' | '2';
1272
1436
  /** OAuth access token. */
1273
1437
  access_token?: string;
1274
1438
  /** Data format for response. */
1275
- alt?: string;
1439
+ alt?: 'json' | 'media' | 'proto';
1276
1440
  /** JSONP */
1277
1441
  callback?: string;
1278
1442
  /** Selector specifying which fields to include in a partial response. */
@@ -1299,11 +1463,11 @@ declare namespace gapi.client {
1299
1463
  /** Lists exemplars relevant to a given PromQL query, */
1300
1464
  query_exemplars(request: {
1301
1465
  /** V1 error format. */
1302
- '$.xgafv'?: string;
1466
+ '$.xgafv'?: '1' | '2';
1303
1467
  /** OAuth access token. */
1304
1468
  access_token?: string;
1305
1469
  /** Data format for response. */
1306
- alt?: string;
1470
+ alt?: 'json' | 'media' | 'proto';
1307
1471
  /** JSONP */
1308
1472
  callback?: string;
1309
1473
  /** Selector specifying which fields to include in a partial response. */
@@ -1330,11 +1494,11 @@ declare namespace gapi.client {
1330
1494
  query_exemplars(
1331
1495
  request: {
1332
1496
  /** V1 error format. */
1333
- '$.xgafv'?: string;
1497
+ '$.xgafv'?: '1' | '2';
1334
1498
  /** OAuth access token. */
1335
1499
  access_token?: string;
1336
1500
  /** Data format for response. */
1337
- alt?: string;
1501
+ alt?: 'json' | 'media' | 'proto';
1338
1502
  /** JSONP */
1339
1503
  callback?: string;
1340
1504
  /** Selector specifying which fields to include in a partial response. */
@@ -1361,11 +1525,11 @@ declare namespace gapi.client {
1361
1525
  /** Evaluate a PromQL query with start, end time range. */
1362
1526
  query_range(request: {
1363
1527
  /** V1 error format. */
1364
- '$.xgafv'?: string;
1528
+ '$.xgafv'?: '1' | '2';
1365
1529
  /** OAuth access token. */
1366
1530
  access_token?: string;
1367
1531
  /** Data format for response. */
1368
- alt?: string;
1532
+ alt?: 'json' | 'media' | 'proto';
1369
1533
  /** JSONP */
1370
1534
  callback?: string;
1371
1535
  /** Selector specifying which fields to include in a partial response. */
@@ -1392,11 +1556,11 @@ declare namespace gapi.client {
1392
1556
  query_range(
1393
1557
  request: {
1394
1558
  /** V1 error format. */
1395
- '$.xgafv'?: string;
1559
+ '$.xgafv'?: '1' | '2';
1396
1560
  /** OAuth access token. */
1397
1561
  access_token?: string;
1398
1562
  /** Data format for response. */
1399
- alt?: string;
1563
+ alt?: 'json' | 'media' | 'proto';
1400
1564
  /** JSONP */
1401
1565
  callback?: string;
1402
1566
  /** Selector specifying which fields to include in a partial response. */
@@ -1423,11 +1587,11 @@ declare namespace gapi.client {
1423
1587
  /** Lists metadata for metrics. */
1424
1588
  series(request: {
1425
1589
  /** V1 error format. */
1426
- '$.xgafv'?: string;
1590
+ '$.xgafv'?: '1' | '2';
1427
1591
  /** OAuth access token. */
1428
1592
  access_token?: string;
1429
1593
  /** Data format for response. */
1430
- alt?: string;
1594
+ alt?: 'json' | 'media' | 'proto';
1431
1595
  /** JSONP */
1432
1596
  callback?: string;
1433
1597
  /** Selector specifying which fields to include in a partial response. */
@@ -1454,11 +1618,11 @@ declare namespace gapi.client {
1454
1618
  series(
1455
1619
  request: {
1456
1620
  /** V1 error format. */
1457
- '$.xgafv'?: string;
1621
+ '$.xgafv'?: '1' | '2';
1458
1622
  /** OAuth access token. */
1459
1623
  access_token?: string;
1460
1624
  /** Data format for response. */
1461
- alt?: string;
1625
+ alt?: 'json' | 'media' | 'proto';
1462
1626
  /** JSONP */
1463
1627
  callback?: string;
1464
1628
  /** 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.20260310",
3
+ "version": "0.1.20260604",
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: