@maxim_mazurok/gapi.client.monitoring-v3 0.0.20221114 → 0.0.20221205

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://monitoring.googleapis.com/$discovery/rest?version=v3
-// Revision: 20221114
+// Revision: 20221205
 
 /// <reference types="gapi.client" />
 
@@ -306,6 +306,13 @@ declare namespace gapi.client {
             /** The number of points in the request. */
             totalPointCount?: number;
         }
+        interface Criteria {
+            /**
+             * The specific AlertPolicy names for the alert that should be snoozed. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID] There is a limit of 10 policies per
+             * snooze. This limit is checked during snooze creation.
+             */
+            policies?: string[];
+        }
         // tslint:disable-next-line:no-empty-interface
         interface Custom {
         }
@@ -410,6 +417,13 @@ declare namespace gapi.client {
             /** The field type URL, without the scheme, for message or enumeration types. Example: "type.googleapis.com/google.protobuf.Timestamp". */
             typeUrl?: string;
         }
+        interface ForecastOptions {
+            /**
+             * Required. The length of time into the future to forecast whether a time series will violate the threshold. If the predicted value is found to violate the threshold, and the
+             * violation is observed in all forecasts made for the configured duration, then the time series is considered to be failing.
+             */
+            forecastHorizon?: string;
+        }
         interface GetNotificationChannelVerificationCodeRequest {
             /**
              * 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
@@ -703,6 +717,12 @@ declare namespace gapi.client {
             /** The Services matching the specified filter. */
             services?: Service[];
         }
+        interface ListSnoozesResponse {
+            /** Page token for repeated calls to ListSnoozes, to fetch additional pages of results. If this is empty or missing, there are no more pages. */
+            nextPageToken?: string;
+            /** Snoozes matching this list call. */
+            snoozes?: Snooze[];
+        }
         interface ListTimeSeriesResponse {
             /** Query execution errors that may have caused the time series data returned to be incomplete. */
             executionErrors?: Status[];
@@ -905,6 +925,11 @@ declare namespace gapi.client {
              * 2048 Unicode characters in length.
              */
             filter?: string;
+            /**
+             * When this field is present, the MetricThreshold condition forecasts whether the time series is predicted to violate the threshold within the forecast_horizion. When this field is
+             * not set, the MetricThreshold tests the current value of the timeseries against the threshold.
+             */
+            forecastOptions?: ForecastOptions;
             /** A value against which to compare the time series. */
             thresholdValue?: number;
             /**
@@ -1231,6 +1256,19 @@ declare namespace gapi.client {
              */
             userLabels?: { [P in string]: string };
         }
+        interface Snooze {
+            /** Required. This defines the criteria for applying the Snooze. See Criteria for more information. */
+            criteria?: Criteria;
+            /** Required. A display name for the Snooze. This can be, at most, 512 unicode characters. */
+            displayName?: string;
+            /**
+             * Required. The Snooze will be active from interval.start_time through interval.end_time. interval.start_time cannot be in the past. There is a 15 second clock skew to account for the
+             * time it takes for a request to reach the API from the UI.
+             */
+            interval?: TimeInterval;
+            /** Required. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system. */
+            name?: string;
+        }
         interface SourceContext {
             /** The path-qualified name of the .proto file that contained the associated protobuf element. For example: "google/protobuf/source_context.proto". */
             fileName?: string;
@@ -3047,6 +3085,202 @@ declare namespace gapi.client {
             },
             body: VerifyNotificationChannelRequest): Request<NotificationChannel>;
         }
+        interface SnoozesResource {
+            /** Creates a Snooze that will prevent alerts, which match the provided criteria, from being opened. The Snooze applies for a specific time interval. */
+            create(request: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) in which a Snooze should be created. The format is: projects/[PROJECT_ID_OR_NUMBER] */
+                parent: string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?: boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+                /** Request body */
+                resource: Snooze;
+            }): Request<Snooze>;
+            create(request: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) in which a Snooze should be created. The format is: projects/[PROJECT_ID_OR_NUMBER] */
+                parent: string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?: boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            },
+            body: Snooze): Request<Snooze>;
+            /** Retrieves a Snooze by name. */
+            get(request?: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?: string;
+                /** Required. The ID of the Snooze to retrieve. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] */
+                name: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?: boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            }): Request<Snooze>;
+            /** Lists the Snoozes associated with a project. Can optionally pass in filter, which specifies predicates to match Snoozes. */
+            list(request?: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /**
+                 * Optional. Optional filter to restrict results to the given criteria. The following fields are supported. interval.start_time interval.end_timeFor example: ```
+                 * interval.start_time > "2022-03-11T00:00:00-08:00" AND interval.end_time < "2022-03-12T00:00:00-08:00" ```
+                 */
+                filter?: string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /**
+                 * Optional. The maximum number of results to return for a single query. The server may further constrain the maximum number of results returned in a single page. The value should
+                 * be in the range 1, 1000. If the value given is outside this range, the server will decide the number of results to be returned.
+                 */
+                pageSize?: number;
+                /** Optional. The next_page_token from a previous call to ListSnoozesRequest to get the next page of results. */
+                pageToken?: string;
+                /** Required. The project (https://cloud.google.com/monitoring/api/v3#project_name) whose Snoozes should be listed. The format is: projects/[PROJECT_ID_OR_NUMBER] */
+                parent: string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?: boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            }): Request<ListSnoozesResponse>;
+            /** Updates a Snooze, identified by its name, with the parameters in the given Snooze object. */
+            patch(request: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?: string;
+                /** Required. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system. */
+                name: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?: boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?: string;
+                /**
+                 * Required. The fields to update.For each field listed in update_mask: If the Snooze object supplied in the UpdateSnoozeRequest has a value for that field, the value of the field
+                 * in the existing Snooze will be set to the value of the field in the supplied Snooze. If the field does not have a value in the supplied Snooze, the field in the existing Snooze
+                 * is set to its default value.Fields not listed retain their existing value.The following are the field names that are accepted in update_mask: display_name interval.start_time
+                 * interval.end_timeThat said, the start time and end time of the Snooze determines which fields can legally be updated. Before attempting an update, users should consult the
+                 * documentation for UpdateSnoozeRequest, which talks about which fields can be updated.
+                 */
+                updateMask?: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+                /** Request body */
+                resource: Snooze;
+            }): Request<Snooze>;
+            patch(request: {
+                /** V1 error format. */
+                "$.xgafv"?: string;
+                /** OAuth access token. */
+                access_token?: string;
+                /** Data format for response. */
+                alt?: string;
+                /** JSONP */
+                callback?: string;
+                /** Selector specifying which fields to include in a partial response. */
+                fields?: string;
+                /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+                key?: string;
+                /** Required. The name of the Snooze. The format is: projects/[PROJECT_ID_OR_NUMBER]/snoozes/[SNOOZE_ID] The ID of the Snooze will be generated by the system. */
+                name: string;
+                /** OAuth 2.0 token for the current user. */
+                oauth_token?: string;
+                /** Returns response with indentations and line breaks. */
+                prettyPrint?: boolean;
+                /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+                quotaUser?: string;
+                /**
+                 * Required. The fields to update.For each field listed in update_mask: If the Snooze object supplied in the UpdateSnoozeRequest has a value for that field, the value of the field
+                 * in the existing Snooze will be set to the value of the field in the supplied Snooze. If the field does not have a value in the supplied Snooze, the field in the existing Snooze
+                 * is set to its default value.Fields not listed retain their existing value.The following are the field names that are accepted in update_mask: display_name interval.start_time
+                 * interval.end_timeThat said, the start time and end time of the Snooze determines which fields can legally be updated. Before attempting an update, users should consult the
+                 * documentation for UpdateSnoozeRequest, which talks about which fields can be updated.
+                 */
+                updateMask?: string;
+                /** Upload protocol for media (e.g. "raw", "multipart"). */
+                upload_protocol?: string;
+                /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+                uploadType?: string;
+            },
+            body: Snooze): Request<Snooze>;
+        }
         interface TimeSeriesResource {
             /**
              * 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
@@ -3582,6 +3816,7 @@ declare namespace gapi.client {
             monitoredResourceDescriptors: MonitoredResourceDescriptorsResource;
             notificationChannelDescriptors: NotificationChannelDescriptorsResource;
             notificationChannels: NotificationChannelsResource;
+            snoozes: SnoozesResource;
             timeSeries: TimeSeriesResource;
             uptimeCheckConfigs: UptimeCheckConfigsResource;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.monitoring-v3",
-  "version": "0.0.20221114",
+  "version": "0.0.20221205",
   "description": "TypeScript typings for Cloud Monitoring API v3",
   "license": "MIT",
   "author": {

package/tests.ts

@@ -3,7 +3,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 
-// Revision: 20221114
+// Revision: 20221205
 
 gapi.load('client', async () => {
     /** now we can use gapi.client */
@@ -148,6 +148,9 @@ gapi.load('client', async () => {
                         duration: "Test string",
                         evaluationMissingData: "Test string",
                         filter: "Test string",
+                        forecastOptions: {
+                            forecastHorizon: "Test string",
+                        },
                         thresholdValue: 42,
                         trigger: {
                             count: 42,
@@ -285,6 +288,9 @@ gapi.load('client', async () => {
                         duration: "Test string",
                         evaluationMissingData: "Test string",
                         filter: "Test string",
+                        forecastOptions: {
+                            forecastHorizon: "Test string",
+                        },
                         thresholdValue: 42,
                         trigger: {
                             count: 42,
@@ -674,6 +680,50 @@ gapi.load('client', async () => {
         }, {
             code: "Test string",
         });
+        /** Creates a Snooze that will prevent alerts, which match the provided criteria, from being opened. The Snooze applies for a specific time interval. */
+        await gapi.client.monitoring.projects.snoozes.create({
+            parent: "Test string",
+        }, {
+            criteria: {
+                policies: [
+                    "Test string"
+                ],
+            },
+            displayName: "Test string",
+            interval: {
+                endTime: "Test string",
+                startTime: "Test string",
+            },
+            name: "Test string",
+        });
+        /** Retrieves a Snooze by name. */
+        await gapi.client.monitoring.projects.snoozes.get({
+            name: "Test string",
+        });
+        /** Lists the Snoozes associated with a project. Can optionally pass in filter, which specifies predicates to match Snoozes. */
+        await gapi.client.monitoring.projects.snoozes.list({
+            filter: "Test string",
+            pageSize: 42,
+            pageToken: "Test string",
+            parent: "Test string",
+        });
+        /** Updates a Snooze, identified by its name, with the parameters in the given Snooze object. */
+        await gapi.client.monitoring.projects.snoozes.patch({
+            name: "Test string",
+            updateMask: "Test string",
+        }, {
+            criteria: {
+                policies: [
+                    "Test string"
+                ],
+            },
+            displayName: "Test string",
+            interval: {
+                endTime: "Test string",
+                startTime: "Test string",
+            },
+            name: "Test string",
+        });
         /**
          * 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 failure
          * message is included in the error response.