@maxim_mazurok/gapi.client.monitoring-v3 0.0.20240929 → 0.0.20241003

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +18 -16
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://monitoring.googleapis.com/$discovery/rest?version=v3
12
- // Revision: 20240929
12
+ // Revision: 20241003
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -35,7 +35,7 @@ declare namespace gapi.client {
35
35
  perSeriesAligner?: string;
36
36
  }
37
37
  interface AlertPolicy {
38
- /** Control over how this alert policy's notification channels are notified. */
38
+ /** Control over how this alerting policy's notification channels are notified. */
39
39
  alertStrategy?: AlertStrategy;
40
40
  /** 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. */
41
41
  combiner?: string;
@@ -55,19 +55,21 @@ declare namespace gapi.client {
55
55
  name?: string;
56
56
  /** 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 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 in this field is: projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID] */
57
57
  notificationChannels?: string[];
58
- /** Optional. The severity of an alert policy indicates how important incidents generated by that policy are. The severity level will be displayed on the Incident detail page and in notifications. */
58
+ /** Optional. The severity of an alerting policy indicates how important incidents generated by that policy are. The severity level will be displayed on the Incident detail page and in notifications. */
59
59
  severity?: string;
60
60
  /** 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 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.Note that Prometheus {alert name} is a valid Prometheus label names (https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels), whereas Prometheus {rule group} is an unrestricted UTF-8 string. This means that they cannot be stored as-is in user labels, because they may contain characters that are not allowed in user-label values. */
61
61
  userLabels?: {[P in string]: string};
62
- /** Read-only description of how the alert policy is invalid. This field is only set when the alert policy is invalid. An invalid alert policy will not generate incidents. */
62
+ /** Read-only description of how the alerting policy is invalid. This field is only set when the alerting policy is invalid. An invalid alerting policy will not generate incidents. */
63
63
  validity?: Status;
64
64
  }
65
65
  interface AlertStrategy {
66
- /** If an alert policy that was active has no data for this long, any open incidents will close */
66
+ /** If an alerting policy that was active has no data for this long, any open incidents will close */
67
67
  autoClose?: string;
68
68
  /** Control how notifications will be sent out, on a per-channel basis. */
69
69
  notificationChannelStrategy?: NotificationChannelStrategy[];
70
- /** Required for log-based alert policies, i.e. policies with a LogMatch condition.This limit is not implemented for alert policies that do not have a LogMatch condition. */
70
+ /** For log-based alert policies, the notification prompts is always OPENED. For non log-based alert policies, the notification prompts can be OPENED or OPENED, CLOSED. */
71
+ notificationPrompts?: string[];
72
+ /** Required for log-based alerting policies, i.e. policies with a LogMatch condition.This limit is not implemented for alerting policies that do not have a LogMatch condition. */
71
73
  notificationRateLimit?: NotificationRateLimit;
72
74
  }
73
75
  interface AppEngine {
@@ -186,7 +188,7 @@ declare namespace gapi.client {
186
188
  conditionMonitoringQueryLanguage?: MonitoringQueryLanguageCondition;
187
189
  /** A condition that uses the Prometheus query language to define alerts. */
188
190
  conditionPrometheusQueryLanguage?: PrometheusQueryLanguageCondition;
189
- /** A condition that uses SQL to define alerts in Logs Analytics. */
191
+ /** A condition that periodically evaluates a SQL query result. */
190
192
  conditionSql?: SqlCondition;
191
193
  /** A condition that compares a time series against a threshold. */
192
194
  conditionThreshold?: MetricThreshold;
@@ -237,7 +239,7 @@ declare namespace gapi.client {
237
239
  interface Daily {
238
240
  /** Optional. The time of day (in UTC) at which the query should run. If left unspecified, the server picks an arbitrary time of day and runs the query at the same time each day. */
239
241
  executionTime?: TimeOfDay;
240
- /** Required. LINT.IfChange The number of days between runs. Must be greater than or equal to 1 day and less than or equal to 31 days. LINT.ThenChange(//depot/google3/cloud/monitoring/api/alerts/policy_validation.cc) */
242
+ /** Required. The number of days between runs. Must be greater than or equal to 1 day and less than or equal to 31 days. */
241
243
  periodicity?: number;
242
244
  }
243
245
  interface Distribution {
@@ -394,9 +396,9 @@ declare namespace gapi.client {
394
396
  parentName?: string;
395
397
  }
396
398
  interface Hourly {
397
- /** Optional. LINT.IfChange The number of minutes after the hour (in UTC) to run the query. Must be between 0 and 59 inclusive. If left unspecified, then an arbitrary offset is used. LINT.ThenChange(//depot/google3/cloud/monitoring/api/alerts/policy_validation.cc) */
399
+ /** Optional. The number of minutes after the hour (in UTC) to run the query. Must be greater than or equal to 0 minutes and less than or equal to 59 minutes. If left unspecified, then an arbitrary offset is used. */
398
400
  minuteOffset?: number;
399
- /** Required. LINT.IfChange The number of hours between runs. Must be greater than or equal to 1 hour and less than or equal to 48 hours. LINT.ThenChange(//depot/google3/cloud/monitoring/api/alerts/policy_validation.cc) */
401
+ /** Required. The number of hours between runs. Must be greater than or equal to 1 hour and less than or equal to 48 hours. */
400
402
  periodicity?: number;
401
403
  }
402
404
  interface HttpCheck {
@@ -674,7 +676,7 @@ declare namespace gapi.client {
674
676
  trigger?: Trigger;
675
677
  }
676
678
  interface Minutes {
677
- /** Required. LINT.IfChange Number of minutes between runs. The interval must be between 5 minutes and 1440 minutes. LINT.ThenChange(//depot/google3/cloud/monitoring/api/alerts/policy_validation.cc) */
679
+ /** Required. Number of minutes between runs. The interval must be greater than or equal to 5 minutes and less than or equal to 1440 minutes. */
678
680
  periodicity?: number;
679
681
  }
680
682
  interface MonitoredResource {
@@ -955,7 +957,7 @@ declare namespace gapi.client {
955
957
  hourly?: Hourly;
956
958
  /** Schedule the query to execute every so many minutes. */
957
959
  minutes?: Minutes;
958
- /** Required. The Log Analytics SQL query to run, as a string. The query must conform to the required shape. Specifically, the query must not try to filter the input by time. A filter will automatically be applied to filter the input so that the query receives all rows received since the last time the query was run.E.g. Extract all log entries containing an HTTP request:SELECT timestamp, log_name, severity, http_request, resource, labels FROM my-project.global._Default._AllLogs WHERE http_request IS NOT NULL */
960
+ /** Required. The Log Analytics SQL query to run, as a string. The query must conform to the required shape. Specifically, the query must not try to filter the input by time. A filter will automatically be applied to filter the input so that the query receives all rows received since the last time the query was run.For example, the following query extracts all log entries containing an HTTP request:SELECT timestamp, log_name, severity, http_request, resource, labels FROM my-project.global._Default._AllLogs WHERE http_request IS NOT NULL */
959
961
  query?: string;
960
962
  /** Test the row count against a threshold. */
961
963
  rowCountTest?: RowCountTest;
@@ -989,13 +991,13 @@ declare namespace gapi.client {
989
991
  startTime?: string;
990
992
  }
991
993
  interface TimeOfDay {
992
- /** Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */
994
+ /** Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. */
993
995
  hours?: number;
994
- /** Minutes of hour of day. Must be from 0 to 59. */
996
+ /** Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. */
995
997
  minutes?: number;
996
- /** Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. */
998
+ /** Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. */
997
999
  nanos?: number;
998
- /** Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. */
1000
+ /** Seconds of a minute. Must be greater than or equal to 0 and typically must be less than or equal to 59. An API may allow the value 60 if it allows leap-seconds. */
999
1001
  seconds?: number;
1000
1002
  }
1001
1003
  interface TimeSeries {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.monitoring-v3",
3
- "version": "0.0.20240929",
3
+ "version": "0.0.20241003",
4
4
  "description": "TypeScript typings for Cloud Monitoring API v3",
5
5
  "repository": {
6
6
  "type": "git",