@maxim_mazurok/gapi.client.monitoring-v1 0.0.20220806

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.
package/index.d.ts ADDED
@@ -0,0 +1,1310 @@
1
+ /* Type definitions for non-npm package Cloud Monitoring API v1 0.0 */
2
+ // Project: https://cloud.google.com/monitoring/api/
3
+ // Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
4
+ // Nick Amoscato <https://github.com/namoscato>
5
+ // Declan Vong <https://github.com/declanvong>
6
+ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
7
+ // TypeScript Version: 2.8
8
+
9
+ // IMPORTANT
10
+ // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
11
+ // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
12
+ // Generated from: https://monitoring.googleapis.com/$discovery/rest?version=v1
13
+ // Revision: 20220806
14
+
15
+ /// <reference types="gapi.client" />
16
+
17
+ declare namespace gapi.client {
18
+ /** Load Cloud Monitoring API v1 */
19
+ function load(urlOrObject: "https://monitoring.googleapis.com/$discovery/rest?version=v1"): Promise<void>;
20
+ /** @deprecated Please load APIs with discovery documents. */
21
+ function load(name: "monitoring", version: "v1"): Promise<void>;
22
+ /** @deprecated Please load APIs with discovery documents. */
23
+ function load(name: "monitoring", version: "v1", callback: () => any): void;
24
+
25
+ namespace monitoring {
26
+ interface Aggregation {
27
+ /**
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
29
+ * 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
30
+ * 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
31
+ * weeks.
32
+ */
33
+ alignmentPeriod?: string;
34
+ /**
35
+ * 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
36
+ * 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
37
+ * 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)
38
+ * 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
39
+ * must also be specified; otherwise, an error is returned.
40
+ */
41
+ crossSeriesReducer?: string;
42
+ /**
43
+ * 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
44
+ * 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
45
+ * 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
46
+ * 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
47
+ * into a single output time series. If cross_series_reducer is not defined, this field is ignored.
48
+ */
49
+ groupByFields?: string[];
50
+ /**
51
+ * 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
52
+ * 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
53
+ * 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
54
+ * 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
55
+ * specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned.
56
+ */
57
+ perSeriesAligner?: string;
58
+ }
59
+ interface AlertChart {
60
+ /** Required. The resource name of the alert policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] */
61
+ name?: string;
62
+ }
63
+ interface Axis {
64
+ /** The label of the axis. */
65
+ label?: string;
66
+ /** The axis scale. By default, a linear scale is used. */
67
+ scale?: string;
68
+ }
69
+ interface ChartOptions {
70
+ /** The chart mode. */
71
+ mode?: string;
72
+ }
73
+ interface CollapsibleGroup {
74
+ /** The collapsed state of the widget on first page load. */
75
+ collapsed?: boolean;
76
+ }
77
+ interface Column {
78
+ /**
79
+ * 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
80
+ * on the screen. If omitted, a value of 1 is used while rendering.
81
+ */
82
+ weight?: string;
83
+ /** The display widgets arranged vertically in this column. */
84
+ widgets?: Widget[];
85
+ }
86
+ interface ColumnLayout {
87
+ /** The columns of content to display. */
88
+ columns?: Column[];
89
+ }
90
+ interface Dashboard {
91
+ /** The content is divided into equally spaced columns and the widgets are arranged vertically. */
92
+ columnLayout?: ColumnLayout;
93
+ /** Filters to reduce the amount of data charted based on the filter criteria. */
94
+ dashboardFilters?: DashboardFilter[];
95
+ /** Required. The mutable, human-readable name. */
96
+ displayName?: string;
97
+ /**
98
+ * 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
99
+ * 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
100
+ * configuration. The field should not be passed during dashboard creation.
101
+ */
102
+ etag?: string;
103
+ /** Content is arranged with a basic layout that re-flows a simple list of informational elements like widgets or tiles. */
104
+ gridLayout?: GridLayout;
105
+ /** Labels applied to the dashboard */
106
+ labels?: { [P in string]: string };
107
+ /** The content is arranged as a grid of tiles, with each content widget occupying one or more grid blocks. */
108
+ mosaicLayout?: MosaicLayout;
109
+ /** Immutable. The resource name of the dashboard. */
110
+ name?: string;
111
+ /** The content is divided into equally spaced rows and the widgets are arranged horizontally. */
112
+ rowLayout?: RowLayout;
113
+ }
114
+ interface DashboardFilter {
115
+ /** The specified filter type */
116
+ filterType?: string;
117
+ /** Required. The key for the label */
118
+ labelKey?: string;
119
+ /** A variable-length string value. */
120
+ stringValue?: string;
121
+ /** The placeholder text that can be referenced in a filter string or MQL query. If omitted, the dashboard filter will be applied to all relevant widgets in the dashboard. */
122
+ templateVariable?: string;
123
+ }
124
+ interface DataSet {
125
+ /** 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. */
126
+ legendTemplate?: string;
127
+ /**
128
+ * 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
129
+ * 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.
130
+ */
131
+ minAlignmentPeriod?: string;
132
+ /** How this data should be plotted on the chart. */
133
+ plotType?: string;
134
+ /** Optional. The target axis to use for plotting the metric. */
135
+ targetAxis?: string;
136
+ /** Required. Fields for querying time series data from the Stackdriver metrics API. */
137
+ timeSeriesQuery?: TimeSeriesQuery;
138
+ }
139
+ interface DroppedLabels {
140
+ /** Map from label to its value, for all labels dropped in any aggregation. */
141
+ label?: { [P in string]: string };
142
+ }
143
+ // tslint:disable-next-line:no-empty-interface
144
+ interface Empty {
145
+ }
146
+ interface Field {
147
+ /** The field cardinality. */
148
+ cardinality?: string;
149
+ /** The string value of the default value of this field. Proto2 syntax only. */
150
+ defaultValue?: string;
151
+ /** The field JSON name. */
152
+ jsonName?: string;
153
+ /** The field type. */
154
+ kind?: string;
155
+ /** The field name. */
156
+ name?: string;
157
+ /** The field number. */
158
+ number?: number;
159
+ /** 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. */
160
+ oneofIndex?: number;
161
+ /** The protocol buffer options. */
162
+ options?: Option[];
163
+ /** Whether to use alternative packed wire representation. */
164
+ packed?: boolean;
165
+ /** The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp". */
166
+ typeUrl?: string;
167
+ }
168
+ interface GaugeView {
169
+ /** The lower bound for this gauge chart. The value of the chart should always be greater than or equal to this. */
170
+ lowerBound?: number;
171
+ /** The upper bound for this gauge chart. The value of the chart should always be less than or equal to this. */
172
+ upperBound?: number;
173
+ }
174
+ interface GridLayout {
175
+ /** 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. */
176
+ columns?: string;
177
+ /** The informational elements that are arranged into the columns row-first. */
178
+ widgets?: Widget[];
179
+ }
180
+ interface HttpBody {
181
+ /** The HTTP Content-Type header value specifying the content type of the body. */
182
+ contentType?: string;
183
+ /** The HTTP request/response body as raw binary. */
184
+ data?: string;
185
+ /** Application specific response metadata. Must be set in the first response for streaming APIs. */
186
+ extensions?: Array<{ [P in string]: any }>;
187
+ }
188
+ interface ListDashboardsResponse {
189
+ /** The list of requested dashboards. */
190
+ dashboards?: Dashboard[];
191
+ /**
192
+ * 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
193
+ * method.
194
+ */
195
+ nextPageToken?: string;
196
+ }
197
+ interface ListLabelsRequest {
198
+ /** The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. */
199
+ end?: string;
200
+ /** A list of matchers encoded in the Prometheus label matcher format to constrain the values to series that satisfy them. */
201
+ match?: string;
202
+ /** The start time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. */
203
+ start?: string;
204
+ }
205
+ interface ListMetricsScopesByMonitoredProjectResponse {
206
+ /** A set of all metrics scopes that the specified monitored project has been added to. */
207
+ metricsScopes?: MetricsScope[];
208
+ }
209
+ interface LogsPanel {
210
+ /**
211
+ * A filter that chooses which log entries to return. See Advanced Logs Queries (https://cloud.google.com/logging/docs/view/advanced-queries). Only log entries that match the filter
212
+ * are returned. An empty filter matches all log entries.
213
+ */
214
+ filter?: string;
215
+ /** The names of logging resources to collect logs for. Currently only projects are supported. If empty, the widget will default to the host project. */
216
+ resourceNames?: string[];
217
+ }
218
+ interface MetricsScope {
219
+ /** Output only. The time when this Metrics Scope was created. */
220
+ createTime?: string;
221
+ /** Output only. The list of projects monitored by this Metrics Scope. */
222
+ monitoredProjects?: MonitoredProject[];
223
+ /**
224
+ * Immutable. The resource name of the Monitoring Metrics Scope. On input, the resource name can be specified with the scoping project ID or number. On output, the resource name is
225
+ * specified with the scoping project number. Example: locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}
226
+ */
227
+ name?: string;
228
+ /** Output only. The time when this Metrics Scope record was last updated. */
229
+ updateTime?: string;
230
+ }
231
+ interface MonitoredProject {
232
+ /** Output only. The time when this MonitoredProject was created. */
233
+ createTime?: string;
234
+ /**
235
+ * Immutable. The resource name of the MonitoredProject. On input, the resource name includes the scoping project ID and monitored project ID. On output, it contains the equivalent
236
+ * project numbers. Example: locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}/projects/{MONITORED_PROJECT_ID_OR_NUMBER}
237
+ */
238
+ name?: string;
239
+ }
240
+ interface MosaicLayout {
241
+ /** The number of columns in the mosaic grid. The number of columns must be between 1 and 12, inclusive. */
242
+ columns?: number;
243
+ /** The tiles to display. */
244
+ tiles?: Tile[];
245
+ }
246
+ interface Operation {
247
+ /** If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available. */
248
+ done?: boolean;
249
+ /** The error result of the operation in case of failure or cancellation. */
250
+ error?: Status;
251
+ /**
252
+ * Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such
253
+ * metadata. Any method that returns a long-running operation should document the metadata type, if any.
254
+ */
255
+ metadata?: { [P in string]: any };
256
+ /**
257
+ * The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending
258
+ * with operations/{unique_id}.
259
+ */
260
+ name?: string;
261
+ /**
262
+ * The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original
263
+ * method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name.
264
+ * For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
265
+ */
266
+ response?: { [P in string]: any };
267
+ }
268
+ interface OperationMetadata {
269
+ /** The time when the batch request was received. */
270
+ createTime?: string;
271
+ /** Current state of the batch operation. */
272
+ state?: string;
273
+ /** The time when the operation result was last updated. */
274
+ updateTime?: string;
275
+ }
276
+ interface Option {
277
+ /**
278
+ * 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
279
+ * fully-qualified name. For example, "google.api.http".
280
+ */
281
+ name?: string;
282
+ /**
283
+ * 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
284
+ * enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.
285
+ */
286
+ value?: { [P in string]: any };
287
+ }
288
+ interface PickTimeSeriesFilter {
289
+ /** How to use the ranking to select time series that pass through the filter. */
290
+ direction?: string;
291
+ /** How many time series to allow to pass through the filter. */
292
+ numTimeSeries?: number;
293
+ /** 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. */
294
+ rankingMethod?: string;
295
+ }
296
+ interface QueryInstantRequest {
297
+ /** A PromQL query string. Query lanauge documentation: https://prometheus.io/docs/prometheus/latest/querying/basics/. */
298
+ query?: string;
299
+ /** The single point in time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. */
300
+ time?: string;
301
+ /**
302
+ * An upper bound timeout for the query. Either a Prometheus duration string (https://prometheus.io/docs/prometheus/latest/querying/basics/#time-durations) or floating point seconds.
303
+ * This non-standard encoding must be used for compatibility with the open source API. Clients may still implement timeouts at the connection level while ignoring this field.
304
+ */
305
+ timeout?: string;
306
+ }
307
+ interface QueryRangeRequest {
308
+ /** The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. */
309
+ end?: string;
310
+ /** A PromQL query string. Query lanauge documentation: https://prometheus.io/docs/prometheus/latest/querying/basics/. */
311
+ query?: string;
312
+ /** The start time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. */
313
+ start?: string;
314
+ /**
315
+ * The resolution of query result. Either a Prometheus duration string (https://prometheus.io/docs/prometheus/latest/querying/basics/#time-durations) or floating point seconds. This
316
+ * non-standard encoding must be used for compatibility with the open source API. Clients may still implement timeouts at the connection level while ignoring this field.
317
+ */
318
+ step?: string;
319
+ /**
320
+ * An upper bound timeout for the query. Either a Prometheus duration string (https://prometheus.io/docs/prometheus/latest/querying/basics/#time-durations) or floating point seconds.
321
+ * This non-standard encoding must be used for compatibility with the open source API. Clients may still implement timeouts at the connection level while ignoring this field.
322
+ */
323
+ timeout?: string;
324
+ }
325
+ interface QuerySeriesRequest {
326
+ /** The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. */
327
+ end?: string;
328
+ /** The start time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. */
329
+ start?: string;
330
+ }
331
+ interface RatioPart {
332
+ /** By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data. */
333
+ aggregation?: Aggregation;
334
+ /** Required. The monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies the metric types, resources, and projects to query. */
335
+ filter?: string;
336
+ }
337
+ interface Row {
338
+ /**
339
+ * 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
340
+ * screen. If omitted, a value of 1 is used while rendering.
341
+ */
342
+ weight?: string;
343
+ /** The display widgets arranged horizontally in this row. */
344
+ widgets?: Widget[];
345
+ }
346
+ interface RowLayout {
347
+ /** The rows of content to display. */
348
+ rows?: Row[];
349
+ }
350
+ interface Scorecard {
351
+ /** Will cause the scorecard to show a gauge chart. */
352
+ gaugeView?: GaugeView;
353
+ /** Will cause the scorecard to show a spark chart. */
354
+ sparkChartView?: SparkChartView;
355
+ /**
356
+ * 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
357
+ * 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
358
+ * 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
359
+ * thresholds: { value: 90, category: 'DANGER', trigger: 'ABOVE', }, { value: 70, category: 'WARNING', trigger: 'ABOVE', }, { value: 10, category: 'DANGER', trigger: 'BELOW', }, {
360
+ * 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
361
+ * 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
362
+ * DANGER state.
363
+ */
364
+ thresholds?: Threshold[];
365
+ /** Required. Fields for querying time series data from the Stackdriver metrics API. */
366
+ timeSeriesQuery?: TimeSeriesQuery;
367
+ }
368
+ interface SourceContext {
369
+ /** The path-qualified name of the .proto file that contained the associated protobuf element. For example: "google/protobuf/source_context.proto". */
370
+ fileName?: string;
371
+ }
372
+ interface SpanContext {
373
+ /**
374
+ * 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
375
+ * 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.
376
+ */
377
+ spanName?: string;
378
+ }
379
+ interface SparkChartView {
380
+ /**
381
+ * 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
382
+ * 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.
383
+ */
384
+ minAlignmentPeriod?: string;
385
+ /** Required. The type of sparkchart to show in this chartView. */
386
+ sparkChartType?: string;
387
+ }
388
+ interface StatisticalTimeSeriesFilter {
389
+ /** How many time series to output. */
390
+ numTimeSeries?: number;
391
+ /**
392
+ * 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
393
+ * that cannot be applied stream-by-stream, but rather require the full context of a request to evaluate time series.
394
+ */
395
+ rankingMethod?: string;
396
+ }
397
+ interface Status {
398
+ /** The status code, which should be an enum value of google.rpc.Code. */
399
+ code?: number;
400
+ /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
401
+ details?: Array<{ [P in string]: any }>;
402
+ /**
403
+ * 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
404
+ * client.
405
+ */
406
+ message?: string;
407
+ }
408
+ interface TableDataSet {
409
+ /**
410
+ * 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
411
+ * 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.
412
+ */
413
+ minAlignmentPeriod?: string;
414
+ /** Optional. Table display options for configuring how the table is rendered. */
415
+ tableDisplayOptions?: TableDisplayOptions;
416
+ /**
417
+ * Optional. 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
418
+ * value i.e. "${resource.labels.project_id}."
419
+ */
420
+ tableTemplate?: string;
421
+ /** Required. Fields for querying time series data from the Stackdriver metrics API. */
422
+ timeSeriesQuery?: TimeSeriesQuery;
423
+ }
424
+ interface TableDisplayOptions {
425
+ /** Optional. Columns to display in the table. Leave empty to display all available columns. Note: This field is for future features and is not currently used. */
426
+ shownColumns?: string[];
427
+ }
428
+ interface Text {
429
+ /** The text content to be displayed. */
430
+ content?: string;
431
+ /** How the text content is formatted. */
432
+ format?: string;
433
+ }
434
+ interface Threshold {
435
+ /** The state color for this threshold. Color is not allowed in a XyChart. */
436
+ color?: string;
437
+ /** The direction for the current threshold. Direction is not allowed in a XyChart. */
438
+ direction?: string;
439
+ /** A label for the threshold. */
440
+ label?: string;
441
+ /** The target axis to use for plotting the threshold. Target axis is not allowed in a Scorecard. */
442
+ targetAxis?: string;
443
+ /** The value of the threshold. The value should be defined in the native scale of the metric. */
444
+ value?: number;
445
+ }
446
+ interface Tile {
447
+ /** The height of the tile, measured in grid blocks. Tiles must have a minimum height of 1. */
448
+ height?: number;
449
+ /** The informational widget contained in the tile. For example an XyChart. */
450
+ widget?: Widget;
451
+ /** The width of the tile, measured in grid blocks. Tiles must have a minimum width of 1. */
452
+ width?: number;
453
+ /** 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. */
454
+ xPos?: number;
455
+ /** The zero-indexed position of the tile in grid blocks relative to the top edge of the grid. y_pos cannot be negative. */
456
+ yPos?: number;
457
+ }
458
+ interface TimeSeriesFilter {
459
+ /** By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data. */
460
+ aggregation?: Aggregation;
461
+ /** Required. The monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies the metric types, resources, and projects to query. */
462
+ filter?: string;
463
+ /** Ranking based time series filter. */
464
+ pickTimeSeriesFilter?: PickTimeSeriesFilter;
465
+ /** Apply a second aggregation after aggregation is applied. */
466
+ secondaryAggregation?: Aggregation;
467
+ /** Statistics based time series filter. Note: This field is deprecated and completely ignored by the API. */
468
+ statisticalTimeSeriesFilter?: StatisticalTimeSeriesFilter;
469
+ }
470
+ interface TimeSeriesFilterRatio {
471
+ /** The denominator of the ratio. */
472
+ denominator?: RatioPart;
473
+ /** The numerator of the ratio. */
474
+ numerator?: RatioPart;
475
+ /** Ranking based time series filter. */
476
+ pickTimeSeriesFilter?: PickTimeSeriesFilter;
477
+ /** Apply a second aggregation after the ratio is computed. */
478
+ secondaryAggregation?: Aggregation;
479
+ /** Statistics based time series filter. Note: This field is deprecated and completely ignored by the API. */
480
+ statisticalTimeSeriesFilter?: StatisticalTimeSeriesFilter;
481
+ }
482
+ interface TimeSeriesQuery {
483
+ /** Filter parameters to fetch time series. */
484
+ timeSeriesFilter?: TimeSeriesFilter;
485
+ /** Parameters to fetch a ratio between two time series filters. */
486
+ timeSeriesFilterRatio?: TimeSeriesFilterRatio;
487
+ /** A query used to fetch time series with MQL. */
488
+ timeSeriesQueryLanguage?: string;
489
+ /**
490
+ * 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
491
+ * (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors) field in MetricDescriptor.
492
+ */
493
+ unitOverride?: string;
494
+ }
495
+ interface TimeSeriesTable {
496
+ /** Required. The data displayed in this table. */
497
+ dataSets?: TableDataSet[];
498
+ /** Optional. Store rendering strategy */
499
+ metricVisualization?: string;
500
+ }
501
+ interface Type {
502
+ /** The list of fields. */
503
+ fields?: Field[];
504
+ /** The fully qualified message name. */
505
+ name?: string;
506
+ /** The list of types appearing in oneof definitions in this type. */
507
+ oneofs?: string[];
508
+ /** The protocol buffer options. */
509
+ options?: Option[];
510
+ /** The source context. */
511
+ sourceContext?: SourceContext;
512
+ /** The source syntax. */
513
+ syntax?: string;
514
+ }
515
+ interface Widget {
516
+ /** A chart of alert policy data. */
517
+ alertChart?: AlertChart;
518
+ /** A blank space. */
519
+ blank?: any;
520
+ /** A widget that groups the other widgets. All widgets that are within the area spanned by the grouping widget are considered member widgets. */
521
+ collapsibleGroup?: CollapsibleGroup;
522
+ /** A widget that shows a stream of logs. */
523
+ logsPanel?: LogsPanel;
524
+ /** A scorecard summarizing time series data. */
525
+ scorecard?: Scorecard;
526
+ /** A raw string or markdown displaying textual content. */
527
+ text?: Text;
528
+ /** A widget that displays time series data in a tabular format. */
529
+ timeSeriesTable?: TimeSeriesTable;
530
+ /** Optional. The title of the widget. */
531
+ title?: string;
532
+ /** A chart of time series data. */
533
+ xyChart?: XyChart;
534
+ }
535
+ interface XyChart {
536
+ /** Display options for the chart. */
537
+ chartOptions?: ChartOptions;
538
+ /** Required. The data displayed in this chart. */
539
+ dataSets?: DataSet[];
540
+ /** Threshold lines drawn horizontally across the chart. */
541
+ thresholds?: Threshold[];
542
+ /**
543
+ * 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
544
+ * must be positive, and it can only be applied to charts with data sets of LINE plot type.
545
+ */
546
+ timeshiftDuration?: string;
547
+ /** The properties applied to the X axis. */
548
+ xAxis?: Axis;
549
+ /** The properties applied to the Y2 axis. */
550
+ y2Axis?: Axis;
551
+ /** The properties applied to the Y axis. */
552
+ yAxis?: Axis;
553
+ }
554
+ interface ProjectsResource {
555
+ /** Adds a MonitoredProject with the given project ID to the specified Metrics Scope. */
556
+ create(request: {
557
+ /** V1 error format. */
558
+ "$.xgafv"?: string;
559
+ /** OAuth access token. */
560
+ access_token?: string;
561
+ /** Data format for response. */
562
+ alt?: string;
563
+ /** JSONP */
564
+ callback?: string;
565
+ /** Selector specifying which fields to include in a partial response. */
566
+ fields?: string;
567
+ /** 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. */
568
+ key?: string;
569
+ /** OAuth 2.0 token for the current user. */
570
+ oauth_token?: string;
571
+ /** Required. The resource name of the existing Metrics Scope that will monitor this project. Example: locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER} */
572
+ parent: string;
573
+ /** Returns response with indentations and line breaks. */
574
+ prettyPrint?: boolean;
575
+ /** 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. */
576
+ quotaUser?: string;
577
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
578
+ upload_protocol?: string;
579
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
580
+ uploadType?: string;
581
+ /** Request body */
582
+ resource: MonitoredProject;
583
+ }): Request<Operation>;
584
+ create(request: {
585
+ /** V1 error format. */
586
+ "$.xgafv"?: string;
587
+ /** OAuth access token. */
588
+ access_token?: string;
589
+ /** Data format for response. */
590
+ alt?: string;
591
+ /** JSONP */
592
+ callback?: string;
593
+ /** Selector specifying which fields to include in a partial response. */
594
+ fields?: string;
595
+ /** 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. */
596
+ key?: string;
597
+ /** OAuth 2.0 token for the current user. */
598
+ oauth_token?: string;
599
+ /** Required. The resource name of the existing Metrics Scope that will monitor this project. Example: locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER} */
600
+ parent: string;
601
+ /** Returns response with indentations and line breaks. */
602
+ prettyPrint?: boolean;
603
+ /** 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. */
604
+ quotaUser?: string;
605
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
606
+ upload_protocol?: string;
607
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
608
+ uploadType?: string;
609
+ },
610
+ body: MonitoredProject): Request<Operation>;
611
+ /** Deletes a MonitoredProject from the specified Metrics Scope. */
612
+ delete(request?: {
613
+ /** V1 error format. */
614
+ "$.xgafv"?: string;
615
+ /** OAuth access token. */
616
+ access_token?: string;
617
+ /** Data format for response. */
618
+ alt?: string;
619
+ /** JSONP */
620
+ callback?: string;
621
+ /** Selector specifying which fields to include in a partial response. */
622
+ fields?: string;
623
+ /** 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. */
624
+ key?: string;
625
+ /**
626
+ * Required. The resource name of the MonitoredProject. Example:
627
+ * locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER}/projects/{MONITORED_PROJECT_ID_OR_NUMBER}Authorization requires the following Google IAM
628
+ * (https://cloud.google.com/iam) permissions on both the Metrics Scope and on the MonitoredProject: monitoring.metricsScopes.link
629
+ */
630
+ name: string;
631
+ /** OAuth 2.0 token for the current user. */
632
+ oauth_token?: string;
633
+ /** Returns response with indentations and line breaks. */
634
+ prettyPrint?: boolean;
635
+ /** 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. */
636
+ quotaUser?: string;
637
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
638
+ upload_protocol?: string;
639
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
640
+ uploadType?: string;
641
+ }): Request<Operation>;
642
+ }
643
+ interface MetricsScopesResource {
644
+ /** Returns a specific Metrics Scope, including the list of projects monitored by the specified Metrics Scope. */
645
+ get(request?: {
646
+ /** V1 error format. */
647
+ "$.xgafv"?: string;
648
+ /** OAuth access token. */
649
+ access_token?: string;
650
+ /** Data format for response. */
651
+ alt?: string;
652
+ /** JSONP */
653
+ callback?: string;
654
+ /** Selector specifying which fields to include in a partial response. */
655
+ fields?: string;
656
+ /** 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. */
657
+ key?: string;
658
+ /** Required. The resource name of the Metrics Scope. Example: locations/global/metricsScopes/{SCOPING_PROJECT_ID_OR_NUMBER} */
659
+ name: string;
660
+ /** OAuth 2.0 token for the current user. */
661
+ oauth_token?: string;
662
+ /** Returns response with indentations and line breaks. */
663
+ prettyPrint?: boolean;
664
+ /** 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. */
665
+ quotaUser?: string;
666
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
667
+ upload_protocol?: string;
668
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
669
+ uploadType?: string;
670
+ }): Request<MetricsScope>;
671
+ /**
672
+ * 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
673
+ * entry in the response.
674
+ */
675
+ listMetricsScopesByMonitoredProject(request?: {
676
+ /** V1 error format. */
677
+ "$.xgafv"?: string;
678
+ /** OAuth access token. */
679
+ access_token?: string;
680
+ /** Data format for response. */
681
+ alt?: string;
682
+ /** JSONP */
683
+ callback?: string;
684
+ /** Selector specifying which fields to include in a partial response. */
685
+ fields?: string;
686
+ /** 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. */
687
+ key?: string;
688
+ /** Required. The resource name of the Monitored Project being requested. Example: projects/{MONITORED_PROJECT_ID_OR_NUMBER} */
689
+ monitoredResourceContainer?: string;
690
+ /** OAuth 2.0 token for the current user. */
691
+ oauth_token?: string;
692
+ /** Returns response with indentations and line breaks. */
693
+ prettyPrint?: boolean;
694
+ /** 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. */
695
+ quotaUser?: string;
696
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
697
+ upload_protocol?: string;
698
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
699
+ uploadType?: string;
700
+ }): Request<ListMetricsScopesByMonitoredProjectResponse>;
701
+ projects: ProjectsResource;
702
+ }
703
+ interface GlobalResource {
704
+ metricsScopes: MetricsScopesResource;
705
+ }
706
+ interface LocationsResource {
707
+ global: GlobalResource;
708
+ }
709
+ interface OperationsResource {
710
+ /** 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. */
711
+ get(request?: {
712
+ /** V1 error format. */
713
+ "$.xgafv"?: string;
714
+ /** OAuth access token. */
715
+ access_token?: string;
716
+ /** Data format for response. */
717
+ alt?: string;
718
+ /** JSONP */
719
+ callback?: string;
720
+ /** Selector specifying which fields to include in a partial response. */
721
+ fields?: string;
722
+ /** 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. */
723
+ key?: string;
724
+ /** The name of the operation resource. */
725
+ name: string;
726
+ /** OAuth 2.0 token for the current user. */
727
+ oauth_token?: string;
728
+ /** Returns response with indentations and line breaks. */
729
+ prettyPrint?: boolean;
730
+ /** 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. */
731
+ quotaUser?: string;
732
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
733
+ upload_protocol?: string;
734
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
735
+ uploadType?: string;
736
+ }): Request<Operation>;
737
+ }
738
+ interface DashboardsResource {
739
+ /**
740
+ * Creates a new custom dashboard. For examples on how you can use this API to create dashboards, see Managing dashboards by API
741
+ * (https://cloud.google.com/monitoring/dashboards/api-dashboard). This method requires the monitoring.dashboards.create permission on the specified project. For more information about
742
+ * permissions, see Cloud Identity and Access Management (https://cloud.google.com/iam).
743
+ */
744
+ create(request: {
745
+ /** V1 error format. */
746
+ "$.xgafv"?: string;
747
+ /** OAuth access token. */
748
+ access_token?: string;
749
+ /** Data format for response. */
750
+ alt?: string;
751
+ /** JSONP */
752
+ callback?: string;
753
+ /** Selector specifying which fields to include in a partial response. */
754
+ fields?: string;
755
+ /** 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. */
756
+ key?: string;
757
+ /** OAuth 2.0 token for the current user. */
758
+ oauth_token?: string;
759
+ /** 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. */
760
+ parent: string;
761
+ /** Returns response with indentations and line breaks. */
762
+ prettyPrint?: boolean;
763
+ /** 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. */
764
+ quotaUser?: string;
765
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
766
+ upload_protocol?: string;
767
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
768
+ uploadType?: string;
769
+ /** If set, validate the request and preview the review, but do not actually save it. */
770
+ validateOnly?: boolean;
771
+ /** Request body */
772
+ resource: Dashboard;
773
+ }): Request<Dashboard>;
774
+ create(request: {
775
+ /** V1 error format. */
776
+ "$.xgafv"?: string;
777
+ /** OAuth access token. */
778
+ access_token?: string;
779
+ /** Data format for response. */
780
+ alt?: string;
781
+ /** JSONP */
782
+ callback?: string;
783
+ /** Selector specifying which fields to include in a partial response. */
784
+ fields?: string;
785
+ /** 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. */
786
+ key?: string;
787
+ /** OAuth 2.0 token for the current user. */
788
+ oauth_token?: string;
789
+ /** 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. */
790
+ parent: string;
791
+ /** Returns response with indentations and line breaks. */
792
+ prettyPrint?: boolean;
793
+ /** 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. */
794
+ quotaUser?: string;
795
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
796
+ upload_protocol?: string;
797
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
798
+ uploadType?: string;
799
+ /** If set, validate the request and preview the review, but do not actually save it. */
800
+ validateOnly?: boolean;
801
+ },
802
+ body: Dashboard): Request<Dashboard>;
803
+ /**
804
+ * 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
805
+ * Management (https://cloud.google.com/iam).
806
+ */
807
+ delete(request?: {
808
+ /** V1 error format. */
809
+ "$.xgafv"?: string;
810
+ /** OAuth access token. */
811
+ access_token?: string;
812
+ /** Data format for response. */
813
+ alt?: string;
814
+ /** JSONP */
815
+ callback?: string;
816
+ /** Selector specifying which fields to include in a partial response. */
817
+ fields?: string;
818
+ /** 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. */
819
+ key?: string;
820
+ /** Required. The resource name of the Dashboard. The format is: projects/[PROJECT_ID_OR_NUMBER]/dashboards/[DASHBOARD_ID] */
821
+ name: string;
822
+ /** OAuth 2.0 token for the current user. */
823
+ oauth_token?: string;
824
+ /** Returns response with indentations and line breaks. */
825
+ prettyPrint?: boolean;
826
+ /** 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. */
827
+ quotaUser?: string;
828
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
829
+ upload_protocol?: string;
830
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
831
+ uploadType?: string;
832
+ }): Request<{}>;
833
+ /**
834
+ * 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
835
+ * (https://cloud.google.com/iam).
836
+ */
837
+ get(request?: {
838
+ /** V1 error format. */
839
+ "$.xgafv"?: string;
840
+ /** OAuth access token. */
841
+ access_token?: string;
842
+ /** Data format for response. */
843
+ alt?: string;
844
+ /** JSONP */
845
+ callback?: string;
846
+ /** Selector specifying which fields to include in a partial response. */
847
+ fields?: string;
848
+ /** 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. */
849
+ key?: string;
850
+ /**
851
+ * 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]
852
+ * (for custom dashboards).
853
+ */
854
+ name: string;
855
+ /** OAuth 2.0 token for the current user. */
856
+ oauth_token?: string;
857
+ /** Returns response with indentations and line breaks. */
858
+ prettyPrint?: boolean;
859
+ /** 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. */
860
+ quotaUser?: string;
861
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
862
+ upload_protocol?: string;
863
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
864
+ uploadType?: string;
865
+ }): Request<Dashboard>;
866
+ /**
867
+ * 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
868
+ * (https://cloud.google.com/iam).
869
+ */
870
+ list(request?: {
871
+ /** V1 error format. */
872
+ "$.xgafv"?: string;
873
+ /** OAuth access token. */
874
+ access_token?: string;
875
+ /** Data format for response. */
876
+ alt?: string;
877
+ /** JSONP */
878
+ callback?: string;
879
+ /** Selector specifying which fields to include in a partial response. */
880
+ fields?: string;
881
+ /** 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. */
882
+ key?: string;
883
+ /** OAuth 2.0 token for the current user. */
884
+ oauth_token?: string;
885
+ /** A positive number that is the maximum number of results to return. If unspecified, a default of 1000 is used. */
886
+ pageSize?: number;
887
+ /**
888
+ * 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
889
+ * results from the previous method call.
890
+ */
891
+ pageToken?: string;
892
+ /** Required. The scope of the dashboards to list. The format is: projects/[PROJECT_ID_OR_NUMBER] */
893
+ parent: string;
894
+ /** Returns response with indentations and line breaks. */
895
+ prettyPrint?: boolean;
896
+ /** 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. */
897
+ quotaUser?: string;
898
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
899
+ upload_protocol?: string;
900
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
901
+ uploadType?: string;
902
+ }): Request<ListDashboardsResponse>;
903
+ /**
904
+ * 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
905
+ * Cloud Identity and Access Management (https://cloud.google.com/iam).
906
+ */
907
+ patch(request: {
908
+ /** V1 error format. */
909
+ "$.xgafv"?: string;
910
+ /** OAuth access token. */
911
+ access_token?: string;
912
+ /** Data format for response. */
913
+ alt?: string;
914
+ /** JSONP */
915
+ callback?: string;
916
+ /** Selector specifying which fields to include in a partial response. */
917
+ fields?: string;
918
+ /** 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. */
919
+ key?: string;
920
+ /** Immutable. The resource name of the dashboard. */
921
+ name: string;
922
+ /** OAuth 2.0 token for the current user. */
923
+ oauth_token?: string;
924
+ /** Returns response with indentations and line breaks. */
925
+ prettyPrint?: boolean;
926
+ /** 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. */
927
+ quotaUser?: string;
928
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
929
+ upload_protocol?: string;
930
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
931
+ uploadType?: string;
932
+ /** If set, validate the request and preview the review, but do not actually save it. */
933
+ validateOnly?: boolean;
934
+ /** Request body */
935
+ resource: Dashboard;
936
+ }): Request<Dashboard>;
937
+ patch(request: {
938
+ /** V1 error format. */
939
+ "$.xgafv"?: string;
940
+ /** OAuth access token. */
941
+ access_token?: string;
942
+ /** Data format for response. */
943
+ alt?: string;
944
+ /** JSONP */
945
+ callback?: string;
946
+ /** Selector specifying which fields to include in a partial response. */
947
+ fields?: string;
948
+ /** 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. */
949
+ key?: string;
950
+ /** Immutable. The resource name of the dashboard. */
951
+ name: string;
952
+ /** OAuth 2.0 token for the current user. */
953
+ oauth_token?: string;
954
+ /** Returns response with indentations and line breaks. */
955
+ prettyPrint?: boolean;
956
+ /** 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. */
957
+ quotaUser?: string;
958
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
959
+ upload_protocol?: string;
960
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
961
+ uploadType?: string;
962
+ /** If set, validate the request and preview the review, but do not actually save it. */
963
+ validateOnly?: boolean;
964
+ },
965
+ body: Dashboard): Request<Dashboard>;
966
+ }
967
+ interface LabelResource {
968
+ /** Lists possible values for a given label name. */
969
+ values(request?: {
970
+ /** V1 error format. */
971
+ "$.xgafv"?: string;
972
+ /** OAuth access token. */
973
+ access_token?: string;
974
+ /** Data format for response. */
975
+ alt?: string;
976
+ /** JSONP */
977
+ callback?: string;
978
+ /** The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. */
979
+ end?: string;
980
+ /** Selector specifying which fields to include in a partial response. */
981
+ fields?: string;
982
+ /** 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. */
983
+ key?: string;
984
+ /** The label name for which values are queried. */
985
+ label: string;
986
+ /** Location of the resource information. Has to be "global" now. */
987
+ location: string;
988
+ /** A list of matchers encoded in the Prometheus label matcher format to constrain the values to series that satisfy them. */
989
+ match?: string;
990
+ /**
991
+ * The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of
992
+ * Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER.
993
+ */
994
+ name: string;
995
+ /** OAuth 2.0 token for the current user. */
996
+ oauth_token?: string;
997
+ /** Returns response with indentations and line breaks. */
998
+ prettyPrint?: boolean;
999
+ /** 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. */
1000
+ quotaUser?: string;
1001
+ /** The start time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. */
1002
+ start?: string;
1003
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1004
+ upload_protocol?: string;
1005
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1006
+ uploadType?: string;
1007
+ }): Request<HttpBody>;
1008
+ }
1009
+ interface LabelsResource {
1010
+ /** Lists labels for metrics. */
1011
+ list(request?: {
1012
+ /** V1 error format. */
1013
+ "$.xgafv"?: string;
1014
+ /** OAuth access token. */
1015
+ access_token?: string;
1016
+ /** Data format for response. */
1017
+ alt?: string;
1018
+ /** JSONP */
1019
+ callback?: string;
1020
+ /** The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. */
1021
+ end?: string;
1022
+ /** Selector specifying which fields to include in a partial response. */
1023
+ fields?: string;
1024
+ /** 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. */
1025
+ key?: string;
1026
+ /** Location of the resource information. Has to be "global" now. */
1027
+ location: string;
1028
+ /** A list of matchers encoded in the Prometheus label matcher format to constrain the values to series that satisfy them. */
1029
+ match?: string;
1030
+ /**
1031
+ * The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of
1032
+ * Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER.
1033
+ */
1034
+ name: string;
1035
+ /** OAuth 2.0 token for the current user. */
1036
+ oauth_token?: string;
1037
+ /** Returns response with indentations and line breaks. */
1038
+ prettyPrint?: boolean;
1039
+ /** 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. */
1040
+ quotaUser?: string;
1041
+ /** The start time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp. */
1042
+ start?: string;
1043
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1044
+ upload_protocol?: string;
1045
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1046
+ uploadType?: string;
1047
+ }): Request<HttpBody>;
1048
+ }
1049
+ interface MetadataResource {
1050
+ /** Lists metadata for metrics. */
1051
+ list(request?: {
1052
+ /** V1 error format. */
1053
+ "$.xgafv"?: string;
1054
+ /** OAuth access token. */
1055
+ access_token?: string;
1056
+ /** Data format for response. */
1057
+ alt?: string;
1058
+ /** JSONP */
1059
+ callback?: string;
1060
+ /** Selector specifying which fields to include in a partial response. */
1061
+ fields?: string;
1062
+ /** 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. */
1063
+ key?: string;
1064
+ /** Maximum number of metrics to return. */
1065
+ limit?: string;
1066
+ /** Location of the resource information. Has to be "global" for now. */
1067
+ location: string;
1068
+ /** The metric name for which to query metadata. If unset, all metric metadata is returned. */
1069
+ metric?: string;
1070
+ /**
1071
+ * Required. The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus
1072
+ * instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER.
1073
+ */
1074
+ name: string;
1075
+ /** OAuth 2.0 token for the current user. */
1076
+ oauth_token?: string;
1077
+ /** Returns response with indentations and line breaks. */
1078
+ prettyPrint?: boolean;
1079
+ /** 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. */
1080
+ quotaUser?: string;
1081
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1082
+ upload_protocol?: string;
1083
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1084
+ uploadType?: string;
1085
+ }): Request<HttpBody>;
1086
+ }
1087
+ interface V1Resource {
1088
+ /** Evaluate a PromQL query at a single point in time. */
1089
+ query(request: {
1090
+ /** V1 error format. */
1091
+ "$.xgafv"?: string;
1092
+ /** OAuth access token. */
1093
+ access_token?: string;
1094
+ /** Data format for response. */
1095
+ alt?: string;
1096
+ /** JSONP */
1097
+ callback?: string;
1098
+ /** Selector specifying which fields to include in a partial response. */
1099
+ fields?: string;
1100
+ /** 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. */
1101
+ key?: string;
1102
+ /** Location of the resource information. Has to be "global" now. */
1103
+ location: string;
1104
+ /**
1105
+ * The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but
1106
+ * used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.
1107
+ */
1108
+ name: string;
1109
+ /** OAuth 2.0 token for the current user. */
1110
+ oauth_token?: string;
1111
+ /** Returns response with indentations and line breaks. */
1112
+ prettyPrint?: boolean;
1113
+ /** 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. */
1114
+ quotaUser?: string;
1115
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1116
+ upload_protocol?: string;
1117
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1118
+ uploadType?: string;
1119
+ /** Request body */
1120
+ resource: QueryInstantRequest;
1121
+ }): Request<HttpBody>;
1122
+ query(request: {
1123
+ /** V1 error format. */
1124
+ "$.xgafv"?: string;
1125
+ /** OAuth access token. */
1126
+ access_token?: string;
1127
+ /** Data format for response. */
1128
+ alt?: string;
1129
+ /** JSONP */
1130
+ callback?: string;
1131
+ /** Selector specifying which fields to include in a partial response. */
1132
+ fields?: string;
1133
+ /** 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. */
1134
+ key?: string;
1135
+ /** Location of the resource information. Has to be "global" now. */
1136
+ location: string;
1137
+ /**
1138
+ * The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but
1139
+ * used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.
1140
+ */
1141
+ name: string;
1142
+ /** OAuth 2.0 token for the current user. */
1143
+ oauth_token?: string;
1144
+ /** Returns response with indentations and line breaks. */
1145
+ prettyPrint?: boolean;
1146
+ /** 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. */
1147
+ quotaUser?: string;
1148
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1149
+ upload_protocol?: string;
1150
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1151
+ uploadType?: string;
1152
+ },
1153
+ body: QueryInstantRequest): Request<HttpBody>;
1154
+ /** Evaluate a PromQL query with start, end time range. */
1155
+ query_range(request: {
1156
+ /** V1 error format. */
1157
+ "$.xgafv"?: string;
1158
+ /** OAuth access token. */
1159
+ access_token?: string;
1160
+ /** Data format for response. */
1161
+ alt?: string;
1162
+ /** JSONP */
1163
+ callback?: string;
1164
+ /** Selector specifying which fields to include in a partial response. */
1165
+ fields?: string;
1166
+ /** 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. */
1167
+ key?: string;
1168
+ /** Location of the resource information. Has to be "global" now. */
1169
+ location: string;
1170
+ /**
1171
+ * The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but
1172
+ * used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.
1173
+ */
1174
+ name: string;
1175
+ /** OAuth 2.0 token for the current user. */
1176
+ oauth_token?: string;
1177
+ /** Returns response with indentations and line breaks. */
1178
+ prettyPrint?: boolean;
1179
+ /** 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. */
1180
+ quotaUser?: string;
1181
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1182
+ upload_protocol?: string;
1183
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1184
+ uploadType?: string;
1185
+ /** Request body */
1186
+ resource: QueryRangeRequest;
1187
+ }): Request<HttpBody>;
1188
+ query_range(request: {
1189
+ /** V1 error format. */
1190
+ "$.xgafv"?: string;
1191
+ /** OAuth access token. */
1192
+ access_token?: string;
1193
+ /** Data format for response. */
1194
+ alt?: string;
1195
+ /** JSONP */
1196
+ callback?: string;
1197
+ /** Selector specifying which fields to include in a partial response. */
1198
+ fields?: string;
1199
+ /** 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. */
1200
+ key?: string;
1201
+ /** Location of the resource information. Has to be "global" now. */
1202
+ location: string;
1203
+ /**
1204
+ * The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but
1205
+ * used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.
1206
+ */
1207
+ name: string;
1208
+ /** OAuth 2.0 token for the current user. */
1209
+ oauth_token?: string;
1210
+ /** Returns response with indentations and line breaks. */
1211
+ prettyPrint?: boolean;
1212
+ /** 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. */
1213
+ quotaUser?: string;
1214
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1215
+ upload_protocol?: string;
1216
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1217
+ uploadType?: string;
1218
+ },
1219
+ body: QueryRangeRequest): Request<HttpBody>;
1220
+ /** Lists metadata for metrics. */
1221
+ series(request: {
1222
+ /** V1 error format. */
1223
+ "$.xgafv"?: string;
1224
+ /** OAuth access token. */
1225
+ access_token?: string;
1226
+ /** Data format for response. */
1227
+ alt?: string;
1228
+ /** JSONP */
1229
+ callback?: string;
1230
+ /** Selector specifying which fields to include in a partial response. */
1231
+ fields?: string;
1232
+ /** 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. */
1233
+ key?: string;
1234
+ /** Location of the resource information. Has to be "global" for now. */
1235
+ location: string;
1236
+ /**
1237
+ * Required. The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus
1238
+ * instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER.
1239
+ */
1240
+ name: string;
1241
+ /** OAuth 2.0 token for the current user. */
1242
+ oauth_token?: string;
1243
+ /** Returns response with indentations and line breaks. */
1244
+ prettyPrint?: boolean;
1245
+ /** 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. */
1246
+ quotaUser?: string;
1247
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1248
+ upload_protocol?: string;
1249
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1250
+ uploadType?: string;
1251
+ /** Request body */
1252
+ resource: QuerySeriesRequest;
1253
+ }): Request<HttpBody>;
1254
+ series(request: {
1255
+ /** V1 error format. */
1256
+ "$.xgafv"?: string;
1257
+ /** OAuth access token. */
1258
+ access_token?: string;
1259
+ /** Data format for response. */
1260
+ alt?: string;
1261
+ /** JSONP */
1262
+ callback?: string;
1263
+ /** Selector specifying which fields to include in a partial response. */
1264
+ fields?: string;
1265
+ /** 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. */
1266
+ key?: string;
1267
+ /** Location of the resource information. Has to be "global" for now. */
1268
+ location: string;
1269
+ /**
1270
+ * Required. The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus
1271
+ * instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER.
1272
+ */
1273
+ name: string;
1274
+ /** OAuth 2.0 token for the current user. */
1275
+ oauth_token?: string;
1276
+ /** Returns response with indentations and line breaks. */
1277
+ prettyPrint?: boolean;
1278
+ /** 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. */
1279
+ quotaUser?: string;
1280
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1281
+ upload_protocol?: string;
1282
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1283
+ uploadType?: string;
1284
+ },
1285
+ body: QuerySeriesRequest): Request<HttpBody>;
1286
+ label: LabelResource;
1287
+ labels: LabelsResource;
1288
+ metadata: MetadataResource;
1289
+ }
1290
+ interface ApiResource {
1291
+ v1: V1Resource;
1292
+ }
1293
+ interface PrometheusResource {
1294
+ api: ApiResource;
1295
+ }
1296
+ interface LocationResource {
1297
+ prometheus: PrometheusResource;
1298
+ }
1299
+ interface ProjectsResource {
1300
+ dashboards: DashboardsResource;
1301
+ location: LocationResource;
1302
+ }
1303
+
1304
+ const locations: LocationsResource;
1305
+
1306
+ const operations: OperationsResource;
1307
+
1308
+ const projects: ProjectsResource;
1309
+ }
1310
+ }