@maxim_mazurok/gapi.client.monitoring-v3 0.0.20240916 → 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 +60 -6
  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: 20240916
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 {
@@ -99,6 +101,10 @@ declare namespace gapi.client {
99
101
  /** 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 applies to all API versions. For service types that don't support breaking down by version, setting this field will result in an error. */
100
102
  version?: string[];
101
103
  }
104
+ interface BooleanTest {
105
+ /** Required. The name of the column containing the boolean value. If the value in a row is NULL, that row is ignored. */
106
+ column?: string;
107
+ }
102
108
  interface BucketOptions {
103
109
  /** The explicit buckets. */
104
110
  explicitBuckets?: Explicit;
@@ -182,6 +188,8 @@ declare namespace gapi.client {
182
188
  conditionMonitoringQueryLanguage?: MonitoringQueryLanguageCondition;
183
189
  /** A condition that uses the Prometheus query language to define alerts. */
184
190
  conditionPrometheusQueryLanguage?: PrometheusQueryLanguageCondition;
191
+ /** A condition that periodically evaluates a SQL query result. */
192
+ conditionSql?: SqlCondition;
185
193
  /** A condition that compares a time series against a threshold. */
186
194
  conditionThreshold?: MetricThreshold;
187
195
  /** 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 same policy. */
@@ -228,6 +236,12 @@ declare namespace gapi.client {
228
236
  policies?: string[];
229
237
  }
230
238
  interface Custom {}
239
+ interface Daily {
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. */
241
+ executionTime?: TimeOfDay;
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. */
243
+ periodicity?: number;
244
+ }
231
245
  interface Distribution {
232
246
  /** 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 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 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 are assigned values of zero. */
233
247
  bucketCounts?: string[];
@@ -381,6 +395,12 @@ declare namespace gapi.client {
381
395
  /** 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, "". */
382
396
  parentName?: string;
383
397
  }
398
+ interface Hourly {
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. */
400
+ minuteOffset?: number;
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. */
402
+ periodicity?: number;
403
+ }
384
404
  interface HttpCheck {
385
405
  /** 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 200-299. */
386
406
  acceptedResponseStatusCodes?: ResponseStatusCode[];
@@ -655,6 +675,10 @@ declare namespace gapi.client {
655
675
  /** 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 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. */
656
676
  trigger?: Trigger;
657
677
  }
678
+ interface Minutes {
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. */
680
+ periodicity?: number;
681
+ }
658
682
  interface MonitoredResource {
659
683
  /** 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", and "zone". */
660
684
  labels?: {[P in string]: string};
@@ -839,6 +863,12 @@ declare namespace gapi.client {
839
863
  /** A status code to accept. */
840
864
  statusValue?: number;
841
865
  }
866
+ interface RowCountTest {
867
+ /** Required. The comparison to apply between the number of rows returned by the query and the threshold. */
868
+ comparison?: string;
869
+ /** Required. The value against which to compare the row count. */
870
+ threshold?: string;
871
+ }
842
872
  interface SendNotificationChannelVerificationCodeRequest {}
843
873
  interface Service {
844
874
  /** Type used for App Engine services. */
@@ -918,6 +948,20 @@ declare namespace gapi.client {
918
948
  /** 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 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. */
919
949
  spanName?: string;
920
950
  }
951
+ interface SqlCondition {
952
+ /** Test the boolean value in the indicated column. */
953
+ booleanTest?: BooleanTest;
954
+ /** Schedule the query to execute every so many days. */
955
+ daily?: Daily;
956
+ /** Schedule the query to execute every so many hours. */
957
+ hourly?: Hourly;
958
+ /** Schedule the query to execute every so many minutes. */
959
+ minutes?: Minutes;
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 */
961
+ query?: string;
962
+ /** Test the row count against a threshold. */
963
+ rowCountTest?: RowCountTest;
964
+ }
921
965
  interface Status {
922
966
  /** The status code, which should be an enum value of google.rpc.Code. */
923
967
  code?: number;
@@ -946,6 +990,16 @@ declare namespace gapi.client {
946
990
  /** 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. */
947
991
  startTime?: string;
948
992
  }
993
+ interface TimeOfDay {
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. */
995
+ hours?: number;
996
+ /** Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. */
997
+ minutes?: number;
998
+ /** Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. */
999
+ nanos?: number;
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. */
1001
+ seconds?: number;
1002
+ }
949
1003
  interface TimeSeries {
950
1004
  /** Input only. A detailed description of the time series that will be associated with the google.api.MetricDescriptor for the metric. Once set, this field cannot be changed through CreateTimeSeries. */
951
1005
  description?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.monitoring-v3",
3
- "version": "0.0.20240916",
3
+ "version": "0.0.20241003",
4
4
  "description": "TypeScript typings for Cloud Monitoring API v3",
5
5
  "repository": {
6
6
  "type": "git",