@maxim_mazurok/gapi.client.monitoring-v3 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,4039 @@
1
+ /* Type definitions for non-npm package Cloud Monitoring API v3 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=v3
13
+ // Revision: 20220806
14
+
15
+ /// <reference types="gapi.client" />
16
+
17
+ declare namespace gapi.client {
18
+ /** Load Cloud Monitoring API v3 */
19
+ function load(urlOrObject: "https://monitoring.googleapis.com/$discovery/rest?version=v3"): Promise<void>;
20
+ /** @deprecated Please load APIs with discovery documents. */
21
+ function load(name: "monitoring", version: "v3"): Promise<void>;
22
+ /** @deprecated Please load APIs with discovery documents. */
23
+ function load(name: "monitoring", version: "v3", 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 104 weeks (2
31
+ * years) for charts, and 90,000 seconds (25 hours) for alerting policies.
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 AlertPolicy {
60
+ /** Control over how this alert policy's notification channels are notified. */
61
+ alertStrategy?: AlertStrategy;
62
+ /** How to combine the results of multiple conditions to determine if an incident should be opened. If condition_time_series_query_language is present, this must be COMBINE_UNSPECIFIED. */
63
+ combiner?: string;
64
+ /**
65
+ * A list of conditions for the policy. The conditions are combined by AND or OR according to the combiner field. If the combined conditions evaluate to true, then an incident is
66
+ * created. A policy can have from one to six conditions. If condition_time_series_query_language is present, it must be the only condition.
67
+ */
68
+ conditions?: Condition[];
69
+ /** A read-only record of the creation of the alerting policy. If provided in a call to create or update, this field will be ignored. */
70
+ creationRecord?: MutationRecord;
71
+ /**
72
+ * A short name or phrase used to identify the policy in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple policies in the same
73
+ * project. The name is limited to 512 Unicode characters.
74
+ */
75
+ displayName?: string;
76
+ /**
77
+ * Documentation that is included with notifications and incidents related to this policy. Best practice is for the documentation to include information to help responders understand,
78
+ * mitigate, escalate, and correct the underlying problems detected by the alerting policy. Notification channels that have limited capacity might not show this documentation.
79
+ */
80
+ documentation?: Documentation;
81
+ /**
82
+ * Whether or not the policy is enabled. On write, the default interpretation if unset is that the policy is enabled. On read, clients should not make any assumption about the state if
83
+ * it has not been populated. The field should always be populated on List and Get operations, unless a field projection has been specified that strips it out.
84
+ */
85
+ enabled?: boolean;
86
+ /** A read-only record of the most recent change to the alerting policy. If provided in a call to create or update, this field will be ignored. */
87
+ mutationRecord?: MutationRecord;
88
+ /**
89
+ * Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by
90
+ * Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.
91
+ */
92
+ name?: string;
93
+ /**
94
+ * Identifies the notification channels to which notifications should be sent when incidents are opened or closed or when new violations occur on an already opened incident. Each
95
+ * element of this array corresponds to the name field in each of the NotificationChannel objects that are returned from the ListNotificationChannels method. The format of the entries
96
+ * in this field is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
97
+ */
98
+ notificationChannels?: string[];
99
+ /**
100
+ * User-supplied key/value data to be used for organizing and identifying the AlertPolicy objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode
101
+ * characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.
102
+ */
103
+ userLabels?: { [P in string]: string };
104
+ /** Read-only description of how the alert policy is invalid. OK if the alert policy is valid. If not OK, the alert policy will not generate incidents. */
105
+ validity?: Status;
106
+ }
107
+ interface AlertStrategy {
108
+ /** If an alert policy that was active has no data for this long, any open incidents will close */
109
+ autoClose?: string;
110
+ /** Required for alert policies with a LogMatch condition.This limit is not implemented for alert policies that are not log-based. */
111
+ notificationRateLimit?: NotificationRateLimit;
112
+ }
113
+ interface AppEngine {
114
+ /**
115
+ * The ID of the App Engine module underlying this service. Corresponds to the module_id resource label in the gae_app monitored resource
116
+ * (https://cloud.google.com/monitoring/api/resources#tag_gae_app).
117
+ */
118
+ moduleId?: string;
119
+ }
120
+ // tslint:disable-next-line:no-empty-interface
121
+ interface AvailabilityCriteria {
122
+ }
123
+ interface BasicAuthentication {
124
+ /** The password to use when authenticating with the HTTP server. */
125
+ password?: string;
126
+ /** The username to use when authenticating with the HTTP server. */
127
+ username?: string;
128
+ }
129
+ interface BasicSli {
130
+ /** Good service is defined to be the count of requests made to this service that return successfully. */
131
+ availability?: any;
132
+ /** Good service is defined to be the count of requests made to this service that are fast enough with respect to latency.threshold. */
133
+ latency?: LatencyCriteria;
134
+ /**
135
+ * OPTIONAL: The set of locations to which this SLI is relevant. Telemetry from other locations will not be used to calculate performance for this SLI. If omitted, this SLI applies to
136
+ * all locations in which the Service has activity. For service types that don't support breaking down by location, setting this field will result in an error.
137
+ */
138
+ location?: string[];
139
+ /**
140
+ * OPTIONAL: The set of RPCs to which this SLI is relevant. Telemetry from other methods will not be used to calculate performance for this SLI. If omitted, this SLI applies to all the
141
+ * Service's methods. For service types that don't support breaking down by method, setting this field will result in an error.
142
+ */
143
+ method?: string[];
144
+ /**
145
+ * OPTIONAL: The set of API versions to which this SLI is relevant. Telemetry from other API versions will not be used to calculate performance for this SLI. If omitted, this SLI
146
+ * applies to all API versions. For service types that don't support breaking down by version, setting this field will result in an error.
147
+ */
148
+ version?: string[];
149
+ }
150
+ interface BucketOptions {
151
+ /** The explicit buckets. */
152
+ explicitBuckets?: Explicit;
153
+ /** The exponential buckets. */
154
+ exponentialBuckets?: Exponential;
155
+ /** The linear bucket. */
156
+ linearBuckets?: Linear;
157
+ }
158
+ interface CloudEndpoints {
159
+ /**
160
+ * The name of the Cloud Endpoints service underlying this service. Corresponds to the service resource label in the api monitored resource
161
+ * (https://cloud.google.com/monitoring/api/resources#tag_api).
162
+ */
163
+ service?: string;
164
+ }
165
+ interface CloudRun {
166
+ /**
167
+ * The location the service is run. Corresponds to the location resource label in the cloud_run_revision monitored resource
168
+ * (https://cloud.google.com/monitoring/api/resources#tag_cloud_run_revision).
169
+ */
170
+ location?: string;
171
+ /**
172
+ * The name of the Cloud Run service. Corresponds to the service_name resource label in the cloud_run_revision monitored resource
173
+ * (https://cloud.google.com/monitoring/api/resources#tag_cloud_run_revision).
174
+ */
175
+ serviceName?: string;
176
+ }
177
+ interface ClusterIstio {
178
+ /** The name of the Kubernetes cluster in which this Istio service is defined. Corresponds to the cluster_name resource label in k8s_cluster resources. */
179
+ clusterName?: string;
180
+ /** The location of the Kubernetes cluster in which this Istio service is defined. Corresponds to the location resource label in k8s_cluster resources. */
181
+ location?: string;
182
+ /** The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics. */
183
+ serviceName?: string;
184
+ /** The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics. */
185
+ serviceNamespace?: string;
186
+ }
187
+ interface CollectdPayload {
188
+ /** The end time of the interval. */
189
+ endTime?: string;
190
+ /** The measurement metadata. Example: "process_id" -> 12345 */
191
+ metadata?: { [P in string]: TypedValue };
192
+ /** The name of the plugin. Example: "disk". */
193
+ plugin?: string;
194
+ /** The instance name of the plugin Example: "hdcl". */
195
+ pluginInstance?: string;
196
+ /** The start time of the interval. */
197
+ startTime?: string;
198
+ /** The measurement type. Example: "memory". */
199
+ type?: string;
200
+ /** The measurement type instance. Example: "used". */
201
+ typeInstance?: string;
202
+ /** The measured values during this time interval. Each value must have a different data_source_name. */
203
+ values?: CollectdValue[];
204
+ }
205
+ interface CollectdPayloadError {
206
+ /** Records the error status for the payload. If this field is present, the partial errors for nested values won't be populated. */
207
+ error?: Status;
208
+ /** The zero-based index in CreateCollectdTimeSeriesRequest.collectd_payloads. */
209
+ index?: number;
210
+ /** Records the error status for values that were not written due to an error.Failed payloads for which nothing is written will not include partial value errors. */
211
+ valueErrors?: CollectdValueError[];
212
+ }
213
+ interface CollectdValue {
214
+ /** The data source for the collectd value. For example, there are two data sources for network measurements: "rx" and "tx". */
215
+ dataSourceName?: string;
216
+ /** The type of measurement. */
217
+ dataSourceType?: string;
218
+ /** The measurement value. */
219
+ value?: TypedValue;
220
+ }
221
+ interface CollectdValueError {
222
+ /** Records the error status for the value. */
223
+ error?: Status;
224
+ /** The zero-based index in CollectdPayload.values within the parent CreateCollectdTimeSeriesRequest.collectd_payloads. */
225
+ index?: number;
226
+ }
227
+ interface Condition {
228
+ /** A condition that checks that a time series continues to receive new data points. */
229
+ conditionAbsent?: MetricAbsence;
230
+ /** A condition that checks for log messages matching given constraints. If set, no other conditions can be present. */
231
+ conditionMatchedLog?: LogMatch;
232
+ /** A condition that uses the Monitoring Query Language to define alerts. */
233
+ conditionMonitoringQueryLanguage?: MonitoringQueryLanguageCondition;
234
+ /** A condition that compares a time series against a threshold. */
235
+ conditionThreshold?: MetricThreshold;
236
+ /**
237
+ * A short name or phrase used to identify the condition in dashboards, notifications, and incidents. To avoid confusion, don't use the same display name for multiple conditions in the
238
+ * same policy.
239
+ */
240
+ displayName?: string;
241
+ /**
242
+ * Required if the condition exists. The unique resource name for this condition. Its format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID]
243
+ * [CONDITION_ID] is assigned by Cloud Monitoring when the condition is created as part of a new or updated alerting policy.When calling the alertPolicies.create method, do not include
244
+ * the name field in the conditions of the requested alerting policy. Cloud Monitoring creates the condition identifiers and includes them in the new policy.When calling the
245
+ * alertPolicies.update method to update a policy, including a condition name causes the existing condition to be updated. Conditions without names are added to the updated policy.
246
+ * Existing conditions are deleted if they are not updated.Best practice is to preserve [CONDITION_ID] if you make only small changes, such as those to condition thresholds, durations,
247
+ * or trigger values. Otherwise, treat the change as a new condition and let the existing condition be deleted.
248
+ */
249
+ name?: string;
250
+ }
251
+ interface ContentMatcher {
252
+ /** String, regex or JSON content to match. Maximum 1024 bytes. An empty content string indicates no content matching is to be performed. */
253
+ content?: string;
254
+ /** Matcher information for MATCHES_JSON_PATH and NOT_MATCHES_JSON_PATH */
255
+ jsonPathMatcher?: JsonPathMatcher;
256
+ /** The type of content matcher that will be applied to the server output, compared to the content string when the check is run. */
257
+ matcher?: string;
258
+ }
259
+ interface CreateCollectdTimeSeriesRequest {
260
+ /**
261
+ * The collectd payloads representing the time series data. You must not include more than a single point for each time series, so no two payloads can have the same values for all of
262
+ * the fields plugin, plugin_instance, type, and type_instance.
263
+ */
264
+ collectdPayloads?: CollectdPayload[];
265
+ /** The version of collectd that collected the data. Example: "5.3.0-192.el6". */
266
+ collectdVersion?: string;
267
+ /** The monitored resource associated with the time series. */
268
+ resource?: MonitoredResource;
269
+ }
270
+ interface CreateCollectdTimeSeriesResponse {
271
+ /**
272
+ * Records the error status for points that were not written due to an error in the request.Failed requests for which nothing is written will return an error response instead. Requests
273
+ * where data points were rejected by the backend will set summary instead.
274
+ */
275
+ payloadErrors?: CollectdPayloadError[];
276
+ /**
277
+ * Aggregate statistics from writing the payloads. This field is omitted if all points were successfully written, so that the response is empty. This is for backwards compatibility
278
+ * with clients that log errors on any non-empty response.
279
+ */
280
+ summary?: CreateTimeSeriesSummary;
281
+ }
282
+ interface CreateTimeSeriesRequest {
283
+ /**
284
+ * Required. The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point
285
+ * in its time series. Each TimeSeries value must fully specify a unique time series by supplying all label values for the metric and the monitored resource.The maximum number of
286
+ * TimeSeries objects per Create request is 200.
287
+ */
288
+ timeSeries?: TimeSeries[];
289
+ }
290
+ interface CreateTimeSeriesSummary {
291
+ /** The number of points that failed to be written. Order is not guaranteed. */
292
+ errors?: Error[];
293
+ /** The number of points that were successfully written. */
294
+ successPointCount?: number;
295
+ /** The number of points in the request. */
296
+ totalPointCount?: number;
297
+ }
298
+ // tslint:disable-next-line:no-empty-interface
299
+ interface Custom {
300
+ }
301
+ interface Distribution {
302
+ /**
303
+ * Required in the Cloud Monitoring API v3. The values for each bucket specified in bucket_options. The sum of the values in bucketCounts must equal the value in the count field of the
304
+ * Distribution object. The order of the bucket counts follows the numbering schemes described for the three bucket types. The underflow bucket has number 0; the finite buckets, if
305
+ * any, have numbers 1 through N-2; and the overflow bucket has number N-1. The size of bucket_counts must not be greater than N. If the size is less than N, then the remaining buckets
306
+ * are assigned values of zero.
307
+ */
308
+ bucketCounts?: string[];
309
+ /** Required in the Cloud Monitoring API v3. Defines the histogram bucket boundaries. */
310
+ bucketOptions?: BucketOptions;
311
+ /** The number of values in the population. Must be non-negative. This value must equal the sum of the values in bucket_counts if a histogram is provided. */
312
+ count?: string;
313
+ /** Must be in increasing order of value field. */
314
+ exemplars?: Exemplar[];
315
+ /** The arithmetic mean of the values in the population. If count is zero then this field must be zero. */
316
+ mean?: number;
317
+ /** If specified, contains the range of the population values. The field must not be present if the count is zero. This field is presently ignored by the Cloud Monitoring API v3. */
318
+ range?: Range;
319
+ /**
320
+ * The sum of squared deviations from the mean of the values in the population. For values x_i this is: Sum[i=1..n]((x_i - mean)^2) Knuth, "The Art of Computer Programming", Vol. 2,
321
+ * page 232, 3rd edition describes Welford's method for accumulating this sum in one pass.If count is zero then this field must be zero.
322
+ */
323
+ sumOfSquaredDeviation?: number;
324
+ }
325
+ interface DistributionCut {
326
+ /**
327
+ * A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying a TimeSeries aggregating values. Must have ValueType = DISTRIBUTION and MetricKind = DELTA or
328
+ * MetricKind = CUMULATIVE.
329
+ */
330
+ distributionFilter?: string;
331
+ /** Range of values considered "good." For a one-sided range, set one bound to an infinite value. */
332
+ range?: GoogleMonitoringV3Range;
333
+ }
334
+ interface Documentation {
335
+ /**
336
+ * The text of the documentation, interpreted according to mime_type. The content may not exceed 8,192 Unicode characters and may not exceed more than 10,240 bytes when encoded in
337
+ * UTF-8 format, whichever is smaller. This text can be templatized by using variables (https://cloud.google.com/monitoring/alerts/doc-variables).
338
+ */
339
+ content?: string;
340
+ /** The format of the content field. Presently, only the value "text/markdown" is supported. See Markdown (https://en.wikipedia.org/wiki/Markdown) for more information. */
341
+ mimeType?: string;
342
+ }
343
+ interface DroppedLabels {
344
+ /** Map from label to its value, for all labels dropped in any aggregation. */
345
+ label?: { [P in string]: string };
346
+ }
347
+ // tslint:disable-next-line:no-empty-interface
348
+ interface Empty {
349
+ }
350
+ interface Error {
351
+ /** The number of points that couldn't be written because of status. */
352
+ pointCount?: number;
353
+ /** The status of the requested write operation. */
354
+ status?: Status;
355
+ }
356
+ interface Exemplar {
357
+ /**
358
+ * Contextual information about the example value. Examples are:Trace: type.googleapis.com/google.monitoring.v3.SpanContextLiteral string:
359
+ * type.googleapis.com/google.protobuf.StringValueLabels dropped during aggregation: type.googleapis.com/google.monitoring.v3.DroppedLabelsThere may be only a single attachment of any
360
+ * given message type in a single exemplar, and this is enforced by the system.
361
+ */
362
+ attachments?: Array<{ [P in string]: any }>;
363
+ /** The observation (sampling) time of the above value. */
364
+ timestamp?: string;
365
+ /** Value of the exemplar point. This value determines to which bucket the exemplar belongs. */
366
+ value?: number;
367
+ }
368
+ interface Explicit {
369
+ /** The values must be monotonically increasing. */
370
+ bounds?: number[];
371
+ }
372
+ interface Exponential {
373
+ /** Must be greater than 1. */
374
+ growthFactor?: number;
375
+ /** Must be greater than 0. */
376
+ numFiniteBuckets?: number;
377
+ /** Must be greater than 0. */
378
+ scale?: number;
379
+ }
380
+ interface Field {
381
+ /** The field cardinality. */
382
+ cardinality?: string;
383
+ /** The string value of the default value of this field. Proto2 syntax only. */
384
+ defaultValue?: string;
385
+ /** The field JSON name. */
386
+ jsonName?: string;
387
+ /** The field type. */
388
+ kind?: string;
389
+ /** The field name. */
390
+ name?: string;
391
+ /** The field number. */
392
+ number?: number;
393
+ /** 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. */
394
+ oneofIndex?: number;
395
+ /** The protocol buffer options. */
396
+ options?: Option[];
397
+ /** Whether to use alternative packed wire representation. */
398
+ packed?: boolean;
399
+ /** The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp". */
400
+ typeUrl?: string;
401
+ }
402
+ interface GetNotificationChannelVerificationCodeRequest {
403
+ /**
404
+ * The desired expiration time. If specified, the API will guarantee that the returned code will not be valid after the specified timestamp; however, the API cannot guarantee that the
405
+ * returned code will be valid for at least as long as the requested time (the API puts an upper bound on the amount of time for which a code may be valid). If omitted, a default
406
+ * expiration will be used, which may be less than the max permissible expiration (so specifying an expiration may extend the code's lifetime over omitting an expiration, even though
407
+ * the API does impose an upper limit on the maximum expiration that is permitted).
408
+ */
409
+ expireTime?: string;
410
+ }
411
+ interface GetNotificationChannelVerificationCodeResponse {
412
+ /**
413
+ * The verification code, which may be used to verify other channels that have an equivalent identity (i.e. other channels of the same type with the same fingerprint such as other
414
+ * email channels with the same email address or other sms channels with the same number).
415
+ */
416
+ code?: string;
417
+ /**
418
+ * The expiration time associated with the code that was returned. If an expiration was provided in the request, this is the minimum of the requested expiration in the request and the
419
+ * max permitted expiration.
420
+ */
421
+ expireTime?: string;
422
+ }
423
+ interface GkeNamespace {
424
+ /** The name of the parent cluster. */
425
+ clusterName?: string;
426
+ /** The location of the parent cluster. This may be a zone or region. */
427
+ location?: string;
428
+ /** The name of this namespace. */
429
+ namespaceName?: string;
430
+ /** Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself. */
431
+ projectId?: string;
432
+ }
433
+ interface GkeService {
434
+ /** The name of the parent cluster. */
435
+ clusterName?: string;
436
+ /** The location of the parent cluster. This may be a zone or region. */
437
+ location?: string;
438
+ /** The name of the parent namespace. */
439
+ namespaceName?: string;
440
+ /** Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself. */
441
+ projectId?: string;
442
+ /** The name of this service. */
443
+ serviceName?: string;
444
+ }
445
+ interface GkeWorkload {
446
+ /** The name of the parent cluster. */
447
+ clusterName?: string;
448
+ /** The location of the parent cluster. This may be a zone or region. */
449
+ location?: string;
450
+ /** The name of the parent namespace. */
451
+ namespaceName?: string;
452
+ /** Output only. The project this resource lives in. For legacy services migrated from the Custom type, this may be a distinct project from the one parenting the service itself. */
453
+ projectId?: string;
454
+ /** The name of this workload. */
455
+ topLevelControllerName?: string;
456
+ /** The type of this workload (for example, "Deployment" or "DaemonSet") */
457
+ topLevelControllerType?: string;
458
+ }
459
+ interface GoogleMonitoringV3Range {
460
+ /** Range maximum. */
461
+ max?: number;
462
+ /** Range minimum. */
463
+ min?: number;
464
+ }
465
+ interface Group {
466
+ /** A user-assigned name for this group, used only for display purposes. */
467
+ displayName?: string;
468
+ /** The filter used to determine which monitored resources belong to this group. */
469
+ filter?: string;
470
+ /** If true, the members of this group are considered to be a cluster. The system can perform additional analysis on groups that are clusters. */
471
+ isCluster?: boolean;
472
+ /**
473
+ * Output only. The name of this group. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] When creating a group, this field is ignored and a new name is created
474
+ * consisting of the project specified in the call to CreateGroup and a unique [GROUP_ID] that is generated automatically.
475
+ */
476
+ name?: string;
477
+ /** The name of the group's parent, if it has one. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] For groups with no parent, parent_name is the empty string, "". */
478
+ parentName?: string;
479
+ }
480
+ interface HttpCheck {
481
+ /**
482
+ * If present, the check will only pass if the HTTP response status code is in this set of status codes. If empty, the HTTP status code will only pass if the HTTP status code is
483
+ * 200-299.
484
+ */
485
+ acceptedResponseStatusCodes?: ResponseStatusCode[];
486
+ /** The authentication information. Optional when creating an HTTP check; defaults to empty. */
487
+ authInfo?: BasicAuthentication;
488
+ /**
489
+ * The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the
490
+ * headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte.Note: If client libraries
491
+ * aren't used (which performs the conversion automatically) base64 encode your body data since the field is of bytes type.
492
+ */
493
+ body?: string;
494
+ /**
495
+ * The content type header to use for the check. The following configurations result in errors: 1. Content type is specified in both the headers field and the content_type field. 2.
496
+ * Request method is GET and content_type is not TYPE_UNSPECIFIED 3. Request method is POST and content_type is TYPE_UNSPECIFIED. 4. Request method is POST and a "Content-Type" header
497
+ * is provided via headers field. The content_type field should be used instead.
498
+ */
499
+ contentType?: string;
500
+ /**
501
+ * The list of headers to send as part of the Uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value
502
+ * being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in
503
+ * a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100.
504
+ */
505
+ headers?: { [P in string]: string };
506
+ /**
507
+ * Boolean specifying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when
508
+ * retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to true then the headers will be obscured with
509
+ * ******.
510
+ */
511
+ maskHeaders?: boolean;
512
+ /**
513
+ * Optional (defaults to "/"). The path to the page against which to run the check. Will be combined with the host (specified within the monitored_resource) and port to construct the
514
+ * full URL. If the provided path does not begin with "/", a "/" will be prepended automatically.
515
+ */
516
+ path?: string;
517
+ /**
518
+ * Optional (defaults to 80 when use_ssl is false, and 443 when use_ssl is true). The TCP port on the HTTP server against which to run the check. Will be combined with host (specified
519
+ * within the monitored_resource) and path to construct the full URL.
520
+ */
521
+ port?: number;
522
+ /** The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET. */
523
+ requestMethod?: string;
524
+ /** If true, use HTTPS instead of HTTP to run the check. */
525
+ useSsl?: boolean;
526
+ /**
527
+ * Boolean specifying whether to include SSL certificate validation as a part of the Uptime check. Only applies to checks where monitored_resource is set to uptime_url. If use_ssl is
528
+ * false, setting validate_ssl to true has no effect.
529
+ */
530
+ validateSsl?: boolean;
531
+ }
532
+ interface InternalChecker {
533
+ /**
534
+ * The checker's human-readable name. The display name should be unique within a Cloud Monitoring Metrics Scope in order to make it easier to identify; however, uniqueness is not
535
+ * enforced.
536
+ */
537
+ displayName?: string;
538
+ /** The GCP zone the Uptime check should egress from. Only respected for internal Uptime checks, where internal_network is specified. */
539
+ gcpZone?: string;
540
+ /**
541
+ * A unique resource name for this InternalChecker. The format is: projects/[PROJECT_ID_OR_NUMBER]/internalCheckers/[INTERNAL_CHECKER_ID] [PROJECT_ID_OR_NUMBER] is the Cloud Monitoring
542
+ * Metrics Scope project for the Uptime check config associated with the internal checker.
543
+ */
544
+ name?: string;
545
+ /** The GCP VPC network (https://cloud.google.com/vpc/docs/vpc) where the internal resource lives (ex: "default"). */
546
+ network?: string;
547
+ /** The GCP project ID where the internal checker lives. Not necessary the same as the Metrics Scope project. */
548
+ peerProjectId?: string;
549
+ /** The current operational state of the internal checker. */
550
+ state?: string;
551
+ }
552
+ interface IstioCanonicalService {
553
+ /**
554
+ * The name of the canonical service underlying this service. Corresponds to the destination_canonical_service_name metric label in label in Istio metrics
555
+ * (https://cloud.google.com/monitoring/api/metrics_istio).
556
+ */
557
+ canonicalService?: string;
558
+ /**
559
+ * The namespace of the canonical service underlying this service. Corresponds to the destination_canonical_service_namespace metric label in Istio metrics
560
+ * (https://cloud.google.com/monitoring/api/metrics_istio).
561
+ */
562
+ canonicalServiceNamespace?: string;
563
+ /**
564
+ * Identifier for the Istio mesh in which this canonical service is defined. Corresponds to the mesh_uid metric label in Istio metrics
565
+ * (https://cloud.google.com/monitoring/api/metrics_istio).
566
+ */
567
+ meshUid?: string;
568
+ }
569
+ interface JsonPathMatcher {
570
+ /** The type of JSONPath match that will be applied to the JSON output (ContentMatcher.content) */
571
+ jsonMatcher?: string;
572
+ /** JSONPath within the response output pointing to the expected ContentMatcher::content to match against. */
573
+ jsonPath?: string;
574
+ }
575
+ interface LabelDescriptor {
576
+ /** A human-readable description for the label. */
577
+ description?: string;
578
+ /**
579
+ * The key for this label. The key must meet the following criteria: Does not exceed 100 characters. Matches the following regular expression: [a-zA-Z][a-zA-Z0-9_]* The first character
580
+ * must be an upper- or lower-case letter. The remaining characters must be letters, digits, or underscores.
581
+ */
582
+ key?: string;
583
+ /** The type of data that can be assigned to the label. */
584
+ valueType?: string;
585
+ }
586
+ interface LabelValue {
587
+ /** A bool label value. */
588
+ boolValue?: boolean;
589
+ /** An int64 label value. */
590
+ int64Value?: string;
591
+ /** A string label value. */
592
+ stringValue?: string;
593
+ }
594
+ interface LatencyCriteria {
595
+ /** Good service is defined to be the count of requests made to this service that return in no more than threshold. */
596
+ threshold?: string;
597
+ }
598
+ interface Linear {
599
+ /** Must be greater than 0. */
600
+ numFiniteBuckets?: number;
601
+ /** Lower bound of the first bucket. */
602
+ offset?: number;
603
+ /** Must be greater than 0. */
604
+ width?: number;
605
+ }
606
+ interface ListAlertPoliciesResponse {
607
+ /** The returned alert policies. */
608
+ alertPolicies?: AlertPolicy[];
609
+ /**
610
+ * If there might be more results than were 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
611
+ * method.
612
+ */
613
+ nextPageToken?: string;
614
+ /** The total number of alert policies in all pages. This number is only an estimate, and may change in subsequent pages. https://aip.dev/158 */
615
+ totalSize?: number;
616
+ }
617
+ interface ListGroupMembersResponse {
618
+ /** A set of monitored resources in the group. */
619
+ members?: MonitoredResource[];
620
+ /**
621
+ * 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
622
+ * method.
623
+ */
624
+ nextPageToken?: string;
625
+ /** The total number of elements matching this request. */
626
+ totalSize?: number;
627
+ }
628
+ interface ListGroupsResponse {
629
+ /** The groups that match the specified filters. */
630
+ group?: Group[];
631
+ /**
632
+ * 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
633
+ * method.
634
+ */
635
+ nextPageToken?: string;
636
+ }
637
+ interface ListMetricDescriptorsResponse {
638
+ /** The metric descriptors that are available to the project and that match the value of filter, if present. */
639
+ metricDescriptors?: MetricDescriptor[];
640
+ /**
641
+ * 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
642
+ * method.
643
+ */
644
+ nextPageToken?: string;
645
+ }
646
+ interface ListMonitoredResourceDescriptorsResponse {
647
+ /**
648
+ * 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
649
+ * method.
650
+ */
651
+ nextPageToken?: string;
652
+ /** The monitored resource descriptors that are available to this project and that match filter, if present. */
653
+ resourceDescriptors?: MonitoredResourceDescriptor[];
654
+ }
655
+ interface ListNotificationChannelDescriptorsResponse {
656
+ /** The monitored resource descriptors supported for the specified project, optionally filtered. */
657
+ channelDescriptors?: NotificationChannelDescriptor[];
658
+ /**
659
+ * If not empty, indicates that there may be more results that match the request. Use the value in the page_token field in a subsequent request to fetch the next set of results. If
660
+ * empty, all results have been returned.
661
+ */
662
+ nextPageToken?: string;
663
+ }
664
+ interface ListNotificationChannelsResponse {
665
+ /**
666
+ * If not empty, indicates that there may be more results that match the request. Use the value in the page_token field in a subsequent request to fetch the next set of results. If
667
+ * empty, all results have been returned.
668
+ */
669
+ nextPageToken?: string;
670
+ /** The notification channels defined for the specified project. */
671
+ notificationChannels?: NotificationChannel[];
672
+ /** The total number of notification channels in all pages. This number is only an estimate, and may change in subsequent pages. https://aip.dev/158 */
673
+ totalSize?: number;
674
+ }
675
+ interface ListServiceLevelObjectivesResponse {
676
+ /**
677
+ * 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
678
+ * method.
679
+ */
680
+ nextPageToken?: string;
681
+ /** The ServiceLevelObjectives matching the specified filter. */
682
+ serviceLevelObjectives?: ServiceLevelObjective[];
683
+ }
684
+ interface ListServicesResponse {
685
+ /**
686
+ * 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
687
+ * method.
688
+ */
689
+ nextPageToken?: string;
690
+ /** The Services matching the specified filter. */
691
+ services?: Service[];
692
+ }
693
+ interface ListTimeSeriesResponse {
694
+ /** Query execution errors that may have caused the time series data returned to be incomplete. */
695
+ executionErrors?: Status[];
696
+ /**
697
+ * 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
698
+ * method.
699
+ */
700
+ nextPageToken?: string;
701
+ /** One or more time series that match the filter included in the request. */
702
+ timeSeries?: TimeSeries[];
703
+ /**
704
+ * The unit in which all time_series point values are reported. unit follows the UCUM format for units as seen in https://unitsofmeasure.org/ucum.html. If different time_series have
705
+ * different units (for example, because they come from different metric types, or a unit is absent), then unit will be "{not_a_unit}".
706
+ */
707
+ unit?: string;
708
+ }
709
+ interface ListUptimeCheckConfigsResponse {
710
+ /**
711
+ * This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of
712
+ * results, the value of the next_page_token is passed to the subsequent List method call (in the request message's page_token field).
713
+ */
714
+ nextPageToken?: string;
715
+ /** The total number of Uptime check configurations for the project, irrespective of any pagination. */
716
+ totalSize?: number;
717
+ /** The returned Uptime check configurations. */
718
+ uptimeCheckConfigs?: UptimeCheckConfig[];
719
+ }
720
+ interface ListUptimeCheckIpsResponse {
721
+ /**
722
+ * This field represents the pagination token to retrieve the next page of results. If the value is empty, it means no further results for the request. To retrieve the next page of
723
+ * results, the value of the next_page_token is passed to the subsequent List method call (in the request message's page_token field). NOTE: this field is not yet implemented
724
+ */
725
+ nextPageToken?: string;
726
+ /** The returned list of IP addresses (including region and location) that the checkers run from. */
727
+ uptimeCheckIps?: UptimeCheckIp[];
728
+ }
729
+ interface LogMatch {
730
+ /** Required. A logs-based filter. See Advanced Logs Queries (https://cloud.google.com/logging/docs/view/advanced-queries) for how this filter should be constructed. */
731
+ filter?: string;
732
+ /**
733
+ * Optional. A map from a label key to an extractor expression, which is used to extract the value for this label key. Each entry in this map is a specification for how data should be
734
+ * extracted from log entries that match filter. Each combination of extracted values is treated as a separate rule for the purposes of triggering notifications. Label keys and
735
+ * corresponding values can be used in notifications generated by this condition.Please see the documentation on logs-based metric valueExtractors
736
+ * (https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.metrics#LogMetric.FIELDS.value_extractor) for syntax and examples.
737
+ */
738
+ labelExtractors?: { [P in string]: string };
739
+ }
740
+ interface MeshIstio {
741
+ /** Identifier for the mesh in which this Istio service is defined. Corresponds to the mesh_uid metric label in Istio metrics. */
742
+ meshUid?: string;
743
+ /** The name of the Istio service underlying this service. Corresponds to the destination_service_name metric label in Istio metrics. */
744
+ serviceName?: string;
745
+ /** The namespace of the Istio service underlying this service. Corresponds to the destination_service_namespace metric label in Istio metrics. */
746
+ serviceNamespace?: string;
747
+ }
748
+ interface Metric {
749
+ /** The set of label values that uniquely identify this metric. All labels listed in the MetricDescriptor must be assigned values. */
750
+ labels?: { [P in string]: string };
751
+ /** An existing metric type, see google.api.MetricDescriptor. For example, custom.googleapis.com/invoice/paid/amount. */
752
+ type?: string;
753
+ }
754
+ interface MetricAbsence {
755
+ /**
756
+ * Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each
757
+ * resource to a single stream for each resource or when aggregating streams across all members of a group of resources). Multiple aggregations are applied in the order specified.This
758
+ * field is similar to the one in the ListTimeSeries request (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list). It is advisable to use the
759
+ * ListTimeSeries method when debugging this field.
760
+ */
761
+ aggregations?: Aggregation[];
762
+ /**
763
+ * The amount of time that a time series must fail to report new data to be considered failing. The minimum value of this field is 120 seconds. Larger values that are a multiple of a
764
+ * minute--for example, 240 or 300 seconds--are supported. If an invalid value is given, an error will be returned. The Duration.nanos field is ignored.
765
+ */
766
+ duration?: string;
767
+ /**
768
+ * Required. A filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies which time series should be compared with the threshold.The filter is similar to the one that
769
+ * is specified in the ListTimeSeries request (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) (that call is useful to verify the time series that will
770
+ * be retrieved / processed). The filter must specify the metric type and the resource type. Optionally, it can specify resource labels and metric labels. This field must not exceed
771
+ * 2048 Unicode characters in length.
772
+ */
773
+ filter?: string;
774
+ /**
775
+ * The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true
776
+ * for any of the time series that have been identified by filter and aggregations.
777
+ */
778
+ trigger?: Trigger;
779
+ }
780
+ interface MetricDescriptor {
781
+ /** A detailed description of the metric, which can be used in documentation. */
782
+ description?: string;
783
+ /**
784
+ * A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is
785
+ * recommended to be set for any metrics associated with user-visible concepts, such as Quota.
786
+ */
787
+ displayName?: string;
788
+ /**
789
+ * The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a
790
+ * label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.
791
+ */
792
+ labels?: LabelDescriptor[];
793
+ /** Optional. The launch stage of the metric definition. */
794
+ launchStage?: string;
795
+ /** Optional. Metadata which can be used to guide usage of the metric. */
796
+ metadata?: MetricDescriptorMetadata;
797
+ /** Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported. */
798
+ metricKind?: string;
799
+ /**
800
+ * Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be
801
+ * associated with one of the monitored resource types listed here.
802
+ */
803
+ monitoredResourceTypes?: string[];
804
+ /** The resource name of the metric descriptor. */
805
+ name?: string;
806
+ /**
807
+ * The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name custom.googleapis.com or external.googleapis.com. Metric
808
+ * types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up"
809
+ * "appengine.googleapis.com/http/server/response_latencies"
810
+ */
811
+ type?: string;
812
+ /**
813
+ * The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric
814
+ * values.Different systems might scale the values to be more easily displayed (so a value of 0.02kBy might be displayed as 20By, and a value of 3523kBy might be displayed as 3.5MBy).
815
+ * However, if the unit is kBy, then the value of the metric is always in thousands of bytes, no matter how it might be displayed.If you want a custom metric to record the exact number
816
+ * of CPU-seconds used by a job, you can create an INT64 CUMULATIVE metric whose unit is s{CPU} (or equivalently 1s{CPU} or just s). If the job uses 12,005 CPU-seconds, then the value
817
+ * is written as 12005.Alternatively, if you want a custom metric to record data in a more granular way, you can create a DOUBLE CUMULATIVE metric whose unit is ks{CPU}, and then write
818
+ * the value 12.005 (which is 12005/1000), or use Kis{CPU} and write 11.723 (which is 12005/1024).The supported units are a subset of The Unified Code for Units of Measure
819
+ * (https://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT) bit bit By byte s second min minute h hour d day 1 dimensionlessPrefixes (PREFIX) k kilo (10^3) M mega (10^6) G
820
+ * giga (10^9) T tera (10^12) P peta (10^15) E exa (10^18) Z zetta (10^21) Y yotta (10^24) m milli (10^-3) u micro (10^-6) n nano (10^-9) p pico (10^-12) f femto (10^-15) a atto
821
+ * (10^-18) z zepto (10^-21) y yocto (10^-24) Ki kibi (2^10) Mi mebi (2^20) Gi gibi (2^30) Ti tebi (2^40) Pi pebi (2^50)GrammarThe grammar also includes these connectors: / division or
822
+ * ratio (as an infix operator). For examples, kBy/{email} or MiBy/10ms (although you should almost never have /s in a metric unit; rates should always be computed at query time from
823
+ * the underlying cumulative or delta value). . multiplication or composition (as an infix operator). For examples, GBy.d or k{watt}.h.The grammar for a unit is as follows: Expression
824
+ * = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}" ; Notes: Annotation is just a
825
+ * comment if it follows a UNIT. If the annotation is used alone, then the unit is equivalent to 1. For examples, {request}/s == 1/s, By{transmitted}/s == By/s. NAME is a sequence of
826
+ * non-blank printable ASCII characters not containing { or }. 1 represents a unitary dimensionless unit (https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in 1/s. It
827
+ * is typically used when none of the basic units are appropriate. For example, "new users per day" can be represented as 1/d or {new-users}/d (and a metric value 5 would mean "5 new
828
+ * users). Alternatively, "thousands of page views per day" would be represented as 1000/d or k1/d or k{page_views}/d (and a metric value of 5.3 would mean "5300 page views per day").
829
+ * % represents dimensionless value of 1/100, and annotates values giving a percentage (so the metric values are typically in the range of 0..100, and a metric value 3 means "3
830
+ * percent"). 10^2.% indicates a metric contains a ratio, typically in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value 0.03 means "3
831
+ * percent").
832
+ */
833
+ unit?: string;
834
+ /** Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported. */
835
+ valueType?: string;
836
+ }
837
+ interface MetricDescriptorMetadata {
838
+ /** The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. */
839
+ ingestDelay?: string;
840
+ /** Deprecated. Must use the MetricDescriptor.launch_stage instead. */
841
+ launchStage?: string;
842
+ /**
843
+ * The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors.
844
+ * Metrics with a higher granularity have a smaller sampling period.
845
+ */
846
+ samplePeriod?: string;
847
+ }
848
+ interface MetricRange {
849
+ /** Range of values considered "good." For a one-sided range, set one bound to an infinite value. */
850
+ range?: GoogleMonitoringV3Range;
851
+ /** A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying the TimeSeries to use for evaluating window quality. */
852
+ timeSeries?: string;
853
+ }
854
+ interface MetricThreshold {
855
+ /**
856
+ * Specifies the alignment of data points in individual time series as well as how to combine the retrieved time series together (such as when aggregating multiple streams on each
857
+ * resource to a single stream for each resource or when aggregating streams across all members of a group of resources). Multiple aggregations are applied in the order specified.This
858
+ * field is similar to the one in the ListTimeSeries request (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list). It is advisable to use the
859
+ * ListTimeSeries method when debugging this field.
860
+ */
861
+ aggregations?: Aggregation[];
862
+ /**
863
+ * The comparison to apply between the time series (indicated by filter and aggregation) and the threshold (indicated by threshold_value). The comparison is applied on each time
864
+ * series, with the time series on the left-hand side and the threshold on the right-hand side.Only COMPARISON_LT and COMPARISON_GT are supported currently.
865
+ */
866
+ comparison?: string;
867
+ /**
868
+ * Specifies the alignment of data points in individual time series selected by denominatorFilter as well as how to combine the retrieved time series together (such as when aggregating
869
+ * multiple streams on each resource to a single stream for each resource or when aggregating streams across all members of a group of resources).When computing ratios, the
870
+ * aggregations and denominator_aggregations fields must use the same alignment period and produce time series that have the same periodicity and labels.
871
+ */
872
+ denominatorAggregations?: Aggregation[];
873
+ /**
874
+ * A filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies a time series that should be used as the denominator of a ratio that will be compared with the
875
+ * threshold. If a denominator_filter is specified, the time series specified by the filter field will be used as the numerator.The filter must specify the metric type and optionally
876
+ * may contain restrictions on resource type, resource labels, and metric labels. This field may not exceed 2048 Unicode characters in length.
877
+ */
878
+ denominatorFilter?: string;
879
+ /**
880
+ * The amount of time that a time series must violate the threshold to be considered failing. Currently, only values that are a multiple of a minute--e.g., 0, 60, 120, or 300
881
+ * seconds--are supported. If an invalid value is given, an error will be returned. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series
882
+ * data (which may also be affected by any alignments specified in the aggregations field); a good duration is long enough so that a single outlier does not generate spurious alerts,
883
+ * but short enough that unhealthy states are detected and alerted on quickly.
884
+ */
885
+ duration?: string;
886
+ /** A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. */
887
+ evaluationMissingData?: string;
888
+ /**
889
+ * Required. A filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies which time series should be compared with the threshold.The filter is similar to the one that
890
+ * is specified in the ListTimeSeries request (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) (that call is useful to verify the time series that will
891
+ * be retrieved / processed). The filter must specify the metric type and the resource type. Optionally, it can specify resource labels and metric labels. This field must not exceed
892
+ * 2048 Unicode characters in length.
893
+ */
894
+ filter?: string;
895
+ /** A value against which to compare the time series. */
896
+ thresholdValue?: number;
897
+ /**
898
+ * The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true
899
+ * for any of the time series that have been identified by filter and aggregations, or by the ratio, if denominator_filter and denominator_aggregations are specified.
900
+ */
901
+ trigger?: Trigger;
902
+ }
903
+ interface MonitoredResource {
904
+ /**
905
+ * Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels "project_id", "instance_id",
906
+ * and "zone".
907
+ */
908
+ labels?: { [P in string]: string };
909
+ /**
910
+ * Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is
911
+ * gce_instance. For a list of types, see Monitoring resource types (https://cloud.google.com/monitoring/api/resources) and Logging resource types
912
+ * (https://cloud.google.com/logging/docs/api/v2/resource-list).
913
+ */
914
+ type?: string;
915
+ }
916
+ interface MonitoredResourceDescriptor {
917
+ /** Optional. A detailed description of the monitored resource type that might be used in documentation. */
918
+ description?: string;
919
+ /**
920
+ * Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other
921
+ * determiners. For example, "Google Cloud SQL Database".
922
+ */
923
+ displayName?: string;
924
+ /**
925
+ * Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels
926
+ * "database_id" and "zone".
927
+ */
928
+ labels?: LabelDescriptor[];
929
+ /** Optional. The launch stage of the monitored resource definition. */
930
+ launchStage?: string;
931
+ /**
932
+ * Optional. The resource name of the monitored resource descriptor: "projects/{project_id}/monitoredResourceDescriptors/{type}" where {type} is the value of the type field in this
933
+ * object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format
934
+ * "monitoredResourceDescriptors/{type}".
935
+ */
936
+ name?: string;
937
+ /**
938
+ * Required. The monitored resource type. For example, the type "cloudsql_database" represents databases in Google Cloud SQL. For a list of types, see Monitoring resource types
939
+ * (https://cloud.google.com/monitoring/api/resources) and Logging resource types (https://cloud.google.com/logging/docs/api/v2/resource-list).
940
+ */
941
+ type?: string;
942
+ }
943
+ interface MonitoredResourceMetadata {
944
+ /**
945
+ * Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google, including "machine_image", "vpc", "subnet_id", "security_group",
946
+ * "name", etc. System label values can be only strings, Boolean values, or a list of strings. For example: { "name": "my-test-instance", "security_group": ["a", "b", "c"],
947
+ * "spot_instance": false }
948
+ */
949
+ systemLabels?: { [P in string]: any };
950
+ /** Output only. A map of user-defined metadata labels. */
951
+ userLabels?: { [P in string]: string };
952
+ }
953
+ interface MonitoringQueryLanguageCondition {
954
+ /**
955
+ * The amount of time that a time series must violate the threshold to be considered failing. Currently, only values that are a multiple of a minute--e.g., 0, 60, 120, or 300
956
+ * seconds--are supported. If an invalid value is given, an error will be returned. When choosing a duration, it is useful to keep in mind the frequency of the underlying time series
957
+ * data (which may also be affected by any alignments specified in the aggregations field); a good duration is long enough so that a single outlier does not generate spurious alerts,
958
+ * but short enough that unhealthy states are detected and alerted on quickly.
959
+ */
960
+ duration?: string;
961
+ /** A condition control that determines how metric-threshold conditions are evaluated when data stops arriving. */
962
+ evaluationMissingData?: string;
963
+ /** Monitoring Query Language (https://cloud.google.com/monitoring/mql) query that outputs a boolean stream. */
964
+ query?: string;
965
+ /**
966
+ * The number/percent of time series for which the comparison must hold in order for the condition to trigger. If unspecified, then the condition will trigger if the comparison is true
967
+ * for any of the time series that have been identified by filter and aggregations, or by the ratio, if denominator_filter and denominator_aggregations are specified.
968
+ */
969
+ trigger?: Trigger;
970
+ }
971
+ interface MutationRecord {
972
+ /** The email address of the user making the change. */
973
+ mutatedBy?: string;
974
+ /** When the change occurred. */
975
+ mutateTime?: string;
976
+ }
977
+ interface NotificationChannel {
978
+ /** Record of the creation of this channel. */
979
+ creationRecord?: MutationRecord;
980
+ /**
981
+ * An optional human-readable description of this notification channel. This description may provide additional details, beyond the display name, for the channel. This may not exceed
982
+ * 1024 Unicode characters.
983
+ */
984
+ description?: string;
985
+ /**
986
+ * An optional human-readable name for this notification channel. It is recommended that you specify a non-empty and unique name in order to make it easier to identify the channels in
987
+ * your project, though this is not enforced. The display name is limited to 512 Unicode characters.
988
+ */
989
+ displayName?: string;
990
+ /**
991
+ * Whether notifications are forwarded to the described channel. This makes it possible to disable delivery of notifications to a particular channel without removing the channel from
992
+ * all alerting policies that reference the channel. This is a more convenient approach when the change is temporary and you want to receive notifications from the same set of alerting
993
+ * policies on the channel at some point in the future.
994
+ */
995
+ enabled?: boolean;
996
+ /**
997
+ * Configuration fields that define the channel and its behavior. The permissible and required labels are specified in the NotificationChannelDescriptor.labels of the
998
+ * NotificationChannelDescriptor corresponding to the type field.
999
+ */
1000
+ labels?: { [P in string]: string };
1001
+ /** Records of the modification of this channel. */
1002
+ mutationRecords?: MutationRecord[];
1003
+ /**
1004
+ * The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the
1005
+ * server on creation.
1006
+ */
1007
+ name?: string;
1008
+ /** The type of the notification channel. This field matches the value of the NotificationChannelDescriptor.type field. */
1009
+ type?: string;
1010
+ /**
1011
+ * User-supplied key/value data that does not need to conform to the corresponding NotificationChannelDescriptor's schema, unlike the labels field. This field is intended to be used
1012
+ * for organizing and identifying the NotificationChannel objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever
1013
+ * is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.
1014
+ */
1015
+ userLabels?: { [P in string]: string };
1016
+ /**
1017
+ * Indicates whether this channel has been verified or not. On a ListNotificationChannels or GetNotificationChannel operation, this field is expected to be populated.If the value is
1018
+ * UNVERIFIED, then it indicates that the channel is non-functioning (it both requires verification and lacks verification); otherwise, it is assumed that the channel works.If the
1019
+ * channel is neither VERIFIED nor UNVERIFIED, it implies that the channel is of a type that does not require verification or that this specific channel has been exempted from
1020
+ * verification because it was created prior to verification being required for channels of this type.This field cannot be modified using a standard UpdateNotificationChannel
1021
+ * operation. To change the value of this field, you must call VerifyNotificationChannel.
1022
+ */
1023
+ verificationStatus?: string;
1024
+ }
1025
+ interface NotificationChannelDescriptor {
1026
+ /** A human-readable description of the notification channel type. The description may include a description of the properties of the channel and pointers to external documentation. */
1027
+ description?: string;
1028
+ /** A human-readable name for the notification channel type. This form of the name is suitable for a user interface. */
1029
+ displayName?: string;
1030
+ /** The set of labels that must be defined to identify a particular channel of the corresponding type. Each label includes a description for how that field should be populated. */
1031
+ labels?: LabelDescriptor[];
1032
+ /** The product launch stage for channels of this type. */
1033
+ launchStage?: string;
1034
+ /**
1035
+ * The full REST resource name for this descriptor. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[TYPE] In the above, [TYPE] is the value of the type
1036
+ * field.
1037
+ */
1038
+ name?: string;
1039
+ /** The tiers that support this notification channel; the project service tier must be one of the supported_tiers. */
1040
+ supportedTiers?: string[];
1041
+ /**
1042
+ * The type of notification channel, such as "email" and "sms". To view the full list of channels, see Channel descriptors
1043
+ * (https://cloud.google.com/monitoring/alerts/using-channels-api#ncd). Notification channel types are globally unique.
1044
+ */
1045
+ type?: string;
1046
+ }
1047
+ interface NotificationRateLimit {
1048
+ /** Not more than one notification per period. */
1049
+ period?: string;
1050
+ }
1051
+ interface OperationMetadata {
1052
+ /** The time when the batch request was received. */
1053
+ createTime?: string;
1054
+ /** Current state of the batch operation. */
1055
+ state?: string;
1056
+ /** The time when the operation result was last updated. */
1057
+ updateTime?: string;
1058
+ }
1059
+ interface Option {
1060
+ /**
1061
+ * 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
1062
+ * fully-qualified name. For example, "google.api.http".
1063
+ */
1064
+ name?: string;
1065
+ /**
1066
+ * 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
1067
+ * enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.
1068
+ */
1069
+ value?: { [P in string]: any };
1070
+ }
1071
+ interface PerformanceThreshold {
1072
+ /** BasicSli to evaluate to judge window quality. */
1073
+ basicSliPerformance?: BasicSli;
1074
+ /** RequestBasedSli to evaluate to judge window quality. */
1075
+ performance?: RequestBasedSli;
1076
+ /** If window performance >= threshold, the window is counted as good. */
1077
+ threshold?: number;
1078
+ }
1079
+ interface Point {
1080
+ /**
1081
+ * The time interval to which the data point applies. For GAUGE metrics, the start time is optional, but if it is supplied, it must equal the end time. For DELTA metrics, the start and
1082
+ * end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should
1083
+ * specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start
1084
+ * time for the following points.
1085
+ */
1086
+ interval?: TimeInterval;
1087
+ /** The value of the data point. */
1088
+ value?: TypedValue;
1089
+ }
1090
+ interface PointData {
1091
+ /** The time interval associated with the point. */
1092
+ timeInterval?: TimeInterval;
1093
+ /** The values that make up the point. */
1094
+ values?: TypedValue[];
1095
+ }
1096
+ interface QueryTimeSeriesRequest {
1097
+ /** A positive number that is the maximum number of time_series_data to return. */
1098
+ pageSize?: number;
1099
+ /**
1100
+ * If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results
1101
+ * from the previous method call.
1102
+ */
1103
+ pageToken?: string;
1104
+ /** Required. The query in the Monitoring Query Language (https://cloud.google.com/monitoring/mql/reference) format. The default time zone is in UTC. */
1105
+ query?: string;
1106
+ }
1107
+ interface QueryTimeSeriesResponse {
1108
+ /**
1109
+ * 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
1110
+ * method.
1111
+ */
1112
+ nextPageToken?: string;
1113
+ /** Query execution errors that may have caused the time series data returned to be incomplete. The available data will be available in the response. */
1114
+ partialErrors?: Status[];
1115
+ /** The time series data. */
1116
+ timeSeriesData?: TimeSeriesData[];
1117
+ /** The descriptor for the time series data. */
1118
+ timeSeriesDescriptor?: TimeSeriesDescriptor;
1119
+ }
1120
+ interface Range {
1121
+ /** The maximum of the population values. */
1122
+ max?: number;
1123
+ /** The minimum of the population values. */
1124
+ min?: number;
1125
+ }
1126
+ interface RequestBasedSli {
1127
+ /**
1128
+ * distribution_cut is used when good_service is a count of values aggregated in a Distribution that fall into a good range. The total_service is the total count of all values
1129
+ * aggregated in the Distribution.
1130
+ */
1131
+ distributionCut?: DistributionCut;
1132
+ /** good_total_ratio is used when the ratio of good_service to total_service is computed from two TimeSeries. */
1133
+ goodTotalRatio?: TimeSeriesRatio;
1134
+ }
1135
+ interface ResourceGroup {
1136
+ /** The group of resources being monitored. Should be only the [GROUP_ID], and not the full-path projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID]. */
1137
+ groupId?: string;
1138
+ /** The resource type of the group members. */
1139
+ resourceType?: string;
1140
+ }
1141
+ interface ResponseStatusCode {
1142
+ /** A class of status codes to accept. */
1143
+ statusClass?: string;
1144
+ /** A status code to accept. */
1145
+ statusValue?: number;
1146
+ }
1147
+ // tslint:disable-next-line:no-empty-interface
1148
+ interface SendNotificationChannelVerificationCodeRequest {
1149
+ }
1150
+ interface Service {
1151
+ /** Type used for App Engine services. */
1152
+ appEngine?: AppEngine;
1153
+ /** Type used for Cloud Endpoints services. */
1154
+ cloudEndpoints?: CloudEndpoints;
1155
+ /** Type used for Cloud Run services. */
1156
+ cloudRun?: CloudRun;
1157
+ /** Type used for Istio services that live in a Kubernetes cluster. */
1158
+ clusterIstio?: ClusterIstio;
1159
+ /** Custom service type. */
1160
+ custom?: any;
1161
+ /** Name used for UI elements listing this Service. */
1162
+ displayName?: string;
1163
+ /** Type used for GKE Namespaces. */
1164
+ gkeNamespace?: GkeNamespace;
1165
+ /** Type used for GKE Services (the Kubernetes concept of a service). */
1166
+ gkeService?: GkeService;
1167
+ /** Type used for GKE Workloads. */
1168
+ gkeWorkload?: GkeWorkload;
1169
+ /** Type used for canonical services scoped to an Istio mesh. Metrics for Istio are documented here (https://istio.io/latest/docs/reference/config/metrics/) */
1170
+ istioCanonicalService?: IstioCanonicalService;
1171
+ /** Type used for Istio services scoped to an Istio mesh. */
1172
+ meshIstio?: MeshIstio;
1173
+ /** Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] */
1174
+ name?: string;
1175
+ /** Configuration for how to query telemetry on a Service. */
1176
+ telemetry?: Telemetry;
1177
+ /**
1178
+ * Labels which have been used to annotate the service. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores, and dashes.
1179
+ * Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have a semantic
1180
+ * value, the empty string may be supplied for the label value.
1181
+ */
1182
+ userLabels?: { [P in string]: string };
1183
+ }
1184
+ interface ServiceLevelIndicator {
1185
+ /** Basic SLI on a well-known service type. */
1186
+ basicSli?: BasicSli;
1187
+ /** Request-based SLIs */
1188
+ requestBased?: RequestBasedSli;
1189
+ /** Windows-based SLIs */
1190
+ windowsBased?: WindowsBasedSli;
1191
+ }
1192
+ interface ServiceLevelObjective {
1193
+ /** A calendar period, semantically "since the start of the current ". At this time, only DAY, WEEK, FORTNIGHT, and MONTH are supported. */
1194
+ calendarPeriod?: string;
1195
+ /** Name used for UI elements listing this SLO. */
1196
+ displayName?: string;
1197
+ /** The fraction of service that must be good in order for this objective to be met. 0 < goal <= 0.999. */
1198
+ goal?: number;
1199
+ /** Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] */
1200
+ name?: string;
1201
+ /** A rolling time period, semantically "in the past ". Must be an integer multiple of 1 day no larger than 30 days. */
1202
+ rollingPeriod?: string;
1203
+ /** The definition of good service, used to measure and calculate the quality of the Service's performance with respect to a single aspect of service quality. */
1204
+ serviceLevelIndicator?: ServiceLevelIndicator;
1205
+ /**
1206
+ * Labels which have been used to annotate the service-level objective. Label keys must start with a letter. Label keys and values may contain lowercase letters, numbers, underscores,
1207
+ * and dashes. Label keys and values have a maximum length of 63 characters, and must be less than 128 bytes in size. Up to 64 label entries may be stored. For labels which do not have
1208
+ * a semantic value, the empty string may be supplied for the label value.
1209
+ */
1210
+ userLabels?: { [P in string]: string };
1211
+ }
1212
+ interface SourceContext {
1213
+ /** The path-qualified name of the .proto file that contained the associated protobuf element. For example: "google/protobuf/source_context.proto". */
1214
+ fileName?: string;
1215
+ }
1216
+ interface SpanContext {
1217
+ /**
1218
+ * 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
1219
+ * 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.
1220
+ */
1221
+ spanName?: string;
1222
+ }
1223
+ interface Status {
1224
+ /** The status code, which should be an enum value of google.rpc.Code. */
1225
+ code?: number;
1226
+ /** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
1227
+ details?: Array<{ [P in string]: any }>;
1228
+ /**
1229
+ * 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
1230
+ * client.
1231
+ */
1232
+ message?: string;
1233
+ }
1234
+ interface TcpCheck {
1235
+ /** The TCP port on the server against which to run the check. Will be combined with host (specified within the monitored_resource) to construct the full URL. Required. */
1236
+ port?: number;
1237
+ }
1238
+ interface Telemetry {
1239
+ /** The full name of the resource that defines this service. Formatted as described in https://cloud.google.com/apis/design/resource_names. */
1240
+ resourceName?: string;
1241
+ }
1242
+ interface TimeInterval {
1243
+ /** Required. The end of the time interval. */
1244
+ endTime?: string;
1245
+ /** Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. */
1246
+ startTime?: string;
1247
+ }
1248
+ interface TimeSeries {
1249
+ /**
1250
+ * Output only. The associated monitored resource metadata. When reading a time series, this field will include metadata labels that are explicitly named in the reduction. When
1251
+ * creating a time series, this field is ignored.
1252
+ */
1253
+ metadata?: MonitoredResourceMetadata;
1254
+ /** The associated metric. A fully-specified metric used to identify the time series. */
1255
+ metric?: Metric;
1256
+ /**
1257
+ * The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment
1258
+ * or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated
1259
+ * metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.
1260
+ */
1261
+ metricKind?: string;
1262
+ /**
1263
+ * The data points of this time series. When listing time series, points are returned in reverse time order.When creating a time series, this field must contain exactly one point and
1264
+ * the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is
1265
+ * determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.
1266
+ */
1267
+ points?: Point[];
1268
+ /**
1269
+ * The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data. For more information, see Monitored resources for custom
1270
+ * metrics (https://cloud.google.com/monitoring/custom-metrics/creating-metrics#custom-metric-resources).
1271
+ */
1272
+ resource?: MonitoredResource;
1273
+ /**
1274
+ * The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric
1275
+ * values.
1276
+ */
1277
+ unit?: string;
1278
+ /**
1279
+ * The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or
1280
+ * reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field.
1281
+ */
1282
+ valueType?: string;
1283
+ }
1284
+ interface TimeSeriesData {
1285
+ /**
1286
+ * The values of the labels in the time series identifier, given in the same order as the label_descriptors field of the TimeSeriesDescriptor associated with this object. Each value
1287
+ * must have a value of the type given in the corresponding entry of label_descriptors.
1288
+ */
1289
+ labelValues?: LabelValue[];
1290
+ /** The points in the time series. */
1291
+ pointData?: PointData[];
1292
+ }
1293
+ interface TimeSeriesDescriptor {
1294
+ /** Descriptors for the labels. */
1295
+ labelDescriptors?: LabelDescriptor[];
1296
+ /** Descriptors for the point data value columns. */
1297
+ pointDescriptors?: ValueDescriptor[];
1298
+ }
1299
+ interface TimeSeriesRatio {
1300
+ /**
1301
+ * A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying a TimeSeries quantifying bad service, either demanded service that was not provided or demanded
1302
+ * service that was of inadequate quality. Must have ValueType = DOUBLE or ValueType = INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE.
1303
+ */
1304
+ badServiceFilter?: string;
1305
+ /**
1306
+ * A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying a TimeSeries quantifying good service provided. Must have ValueType = DOUBLE or ValueType = INT64
1307
+ * and must have MetricKind = DELTA or MetricKind = CUMULATIVE.
1308
+ */
1309
+ goodServiceFilter?: string;
1310
+ /**
1311
+ * A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying a TimeSeries quantifying total demanded service. Must have ValueType = DOUBLE or ValueType =
1312
+ * INT64 and must have MetricKind = DELTA or MetricKind = CUMULATIVE.
1313
+ */
1314
+ totalServiceFilter?: string;
1315
+ }
1316
+ interface Trigger {
1317
+ /** The absolute number of time series that must fail the predicate for the condition to be triggered. */
1318
+ count?: number;
1319
+ /** The percentage of time series that must fail the predicate for the condition to be triggered. */
1320
+ percent?: number;
1321
+ }
1322
+ interface Type {
1323
+ /** The list of fields. */
1324
+ fields?: Field[];
1325
+ /** The fully qualified message name. */
1326
+ name?: string;
1327
+ /** The list of types appearing in oneof definitions in this type. */
1328
+ oneofs?: string[];
1329
+ /** The protocol buffer options. */
1330
+ options?: Option[];
1331
+ /** The source context. */
1332
+ sourceContext?: SourceContext;
1333
+ /** The source syntax. */
1334
+ syntax?: string;
1335
+ }
1336
+ interface TypedValue {
1337
+ /** A Boolean value: true or false. */
1338
+ boolValue?: boolean;
1339
+ /** A distribution value. */
1340
+ distributionValue?: Distribution;
1341
+ /** A 64-bit double-precision floating-point number. Its magnitude is approximately ±10±300 and it has 16 significant digits of precision. */
1342
+ doubleValue?: number;
1343
+ /** A 64-bit integer. Its range is approximately ±9.2x1018. */
1344
+ int64Value?: string;
1345
+ /** A variable-length string value. */
1346
+ stringValue?: string;
1347
+ }
1348
+ interface UptimeCheckConfig {
1349
+ /** The type of checkers to use to execute the Uptime check. */
1350
+ checkerType?: string;
1351
+ /**
1352
+ * The content that is expected to appear in the data returned by the target server against which the check is run. Currently, only the first entry in the content_matchers list is
1353
+ * supported, and additional entries will be ignored. This field is optional and should only be specified if a content match is required as part of the/ Uptime check.
1354
+ */
1355
+ contentMatchers?: ContentMatcher[];
1356
+ /**
1357
+ * A human-friendly name for the Uptime check configuration. The display name should be unique within a Cloud Monitoring Workspace in order to make it easier to identify; however,
1358
+ * uniqueness is not enforced. Required.
1359
+ */
1360
+ displayName?: string;
1361
+ /** Contains information needed to make an HTTP or HTTPS check. */
1362
+ httpCheck?: HttpCheck;
1363
+ /**
1364
+ * The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project
1365
+ * that owns this UptimeCheckConfig.
1366
+ */
1367
+ internalCheckers?: InternalChecker[];
1368
+ /**
1369
+ * If this is true, then checks are made only from the 'internal_checkers'. If it is false, then checks are made only from the 'selected_regions'. It is an error to provide
1370
+ * 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false.
1371
+ */
1372
+ isInternal?: boolean;
1373
+ /**
1374
+ * The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are valid for this field:
1375
+ * uptime_url, gce_instance, gae_app, aws_ec2_instance, aws_elb_load_balancer k8s_service servicedirectory_service cloud_run_revision
1376
+ */
1377
+ monitoredResource?: MonitoredResource;
1378
+ /**
1379
+ * A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] [PROJECT_ID_OR_NUMBER] is the
1380
+ * Workspace host project associated with the Uptime check.This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the
1381
+ * server and included in the response.
1382
+ */
1383
+ name?: string;
1384
+ /**
1385
+ * How often, in seconds, the Uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional,
1386
+ * defaults to 60s.
1387
+ */
1388
+ period?: string;
1389
+ /** The group resource associated with the configuration. */
1390
+ resourceGroup?: ResourceGroup;
1391
+ /**
1392
+ * The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions must be
1393
+ * provided to include a minimum of 3 locations. Not specifying this field will result in Uptime checks running from all available regions.
1394
+ */
1395
+ selectedRegions?: string[];
1396
+ /** Contains information needed to make a TCP check. */
1397
+ tcpCheck?: TcpCheck;
1398
+ /** The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required. */
1399
+ timeout?: string;
1400
+ /**
1401
+ * User-supplied key/value data to be used for organizing and identifying the UptimeCheckConfig objects.The field can contain up to 64 entries. Each key and value is limited to 63
1402
+ * Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.
1403
+ */
1404
+ userLabels?: { [P in string]: string };
1405
+ }
1406
+ interface UptimeCheckIp {
1407
+ /**
1408
+ * The IP address from which the Uptime check originates. This is a fully specified IP address (not an IP address range). Most IP addresses, as of this publication, are in IPv4 format;
1409
+ * however, one should not rely on the IP addresses being in IPv4 format indefinitely, and should support interpreting this field in either IPv4 or IPv6 format.
1410
+ */
1411
+ ipAddress?: string;
1412
+ /**
1413
+ * A more specific location within the region that typically encodes a particular city/town/metro (and its containing state/province or country) within the broader umbrella region
1414
+ * category.
1415
+ */
1416
+ location?: string;
1417
+ /** A broad region category in which the IP address is located. */
1418
+ region?: string;
1419
+ }
1420
+ interface ValueDescriptor {
1421
+ /** The value key. */
1422
+ key?: string;
1423
+ /** The value stream kind. */
1424
+ metricKind?: string;
1425
+ /**
1426
+ * The unit in which time_series point values are reported. unit follows the UCUM format for units as seen in https://unitsofmeasure.org/ucum.html. unit is only valid if value_type is
1427
+ * INTEGER, DOUBLE, DISTRIBUTION.
1428
+ */
1429
+ unit?: string;
1430
+ /** The value type. */
1431
+ valueType?: string;
1432
+ }
1433
+ interface VerifyNotificationChannelRequest {
1434
+ /**
1435
+ * Required. The verification code that was delivered to the channel as a result of invoking the SendNotificationChannelVerificationCode API method or that was retrieved from a
1436
+ * verified channel via GetNotificationChannelVerificationCode. For example, one might have "G-123456" or "TKNZGhhd2EyN3I1MnRnMjRv" (in general, one is only guaranteed that the code is
1437
+ * valid UTF-8; one should not make any assumptions regarding the structure or format of the code).
1438
+ */
1439
+ code?: string;
1440
+ }
1441
+ interface WindowsBasedSli {
1442
+ /** A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) specifying a TimeSeries with ValueType = BOOL. The window is good if any true values appear in the window. */
1443
+ goodBadMetricFilter?: string;
1444
+ /** A window is good if its performance is high enough. */
1445
+ goodTotalRatioThreshold?: PerformanceThreshold;
1446
+ /** A window is good if the metric's value is in a good range, averaged across returned streams. */
1447
+ metricMeanInRange?: MetricRange;
1448
+ /** A window is good if the metric's value is in a good range, summed across returned streams. */
1449
+ metricSumInRange?: MetricRange;
1450
+ /** Duration over which window quality is evaluated. Must be an integer fraction of a day and at least 60s. */
1451
+ windowPeriod?: string;
1452
+ }
1453
+ interface TimeSeriesResource {
1454
+ /** Lists time series that match a filter. */
1455
+ list(request?: {
1456
+ /** V1 error format. */
1457
+ "$.xgafv"?: string;
1458
+ /** OAuth access token. */
1459
+ access_token?: string;
1460
+ /**
1461
+ * 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
1462
+ * 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
1463
+ * 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 104
1464
+ * weeks (2 years) for charts, and 90,000 seconds (25 hours) for alerting policies.
1465
+ */
1466
+ "aggregation.alignmentPeriod"?: string;
1467
+ /**
1468
+ * 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
1469
+ * 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
1470
+ * 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
1471
+ * 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.
1472
+ * An alignment_period must also be specified; otherwise, an error is returned.
1473
+ */
1474
+ "aggregation.crossSeriesReducer"?: string;
1475
+ /**
1476
+ * 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
1477
+ * 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.
1478
+ * 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.
1479
+ * 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
1480
+ * aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored.
1481
+ */
1482
+ "aggregation.groupByFields"?: string | string[];
1483
+ /**
1484
+ * 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
1485
+ * 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
1486
+ * 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
1487
+ * 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
1488
+ * must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned.
1489
+ */
1490
+ "aggregation.perSeriesAligner"?: string;
1491
+ /** Data format for response. */
1492
+ alt?: string;
1493
+ /** JSONP */
1494
+ callback?: string;
1495
+ /** Selector specifying which fields to include in a partial response. */
1496
+ fields?: string;
1497
+ /**
1498
+ * Required. A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that specifies which time series should be returned. The filter must specify a single metric
1499
+ * type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
1500
+ * metric.labels.instance_name = "my-instance-name"
1501
+ */
1502
+ filter?: string;
1503
+ /** Required. The end of the time interval. */
1504
+ "interval.endTime"?: string;
1505
+ /** Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. */
1506
+ "interval.startTime"?: string;
1507
+ /** 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. */
1508
+ key?: string;
1509
+ /**
1510
+ * Required. The project (https://cloud.google.com/monitoring/api/v3#project_name), organization or folder on which to execute the request. The format is:
1511
+ * projects/[PROJECT_ID_OR_NUMBER] organizations/[ORGANIZATION_ID] folders/[FOLDER_ID]
1512
+ */
1513
+ name: string;
1514
+ /** OAuth 2.0 token for the current user. */
1515
+ oauth_token?: string;
1516
+ /** Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest). */
1517
+ orderBy?: string;
1518
+ /**
1519
+ * A positive number that is the maximum number of results to return. If page_size is empty or more than 100,000 results, the effective page_size is 100,000 results. If view is set
1520
+ * to FULL, this is the maximum number of Points returned. If view is set to HEADERS, this is the maximum number of TimeSeries returned.
1521
+ */
1522
+ pageSize?: number;
1523
+ /**
1524
+ * 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
1525
+ * results from the previous method call.
1526
+ */
1527
+ pageToken?: string;
1528
+ /** Returns response with indentations and line breaks. */
1529
+ prettyPrint?: boolean;
1530
+ /** 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. */
1531
+ quotaUser?: string;
1532
+ /**
1533
+ * 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
1534
+ * 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
1535
+ * 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 104
1536
+ * weeks (2 years) for charts, and 90,000 seconds (25 hours) for alerting policies.
1537
+ */
1538
+ "secondaryAggregation.alignmentPeriod"?: string;
1539
+ /**
1540
+ * 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
1541
+ * 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
1542
+ * 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
1543
+ * 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.
1544
+ * An alignment_period must also be specified; otherwise, an error is returned.
1545
+ */
1546
+ "secondaryAggregation.crossSeriesReducer"?: string;
1547
+ /**
1548
+ * 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
1549
+ * 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.
1550
+ * 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.
1551
+ * 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
1552
+ * aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored.
1553
+ */
1554
+ "secondaryAggregation.groupByFields"?: string | string[];
1555
+ /**
1556
+ * 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
1557
+ * 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
1558
+ * 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
1559
+ * 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
1560
+ * must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned.
1561
+ */
1562
+ "secondaryAggregation.perSeriesAligner"?: string;
1563
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1564
+ upload_protocol?: string;
1565
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1566
+ uploadType?: string;
1567
+ /** Required. Specifies which information is returned about the time series. */
1568
+ view?: string;
1569
+ }): Request<ListTimeSeriesResponse>;
1570
+ }
1571
+ interface FoldersResource {
1572
+ timeSeries: TimeSeriesResource;
1573
+ }
1574
+ interface TimeSeriesResource {
1575
+ /** Lists time series that match a filter. */
1576
+ list(request?: {
1577
+ /** V1 error format. */
1578
+ "$.xgafv"?: string;
1579
+ /** OAuth access token. */
1580
+ access_token?: string;
1581
+ /**
1582
+ * 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
1583
+ * 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
1584
+ * 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 104
1585
+ * weeks (2 years) for charts, and 90,000 seconds (25 hours) for alerting policies.
1586
+ */
1587
+ "aggregation.alignmentPeriod"?: string;
1588
+ /**
1589
+ * 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
1590
+ * 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
1591
+ * 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
1592
+ * 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.
1593
+ * An alignment_period must also be specified; otherwise, an error is returned.
1594
+ */
1595
+ "aggregation.crossSeriesReducer"?: string;
1596
+ /**
1597
+ * 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
1598
+ * 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.
1599
+ * 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.
1600
+ * 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
1601
+ * aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored.
1602
+ */
1603
+ "aggregation.groupByFields"?: string | string[];
1604
+ /**
1605
+ * 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
1606
+ * 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
1607
+ * 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
1608
+ * 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
1609
+ * must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned.
1610
+ */
1611
+ "aggregation.perSeriesAligner"?: string;
1612
+ /** Data format for response. */
1613
+ alt?: string;
1614
+ /** JSONP */
1615
+ callback?: string;
1616
+ /** Selector specifying which fields to include in a partial response. */
1617
+ fields?: string;
1618
+ /**
1619
+ * Required. A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that specifies which time series should be returned. The filter must specify a single metric
1620
+ * type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
1621
+ * metric.labels.instance_name = "my-instance-name"
1622
+ */
1623
+ filter?: string;
1624
+ /** Required. The end of the time interval. */
1625
+ "interval.endTime"?: string;
1626
+ /** Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. */
1627
+ "interval.startTime"?: string;
1628
+ /** 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. */
1629
+ key?: string;
1630
+ /**
1631
+ * Required. The project (https://cloud.google.com/monitoring/api/v3#project_name), organization or folder on which to execute the request. The format is:
1632
+ * projects/[PROJECT_ID_OR_NUMBER] organizations/[ORGANIZATION_ID] folders/[FOLDER_ID]
1633
+ */
1634
+ name: string;
1635
+ /** OAuth 2.0 token for the current user. */
1636
+ oauth_token?: string;
1637
+ /** Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest). */
1638
+ orderBy?: string;
1639
+ /**
1640
+ * A positive number that is the maximum number of results to return. If page_size is empty or more than 100,000 results, the effective page_size is 100,000 results. If view is set
1641
+ * to FULL, this is the maximum number of Points returned. If view is set to HEADERS, this is the maximum number of TimeSeries returned.
1642
+ */
1643
+ pageSize?: number;
1644
+ /**
1645
+ * 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
1646
+ * results from the previous method call.
1647
+ */
1648
+ pageToken?: string;
1649
+ /** Returns response with indentations and line breaks. */
1650
+ prettyPrint?: boolean;
1651
+ /** 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. */
1652
+ quotaUser?: string;
1653
+ /**
1654
+ * 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
1655
+ * 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
1656
+ * 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 104
1657
+ * weeks (2 years) for charts, and 90,000 seconds (25 hours) for alerting policies.
1658
+ */
1659
+ "secondaryAggregation.alignmentPeriod"?: string;
1660
+ /**
1661
+ * 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
1662
+ * 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
1663
+ * 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
1664
+ * 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.
1665
+ * An alignment_period must also be specified; otherwise, an error is returned.
1666
+ */
1667
+ "secondaryAggregation.crossSeriesReducer"?: string;
1668
+ /**
1669
+ * 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
1670
+ * 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.
1671
+ * 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.
1672
+ * 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
1673
+ * aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored.
1674
+ */
1675
+ "secondaryAggregation.groupByFields"?: string | string[];
1676
+ /**
1677
+ * 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
1678
+ * 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
1679
+ * 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
1680
+ * 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
1681
+ * must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned.
1682
+ */
1683
+ "secondaryAggregation.perSeriesAligner"?: string;
1684
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1685
+ upload_protocol?: string;
1686
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1687
+ uploadType?: string;
1688
+ /** Required. Specifies which information is returned about the time series. */
1689
+ view?: string;
1690
+ }): Request<ListTimeSeriesResponse>;
1691
+ }
1692
+ interface OrganizationsResource {
1693
+ timeSeries: TimeSeriesResource;
1694
+ }
1695
+ interface AlertPoliciesResource {
1696
+ /** Creates a new alerting policy. */
1697
+ create(request: {
1698
+ /** V1 error format. */
1699
+ "$.xgafv"?: string;
1700
+ /** OAuth access token. */
1701
+ access_token?: string;
1702
+ /** Data format for response. */
1703
+ alt?: string;
1704
+ /** JSONP */
1705
+ callback?: string;
1706
+ /** Selector specifying which fields to include in a partial response. */
1707
+ fields?: string;
1708
+ /** 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. */
1709
+ key?: string;
1710
+ /**
1711
+ * Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) in which to create the alerting policy. The format is: projects/[PROJECT_ID_OR_NUMBER] Note that
1712
+ * this field names the parent container in which the alerting policy will be written, not the name of the created policy. |name| must be a host project of a Metrics Scope,
1713
+ * otherwise INVALID_ARGUMENT error will return. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a
1714
+ * suffix of the form /alertPolicies/[ALERT_POLICY_ID], identifying the policy in the container.
1715
+ */
1716
+ name: string;
1717
+ /** OAuth 2.0 token for the current user. */
1718
+ oauth_token?: string;
1719
+ /** Returns response with indentations and line breaks. */
1720
+ prettyPrint?: boolean;
1721
+ /** 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. */
1722
+ quotaUser?: string;
1723
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1724
+ upload_protocol?: string;
1725
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1726
+ uploadType?: string;
1727
+ /** Request body */
1728
+ resource: AlertPolicy;
1729
+ }): Request<AlertPolicy>;
1730
+ create(request: {
1731
+ /** V1 error format. */
1732
+ "$.xgafv"?: string;
1733
+ /** OAuth access token. */
1734
+ access_token?: string;
1735
+ /** Data format for response. */
1736
+ alt?: string;
1737
+ /** JSONP */
1738
+ callback?: string;
1739
+ /** Selector specifying which fields to include in a partial response. */
1740
+ fields?: string;
1741
+ /** 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. */
1742
+ key?: string;
1743
+ /**
1744
+ * Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) in which to create the alerting policy. The format is: projects/[PROJECT_ID_OR_NUMBER] Note that
1745
+ * this field names the parent container in which the alerting policy will be written, not the name of the created policy. |name| must be a host project of a Metrics Scope,
1746
+ * otherwise INVALID_ARGUMENT error will return. The alerting policy that is returned will have a name that contains a normalized representation of this name as a prefix but adds a
1747
+ * suffix of the form /alertPolicies/[ALERT_POLICY_ID], identifying the policy in the container.
1748
+ */
1749
+ name: string;
1750
+ /** OAuth 2.0 token for the current user. */
1751
+ oauth_token?: string;
1752
+ /** Returns response with indentations and line breaks. */
1753
+ prettyPrint?: boolean;
1754
+ /** 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. */
1755
+ quotaUser?: string;
1756
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1757
+ upload_protocol?: string;
1758
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1759
+ uploadType?: string;
1760
+ },
1761
+ body: AlertPolicy): Request<AlertPolicy>;
1762
+ /** Deletes an alerting policy. */
1763
+ delete(request?: {
1764
+ /** V1 error format. */
1765
+ "$.xgafv"?: string;
1766
+ /** OAuth access token. */
1767
+ access_token?: string;
1768
+ /** Data format for response. */
1769
+ alt?: string;
1770
+ /** JSONP */
1771
+ callback?: string;
1772
+ /** Selector specifying which fields to include in a partial response. */
1773
+ fields?: string;
1774
+ /** 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. */
1775
+ key?: string;
1776
+ /** Required. The alerting policy to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] For more information, see AlertPolicy. */
1777
+ name: string;
1778
+ /** OAuth 2.0 token for the current user. */
1779
+ oauth_token?: string;
1780
+ /** Returns response with indentations and line breaks. */
1781
+ prettyPrint?: boolean;
1782
+ /** 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. */
1783
+ quotaUser?: string;
1784
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1785
+ upload_protocol?: string;
1786
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1787
+ uploadType?: string;
1788
+ }): Request<{}>;
1789
+ /** Gets a single alerting policy. */
1790
+ get(request?: {
1791
+ /** V1 error format. */
1792
+ "$.xgafv"?: string;
1793
+ /** OAuth access token. */
1794
+ access_token?: string;
1795
+ /** Data format for response. */
1796
+ alt?: string;
1797
+ /** JSONP */
1798
+ callback?: string;
1799
+ /** Selector specifying which fields to include in a partial response. */
1800
+ fields?: string;
1801
+ /** 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. */
1802
+ key?: string;
1803
+ /** Required. The alerting policy to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] */
1804
+ name: string;
1805
+ /** OAuth 2.0 token for the current user. */
1806
+ oauth_token?: string;
1807
+ /** Returns response with indentations and line breaks. */
1808
+ prettyPrint?: boolean;
1809
+ /** 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. */
1810
+ quotaUser?: string;
1811
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1812
+ upload_protocol?: string;
1813
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1814
+ uploadType?: string;
1815
+ }): Request<AlertPolicy>;
1816
+ /** Lists the existing alerting policies for the workspace. */
1817
+ list(request?: {
1818
+ /** V1 error format. */
1819
+ "$.xgafv"?: string;
1820
+ /** OAuth access token. */
1821
+ access_token?: string;
1822
+ /** Data format for response. */
1823
+ alt?: string;
1824
+ /** JSONP */
1825
+ callback?: string;
1826
+ /** Selector specifying which fields to include in a partial response. */
1827
+ fields?: string;
1828
+ /**
1829
+ * If provided, this field specifies the criteria that must be met by alert policies to be included in the response.For more details, see sorting and filtering
1830
+ * (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
1831
+ */
1832
+ filter?: string;
1833
+ /** 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. */
1834
+ key?: string;
1835
+ /**
1836
+ * Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) whose alert policies are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER] Note that
1837
+ * this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation,
1838
+ * instead.
1839
+ */
1840
+ name: string;
1841
+ /** OAuth 2.0 token for the current user. */
1842
+ oauth_token?: string;
1843
+ /**
1844
+ * A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by
1845
+ * the field in descending order.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
1846
+ */
1847
+ orderBy?: string;
1848
+ /** The maximum number of results to return in a single response. */
1849
+ pageSize?: number;
1850
+ /**
1851
+ * 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 more results
1852
+ * from the previous method call.
1853
+ */
1854
+ pageToken?: string;
1855
+ /** Returns response with indentations and line breaks. */
1856
+ prettyPrint?: boolean;
1857
+ /** 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. */
1858
+ quotaUser?: string;
1859
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1860
+ upload_protocol?: string;
1861
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1862
+ uploadType?: string;
1863
+ }): Request<ListAlertPoliciesResponse>;
1864
+ /**
1865
+ * Updates an alerting policy. You can either replace the entire policy with a new one or replace only certain fields in the current alerting policy by specifying the fields to be
1866
+ * updated via updateMask. Returns the updated alerting policy.
1867
+ */
1868
+ patch(request: {
1869
+ /** V1 error format. */
1870
+ "$.xgafv"?: string;
1871
+ /** OAuth access token. */
1872
+ access_token?: string;
1873
+ /** Data format for response. */
1874
+ alt?: string;
1875
+ /** JSONP */
1876
+ callback?: string;
1877
+ /** Selector specifying which fields to include in a partial response. */
1878
+ fields?: string;
1879
+ /** 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. */
1880
+ key?: string;
1881
+ /**
1882
+ * Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by
1883
+ * Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.
1884
+ */
1885
+ name: string;
1886
+ /** OAuth 2.0 token for the current user. */
1887
+ oauth_token?: string;
1888
+ /** Returns response with indentations and line breaks. */
1889
+ prettyPrint?: boolean;
1890
+ /** 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. */
1891
+ quotaUser?: string;
1892
+ /**
1893
+ * Optional. A list of alerting policy field names. If this field is not empty, each listed field in the existing alerting policy is set to the value of the corresponding field in
1894
+ * the supplied policy (alert_policy), or to the field's default value if the field is not in the supplied alerting policy. Fields not listed retain their previous value.Examples
1895
+ * of valid field masks include display_name, documentation, documentation.content, documentation.mime_type, user_labels, user_label.nameofkey, enabled, conditions, combiner,
1896
+ * etc.If this field is empty, then the supplied alerting policy replaces the existing policy. It is the same as deleting the existing policy and adding the supplied policy, except
1897
+ * for the following: The new policy will have the same [ALERT_POLICY_ID] as the former policy. This gives you continuity with the former policy in your notifications and
1898
+ * incidents. Conditions in the new policy will keep their former [CONDITION_ID] if the supplied condition includes the name field with that [CONDITION_ID]. If the supplied
1899
+ * condition omits the name field, then a new [CONDITION_ID] is created.
1900
+ */
1901
+ updateMask?: string;
1902
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1903
+ upload_protocol?: string;
1904
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1905
+ uploadType?: string;
1906
+ /** Request body */
1907
+ resource: AlertPolicy;
1908
+ }): Request<AlertPolicy>;
1909
+ patch(request: {
1910
+ /** V1 error format. */
1911
+ "$.xgafv"?: string;
1912
+ /** OAuth access token. */
1913
+ access_token?: string;
1914
+ /** Data format for response. */
1915
+ alt?: string;
1916
+ /** JSONP */
1917
+ callback?: string;
1918
+ /** Selector specifying which fields to include in a partial response. */
1919
+ fields?: string;
1920
+ /** 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. */
1921
+ key?: string;
1922
+ /**
1923
+ * Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by
1924
+ * Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.
1925
+ */
1926
+ name: string;
1927
+ /** OAuth 2.0 token for the current user. */
1928
+ oauth_token?: string;
1929
+ /** Returns response with indentations and line breaks. */
1930
+ prettyPrint?: boolean;
1931
+ /** 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. */
1932
+ quotaUser?: string;
1933
+ /**
1934
+ * Optional. A list of alerting policy field names. If this field is not empty, each listed field in the existing alerting policy is set to the value of the corresponding field in
1935
+ * the supplied policy (alert_policy), or to the field's default value if the field is not in the supplied alerting policy. Fields not listed retain their previous value.Examples
1936
+ * of valid field masks include display_name, documentation, documentation.content, documentation.mime_type, user_labels, user_label.nameofkey, enabled, conditions, combiner,
1937
+ * etc.If this field is empty, then the supplied alerting policy replaces the existing policy. It is the same as deleting the existing policy and adding the supplied policy, except
1938
+ * for the following: The new policy will have the same [ALERT_POLICY_ID] as the former policy. This gives you continuity with the former policy in your notifications and
1939
+ * incidents. Conditions in the new policy will keep their former [CONDITION_ID] if the supplied condition includes the name field with that [CONDITION_ID]. If the supplied
1940
+ * condition omits the name field, then a new [CONDITION_ID] is created.
1941
+ */
1942
+ updateMask?: string;
1943
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1944
+ upload_protocol?: string;
1945
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1946
+ uploadType?: string;
1947
+ },
1948
+ body: AlertPolicy): Request<AlertPolicy>;
1949
+ }
1950
+ interface CollectdTimeSeriesResource {
1951
+ /** Cloud Monitoring Agent only: Creates a new time series.This method is only for use by the Cloud Monitoring Agent. Use projects.timeSeries.create instead. */
1952
+ create(request: {
1953
+ /** V1 error format. */
1954
+ "$.xgafv"?: string;
1955
+ /** OAuth access token. */
1956
+ access_token?: string;
1957
+ /** Data format for response. */
1958
+ alt?: string;
1959
+ /** JSONP */
1960
+ callback?: string;
1961
+ /** Selector specifying which fields to include in a partial response. */
1962
+ fields?: string;
1963
+ /** 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. */
1964
+ key?: string;
1965
+ /** The project (https://cloud.google.com/monitoring/api/v3#project_name) in which to create the time series. The format is: projects/[PROJECT_ID_OR_NUMBER] */
1966
+ name: string;
1967
+ /** OAuth 2.0 token for the current user. */
1968
+ oauth_token?: string;
1969
+ /** Returns response with indentations and line breaks. */
1970
+ prettyPrint?: boolean;
1971
+ /** 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. */
1972
+ quotaUser?: string;
1973
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
1974
+ upload_protocol?: string;
1975
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
1976
+ uploadType?: string;
1977
+ /** Request body */
1978
+ resource: CreateCollectdTimeSeriesRequest;
1979
+ }): Request<CreateCollectdTimeSeriesResponse>;
1980
+ create(request: {
1981
+ /** V1 error format. */
1982
+ "$.xgafv"?: string;
1983
+ /** OAuth access token. */
1984
+ access_token?: string;
1985
+ /** Data format for response. */
1986
+ alt?: string;
1987
+ /** JSONP */
1988
+ callback?: string;
1989
+ /** Selector specifying which fields to include in a partial response. */
1990
+ fields?: string;
1991
+ /** 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. */
1992
+ key?: string;
1993
+ /** The project (https://cloud.google.com/monitoring/api/v3#project_name) in which to create the time series. The format is: projects/[PROJECT_ID_OR_NUMBER] */
1994
+ name: string;
1995
+ /** OAuth 2.0 token for the current user. */
1996
+ oauth_token?: string;
1997
+ /** Returns response with indentations and line breaks. */
1998
+ prettyPrint?: boolean;
1999
+ /** 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. */
2000
+ quotaUser?: string;
2001
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2002
+ upload_protocol?: string;
2003
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2004
+ uploadType?: string;
2005
+ },
2006
+ body: CreateCollectdTimeSeriesRequest): Request<CreateCollectdTimeSeriesResponse>;
2007
+ }
2008
+ interface MembersResource {
2009
+ /** Lists the monitored resources that are members of a group. */
2010
+ list(request?: {
2011
+ /** V1 error format. */
2012
+ "$.xgafv"?: string;
2013
+ /** OAuth access token. */
2014
+ access_token?: string;
2015
+ /** Data format for response. */
2016
+ alt?: string;
2017
+ /** JSONP */
2018
+ callback?: string;
2019
+ /** Selector specifying which fields to include in a partial response. */
2020
+ fields?: string;
2021
+ /**
2022
+ * An optional list filter (https://cloud.google.com/monitoring/api/learn_more#filtering) describing the members to be returned. The filter may reference the type, labels, and
2023
+ * metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter: `resource.type =
2024
+ * "gce_instance"`
2025
+ */
2026
+ filter?: string;
2027
+ /** Required. The end of the time interval. */
2028
+ "interval.endTime"?: string;
2029
+ /** Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. */
2030
+ "interval.startTime"?: string;
2031
+ /** 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. */
2032
+ key?: string;
2033
+ /** Required. The group whose members are listed. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] */
2034
+ name: string;
2035
+ /** OAuth 2.0 token for the current user. */
2036
+ oauth_token?: string;
2037
+ /** A positive number that is the maximum number of results to return. */
2038
+ pageSize?: number;
2039
+ /**
2040
+ * If this field is not empty then it must contain the next_page_token value returned by a previous call to this method. Using this field causes the method to return additional
2041
+ * results from the previous method call.
2042
+ */
2043
+ pageToken?: string;
2044
+ /** Returns response with indentations and line breaks. */
2045
+ prettyPrint?: boolean;
2046
+ /** 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. */
2047
+ quotaUser?: string;
2048
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2049
+ upload_protocol?: string;
2050
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2051
+ uploadType?: string;
2052
+ }): Request<ListGroupMembersResponse>;
2053
+ }
2054
+ interface GroupsResource {
2055
+ /** Creates a new group. */
2056
+ create(request: {
2057
+ /** V1 error format. */
2058
+ "$.xgafv"?: string;
2059
+ /** OAuth access token. */
2060
+ access_token?: string;
2061
+ /** Data format for response. */
2062
+ alt?: string;
2063
+ /** JSONP */
2064
+ callback?: string;
2065
+ /** Selector specifying which fields to include in a partial response. */
2066
+ fields?: string;
2067
+ /** 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. */
2068
+ key?: string;
2069
+ /** Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) in which to create the group. The format is: projects/[PROJECT_ID_OR_NUMBER] */
2070
+ name: string;
2071
+ /** OAuth 2.0 token for the current user. */
2072
+ oauth_token?: string;
2073
+ /** Returns response with indentations and line breaks. */
2074
+ prettyPrint?: boolean;
2075
+ /** 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. */
2076
+ quotaUser?: string;
2077
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2078
+ upload_protocol?: string;
2079
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2080
+ uploadType?: string;
2081
+ /** If true, validate this request but do not create the group. */
2082
+ validateOnly?: boolean;
2083
+ /** Request body */
2084
+ resource: Group;
2085
+ }): Request<Group>;
2086
+ create(request: {
2087
+ /** V1 error format. */
2088
+ "$.xgafv"?: string;
2089
+ /** OAuth access token. */
2090
+ access_token?: string;
2091
+ /** Data format for response. */
2092
+ alt?: string;
2093
+ /** JSONP */
2094
+ callback?: string;
2095
+ /** Selector specifying which fields to include in a partial response. */
2096
+ fields?: string;
2097
+ /** 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. */
2098
+ key?: string;
2099
+ /** Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) in which to create the group. The format is: projects/[PROJECT_ID_OR_NUMBER] */
2100
+ name: string;
2101
+ /** OAuth 2.0 token for the current user. */
2102
+ oauth_token?: string;
2103
+ /** Returns response with indentations and line breaks. */
2104
+ prettyPrint?: boolean;
2105
+ /** 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. */
2106
+ quotaUser?: string;
2107
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2108
+ upload_protocol?: string;
2109
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2110
+ uploadType?: string;
2111
+ /** If true, validate this request but do not create the group. */
2112
+ validateOnly?: boolean;
2113
+ },
2114
+ body: Group): Request<Group>;
2115
+ /** Deletes an existing group. */
2116
+ delete(request?: {
2117
+ /** V1 error format. */
2118
+ "$.xgafv"?: string;
2119
+ /** OAuth access token. */
2120
+ access_token?: string;
2121
+ /** Data format for response. */
2122
+ alt?: string;
2123
+ /** JSONP */
2124
+ callback?: string;
2125
+ /** Selector specifying which fields to include in a partial response. */
2126
+ fields?: string;
2127
+ /** 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. */
2128
+ key?: string;
2129
+ /** Required. The group to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] */
2130
+ name: string;
2131
+ /** OAuth 2.0 token for the current user. */
2132
+ oauth_token?: string;
2133
+ /** Returns response with indentations and line breaks. */
2134
+ prettyPrint?: boolean;
2135
+ /** 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. */
2136
+ quotaUser?: string;
2137
+ /**
2138
+ * If this field is true, then the request means to delete a group with all its descendants. Otherwise, the request means to delete a group only when it has no descendants. The
2139
+ * default value is false.
2140
+ */
2141
+ recursive?: boolean;
2142
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2143
+ upload_protocol?: string;
2144
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2145
+ uploadType?: string;
2146
+ }): Request<{}>;
2147
+ /** Gets a single group. */
2148
+ get(request?: {
2149
+ /** V1 error format. */
2150
+ "$.xgafv"?: string;
2151
+ /** OAuth access token. */
2152
+ access_token?: string;
2153
+ /** Data format for response. */
2154
+ alt?: string;
2155
+ /** JSONP */
2156
+ callback?: string;
2157
+ /** Selector specifying which fields to include in a partial response. */
2158
+ fields?: string;
2159
+ /** 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. */
2160
+ key?: string;
2161
+ /** Required. The group to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] */
2162
+ name: string;
2163
+ /** OAuth 2.0 token for the current user. */
2164
+ oauth_token?: string;
2165
+ /** Returns response with indentations and line breaks. */
2166
+ prettyPrint?: boolean;
2167
+ /** 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. */
2168
+ quotaUser?: string;
2169
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2170
+ upload_protocol?: string;
2171
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2172
+ uploadType?: string;
2173
+ }): Request<Group>;
2174
+ /** Lists the existing groups. */
2175
+ list(request?: {
2176
+ /** V1 error format. */
2177
+ "$.xgafv"?: string;
2178
+ /** OAuth access token. */
2179
+ access_token?: string;
2180
+ /** Data format for response. */
2181
+ alt?: string;
2182
+ /**
2183
+ * A group name. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Returns groups that are ancestors of the specified group. The groups are returned in order,
2184
+ * starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.
2185
+ */
2186
+ ancestorsOfGroup?: string;
2187
+ /** JSONP */
2188
+ callback?: string;
2189
+ /**
2190
+ * A group name. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Returns groups whose parent_name field contains the group name. If no groups have this parent, the
2191
+ * results are empty.
2192
+ */
2193
+ childrenOfGroup?: string;
2194
+ /**
2195
+ * A group name. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] Returns the descendants of the specified group. This is a superset of the results returned by the
2196
+ * children_of_group filter, and includes children-of-children, and so forth.
2197
+ */
2198
+ descendantsOfGroup?: string;
2199
+ /** Selector specifying which fields to include in a partial response. */
2200
+ fields?: string;
2201
+ /** 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. */
2202
+ key?: string;
2203
+ /** Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) whose groups are to be listed. The format is: projects/[PROJECT_ID_OR_NUMBER] */
2204
+ name: string;
2205
+ /** OAuth 2.0 token for the current user. */
2206
+ oauth_token?: string;
2207
+ /** A positive number that is the maximum number of results to return. */
2208
+ pageSize?: number;
2209
+ /**
2210
+ * If this field is not empty then it must contain the next_page_token value returned by a previous call to this method. Using this field causes the method to return additional
2211
+ * results from the previous method call.
2212
+ */
2213
+ pageToken?: string;
2214
+ /** Returns response with indentations and line breaks. */
2215
+ prettyPrint?: boolean;
2216
+ /** 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. */
2217
+ quotaUser?: string;
2218
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2219
+ upload_protocol?: string;
2220
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2221
+ uploadType?: string;
2222
+ }): Request<ListGroupsResponse>;
2223
+ /** Updates an existing group. You can change any group attributes except name. */
2224
+ update(request: {
2225
+ /** V1 error format. */
2226
+ "$.xgafv"?: string;
2227
+ /** OAuth access token. */
2228
+ access_token?: string;
2229
+ /** Data format for response. */
2230
+ alt?: string;
2231
+ /** JSONP */
2232
+ callback?: string;
2233
+ /** Selector specifying which fields to include in a partial response. */
2234
+ fields?: string;
2235
+ /** 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. */
2236
+ key?: string;
2237
+ /**
2238
+ * Output only. The name of this group. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] When creating a group, this field is ignored and a new name is created
2239
+ * consisting of the project specified in the call to CreateGroup and a unique [GROUP_ID] that is generated automatically.
2240
+ */
2241
+ name: string;
2242
+ /** OAuth 2.0 token for the current user. */
2243
+ oauth_token?: string;
2244
+ /** Returns response with indentations and line breaks. */
2245
+ prettyPrint?: boolean;
2246
+ /** 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. */
2247
+ quotaUser?: string;
2248
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2249
+ upload_protocol?: string;
2250
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2251
+ uploadType?: string;
2252
+ /** If true, validate this request but do not update the existing group. */
2253
+ validateOnly?: boolean;
2254
+ /** Request body */
2255
+ resource: Group;
2256
+ }): Request<Group>;
2257
+ update(request: {
2258
+ /** V1 error format. */
2259
+ "$.xgafv"?: string;
2260
+ /** OAuth access token. */
2261
+ access_token?: string;
2262
+ /** Data format for response. */
2263
+ alt?: string;
2264
+ /** JSONP */
2265
+ callback?: string;
2266
+ /** Selector specifying which fields to include in a partial response. */
2267
+ fields?: string;
2268
+ /** 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. */
2269
+ key?: string;
2270
+ /**
2271
+ * Output only. The name of this group. The format is: projects/[PROJECT_ID_OR_NUMBER]/groups/[GROUP_ID] When creating a group, this field is ignored and a new name is created
2272
+ * consisting of the project specified in the call to CreateGroup and a unique [GROUP_ID] that is generated automatically.
2273
+ */
2274
+ name: string;
2275
+ /** OAuth 2.0 token for the current user. */
2276
+ oauth_token?: string;
2277
+ /** Returns response with indentations and line breaks. */
2278
+ prettyPrint?: boolean;
2279
+ /** 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. */
2280
+ quotaUser?: string;
2281
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2282
+ upload_protocol?: string;
2283
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2284
+ uploadType?: string;
2285
+ /** If true, validate this request but do not update the existing group. */
2286
+ validateOnly?: boolean;
2287
+ },
2288
+ body: Group): Request<Group>;
2289
+ members: MembersResource;
2290
+ }
2291
+ interface MetricDescriptorsResource {
2292
+ /**
2293
+ * Creates a new metric descriptor. The creation is executed asynchronously. User-created metric descriptors define custom metrics (https://cloud.google.com/monitoring/custom-metrics).
2294
+ * The metric descriptor is updated if it already exists, except that metric labels are never removed.
2295
+ */
2296
+ create(request: {
2297
+ /** V1 error format. */
2298
+ "$.xgafv"?: string;
2299
+ /** OAuth access token. */
2300
+ access_token?: string;
2301
+ /** Data format for response. */
2302
+ alt?: string;
2303
+ /** JSONP */
2304
+ callback?: string;
2305
+ /** Selector specifying which fields to include in a partial response. */
2306
+ fields?: string;
2307
+ /** 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. */
2308
+ key?: string;
2309
+ /** Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: 4 projects/PROJECT_ID_OR_NUMBER */
2310
+ name: string;
2311
+ /** OAuth 2.0 token for the current user. */
2312
+ oauth_token?: string;
2313
+ /** Returns response with indentations and line breaks. */
2314
+ prettyPrint?: boolean;
2315
+ /** 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. */
2316
+ quotaUser?: string;
2317
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2318
+ upload_protocol?: string;
2319
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2320
+ uploadType?: string;
2321
+ /** Request body */
2322
+ resource: MetricDescriptor;
2323
+ }): Request<MetricDescriptor>;
2324
+ create(request: {
2325
+ /** V1 error format. */
2326
+ "$.xgafv"?: string;
2327
+ /** OAuth access token. */
2328
+ access_token?: string;
2329
+ /** Data format for response. */
2330
+ alt?: string;
2331
+ /** JSONP */
2332
+ callback?: string;
2333
+ /** Selector specifying which fields to include in a partial response. */
2334
+ fields?: string;
2335
+ /** 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. */
2336
+ key?: string;
2337
+ /** Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: 4 projects/PROJECT_ID_OR_NUMBER */
2338
+ name: string;
2339
+ /** OAuth 2.0 token for the current user. */
2340
+ oauth_token?: string;
2341
+ /** Returns response with indentations and line breaks. */
2342
+ prettyPrint?: boolean;
2343
+ /** 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. */
2344
+ quotaUser?: string;
2345
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2346
+ upload_protocol?: string;
2347
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2348
+ uploadType?: string;
2349
+ },
2350
+ body: MetricDescriptor): Request<MetricDescriptor>;
2351
+ /** Deletes a metric descriptor. Only user-created custom metrics (https://cloud.google.com/monitoring/custom-metrics) can be deleted. */
2352
+ delete(request?: {
2353
+ /** V1 error format. */
2354
+ "$.xgafv"?: string;
2355
+ /** OAuth access token. */
2356
+ access_token?: string;
2357
+ /** Data format for response. */
2358
+ alt?: string;
2359
+ /** JSONP */
2360
+ callback?: string;
2361
+ /** Selector specifying which fields to include in a partial response. */
2362
+ fields?: string;
2363
+ /** 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. */
2364
+ key?: string;
2365
+ /**
2366
+ * Required. The metric descriptor on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] An example of [METRIC_ID] is:
2367
+ * "custom.googleapis.com/my_test_metric".
2368
+ */
2369
+ name: string;
2370
+ /** OAuth 2.0 token for the current user. */
2371
+ oauth_token?: string;
2372
+ /** Returns response with indentations and line breaks. */
2373
+ prettyPrint?: boolean;
2374
+ /** 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. */
2375
+ quotaUser?: string;
2376
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2377
+ upload_protocol?: string;
2378
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2379
+ uploadType?: string;
2380
+ }): Request<{}>;
2381
+ /** Gets a single metric descriptor. */
2382
+ get(request?: {
2383
+ /** V1 error format. */
2384
+ "$.xgafv"?: string;
2385
+ /** OAuth access token. */
2386
+ access_token?: string;
2387
+ /** Data format for response. */
2388
+ alt?: string;
2389
+ /** JSONP */
2390
+ callback?: string;
2391
+ /** Selector specifying which fields to include in a partial response. */
2392
+ fields?: string;
2393
+ /** 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. */
2394
+ key?: string;
2395
+ /**
2396
+ * Required. The metric descriptor on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID] An example value of [METRIC_ID] is
2397
+ * "compute.googleapis.com/instance/disk/read_bytes_count".
2398
+ */
2399
+ name: string;
2400
+ /** OAuth 2.0 token for the current user. */
2401
+ oauth_token?: string;
2402
+ /** Returns response with indentations and line breaks. */
2403
+ prettyPrint?: boolean;
2404
+ /** 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. */
2405
+ quotaUser?: string;
2406
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2407
+ upload_protocol?: string;
2408
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2409
+ uploadType?: string;
2410
+ }): Request<MetricDescriptor>;
2411
+ /** Lists metric descriptors that match a filter. */
2412
+ list(request?: {
2413
+ /** V1 error format. */
2414
+ "$.xgafv"?: string;
2415
+ /** OAuth access token. */
2416
+ access_token?: string;
2417
+ /** Data format for response. */
2418
+ alt?: string;
2419
+ /** JSONP */
2420
+ callback?: string;
2421
+ /** Selector specifying which fields to include in a partial response. */
2422
+ fields?: string;
2423
+ /**
2424
+ * If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter (https://cloud.google.com/monitoring/api/v3/filters) specifies which
2425
+ * metric descriptors are to be returned. For example, the following filter matches all custom metrics (https://cloud.google.com/monitoring/custom-metrics): metric.type =
2426
+ * starts_with("custom.googleapis.com/")
2427
+ */
2428
+ filter?: string;
2429
+ /** 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. */
2430
+ key?: string;
2431
+ /** Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] */
2432
+ name: string;
2433
+ /** OAuth 2.0 token for the current user. */
2434
+ oauth_token?: string;
2435
+ /** A positive number that is the maximum number of results to return. */
2436
+ pageSize?: number;
2437
+ /**
2438
+ * 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
2439
+ * results from the previous method call.
2440
+ */
2441
+ pageToken?: string;
2442
+ /** Returns response with indentations and line breaks. */
2443
+ prettyPrint?: boolean;
2444
+ /** 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. */
2445
+ quotaUser?: string;
2446
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2447
+ upload_protocol?: string;
2448
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2449
+ uploadType?: string;
2450
+ }): Request<ListMetricDescriptorsResponse>;
2451
+ }
2452
+ interface MonitoredResourceDescriptorsResource {
2453
+ /** Gets a single monitored resource descriptor. */
2454
+ get(request?: {
2455
+ /** V1 error format. */
2456
+ "$.xgafv"?: string;
2457
+ /** OAuth access token. */
2458
+ access_token?: string;
2459
+ /** Data format for response. */
2460
+ alt?: string;
2461
+ /** JSONP */
2462
+ callback?: string;
2463
+ /** Selector specifying which fields to include in a partial response. */
2464
+ fields?: string;
2465
+ /** 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. */
2466
+ key?: string;
2467
+ /**
2468
+ * Required. The monitored resource descriptor to get. The format is: projects/[PROJECT_ID_OR_NUMBER]/monitoredResourceDescriptors/[RESOURCE_TYPE] The [RESOURCE_TYPE] is a
2469
+ * predefined type, such as cloudsql_database.
2470
+ */
2471
+ name: string;
2472
+ /** OAuth 2.0 token for the current user. */
2473
+ oauth_token?: string;
2474
+ /** Returns response with indentations and line breaks. */
2475
+ prettyPrint?: boolean;
2476
+ /** 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. */
2477
+ quotaUser?: string;
2478
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2479
+ upload_protocol?: string;
2480
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2481
+ uploadType?: string;
2482
+ }): Request<MonitoredResourceDescriptor>;
2483
+ /** Lists monitored resource descriptors that match a filter. */
2484
+ list(request?: {
2485
+ /** V1 error format. */
2486
+ "$.xgafv"?: string;
2487
+ /** OAuth access token. */
2488
+ access_token?: string;
2489
+ /** Data format for response. */
2490
+ alt?: string;
2491
+ /** JSONP */
2492
+ callback?: string;
2493
+ /** Selector specifying which fields to include in a partial response. */
2494
+ fields?: string;
2495
+ /**
2496
+ * An optional filter (https://cloud.google.com/monitoring/api/v3/filters) describing the descriptors to be returned. The filter can reference the descriptor's type and labels. For
2497
+ * example, the following filter returns only Google Compute Engine descriptors that have an id label: resource.type = starts_with("gce_") AND resource.label:id
2498
+ */
2499
+ filter?: string;
2500
+ /** 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. */
2501
+ key?: string;
2502
+ /** Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] */
2503
+ name: string;
2504
+ /** OAuth 2.0 token for the current user. */
2505
+ oauth_token?: string;
2506
+ /** A positive number that is the maximum number of results to return. */
2507
+ pageSize?: number;
2508
+ /**
2509
+ * 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
2510
+ * results from the previous method call.
2511
+ */
2512
+ pageToken?: string;
2513
+ /** Returns response with indentations and line breaks. */
2514
+ prettyPrint?: boolean;
2515
+ /** 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. */
2516
+ quotaUser?: string;
2517
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2518
+ upload_protocol?: string;
2519
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2520
+ uploadType?: string;
2521
+ }): Request<ListMonitoredResourceDescriptorsResponse>;
2522
+ }
2523
+ interface NotificationChannelDescriptorsResource {
2524
+ /** Gets a single channel descriptor. The descriptor indicates which fields are expected / permitted for a notification channel of the given type. */
2525
+ get(request?: {
2526
+ /** V1 error format. */
2527
+ "$.xgafv"?: string;
2528
+ /** OAuth access token. */
2529
+ access_token?: string;
2530
+ /** Data format for response. */
2531
+ alt?: string;
2532
+ /** JSONP */
2533
+ callback?: string;
2534
+ /** Selector specifying which fields to include in a partial response. */
2535
+ fields?: string;
2536
+ /** 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. */
2537
+ key?: string;
2538
+ /** Required. The channel type for which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[CHANNEL_TYPE] */
2539
+ name: string;
2540
+ /** OAuth 2.0 token for the current user. */
2541
+ oauth_token?: string;
2542
+ /** Returns response with indentations and line breaks. */
2543
+ prettyPrint?: boolean;
2544
+ /** 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. */
2545
+ quotaUser?: string;
2546
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2547
+ upload_protocol?: string;
2548
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2549
+ uploadType?: string;
2550
+ }): Request<NotificationChannelDescriptor>;
2551
+ /** Lists the descriptors for supported channel types. The use of descriptors makes it possible for new channel types to be dynamically added. */
2552
+ list(request?: {
2553
+ /** V1 error format. */
2554
+ "$.xgafv"?: string;
2555
+ /** OAuth access token. */
2556
+ access_token?: string;
2557
+ /** Data format for response. */
2558
+ alt?: string;
2559
+ /** JSONP */
2560
+ callback?: string;
2561
+ /** Selector specifying which fields to include in a partial response. */
2562
+ fields?: string;
2563
+ /** 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. */
2564
+ key?: string;
2565
+ /**
2566
+ * Required. The REST resource name of the parent from which to retrieve the notification channel descriptors. The expected syntax is: projects/[PROJECT_ID_OR_NUMBER] Note that
2567
+ * this names (https://cloud.google.com/monitoring/api/v3#project_name) the parent container in which to look for the descriptors; to retrieve a single descriptor by name, use the
2568
+ * GetNotificationChannelDescriptor operation, instead.
2569
+ */
2570
+ name: string;
2571
+ /** OAuth 2.0 token for the current user. */
2572
+ oauth_token?: string;
2573
+ /** The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service. */
2574
+ pageSize?: number;
2575
+ /** If non-empty, page_token must contain a value returned as the next_page_token in a previous response to request the next set of results. */
2576
+ pageToken?: string;
2577
+ /** Returns response with indentations and line breaks. */
2578
+ prettyPrint?: boolean;
2579
+ /** 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. */
2580
+ quotaUser?: string;
2581
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2582
+ upload_protocol?: string;
2583
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2584
+ uploadType?: string;
2585
+ }): Request<ListNotificationChannelDescriptorsResponse>;
2586
+ }
2587
+ interface NotificationChannelsResource {
2588
+ /** Creates a new notification channel, representing a single notification endpoint such as an email address, SMS number, or PagerDuty service. */
2589
+ create(request: {
2590
+ /** V1 error format. */
2591
+ "$.xgafv"?: string;
2592
+ /** OAuth access token. */
2593
+ access_token?: string;
2594
+ /** Data format for response. */
2595
+ alt?: string;
2596
+ /** JSONP */
2597
+ callback?: string;
2598
+ /** Selector specifying which fields to include in a partial response. */
2599
+ fields?: string;
2600
+ /** 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. */
2601
+ key?: string;
2602
+ /**
2603
+ * Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] This names the
2604
+ * container into which the channel will be written, this does not name the newly created channel. The resulting channel's name will have a normalized version of this field as a
2605
+ * prefix, but will add /notificationChannels/[CHANNEL_ID] to identify the channel.
2606
+ */
2607
+ name: string;
2608
+ /** OAuth 2.0 token for the current user. */
2609
+ oauth_token?: string;
2610
+ /** Returns response with indentations and line breaks. */
2611
+ prettyPrint?: boolean;
2612
+ /** 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. */
2613
+ quotaUser?: string;
2614
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2615
+ upload_protocol?: string;
2616
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2617
+ uploadType?: string;
2618
+ /** Request body */
2619
+ resource: NotificationChannel;
2620
+ }): Request<NotificationChannel>;
2621
+ create(request: {
2622
+ /** V1 error format. */
2623
+ "$.xgafv"?: string;
2624
+ /** OAuth access token. */
2625
+ access_token?: string;
2626
+ /** Data format for response. */
2627
+ alt?: string;
2628
+ /** JSONP */
2629
+ callback?: string;
2630
+ /** Selector specifying which fields to include in a partial response. */
2631
+ fields?: string;
2632
+ /** 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. */
2633
+ key?: string;
2634
+ /**
2635
+ * Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] This names the
2636
+ * container into which the channel will be written, this does not name the newly created channel. The resulting channel's name will have a normalized version of this field as a
2637
+ * prefix, but will add /notificationChannels/[CHANNEL_ID] to identify the channel.
2638
+ */
2639
+ name: string;
2640
+ /** OAuth 2.0 token for the current user. */
2641
+ oauth_token?: string;
2642
+ /** Returns response with indentations and line breaks. */
2643
+ prettyPrint?: boolean;
2644
+ /** 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. */
2645
+ quotaUser?: string;
2646
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2647
+ upload_protocol?: string;
2648
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2649
+ uploadType?: string;
2650
+ },
2651
+ body: NotificationChannel): Request<NotificationChannel>;
2652
+ /** Deletes a notification channel. */
2653
+ delete(request?: {
2654
+ /** V1 error format. */
2655
+ "$.xgafv"?: string;
2656
+ /** OAuth access token. */
2657
+ access_token?: string;
2658
+ /** Data format for response. */
2659
+ alt?: string;
2660
+ /** JSONP */
2661
+ callback?: string;
2662
+ /** Selector specifying which fields to include in a partial response. */
2663
+ fields?: string;
2664
+ /**
2665
+ * If true, the notification channel will be deleted regardless of its use in alert policies (the policies will be updated to remove the channel). If false, channels that are still
2666
+ * referenced by an existing alerting policy will fail to be deleted in a delete operation.
2667
+ */
2668
+ force?: boolean;
2669
+ /** 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. */
2670
+ key?: string;
2671
+ /** Required. The channel for which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] */
2672
+ name: string;
2673
+ /** OAuth 2.0 token for the current user. */
2674
+ oauth_token?: string;
2675
+ /** Returns response with indentations and line breaks. */
2676
+ prettyPrint?: boolean;
2677
+ /** 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. */
2678
+ quotaUser?: string;
2679
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2680
+ upload_protocol?: string;
2681
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2682
+ uploadType?: string;
2683
+ }): Request<{}>;
2684
+ /**
2685
+ * Gets a single notification channel. The channel includes the relevant configuration details with which the channel was created. However, the response may truncate or omit passwords,
2686
+ * API keys, or other private key matter and thus the response may not be 100% identical to the information that was supplied in the call to the create method.
2687
+ */
2688
+ get(request?: {
2689
+ /** V1 error format. */
2690
+ "$.xgafv"?: string;
2691
+ /** OAuth access token. */
2692
+ access_token?: string;
2693
+ /** Data format for response. */
2694
+ alt?: string;
2695
+ /** JSONP */
2696
+ callback?: string;
2697
+ /** Selector specifying which fields to include in a partial response. */
2698
+ fields?: string;
2699
+ /** 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. */
2700
+ key?: string;
2701
+ /** Required. The channel for which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] */
2702
+ name: string;
2703
+ /** OAuth 2.0 token for the current user. */
2704
+ oauth_token?: string;
2705
+ /** Returns response with indentations and line breaks. */
2706
+ prettyPrint?: boolean;
2707
+ /** 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. */
2708
+ quotaUser?: string;
2709
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2710
+ upload_protocol?: string;
2711
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2712
+ uploadType?: string;
2713
+ }): Request<NotificationChannel>;
2714
+ /**
2715
+ * Requests a verification code for an already verified channel that can then be used in a call to VerifyNotificationChannel() on a different channel with an equivalent identity in the
2716
+ * same or in a different project. This makes it possible to copy a channel between projects without requiring manual reverification of the channel. If the channel is not in the
2717
+ * verified state, this method will fail (in other words, this may only be used if the SendNotificationChannelVerificationCode and VerifyNotificationChannel paths have already been
2718
+ * used to put the given channel into the verified state).There is no guarantee that the verification codes returned by this method will be of a similar structure or form as the ones
2719
+ * that are delivered to the channel via SendNotificationChannelVerificationCode; while VerifyNotificationChannel() will recognize both the codes delivered via
2720
+ * SendNotificationChannelVerificationCode() and returned from GetNotificationChannelVerificationCode(), it is typically the case that the verification codes delivered via
2721
+ * SendNotificationChannelVerificationCode() will be shorter and also have a shorter expiration (e.g. codes such as "G-123456") whereas GetVerificationCode() will typically return a
2722
+ * much longer, websafe base 64 encoded string that has a longer expiration time.
2723
+ */
2724
+ getVerificationCode(request: {
2725
+ /** V1 error format. */
2726
+ "$.xgafv"?: string;
2727
+ /** OAuth access token. */
2728
+ access_token?: string;
2729
+ /** Data format for response. */
2730
+ alt?: string;
2731
+ /** JSONP */
2732
+ callback?: string;
2733
+ /** Selector specifying which fields to include in a partial response. */
2734
+ fields?: string;
2735
+ /** 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. */
2736
+ key?: string;
2737
+ /**
2738
+ * Required. The notification channel for which a verification code is to be generated and retrieved. This must name a channel that is already verified; if the specified channel is
2739
+ * not verified, the request will fail.
2740
+ */
2741
+ name: string;
2742
+ /** OAuth 2.0 token for the current user. */
2743
+ oauth_token?: string;
2744
+ /** Returns response with indentations and line breaks. */
2745
+ prettyPrint?: boolean;
2746
+ /** 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. */
2747
+ quotaUser?: string;
2748
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2749
+ upload_protocol?: string;
2750
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2751
+ uploadType?: string;
2752
+ /** Request body */
2753
+ resource: GetNotificationChannelVerificationCodeRequest;
2754
+ }): Request<GetNotificationChannelVerificationCodeResponse>;
2755
+ getVerificationCode(request: {
2756
+ /** V1 error format. */
2757
+ "$.xgafv"?: string;
2758
+ /** OAuth access token. */
2759
+ access_token?: string;
2760
+ /** Data format for response. */
2761
+ alt?: string;
2762
+ /** JSONP */
2763
+ callback?: string;
2764
+ /** Selector specifying which fields to include in a partial response. */
2765
+ fields?: string;
2766
+ /** 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. */
2767
+ key?: string;
2768
+ /**
2769
+ * Required. The notification channel for which a verification code is to be generated and retrieved. This must name a channel that is already verified; if the specified channel is
2770
+ * not verified, the request will fail.
2771
+ */
2772
+ name: string;
2773
+ /** OAuth 2.0 token for the current user. */
2774
+ oauth_token?: string;
2775
+ /** Returns response with indentations and line breaks. */
2776
+ prettyPrint?: boolean;
2777
+ /** 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. */
2778
+ quotaUser?: string;
2779
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2780
+ upload_protocol?: string;
2781
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2782
+ uploadType?: string;
2783
+ },
2784
+ body: GetNotificationChannelVerificationCodeRequest): Request<GetNotificationChannelVerificationCodeResponse>;
2785
+ /** Lists the notification channels that have been created for the project. */
2786
+ list(request?: {
2787
+ /** V1 error format. */
2788
+ "$.xgafv"?: string;
2789
+ /** OAuth access token. */
2790
+ access_token?: string;
2791
+ /** Data format for response. */
2792
+ alt?: string;
2793
+ /** JSONP */
2794
+ callback?: string;
2795
+ /** Selector specifying which fields to include in a partial response. */
2796
+ fields?: string;
2797
+ /**
2798
+ * If provided, this field specifies the criteria that must be met by notification channels to be included in the response.For more details, see sorting and filtering
2799
+ * (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
2800
+ */
2801
+ filter?: string;
2802
+ /** 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. */
2803
+ key?: string;
2804
+ /**
2805
+ * Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] This names the
2806
+ * container in which to look for the notification channels; it does not name a specific channel. To query a specific channel by REST resource name, use the GetNotificationChannel
2807
+ * operation.
2808
+ */
2809
+ name: string;
2810
+ /** OAuth 2.0 token for the current user. */
2811
+ oauth_token?: string;
2812
+ /**
2813
+ * A comma-separated list of fields by which to sort the result. Supports the same set of fields as in filter. Entries can be prefixed with a minus sign to sort in descending
2814
+ * rather than ascending order.For more details, see sorting and filtering (https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
2815
+ */
2816
+ orderBy?: string;
2817
+ /** The maximum number of results to return in a single response. If not set to a positive number, a reasonable value will be chosen by the service. */
2818
+ pageSize?: number;
2819
+ /** If non-empty, page_token must contain a value returned as the next_page_token in a previous response to request the next set of results. */
2820
+ pageToken?: string;
2821
+ /** Returns response with indentations and line breaks. */
2822
+ prettyPrint?: boolean;
2823
+ /** 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. */
2824
+ quotaUser?: string;
2825
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2826
+ upload_protocol?: string;
2827
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2828
+ uploadType?: string;
2829
+ }): Request<ListNotificationChannelsResponse>;
2830
+ /** Updates a notification channel. Fields not specified in the field mask remain unchanged. */
2831
+ patch(request: {
2832
+ /** V1 error format. */
2833
+ "$.xgafv"?: string;
2834
+ /** OAuth access token. */
2835
+ access_token?: string;
2836
+ /** Data format for response. */
2837
+ alt?: string;
2838
+ /** JSONP */
2839
+ callback?: string;
2840
+ /** Selector specifying which fields to include in a partial response. */
2841
+ fields?: string;
2842
+ /** 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. */
2843
+ key?: string;
2844
+ /**
2845
+ * The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the
2846
+ * server on creation.
2847
+ */
2848
+ name: string;
2849
+ /** OAuth 2.0 token for the current user. */
2850
+ oauth_token?: string;
2851
+ /** Returns response with indentations and line breaks. */
2852
+ prettyPrint?: boolean;
2853
+ /** 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. */
2854
+ quotaUser?: string;
2855
+ /** The fields to update. */
2856
+ updateMask?: string;
2857
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2858
+ upload_protocol?: string;
2859
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2860
+ uploadType?: string;
2861
+ /** Request body */
2862
+ resource: NotificationChannel;
2863
+ }): Request<NotificationChannel>;
2864
+ patch(request: {
2865
+ /** V1 error format. */
2866
+ "$.xgafv"?: string;
2867
+ /** OAuth access token. */
2868
+ access_token?: string;
2869
+ /** Data format for response. */
2870
+ alt?: string;
2871
+ /** JSONP */
2872
+ callback?: string;
2873
+ /** Selector specifying which fields to include in a partial response. */
2874
+ fields?: string;
2875
+ /** 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. */
2876
+ key?: string;
2877
+ /**
2878
+ * The full REST resource name for this channel. The format is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] The [CHANNEL_ID] is automatically assigned by the
2879
+ * server on creation.
2880
+ */
2881
+ name: string;
2882
+ /** OAuth 2.0 token for the current user. */
2883
+ oauth_token?: string;
2884
+ /** Returns response with indentations and line breaks. */
2885
+ prettyPrint?: boolean;
2886
+ /** 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. */
2887
+ quotaUser?: string;
2888
+ /** The fields to update. */
2889
+ updateMask?: string;
2890
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2891
+ upload_protocol?: string;
2892
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2893
+ uploadType?: string;
2894
+ },
2895
+ body: NotificationChannel): Request<NotificationChannel>;
2896
+ /** Causes a verification code to be delivered to the channel. The code can then be supplied in VerifyNotificationChannel to verify the channel. */
2897
+ sendVerificationCode(request: {
2898
+ /** V1 error format. */
2899
+ "$.xgafv"?: string;
2900
+ /** OAuth access token. */
2901
+ access_token?: string;
2902
+ /** Data format for response. */
2903
+ alt?: string;
2904
+ /** JSONP */
2905
+ callback?: string;
2906
+ /** Selector specifying which fields to include in a partial response. */
2907
+ fields?: string;
2908
+ /** 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. */
2909
+ key?: string;
2910
+ /** Required. The notification channel to which to send a verification code. */
2911
+ name: string;
2912
+ /** OAuth 2.0 token for the current user. */
2913
+ oauth_token?: string;
2914
+ /** Returns response with indentations and line breaks. */
2915
+ prettyPrint?: boolean;
2916
+ /** 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. */
2917
+ quotaUser?: string;
2918
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2919
+ upload_protocol?: string;
2920
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2921
+ uploadType?: string;
2922
+ /** Request body */
2923
+ resource: SendNotificationChannelVerificationCodeRequest;
2924
+ }): Request<{}>;
2925
+ sendVerificationCode(request: {
2926
+ /** V1 error format. */
2927
+ "$.xgafv"?: string;
2928
+ /** OAuth access token. */
2929
+ access_token?: string;
2930
+ /** Data format for response. */
2931
+ alt?: string;
2932
+ /** JSONP */
2933
+ callback?: string;
2934
+ /** Selector specifying which fields to include in a partial response. */
2935
+ fields?: string;
2936
+ /** 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. */
2937
+ key?: string;
2938
+ /** Required. The notification channel to which to send a verification code. */
2939
+ name: string;
2940
+ /** OAuth 2.0 token for the current user. */
2941
+ oauth_token?: string;
2942
+ /** Returns response with indentations and line breaks. */
2943
+ prettyPrint?: boolean;
2944
+ /** 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. */
2945
+ quotaUser?: string;
2946
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2947
+ upload_protocol?: string;
2948
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2949
+ uploadType?: string;
2950
+ },
2951
+ body: SendNotificationChannelVerificationCodeRequest): Request<{}>;
2952
+ /** Verifies a NotificationChannel by proving receipt of the code delivered to the channel as a result of calling SendNotificationChannelVerificationCode. */
2953
+ verify(request: {
2954
+ /** V1 error format. */
2955
+ "$.xgafv"?: string;
2956
+ /** OAuth access token. */
2957
+ access_token?: string;
2958
+ /** Data format for response. */
2959
+ alt?: string;
2960
+ /** JSONP */
2961
+ callback?: string;
2962
+ /** Selector specifying which fields to include in a partial response. */
2963
+ fields?: string;
2964
+ /** 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. */
2965
+ key?: string;
2966
+ /** Required. The notification channel to verify. */
2967
+ name: string;
2968
+ /** OAuth 2.0 token for the current user. */
2969
+ oauth_token?: string;
2970
+ /** Returns response with indentations and line breaks. */
2971
+ prettyPrint?: boolean;
2972
+ /** 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. */
2973
+ quotaUser?: string;
2974
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
2975
+ upload_protocol?: string;
2976
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2977
+ uploadType?: string;
2978
+ /** Request body */
2979
+ resource: VerifyNotificationChannelRequest;
2980
+ }): Request<NotificationChannel>;
2981
+ verify(request: {
2982
+ /** V1 error format. */
2983
+ "$.xgafv"?: string;
2984
+ /** OAuth access token. */
2985
+ access_token?: string;
2986
+ /** Data format for response. */
2987
+ alt?: string;
2988
+ /** JSONP */
2989
+ callback?: string;
2990
+ /** Selector specifying which fields to include in a partial response. */
2991
+ fields?: string;
2992
+ /** 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. */
2993
+ key?: string;
2994
+ /** Required. The notification channel to verify. */
2995
+ name: string;
2996
+ /** OAuth 2.0 token for the current user. */
2997
+ oauth_token?: string;
2998
+ /** Returns response with indentations and line breaks. */
2999
+ prettyPrint?: boolean;
3000
+ /** 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. */
3001
+ quotaUser?: string;
3002
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3003
+ upload_protocol?: string;
3004
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3005
+ uploadType?: string;
3006
+ },
3007
+ body: VerifyNotificationChannelRequest): Request<NotificationChannel>;
3008
+ }
3009
+ interface TimeSeriesResource {
3010
+ /**
3011
+ * Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding
3012
+ * failure message is included in the error response.
3013
+ */
3014
+ create(request: {
3015
+ /** V1 error format. */
3016
+ "$.xgafv"?: string;
3017
+ /** OAuth access token. */
3018
+ access_token?: string;
3019
+ /** Data format for response. */
3020
+ alt?: string;
3021
+ /** JSONP */
3022
+ callback?: string;
3023
+ /** Selector specifying which fields to include in a partial response. */
3024
+ fields?: string;
3025
+ /** 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. */
3026
+ key?: string;
3027
+ /** Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] */
3028
+ name: string;
3029
+ /** OAuth 2.0 token for the current user. */
3030
+ oauth_token?: string;
3031
+ /** Returns response with indentations and line breaks. */
3032
+ prettyPrint?: boolean;
3033
+ /** 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. */
3034
+ quotaUser?: string;
3035
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3036
+ upload_protocol?: string;
3037
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3038
+ uploadType?: string;
3039
+ /** Request body */
3040
+ resource: CreateTimeSeriesRequest;
3041
+ }): Request<{}>;
3042
+ create(request: {
3043
+ /** V1 error format. */
3044
+ "$.xgafv"?: string;
3045
+ /** OAuth access token. */
3046
+ access_token?: string;
3047
+ /** Data format for response. */
3048
+ alt?: string;
3049
+ /** JSONP */
3050
+ callback?: string;
3051
+ /** Selector specifying which fields to include in a partial response. */
3052
+ fields?: string;
3053
+ /** 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. */
3054
+ key?: string;
3055
+ /** Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] */
3056
+ name: string;
3057
+ /** OAuth 2.0 token for the current user. */
3058
+ oauth_token?: string;
3059
+ /** Returns response with indentations and line breaks. */
3060
+ prettyPrint?: boolean;
3061
+ /** 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. */
3062
+ quotaUser?: string;
3063
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3064
+ upload_protocol?: string;
3065
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3066
+ uploadType?: string;
3067
+ },
3068
+ body: CreateTimeSeriesRequest): Request<{}>;
3069
+ /**
3070
+ * Creates or adds data to one or more service time series. A service time series is a time series for a metric from a Google Cloud service. The response is empty if all time series in
3071
+ * the request were written. If any time series could not be written, a corresponding failure message is included in the error response. This endpoint rejects writes to user-defined
3072
+ * metrics. This method is only for use by Google Cloud services. Use projects.timeSeries.create instead.
3073
+ */
3074
+ createService(request: {
3075
+ /** V1 error format. */
3076
+ "$.xgafv"?: string;
3077
+ /** OAuth access token. */
3078
+ access_token?: string;
3079
+ /** Data format for response. */
3080
+ alt?: string;
3081
+ /** JSONP */
3082
+ callback?: string;
3083
+ /** Selector specifying which fields to include in a partial response. */
3084
+ fields?: string;
3085
+ /** 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. */
3086
+ key?: string;
3087
+ /** Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] */
3088
+ name: string;
3089
+ /** OAuth 2.0 token for the current user. */
3090
+ oauth_token?: string;
3091
+ /** Returns response with indentations and line breaks. */
3092
+ prettyPrint?: boolean;
3093
+ /** 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. */
3094
+ quotaUser?: string;
3095
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3096
+ upload_protocol?: string;
3097
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3098
+ uploadType?: string;
3099
+ /** Request body */
3100
+ resource: CreateTimeSeriesRequest;
3101
+ }): Request<{}>;
3102
+ createService(request: {
3103
+ /** V1 error format. */
3104
+ "$.xgafv"?: string;
3105
+ /** OAuth access token. */
3106
+ access_token?: string;
3107
+ /** Data format for response. */
3108
+ alt?: string;
3109
+ /** JSONP */
3110
+ callback?: string;
3111
+ /** Selector specifying which fields to include in a partial response. */
3112
+ fields?: string;
3113
+ /** 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. */
3114
+ key?: string;
3115
+ /** Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] */
3116
+ name: string;
3117
+ /** OAuth 2.0 token for the current user. */
3118
+ oauth_token?: string;
3119
+ /** Returns response with indentations and line breaks. */
3120
+ prettyPrint?: boolean;
3121
+ /** 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. */
3122
+ quotaUser?: string;
3123
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3124
+ upload_protocol?: string;
3125
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3126
+ uploadType?: string;
3127
+ },
3128
+ body: CreateTimeSeriesRequest): Request<{}>;
3129
+ /** Lists time series that match a filter. */
3130
+ list(request?: {
3131
+ /** V1 error format. */
3132
+ "$.xgafv"?: string;
3133
+ /** OAuth access token. */
3134
+ access_token?: string;
3135
+ /**
3136
+ * 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
3137
+ * 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
3138
+ * 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 104
3139
+ * weeks (2 years) for charts, and 90,000 seconds (25 hours) for alerting policies.
3140
+ */
3141
+ "aggregation.alignmentPeriod"?: string;
3142
+ /**
3143
+ * 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
3144
+ * 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
3145
+ * 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
3146
+ * 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.
3147
+ * An alignment_period must also be specified; otherwise, an error is returned.
3148
+ */
3149
+ "aggregation.crossSeriesReducer"?: string;
3150
+ /**
3151
+ * 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
3152
+ * 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.
3153
+ * 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.
3154
+ * 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
3155
+ * aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored.
3156
+ */
3157
+ "aggregation.groupByFields"?: string | string[];
3158
+ /**
3159
+ * 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
3160
+ * 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
3161
+ * 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
3162
+ * 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
3163
+ * must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned.
3164
+ */
3165
+ "aggregation.perSeriesAligner"?: string;
3166
+ /** Data format for response. */
3167
+ alt?: string;
3168
+ /** JSONP */
3169
+ callback?: string;
3170
+ /** Selector specifying which fields to include in a partial response. */
3171
+ fields?: string;
3172
+ /**
3173
+ * Required. A monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that specifies which time series should be returned. The filter must specify a single metric
3174
+ * type, and can additionally specify metric labels and other information. For example: metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
3175
+ * metric.labels.instance_name = "my-instance-name"
3176
+ */
3177
+ filter?: string;
3178
+ /** Required. The end of the time interval. */
3179
+ "interval.endTime"?: string;
3180
+ /** Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time. */
3181
+ "interval.startTime"?: string;
3182
+ /** 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. */
3183
+ key?: string;
3184
+ /**
3185
+ * Required. The project (https://cloud.google.com/monitoring/api/v3#project_name), organization or folder on which to execute the request. The format is:
3186
+ * projects/[PROJECT_ID_OR_NUMBER] organizations/[ORGANIZATION_ID] folders/[FOLDER_ID]
3187
+ */
3188
+ name: string;
3189
+ /** OAuth 2.0 token for the current user. */
3190
+ oauth_token?: string;
3191
+ /** Unsupported: must be left blank. The points in each time series are currently returned in reverse time order (most recent to oldest). */
3192
+ orderBy?: string;
3193
+ /**
3194
+ * A positive number that is the maximum number of results to return. If page_size is empty or more than 100,000 results, the effective page_size is 100,000 results. If view is set
3195
+ * to FULL, this is the maximum number of Points returned. If view is set to HEADERS, this is the maximum number of TimeSeries returned.
3196
+ */
3197
+ pageSize?: number;
3198
+ /**
3199
+ * 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
3200
+ * results from the previous method call.
3201
+ */
3202
+ pageToken?: string;
3203
+ /** Returns response with indentations and line breaks. */
3204
+ prettyPrint?: boolean;
3205
+ /** 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. */
3206
+ quotaUser?: string;
3207
+ /**
3208
+ * 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
3209
+ * 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
3210
+ * 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 104
3211
+ * weeks (2 years) for charts, and 90,000 seconds (25 hours) for alerting policies.
3212
+ */
3213
+ "secondaryAggregation.alignmentPeriod"?: string;
3214
+ /**
3215
+ * 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
3216
+ * 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
3217
+ * 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
3218
+ * 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.
3219
+ * An alignment_period must also be specified; otherwise, an error is returned.
3220
+ */
3221
+ "secondaryAggregation.crossSeriesReducer"?: string;
3222
+ /**
3223
+ * 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
3224
+ * 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.
3225
+ * 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.
3226
+ * 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
3227
+ * aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored.
3228
+ */
3229
+ "secondaryAggregation.groupByFields"?: string | string[];
3230
+ /**
3231
+ * 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
3232
+ * 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
3233
+ * 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
3234
+ * 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
3235
+ * must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned.
3236
+ */
3237
+ "secondaryAggregation.perSeriesAligner"?: string;
3238
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3239
+ upload_protocol?: string;
3240
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3241
+ uploadType?: string;
3242
+ /** Required. Specifies which information is returned about the time series. */
3243
+ view?: string;
3244
+ }): Request<ListTimeSeriesResponse>;
3245
+ /** Queries time series using Monitoring Query Language. */
3246
+ query(request: {
3247
+ /** V1 error format. */
3248
+ "$.xgafv"?: string;
3249
+ /** OAuth access token. */
3250
+ access_token?: string;
3251
+ /** Data format for response. */
3252
+ alt?: string;
3253
+ /** JSONP */
3254
+ callback?: string;
3255
+ /** Selector specifying which fields to include in a partial response. */
3256
+ fields?: string;
3257
+ /** 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. */
3258
+ key?: string;
3259
+ /** Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] */
3260
+ name: string;
3261
+ /** OAuth 2.0 token for the current user. */
3262
+ oauth_token?: string;
3263
+ /** Returns response with indentations and line breaks. */
3264
+ prettyPrint?: boolean;
3265
+ /** 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. */
3266
+ quotaUser?: string;
3267
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3268
+ upload_protocol?: string;
3269
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3270
+ uploadType?: string;
3271
+ /** Request body */
3272
+ resource: QueryTimeSeriesRequest;
3273
+ }): Request<QueryTimeSeriesResponse>;
3274
+ query(request: {
3275
+ /** V1 error format. */
3276
+ "$.xgafv"?: string;
3277
+ /** OAuth access token. */
3278
+ access_token?: string;
3279
+ /** Data format for response. */
3280
+ alt?: string;
3281
+ /** JSONP */
3282
+ callback?: string;
3283
+ /** Selector specifying which fields to include in a partial response. */
3284
+ fields?: string;
3285
+ /** 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. */
3286
+ key?: string;
3287
+ /** Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) on which to execute the request. The format is: projects/[PROJECT_ID_OR_NUMBER] */
3288
+ name: string;
3289
+ /** OAuth 2.0 token for the current user. */
3290
+ oauth_token?: string;
3291
+ /** Returns response with indentations and line breaks. */
3292
+ prettyPrint?: boolean;
3293
+ /** 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. */
3294
+ quotaUser?: string;
3295
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3296
+ upload_protocol?: string;
3297
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3298
+ uploadType?: string;
3299
+ },
3300
+ body: QueryTimeSeriesRequest): Request<QueryTimeSeriesResponse>;
3301
+ }
3302
+ interface UptimeCheckConfigsResource {
3303
+ /** Creates a new Uptime check configuration. */
3304
+ create(request: {
3305
+ /** V1 error format. */
3306
+ "$.xgafv"?: string;
3307
+ /** OAuth access token. */
3308
+ access_token?: string;
3309
+ /** Data format for response. */
3310
+ alt?: string;
3311
+ /** JSONP */
3312
+ callback?: string;
3313
+ /** Selector specifying which fields to include in a partial response. */
3314
+ fields?: string;
3315
+ /** 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. */
3316
+ key?: string;
3317
+ /** OAuth 2.0 token for the current user. */
3318
+ oauth_token?: string;
3319
+ /** Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) in which to create the Uptime check. The format is: projects/[PROJECT_ID_OR_NUMBER] */
3320
+ parent: string;
3321
+ /** Returns response with indentations and line breaks. */
3322
+ prettyPrint?: boolean;
3323
+ /** 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. */
3324
+ quotaUser?: string;
3325
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3326
+ upload_protocol?: string;
3327
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3328
+ uploadType?: string;
3329
+ /** Request body */
3330
+ resource: UptimeCheckConfig;
3331
+ }): Request<UptimeCheckConfig>;
3332
+ create(request: {
3333
+ /** V1 error format. */
3334
+ "$.xgafv"?: string;
3335
+ /** OAuth access token. */
3336
+ access_token?: string;
3337
+ /** Data format for response. */
3338
+ alt?: string;
3339
+ /** JSONP */
3340
+ callback?: string;
3341
+ /** Selector specifying which fields to include in a partial response. */
3342
+ fields?: string;
3343
+ /** 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. */
3344
+ key?: string;
3345
+ /** OAuth 2.0 token for the current user. */
3346
+ oauth_token?: string;
3347
+ /** Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) in which to create the Uptime check. The format is: projects/[PROJECT_ID_OR_NUMBER] */
3348
+ parent: string;
3349
+ /** Returns response with indentations and line breaks. */
3350
+ prettyPrint?: boolean;
3351
+ /** 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. */
3352
+ quotaUser?: string;
3353
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3354
+ upload_protocol?: string;
3355
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3356
+ uploadType?: string;
3357
+ },
3358
+ body: UptimeCheckConfig): Request<UptimeCheckConfig>;
3359
+ /**
3360
+ * Deletes an Uptime check configuration. Note that this method will fail if the Uptime check configuration is referenced by an alert policy or other dependent configs that would be
3361
+ * rendered invalid by the deletion.
3362
+ */
3363
+ delete(request?: {
3364
+ /** V1 error format. */
3365
+ "$.xgafv"?: string;
3366
+ /** OAuth access token. */
3367
+ access_token?: string;
3368
+ /** Data format for response. */
3369
+ alt?: string;
3370
+ /** JSONP */
3371
+ callback?: string;
3372
+ /** Selector specifying which fields to include in a partial response. */
3373
+ fields?: string;
3374
+ /** 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. */
3375
+ key?: string;
3376
+ /** Required. The Uptime check configuration to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] */
3377
+ name: string;
3378
+ /** OAuth 2.0 token for the current user. */
3379
+ oauth_token?: string;
3380
+ /** Returns response with indentations and line breaks. */
3381
+ prettyPrint?: boolean;
3382
+ /** 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. */
3383
+ quotaUser?: string;
3384
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3385
+ upload_protocol?: string;
3386
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3387
+ uploadType?: string;
3388
+ }): Request<{}>;
3389
+ /** Gets a single Uptime check configuration. */
3390
+ get(request?: {
3391
+ /** V1 error format. */
3392
+ "$.xgafv"?: string;
3393
+ /** OAuth access token. */
3394
+ access_token?: string;
3395
+ /** Data format for response. */
3396
+ alt?: string;
3397
+ /** JSONP */
3398
+ callback?: string;
3399
+ /** Selector specifying which fields to include in a partial response. */
3400
+ fields?: string;
3401
+ /** 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. */
3402
+ key?: string;
3403
+ /** Required. The Uptime check configuration to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] */
3404
+ name: string;
3405
+ /** OAuth 2.0 token for the current user. */
3406
+ oauth_token?: string;
3407
+ /** Returns response with indentations and line breaks. */
3408
+ prettyPrint?: boolean;
3409
+ /** 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. */
3410
+ quotaUser?: string;
3411
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3412
+ upload_protocol?: string;
3413
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3414
+ uploadType?: string;
3415
+ }): Request<UptimeCheckConfig>;
3416
+ /** Lists the existing valid Uptime check configurations for the project (leaving out any invalid configurations). */
3417
+ list(request?: {
3418
+ /** V1 error format. */
3419
+ "$.xgafv"?: string;
3420
+ /** OAuth access token. */
3421
+ access_token?: string;
3422
+ /** Data format for response. */
3423
+ alt?: string;
3424
+ /** JSONP */
3425
+ callback?: string;
3426
+ /** Selector specifying which fields to include in a partial response. */
3427
+ fields?: string;
3428
+ /** 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. */
3429
+ key?: string;
3430
+ /** OAuth 2.0 token for the current user. */
3431
+ oauth_token?: string;
3432
+ /**
3433
+ * The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0,
3434
+ * the server will decide the number of results to be returned.
3435
+ */
3436
+ pageSize?: number;
3437
+ /**
3438
+ * 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 more results
3439
+ * from the previous method call.
3440
+ */
3441
+ pageToken?: string;
3442
+ /** Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) whose Uptime check configurations are listed. The format is: projects/[PROJECT_ID_OR_NUMBER] */
3443
+ parent: string;
3444
+ /** Returns response with indentations and line breaks. */
3445
+ prettyPrint?: boolean;
3446
+ /** 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. */
3447
+ quotaUser?: string;
3448
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3449
+ upload_protocol?: string;
3450
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3451
+ uploadType?: string;
3452
+ }): Request<ListUptimeCheckConfigsResponse>;
3453
+ /**
3454
+ * Updates an Uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the
3455
+ * fields to be updated via updateMask. Returns the updated configuration.
3456
+ */
3457
+ patch(request: {
3458
+ /** V1 error format. */
3459
+ "$.xgafv"?: string;
3460
+ /** OAuth access token. */
3461
+ access_token?: string;
3462
+ /** Data format for response. */
3463
+ alt?: string;
3464
+ /** JSONP */
3465
+ callback?: string;
3466
+ /** Selector specifying which fields to include in a partial response. */
3467
+ fields?: string;
3468
+ /** 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. */
3469
+ key?: string;
3470
+ /**
3471
+ * A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] [PROJECT_ID_OR_NUMBER] is the
3472
+ * Workspace host project associated with the Uptime check.This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by
3473
+ * the server and included in the response.
3474
+ */
3475
+ name: string;
3476
+ /** OAuth 2.0 token for the current user. */
3477
+ oauth_token?: string;
3478
+ /** Returns response with indentations and line breaks. */
3479
+ prettyPrint?: boolean;
3480
+ /** 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. */
3481
+ quotaUser?: string;
3482
+ /**
3483
+ * Optional. If present, only the listed fields in the current Uptime check configuration are updated with values from the new configuration. If this field is empty, then the
3484
+ * current configuration is completely replaced with the new configuration.
3485
+ */
3486
+ updateMask?: string;
3487
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3488
+ upload_protocol?: string;
3489
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3490
+ uploadType?: string;
3491
+ /** Request body */
3492
+ resource: UptimeCheckConfig;
3493
+ }): Request<UptimeCheckConfig>;
3494
+ patch(request: {
3495
+ /** V1 error format. */
3496
+ "$.xgafv"?: string;
3497
+ /** OAuth access token. */
3498
+ access_token?: string;
3499
+ /** Data format for response. */
3500
+ alt?: string;
3501
+ /** JSONP */
3502
+ callback?: string;
3503
+ /** Selector specifying which fields to include in a partial response. */
3504
+ fields?: string;
3505
+ /** 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. */
3506
+ key?: string;
3507
+ /**
3508
+ * A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] [PROJECT_ID_OR_NUMBER] is the
3509
+ * Workspace host project associated with the Uptime check.This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by
3510
+ * the server and included in the response.
3511
+ */
3512
+ name: string;
3513
+ /** OAuth 2.0 token for the current user. */
3514
+ oauth_token?: string;
3515
+ /** Returns response with indentations and line breaks. */
3516
+ prettyPrint?: boolean;
3517
+ /** 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. */
3518
+ quotaUser?: string;
3519
+ /**
3520
+ * Optional. If present, only the listed fields in the current Uptime check configuration are updated with values from the new configuration. If this field is empty, then the
3521
+ * current configuration is completely replaced with the new configuration.
3522
+ */
3523
+ updateMask?: string;
3524
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3525
+ upload_protocol?: string;
3526
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3527
+ uploadType?: string;
3528
+ },
3529
+ body: UptimeCheckConfig): Request<UptimeCheckConfig>;
3530
+ }
3531
+ interface ProjectsResource {
3532
+ alertPolicies: AlertPoliciesResource;
3533
+ collectdTimeSeries: CollectdTimeSeriesResource;
3534
+ groups: GroupsResource;
3535
+ metricDescriptors: MetricDescriptorsResource;
3536
+ monitoredResourceDescriptors: MonitoredResourceDescriptorsResource;
3537
+ notificationChannelDescriptors: NotificationChannelDescriptorsResource;
3538
+ notificationChannels: NotificationChannelsResource;
3539
+ timeSeries: TimeSeriesResource;
3540
+ uptimeCheckConfigs: UptimeCheckConfigsResource;
3541
+ }
3542
+ interface ServiceLevelObjectivesResource {
3543
+ /** Create a ServiceLevelObjective for the given Service. */
3544
+ create(request: {
3545
+ /** V1 error format. */
3546
+ "$.xgafv"?: string;
3547
+ /** OAuth access token. */
3548
+ access_token?: string;
3549
+ /** Data format for response. */
3550
+ alt?: string;
3551
+ /** JSONP */
3552
+ callback?: string;
3553
+ /** Selector specifying which fields to include in a partial response. */
3554
+ fields?: string;
3555
+ /** 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. */
3556
+ key?: string;
3557
+ /** OAuth 2.0 token for the current user. */
3558
+ oauth_token?: string;
3559
+ /** Required. Resource name of the parent Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] */
3560
+ parent: string;
3561
+ /** Returns response with indentations and line breaks. */
3562
+ prettyPrint?: boolean;
3563
+ /** 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. */
3564
+ quotaUser?: string;
3565
+ /** Optional. The ServiceLevelObjective id to use for this ServiceLevelObjective. If omitted, an id will be generated instead. Must match the pattern [a-z0-9\-]+ */
3566
+ serviceLevelObjectiveId?: string;
3567
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3568
+ upload_protocol?: string;
3569
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3570
+ uploadType?: string;
3571
+ /** Request body */
3572
+ resource: ServiceLevelObjective;
3573
+ }): Request<ServiceLevelObjective>;
3574
+ create(request: {
3575
+ /** V1 error format. */
3576
+ "$.xgafv"?: string;
3577
+ /** OAuth access token. */
3578
+ access_token?: string;
3579
+ /** Data format for response. */
3580
+ alt?: string;
3581
+ /** JSONP */
3582
+ callback?: string;
3583
+ /** Selector specifying which fields to include in a partial response. */
3584
+ fields?: string;
3585
+ /** 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. */
3586
+ key?: string;
3587
+ /** OAuth 2.0 token for the current user. */
3588
+ oauth_token?: string;
3589
+ /** Required. Resource name of the parent Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] */
3590
+ parent: string;
3591
+ /** Returns response with indentations and line breaks. */
3592
+ prettyPrint?: boolean;
3593
+ /** 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. */
3594
+ quotaUser?: string;
3595
+ /** Optional. The ServiceLevelObjective id to use for this ServiceLevelObjective. If omitted, an id will be generated instead. Must match the pattern [a-z0-9\-]+ */
3596
+ serviceLevelObjectiveId?: string;
3597
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3598
+ upload_protocol?: string;
3599
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3600
+ uploadType?: string;
3601
+ },
3602
+ body: ServiceLevelObjective): Request<ServiceLevelObjective>;
3603
+ /** Delete the given ServiceLevelObjective. */
3604
+ delete(request?: {
3605
+ /** V1 error format. */
3606
+ "$.xgafv"?: string;
3607
+ /** OAuth access token. */
3608
+ access_token?: string;
3609
+ /** Data format for response. */
3610
+ alt?: string;
3611
+ /** JSONP */
3612
+ callback?: string;
3613
+ /** Selector specifying which fields to include in a partial response. */
3614
+ fields?: string;
3615
+ /** 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. */
3616
+ key?: string;
3617
+ /** Required. Resource name of the ServiceLevelObjective to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] */
3618
+ name: string;
3619
+ /** OAuth 2.0 token for the current user. */
3620
+ oauth_token?: string;
3621
+ /** Returns response with indentations and line breaks. */
3622
+ prettyPrint?: boolean;
3623
+ /** 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. */
3624
+ quotaUser?: string;
3625
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3626
+ upload_protocol?: string;
3627
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3628
+ uploadType?: string;
3629
+ }): Request<{}>;
3630
+ /** Get a ServiceLevelObjective by name. */
3631
+ get(request?: {
3632
+ /** V1 error format. */
3633
+ "$.xgafv"?: string;
3634
+ /** OAuth access token. */
3635
+ access_token?: string;
3636
+ /** Data format for response. */
3637
+ alt?: string;
3638
+ /** JSONP */
3639
+ callback?: string;
3640
+ /** Selector specifying which fields to include in a partial response. */
3641
+ fields?: string;
3642
+ /** 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. */
3643
+ key?: string;
3644
+ /** Required. Resource name of the ServiceLevelObjective to get. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] */
3645
+ name: string;
3646
+ /** OAuth 2.0 token for the current user. */
3647
+ oauth_token?: string;
3648
+ /** Returns response with indentations and line breaks. */
3649
+ prettyPrint?: boolean;
3650
+ /** 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. */
3651
+ quotaUser?: string;
3652
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3653
+ upload_protocol?: string;
3654
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3655
+ uploadType?: string;
3656
+ /**
3657
+ * View of the ServiceLevelObjective to return. If DEFAULT, return the ServiceLevelObjective as originally defined. If EXPLICIT and the ServiceLevelObjective is defined in terms of
3658
+ * a BasicSli, replace the BasicSli with a RequestBasedSli spelling out how the SLI is computed.
3659
+ */
3660
+ view?: string;
3661
+ }): Request<ServiceLevelObjective>;
3662
+ /** List the ServiceLevelObjectives for the given Service. */
3663
+ list(request?: {
3664
+ /** V1 error format. */
3665
+ "$.xgafv"?: string;
3666
+ /** OAuth access token. */
3667
+ access_token?: string;
3668
+ /** Data format for response. */
3669
+ alt?: string;
3670
+ /** JSONP */
3671
+ callback?: string;
3672
+ /** Selector specifying which fields to include in a partial response. */
3673
+ fields?: string;
3674
+ /** A filter specifying what ServiceLevelObjectives to return. */
3675
+ filter?: string;
3676
+ /** 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. */
3677
+ key?: string;
3678
+ /** OAuth 2.0 token for the current user. */
3679
+ oauth_token?: string;
3680
+ /** A non-negative number that is the maximum number of results to return. When 0, use default page size. */
3681
+ pageSize?: number;
3682
+ /**
3683
+ * 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
3684
+ * results from the previous method call.
3685
+ */
3686
+ pageToken?: string;
3687
+ /**
3688
+ * Required. Resource name of the parent containing the listed SLOs, either a project or a Monitoring Metrics Scope. The formats are:
3689
+ * projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] workspaces/[HOST_PROJECT_ID_OR_NUMBER]/services/-
3690
+ */
3691
+ parent: string;
3692
+ /** Returns response with indentations and line breaks. */
3693
+ prettyPrint?: boolean;
3694
+ /** 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. */
3695
+ quotaUser?: string;
3696
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3697
+ upload_protocol?: string;
3698
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3699
+ uploadType?: string;
3700
+ /**
3701
+ * View of the ServiceLevelObjectives to return. If DEFAULT, return each ServiceLevelObjective as originally defined. If EXPLICIT and the ServiceLevelObjective is defined in terms
3702
+ * of a BasicSli, replace the BasicSli with a RequestBasedSli spelling out how the SLI is computed.
3703
+ */
3704
+ view?: string;
3705
+ }): Request<ListServiceLevelObjectivesResponse>;
3706
+ /** Update the given ServiceLevelObjective. */
3707
+ patch(request: {
3708
+ /** V1 error format. */
3709
+ "$.xgafv"?: string;
3710
+ /** OAuth access token. */
3711
+ access_token?: string;
3712
+ /** Data format for response. */
3713
+ alt?: string;
3714
+ /** JSONP */
3715
+ callback?: string;
3716
+ /** Selector specifying which fields to include in a partial response. */
3717
+ fields?: string;
3718
+ /** 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. */
3719
+ key?: string;
3720
+ /** Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] */
3721
+ name: string;
3722
+ /** OAuth 2.0 token for the current user. */
3723
+ oauth_token?: string;
3724
+ /** Returns response with indentations and line breaks. */
3725
+ prettyPrint?: boolean;
3726
+ /** 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. */
3727
+ quotaUser?: string;
3728
+ /** A set of field paths defining which fields to use for the update. */
3729
+ updateMask?: string;
3730
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3731
+ upload_protocol?: string;
3732
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3733
+ uploadType?: string;
3734
+ /** Request body */
3735
+ resource: ServiceLevelObjective;
3736
+ }): Request<ServiceLevelObjective>;
3737
+ patch(request: {
3738
+ /** V1 error format. */
3739
+ "$.xgafv"?: string;
3740
+ /** OAuth access token. */
3741
+ access_token?: string;
3742
+ /** Data format for response. */
3743
+ alt?: string;
3744
+ /** JSONP */
3745
+ callback?: string;
3746
+ /** Selector specifying which fields to include in a partial response. */
3747
+ fields?: string;
3748
+ /** 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. */
3749
+ key?: string;
3750
+ /** Resource name for this ServiceLevelObjective. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME] */
3751
+ name: string;
3752
+ /** OAuth 2.0 token for the current user. */
3753
+ oauth_token?: string;
3754
+ /** Returns response with indentations and line breaks. */
3755
+ prettyPrint?: boolean;
3756
+ /** 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. */
3757
+ quotaUser?: string;
3758
+ /** A set of field paths defining which fields to use for the update. */
3759
+ updateMask?: string;
3760
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3761
+ upload_protocol?: string;
3762
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3763
+ uploadType?: string;
3764
+ },
3765
+ body: ServiceLevelObjective): Request<ServiceLevelObjective>;
3766
+ }
3767
+ interface ServicesResource {
3768
+ /** Create a Service. */
3769
+ create(request: {
3770
+ /** V1 error format. */
3771
+ "$.xgafv"?: string;
3772
+ /** OAuth access token. */
3773
+ access_token?: string;
3774
+ /** Data format for response. */
3775
+ alt?: string;
3776
+ /** JSONP */
3777
+ callback?: string;
3778
+ /** Selector specifying which fields to include in a partial response. */
3779
+ fields?: string;
3780
+ /** 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. */
3781
+ key?: string;
3782
+ /** OAuth 2.0 token for the current user. */
3783
+ oauth_token?: string;
3784
+ /** Required. Resource name (https://cloud.google.com/monitoring/api/v3#project_name) of the parent Metrics Scope. The format is: projects/[PROJECT_ID_OR_NUMBER] */
3785
+ parent: string;
3786
+ /** Returns response with indentations and line breaks. */
3787
+ prettyPrint?: boolean;
3788
+ /** 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. */
3789
+ quotaUser?: string;
3790
+ /** Optional. The Service id to use for this Service. If omitted, an id will be generated instead. Must match the pattern [a-z0-9\-]+ */
3791
+ serviceId?: string;
3792
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3793
+ upload_protocol?: string;
3794
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3795
+ uploadType?: string;
3796
+ /** Request body */
3797
+ resource: Service;
3798
+ }): Request<Service>;
3799
+ create(request: {
3800
+ /** V1 error format. */
3801
+ "$.xgafv"?: string;
3802
+ /** OAuth access token. */
3803
+ access_token?: string;
3804
+ /** Data format for response. */
3805
+ alt?: string;
3806
+ /** JSONP */
3807
+ callback?: string;
3808
+ /** Selector specifying which fields to include in a partial response. */
3809
+ fields?: string;
3810
+ /** 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. */
3811
+ key?: string;
3812
+ /** OAuth 2.0 token for the current user. */
3813
+ oauth_token?: string;
3814
+ /** Required. Resource name (https://cloud.google.com/monitoring/api/v3#project_name) of the parent Metrics Scope. The format is: projects/[PROJECT_ID_OR_NUMBER] */
3815
+ parent: string;
3816
+ /** Returns response with indentations and line breaks. */
3817
+ prettyPrint?: boolean;
3818
+ /** 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. */
3819
+ quotaUser?: string;
3820
+ /** Optional. The Service id to use for this Service. If omitted, an id will be generated instead. Must match the pattern [a-z0-9\-]+ */
3821
+ serviceId?: string;
3822
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3823
+ upload_protocol?: string;
3824
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3825
+ uploadType?: string;
3826
+ },
3827
+ body: Service): Request<Service>;
3828
+ /** Soft delete this Service. */
3829
+ delete(request?: {
3830
+ /** V1 error format. */
3831
+ "$.xgafv"?: string;
3832
+ /** OAuth access token. */
3833
+ access_token?: string;
3834
+ /** Data format for response. */
3835
+ alt?: string;
3836
+ /** JSONP */
3837
+ callback?: string;
3838
+ /** Selector specifying which fields to include in a partial response. */
3839
+ fields?: string;
3840
+ /** 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. */
3841
+ key?: string;
3842
+ /** Required. Resource name of the Service to delete. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] */
3843
+ name: string;
3844
+ /** OAuth 2.0 token for the current user. */
3845
+ oauth_token?: string;
3846
+ /** Returns response with indentations and line breaks. */
3847
+ prettyPrint?: boolean;
3848
+ /** 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. */
3849
+ quotaUser?: string;
3850
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3851
+ upload_protocol?: string;
3852
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3853
+ uploadType?: string;
3854
+ }): Request<{}>;
3855
+ /** Get the named Service. */
3856
+ get(request?: {
3857
+ /** V1 error format. */
3858
+ "$.xgafv"?: string;
3859
+ /** OAuth access token. */
3860
+ access_token?: string;
3861
+ /** Data format for response. */
3862
+ alt?: string;
3863
+ /** JSONP */
3864
+ callback?: string;
3865
+ /** Selector specifying which fields to include in a partial response. */
3866
+ fields?: string;
3867
+ /** 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. */
3868
+ key?: string;
3869
+ /** Required. Resource name of the Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] */
3870
+ name: string;
3871
+ /** OAuth 2.0 token for the current user. */
3872
+ oauth_token?: string;
3873
+ /** Returns response with indentations and line breaks. */
3874
+ prettyPrint?: boolean;
3875
+ /** 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. */
3876
+ quotaUser?: string;
3877
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3878
+ upload_protocol?: string;
3879
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3880
+ uploadType?: string;
3881
+ }): Request<Service>;
3882
+ /** List Services for this Metrics Scope. */
3883
+ list(request?: {
3884
+ /** V1 error format. */
3885
+ "$.xgafv"?: string;
3886
+ /** OAuth access token. */
3887
+ access_token?: string;
3888
+ /** Data format for response. */
3889
+ alt?: string;
3890
+ /** JSONP */
3891
+ callback?: string;
3892
+ /** Selector specifying which fields to include in a partial response. */
3893
+ fields?: string;
3894
+ /**
3895
+ * A filter specifying what Services to return. The filter supports filtering on a particular service-identifier type or one of its attributes.To filter on a particular
3896
+ * service-identifier type, the identifier_case refers to which option in the identifier field is populated. For example, the filter identifier_case = "CUSTOM" would match all
3897
+ * services with a value for the custom field. Valid options include "CUSTOM", "APP_ENGINE", "MESH_ISTIO", and the other options listed at
3898
+ * https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#ServiceTo filter on an attribute of a service-identifier type, apply the filter name by using the snake case of
3899
+ * the service-identifier type and the attribute of that service-identifier type, and join the two with a period. For example, to filter by the meshUid field of the MeshIstio
3900
+ * service-identifier type, you must filter on mesh_istio.mesh_uid = "123" to match all services with mesh UID "123". Service-identifier types and their attributes are described at
3901
+ * https://cloud.google.com/monitoring/api/ref_v3/rest/v3/services#Service
3902
+ */
3903
+ filter?: string;
3904
+ /** 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. */
3905
+ key?: string;
3906
+ /** OAuth 2.0 token for the current user. */
3907
+ oauth_token?: string;
3908
+ /** A non-negative number that is the maximum number of results to return. When 0, use default page size. */
3909
+ pageSize?: number;
3910
+ /**
3911
+ * 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
3912
+ * results from the previous method call.
3913
+ */
3914
+ pageToken?: string;
3915
+ /**
3916
+ * Required. Resource name of the parent containing the listed services, either a project (https://cloud.google.com/monitoring/api/v3#project_name) or a Monitoring Metrics Scope.
3917
+ * The formats are: projects/[PROJECT_ID_OR_NUMBER] workspaces/[HOST_PROJECT_ID_OR_NUMBER]
3918
+ */
3919
+ parent: string;
3920
+ /** Returns response with indentations and line breaks. */
3921
+ prettyPrint?: boolean;
3922
+ /** 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. */
3923
+ quotaUser?: string;
3924
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3925
+ upload_protocol?: string;
3926
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3927
+ uploadType?: string;
3928
+ }): Request<ListServicesResponse>;
3929
+ /** Update this Service. */
3930
+ patch(request: {
3931
+ /** V1 error format. */
3932
+ "$.xgafv"?: string;
3933
+ /** OAuth access token. */
3934
+ access_token?: string;
3935
+ /** Data format for response. */
3936
+ alt?: string;
3937
+ /** JSONP */
3938
+ callback?: string;
3939
+ /** Selector specifying which fields to include in a partial response. */
3940
+ fields?: string;
3941
+ /** 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. */
3942
+ key?: string;
3943
+ /** Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] */
3944
+ name: string;
3945
+ /** OAuth 2.0 token for the current user. */
3946
+ oauth_token?: string;
3947
+ /** Returns response with indentations and line breaks. */
3948
+ prettyPrint?: boolean;
3949
+ /** 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. */
3950
+ quotaUser?: string;
3951
+ /** A set of field paths defining which fields to use for the update. */
3952
+ updateMask?: string;
3953
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3954
+ upload_protocol?: string;
3955
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3956
+ uploadType?: string;
3957
+ /** Request body */
3958
+ resource: Service;
3959
+ }): Request<Service>;
3960
+ patch(request: {
3961
+ /** V1 error format. */
3962
+ "$.xgafv"?: string;
3963
+ /** OAuth access token. */
3964
+ access_token?: string;
3965
+ /** Data format for response. */
3966
+ alt?: string;
3967
+ /** JSONP */
3968
+ callback?: string;
3969
+ /** Selector specifying which fields to include in a partial response. */
3970
+ fields?: string;
3971
+ /** 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. */
3972
+ key?: string;
3973
+ /** Resource name for this Service. The format is: projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] */
3974
+ name: string;
3975
+ /** OAuth 2.0 token for the current user. */
3976
+ oauth_token?: string;
3977
+ /** Returns response with indentations and line breaks. */
3978
+ prettyPrint?: boolean;
3979
+ /** 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. */
3980
+ quotaUser?: string;
3981
+ /** A set of field paths defining which fields to use for the update. */
3982
+ updateMask?: string;
3983
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3984
+ upload_protocol?: string;
3985
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3986
+ uploadType?: string;
3987
+ },
3988
+ body: Service): Request<Service>;
3989
+ serviceLevelObjectives: ServiceLevelObjectivesResource;
3990
+ }
3991
+ interface UptimeCheckIpsResource {
3992
+ /** Returns the list of IP addresses that checkers run from */
3993
+ list(request?: {
3994
+ /** V1 error format. */
3995
+ "$.xgafv"?: string;
3996
+ /** OAuth access token. */
3997
+ access_token?: string;
3998
+ /** Data format for response. */
3999
+ alt?: string;
4000
+ /** JSONP */
4001
+ callback?: string;
4002
+ /** Selector specifying which fields to include in a partial response. */
4003
+ fields?: string;
4004
+ /** 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. */
4005
+ key?: string;
4006
+ /** OAuth 2.0 token for the current user. */
4007
+ oauth_token?: string;
4008
+ /**
4009
+ * The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is <=0,
4010
+ * the server will decide the number of results to be returned. NOTE: this field is not yet implemented
4011
+ */
4012
+ pageSize?: number;
4013
+ /**
4014
+ * 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 more results
4015
+ * from the previous method call. NOTE: this field is not yet implemented
4016
+ */
4017
+ pageToken?: string;
4018
+ /** Returns response with indentations and line breaks. */
4019
+ prettyPrint?: boolean;
4020
+ /** 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. */
4021
+ quotaUser?: string;
4022
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4023
+ upload_protocol?: string;
4024
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4025
+ uploadType?: string;
4026
+ }): Request<ListUptimeCheckIpsResponse>;
4027
+ }
4028
+
4029
+ const folders: FoldersResource;
4030
+
4031
+ const organizations: OrganizationsResource;
4032
+
4033
+ const projects: ProjectsResource;
4034
+
4035
+ const services: ServicesResource;
4036
+
4037
+ const uptimeCheckIps: UptimeCheckIpsResource;
4038
+ }
4039
+ }