@hyperlane-xyz/cli 16.2.0 → 18.0.0

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 (190) hide show
  1. package/cli-bundle/index.js +39174 -1835
  2. package/examples/submit/transactions/{alfajores-transactions.json → sepolia-transactions.json} +1 -1
  3. package/package.json +5 -5
  4. package/cli-bundle/798.index.js +0 -169715
  5. package/cli-bundle/proto/channelz.proto +0 -564
  6. package/cli-bundle/protos/compute_operations.d.ts +0 -7304
  7. package/cli-bundle/protos/compute_operations.js +0 -1
  8. package/cli-bundle/protos/compute_operations.json +0 -1
  9. package/cli-bundle/protos/google/api/annotations.proto +0 -31
  10. package/cli-bundle/protos/google/api/apikeys/v2/apikeys.proto +0 -288
  11. package/cli-bundle/protos/google/api/apikeys/v2/resources.proto +0 -175
  12. package/cli-bundle/protos/google/api/auth.proto +0 -237
  13. package/cli-bundle/protos/google/api/backend.proto +0 -185
  14. package/cli-bundle/protos/google/api/billing.proto +0 -77
  15. package/cli-bundle/protos/google/api/client.proto +0 -427
  16. package/cli-bundle/protos/google/api/cloudquotas/v1/cloudquotas.proto +0 -322
  17. package/cli-bundle/protos/google/api/cloudquotas/v1/resources.proto +0 -311
  18. package/cli-bundle/protos/google/api/config_change.proto +0 -84
  19. package/cli-bundle/protos/google/api/consumer.proto +0 -82
  20. package/cli-bundle/protos/google/api/context.proto +0 -90
  21. package/cli-bundle/protos/google/api/control.proto +0 -41
  22. package/cli-bundle/protos/google/api/distribution.proto +0 -213
  23. package/cli-bundle/protos/google/api/documentation.proto +0 -168
  24. package/cli-bundle/protos/google/api/endpoint.proto +0 -73
  25. package/cli-bundle/protos/google/api/error_reason.proto +0 -589
  26. package/cli-bundle/protos/google/api/expr/conformance/v1alpha1/conformance_service.proto +0 -183
  27. package/cli-bundle/protos/google/api/expr/v1alpha1/checked.proto +0 -343
  28. package/cli-bundle/protos/google/api/expr/v1alpha1/eval.proto +0 -118
  29. package/cli-bundle/protos/google/api/expr/v1alpha1/explain.proto +0 -53
  30. package/cli-bundle/protos/google/api/expr/v1alpha1/syntax.proto +0 -400
  31. package/cli-bundle/protos/google/api/expr/v1alpha1/value.proto +0 -115
  32. package/cli-bundle/protos/google/api/expr/v1beta1/decl.proto +0 -84
  33. package/cli-bundle/protos/google/api/expr/v1beta1/eval.proto +0 -125
  34. package/cli-bundle/protos/google/api/expr/v1beta1/expr.proto +0 -265
  35. package/cli-bundle/protos/google/api/expr/v1beta1/source.proto +0 -62
  36. package/cli-bundle/protos/google/api/expr/v1beta1/value.proto +0 -114
  37. package/cli-bundle/protos/google/api/field_behavior.proto +0 -104
  38. package/cli-bundle/protos/google/api/field_info.proto +0 -79
  39. package/cli-bundle/protos/google/api/http.proto +0 -379
  40. package/cli-bundle/protos/google/api/httpbody.proto +0 -81
  41. package/cli-bundle/protos/google/api/label.proto +0 -48
  42. package/cli-bundle/protos/google/api/launch_stage.proto +0 -72
  43. package/cli-bundle/protos/google/api/log.proto +0 -54
  44. package/cli-bundle/protos/google/api/logging.proto +0 -81
  45. package/cli-bundle/protos/google/api/metric.proto +0 -268
  46. package/cli-bundle/protos/google/api/monitored_resource.proto +0 -130
  47. package/cli-bundle/protos/google/api/monitoring.proto +0 -107
  48. package/cli-bundle/protos/google/api/policy.proto +0 -85
  49. package/cli-bundle/protos/google/api/quota.proto +0 -184
  50. package/cli-bundle/protos/google/api/resource.proto +0 -238
  51. package/cli-bundle/protos/google/api/routing.proto +0 -461
  52. package/cli-bundle/protos/google/api/service.proto +0 -191
  53. package/cli-bundle/protos/google/api/servicecontrol/v1/check_error.proto +0 -124
  54. package/cli-bundle/protos/google/api/servicecontrol/v1/distribution.proto +0 -166
  55. package/cli-bundle/protos/google/api/servicecontrol/v1/http_request.proto +0 -93
  56. package/cli-bundle/protos/google/api/servicecontrol/v1/log_entry.proto +0 -126
  57. package/cli-bundle/protos/google/api/servicecontrol/v1/metric_value.proto +0 -81
  58. package/cli-bundle/protos/google/api/servicecontrol/v1/operation.proto +0 -123
  59. package/cli-bundle/protos/google/api/servicecontrol/v1/quota_controller.proto +0 -245
  60. package/cli-bundle/protos/google/api/servicecontrol/v1/service_controller.proto +0 -260
  61. package/cli-bundle/protos/google/api/servicecontrol/v2/service_controller.proto +0 -196
  62. package/cli-bundle/protos/google/api/servicemanagement/v1/resources.proto +0 -295
  63. package/cli-bundle/protos/google/api/servicemanagement/v1/servicemanager.proto +0 -508
  64. package/cli-bundle/protos/google/api/serviceusage/v1/resources.proto +0 -130
  65. package/cli-bundle/protos/google/api/serviceusage/v1/serviceusage.proto +0 -305
  66. package/cli-bundle/protos/google/api/serviceusage/v1beta1/resources.proto +0 -458
  67. package/cli-bundle/protos/google/api/serviceusage/v1beta1/serviceusage.proto +0 -793
  68. package/cli-bundle/protos/google/api/source_info.proto +0 -31
  69. package/cli-bundle/protos/google/api/system_parameter.proto +0 -96
  70. package/cli-bundle/protos/google/api/usage.proto +0 -96
  71. package/cli-bundle/protos/google/api/visibility.proto +0 -113
  72. package/cli-bundle/protos/google/cloud/location/locations.proto +0 -108
  73. package/cli-bundle/protos/google/iam/v1/iam_policy.proto +0 -155
  74. package/cli-bundle/protos/google/iam/v1/logging/audit_data.proto +0 -33
  75. package/cli-bundle/protos/google/iam/v1/options.proto +0 -48
  76. package/cli-bundle/protos/google/iam/v1/policy.proto +0 -410
  77. package/cli-bundle/protos/google/logging/type/http_request.proto +0 -95
  78. package/cli-bundle/protos/google/logging/type/log_severity.proto +0 -71
  79. package/cli-bundle/protos/google/longrunning/operations.proto +0 -247
  80. package/cli-bundle/protos/google/monitoring/v3/alert.proto +0 -669
  81. package/cli-bundle/protos/google/monitoring/v3/alert_service.proto +0 -256
  82. package/cli-bundle/protos/google/monitoring/v3/common.proto +0 -488
  83. package/cli-bundle/protos/google/monitoring/v3/dropped_labels.proto +0 -46
  84. package/cli-bundle/protos/google/monitoring/v3/group.proto +0 -90
  85. package/cli-bundle/protos/google/monitoring/v3/group_service.proto +0 -290
  86. package/cli-bundle/protos/google/monitoring/v3/metric.proto +0 -239
  87. package/cli-bundle/protos/google/monitoring/v3/metric_service.proto +0 -522
  88. package/cli-bundle/protos/google/monitoring/v3/mutation_record.proto +0 -36
  89. package/cli-bundle/protos/google/monitoring/v3/notification.proto +0 -195
  90. package/cli-bundle/protos/google/monitoring/v3/notification_service.proto +0 -448
  91. package/cli-bundle/protos/google/monitoring/v3/query_service.proto +0 -48
  92. package/cli-bundle/protos/google/monitoring/v3/service.proto +0 -457
  93. package/cli-bundle/protos/google/monitoring/v3/service_service.proto +0 -352
  94. package/cli-bundle/protos/google/monitoring/v3/snooze.proto +0 -78
  95. package/cli-bundle/protos/google/monitoring/v3/snooze_service.proto +0 -210
  96. package/cli-bundle/protos/google/monitoring/v3/span_context.proto +0 -45
  97. package/cli-bundle/protos/google/monitoring/v3/uptime.proto +0 -564
  98. package/cli-bundle/protos/google/monitoring/v3/uptime_service.proto +0 -259
  99. package/cli-bundle/protos/google/protobuf/any.proto +0 -162
  100. package/cli-bundle/protos/google/protobuf/api.proto +0 -207
  101. package/cli-bundle/protos/google/protobuf/bridge/message_set.proto +0 -76
  102. package/cli-bundle/protos/google/protobuf/compiler/plugin.proto +0 -180
  103. package/cli-bundle/protos/google/protobuf/compiler/ruby/ruby_generated_code.proto +0 -77
  104. package/cli-bundle/protos/google/protobuf/compiler/ruby/ruby_generated_code_proto2.proto +0 -78
  105. package/cli-bundle/protos/google/protobuf/compiler/ruby/ruby_generated_code_proto2_import.proto +0 -12
  106. package/cli-bundle/protos/google/protobuf/compiler/ruby/ruby_generated_pkg_explicit.proto +0 -16
  107. package/cli-bundle/protos/google/protobuf/compiler/ruby/ruby_generated_pkg_explicit_legacy.proto +0 -16
  108. package/cli-bundle/protos/google/protobuf/compiler/ruby/ruby_generated_pkg_implicit.proto +0 -14
  109. package/cli-bundle/protos/google/protobuf/cpp_features.proto +0 -45
  110. package/cli-bundle/protos/google/protobuf/descriptor.proto +0 -1225
  111. package/cli-bundle/protos/google/protobuf/duration.proto +0 -115
  112. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto2_enum.proto +0 -26
  113. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto2_group.proto +0 -18
  114. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto2_import.proto +0 -16
  115. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto2_inline_comments.proto +0 -33
  116. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto2_multiline_comments.proto +0 -33
  117. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto2_optional.proto +0 -65
  118. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto2_packed.proto +0 -14
  119. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto2_proto3_enum.proto +0 -18
  120. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto2_required.proto +0 -47
  121. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto2_unpacked.proto +0 -19
  122. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto2_utf8_disabled.proto +0 -16
  123. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto2_utf8_lite.proto +0 -17
  124. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto2_utf8_verify.proto +0 -14
  125. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto3_enum.proto +0 -26
  126. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto3_implicit.proto +0 -65
  127. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto3_import.proto +0 -16
  128. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto3_optional.proto +0 -47
  129. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto3_packed.proto +0 -20
  130. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto3_unpacked.proto +0 -19
  131. package/cli-bundle/protos/google/protobuf/editions/codegen_tests/proto3_utf8_strict.proto +0 -15
  132. package/cli-bundle/protos/google/protobuf/editions/golden/editions_transform_proto2.proto +0 -129
  133. package/cli-bundle/protos/google/protobuf/editions/golden/editions_transform_proto2_lite.proto +0 -19
  134. package/cli-bundle/protos/google/protobuf/editions/golden/editions_transform_proto2_utf8_disabled.proto +0 -18
  135. package/cli-bundle/protos/google/protobuf/editions/golden/editions_transform_proto3.proto +0 -32
  136. package/cli-bundle/protos/google/protobuf/editions/golden/editions_transform_proto3_utf8_disabled.proto +0 -18
  137. package/cli-bundle/protos/google/protobuf/editions/golden/simple_proto2.proto +0 -14
  138. package/cli-bundle/protos/google/protobuf/editions/golden/simple_proto2_import.proto +0 -16
  139. package/cli-bundle/protos/google/protobuf/editions/golden/simple_proto3.proto +0 -14
  140. package/cli-bundle/protos/google/protobuf/editions/proto/editions_transform_proto2.proto +0 -91
  141. package/cli-bundle/protos/google/protobuf/editions/proto/editions_transform_proto2_lite.proto +0 -20
  142. package/cli-bundle/protos/google/protobuf/editions/proto/editions_transform_proto2_utf8_disabled.proto +0 -19
  143. package/cli-bundle/protos/google/protobuf/editions/proto/editions_transform_proto3.proto +0 -25
  144. package/cli-bundle/protos/google/protobuf/editions/proto/editions_transform_proto3_utf8_disabled.proto +0 -19
  145. package/cli-bundle/protos/google/protobuf/empty.proto +0 -51
  146. package/cli-bundle/protos/google/protobuf/field_mask.proto +0 -245
  147. package/cli-bundle/protos/google/protobuf/sample_messages_edition.proto +0 -427
  148. package/cli-bundle/protos/google/protobuf/source_context.proto +0 -48
  149. package/cli-bundle/protos/google/protobuf/struct.proto +0 -95
  150. package/cli-bundle/protos/google/protobuf/timestamp.proto +0 -144
  151. package/cli-bundle/protos/google/protobuf/type.proto +0 -193
  152. package/cli-bundle/protos/google/protobuf/util/json_format.proto +0 -116
  153. package/cli-bundle/protos/google/protobuf/util/json_format_proto3.proto +0 -301
  154. package/cli-bundle/protos/google/protobuf/wrappers.proto +0 -123
  155. package/cli-bundle/protos/google/rpc/code.proto +0 -186
  156. package/cli-bundle/protos/google/rpc/context/attribute_context.proto +0 -344
  157. package/cli-bundle/protos/google/rpc/context/audit_context.proto +0 -49
  158. package/cli-bundle/protos/google/rpc/error_details.proto +0 -285
  159. package/cli-bundle/protos/google/rpc/http.proto +0 -64
  160. package/cli-bundle/protos/google/rpc/status.proto +0 -49
  161. package/cli-bundle/protos/google/type/calendar_period.proto +0 -56
  162. package/cli-bundle/protos/google/type/color.proto +0 -174
  163. package/cli-bundle/protos/google/type/date.proto +0 -52
  164. package/cli-bundle/protos/google/type/datetime.proto +0 -104
  165. package/cli-bundle/protos/google/type/dayofweek.proto +0 -50
  166. package/cli-bundle/protos/google/type/decimal.proto +0 -95
  167. package/cli-bundle/protos/google/type/expr.proto +0 -73
  168. package/cli-bundle/protos/google/type/fraction.proto +0 -33
  169. package/cli-bundle/protos/google/type/interval.proto +0 -46
  170. package/cli-bundle/protos/google/type/latlng.proto +0 -37
  171. package/cli-bundle/protos/google/type/localized_text.proto +0 -36
  172. package/cli-bundle/protos/google/type/money.proto +0 -42
  173. package/cli-bundle/protos/google/type/month.proto +0 -65
  174. package/cli-bundle/protos/google/type/phone_number.proto +0 -113
  175. package/cli-bundle/protos/google/type/postal_address.proto +0 -134
  176. package/cli-bundle/protos/google/type/quaternion.proto +0 -94
  177. package/cli-bundle/protos/google/type/timeofday.proto +0 -44
  178. package/cli-bundle/protos/http.d.ts +0 -347
  179. package/cli-bundle/protos/http.js +0 -1
  180. package/cli-bundle/protos/iam_service.d.ts +0 -5035
  181. package/cli-bundle/protos/iam_service.js +0 -1
  182. package/cli-bundle/protos/iam_service.json +0 -1
  183. package/cli-bundle/protos/locations.d.ts +0 -4060
  184. package/cli-bundle/protos/locations.js +0 -1
  185. package/cli-bundle/protos/locations.json +0 -1
  186. package/cli-bundle/protos/operations.d.ts +0 -4783
  187. package/cli-bundle/protos/operations.js +0 -1
  188. package/cli-bundle/protos/operations.json +0 -1
  189. package/cli-bundle/protos/status.json +0 -1
  190. package/cli-bundle/worker2.js +0 -174
@@ -1,669 +0,0 @@
1
- // Copyright 2023 Google LLC
2
- //
3
- // Licensed under the Apache License, Version 2.0 (the "License");
4
- // you may not use this file except in compliance with the License.
5
- // You may obtain a copy of the License at
6
- //
7
- // http://www.apache.org/licenses/LICENSE-2.0
8
- //
9
- // Unless required by applicable law or agreed to in writing, software
10
- // distributed under the License is distributed on an "AS IS" BASIS,
11
- // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
- // See the License for the specific language governing permissions and
13
- // limitations under the License.
14
-
15
- syntax = "proto3";
16
-
17
- package google.monitoring.v3;
18
-
19
- import "google/api/field_behavior.proto";
20
- import "google/api/resource.proto";
21
- import "google/monitoring/v3/common.proto";
22
- import "google/monitoring/v3/mutation_record.proto";
23
- import "google/protobuf/duration.proto";
24
- import "google/protobuf/wrappers.proto";
25
- import "google/rpc/status.proto";
26
-
27
- option csharp_namespace = "Google.Cloud.Monitoring.V3";
28
- option go_package = "cloud.google.com/go/monitoring/apiv3/v2/monitoringpb;monitoringpb";
29
- option java_multiple_files = true;
30
- option java_outer_classname = "AlertProto";
31
- option java_package = "com.google.monitoring.v3";
32
- option php_namespace = "Google\\Cloud\\Monitoring\\V3";
33
- option ruby_package = "Google::Cloud::Monitoring::V3";
34
-
35
- // A description of the conditions under which some aspect of your system is
36
- // considered to be "unhealthy" and the ways to notify people or services about
37
- // this state. For an overview of alert policies, see
38
- // [Introduction to Alerting](https://cloud.google.com/monitoring/alerts/).
39
- //
40
- message AlertPolicy {
41
- option (google.api.resource) = {
42
- type: "monitoring.googleapis.com/AlertPolicy"
43
- pattern: "projects/{project}/alertPolicies/{alert_policy}"
44
- pattern: "organizations/{organization}/alertPolicies/{alert_policy}"
45
- pattern: "folders/{folder}/alertPolicies/{alert_policy}"
46
- pattern: "*"
47
- };
48
-
49
- // A content string and a MIME type that describes the content string's
50
- // format.
51
- message Documentation {
52
- // The body of the documentation, interpreted according to `mime_type`.
53
- // The content may not exceed 8,192 Unicode characters and may not exceed
54
- // more than 10,240 bytes when encoded in UTF-8 format, whichever is
55
- // smaller. This text can be [templatized by using
56
- // variables](https://cloud.google.com/monitoring/alerts/doc-variables).
57
- string content = 1;
58
-
59
- // The format of the `content` field. Presently, only the value
60
- // `"text/markdown"` is supported. See
61
- // [Markdown](https://en.wikipedia.org/wiki/Markdown) for more information.
62
- string mime_type = 2;
63
-
64
- // Optional. The subject line of the notification. The subject line may not
65
- // exceed 10,240 bytes. In notifications generated by this policy, the
66
- // contents of the subject line after variable expansion will be truncated
67
- // to 255 bytes or shorter at the latest UTF-8 character boundary. The
68
- // 255-byte limit is recommended by [this
69
- // thread](https://stackoverflow.com/questions/1592291/what-is-the-email-subject-length-limit).
70
- // It is both the limit imposed by some third-party ticketing products and
71
- // it is common to define textual fields in databases as VARCHAR(255).
72
- //
73
- // The contents of the subject line can be [templatized by using
74
- // variables](https://cloud.google.com/monitoring/alerts/doc-variables).
75
- // If this field is missing or empty, a default subject line will be
76
- // generated.
77
- string subject = 3 [(google.api.field_behavior) = OPTIONAL];
78
- }
79
-
80
- // A condition is a true/false test that determines when an alerting policy
81
- // should open an incident. If a condition evaluates to true, it signifies
82
- // that something is wrong.
83
- message Condition {
84
- option (google.api.resource) = {
85
- type: "monitoring.googleapis.com/AlertPolicyCondition"
86
- pattern: "projects/{project}/alertPolicies/{alert_policy}/conditions/{condition}"
87
- pattern: "organizations/{organization}/alertPolicies/{alert_policy}/conditions/{condition}"
88
- pattern: "folders/{folder}/alertPolicies/{alert_policy}/conditions/{condition}"
89
- pattern: "*"
90
- };
91
-
92
- // Specifies how many time series must fail a predicate to trigger a
93
- // condition. If not specified, then a `{count: 1}` trigger is used.
94
- message Trigger {
95
- // A type of trigger.
96
- oneof type {
97
- // The absolute number of time series that must fail
98
- // the predicate for the condition to be triggered.
99
- int32 count = 1;
100
-
101
- // The percentage of time series that must fail the
102
- // predicate for the condition to be triggered.
103
- double percent = 2;
104
- }
105
- }
106
-
107
- // A condition control that determines how metric-threshold conditions
108
- // are evaluated when data stops arriving.
109
- // This control doesn't affect metric-absence policies.
110
- enum EvaluationMissingData {
111
- // An unspecified evaluation missing data option. Equivalent to
112
- // EVALUATION_MISSING_DATA_NO_OP.
113
- EVALUATION_MISSING_DATA_UNSPECIFIED = 0;
114
-
115
- // If there is no data to evaluate the condition, then evaluate the
116
- // condition as false.
117
- EVALUATION_MISSING_DATA_INACTIVE = 1;
118
-
119
- // If there is no data to evaluate the condition, then evaluate the
120
- // condition as true.
121
- EVALUATION_MISSING_DATA_ACTIVE = 2;
122
-
123
- // Do not evaluate the condition to any value if there is no data.
124
- EVALUATION_MISSING_DATA_NO_OP = 3;
125
- }
126
-
127
- // A condition type that compares a collection of time series
128
- // against a threshold.
129
- message MetricThreshold {
130
- // Options used when forecasting the time series and testing
131
- // the predicted value against the threshold.
132
- message ForecastOptions {
133
- // Required. The length of time into the future to forecast whether a
134
- // time series will violate the threshold. If the predicted value is
135
- // found to violate the threshold, and the violation is observed in all
136
- // forecasts made for the configured `duration`, then the time series is
137
- // considered to be failing.
138
- // The forecast horizon can range from 1 hour to 60 hours.
139
- google.protobuf.Duration forecast_horizon = 1
140
- [(google.api.field_behavior) = REQUIRED];
141
- }
142
-
143
- // Required. A
144
- // [filter](https://cloud.google.com/monitoring/api/v3/filters) that
145
- // identifies which time series should be compared with the threshold.
146
- //
147
- // The filter is similar to the one that is specified in the
148
- // [`ListTimeSeries`
149
- // request](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list)
150
- // (that call is useful to verify the time series that will be retrieved /
151
- // processed). The filter must specify the metric type and the resource
152
- // type. Optionally, it can specify resource labels and metric labels.
153
- // This field must not exceed 2048 Unicode characters in length.
154
- string filter = 2 [(google.api.field_behavior) = REQUIRED];
155
-
156
- // Specifies the alignment of data points in individual time series as
157
- // well as how to combine the retrieved time series together (such as
158
- // when aggregating multiple streams on each resource to a single
159
- // stream for each resource or when aggregating streams across all
160
- // members of a group of resources). Multiple aggregations
161
- // are applied in the order specified.
162
- //
163
- // This field is similar to the one in the [`ListTimeSeries`
164
- // request](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).
165
- // It is advisable to use the `ListTimeSeries` method when debugging this
166
- // field.
167
- repeated Aggregation aggregations = 8;
168
-
169
- // A [filter](https://cloud.google.com/monitoring/api/v3/filters) that
170
- // identifies a time series that should be used as the denominator of a
171
- // ratio that will be compared with the threshold. If a
172
- // `denominator_filter` is specified, the time series specified by the
173
- // `filter` field will be used as the numerator.
174
- //
175
- // The filter must specify the metric type and optionally may contain
176
- // restrictions on resource type, resource labels, and metric labels.
177
- // This field may not exceed 2048 Unicode characters in length.
178
- string denominator_filter = 9;
179
-
180
- // Specifies the alignment of data points in individual time series
181
- // selected by `denominatorFilter` as
182
- // well as how to combine the retrieved time series together (such as
183
- // when aggregating multiple streams on each resource to a single
184
- // stream for each resource or when aggregating streams across all
185
- // members of a group of resources).
186
- //
187
- // When computing ratios, the `aggregations` and
188
- // `denominator_aggregations` fields must use the same alignment period
189
- // and produce time series that have the same periodicity and labels.
190
- repeated Aggregation denominator_aggregations = 10;
191
-
192
- // When this field is present, the `MetricThreshold` condition forecasts
193
- // whether the time series is predicted to violate the threshold within
194
- // the `forecast_horizon`. When this field is not set, the
195
- // `MetricThreshold` tests the current value of the timeseries against the
196
- // threshold.
197
- ForecastOptions forecast_options = 12;
198
-
199
- // The comparison to apply between the time series (indicated by `filter`
200
- // and `aggregation`) and the threshold (indicated by `threshold_value`).
201
- // The comparison is applied on each time series, with the time series
202
- // on the left-hand side and the threshold on the right-hand side.
203
- //
204
- // Only `COMPARISON_LT` and `COMPARISON_GT` are supported currently.
205
- ComparisonType comparison = 4;
206
-
207
- // A value against which to compare the time series.
208
- double threshold_value = 5;
209
-
210
- // The amount of time that a time series must violate the
211
- // threshold to be considered failing. Currently, only values
212
- // that are a multiple of a minute--e.g., 0, 60, 120, or 300
213
- // seconds--are supported. If an invalid value is given, an
214
- // error will be returned. When choosing a duration, it is useful to
215
- // keep in mind the frequency of the underlying time series data
216
- // (which may also be affected by any alignments specified in the
217
- // `aggregations` field); a good duration is long enough so that a single
218
- // outlier does not generate spurious alerts, but short enough that
219
- // unhealthy states are detected and alerted on quickly.
220
- google.protobuf.Duration duration = 6;
221
-
222
- // The number/percent of time series for which the comparison must hold
223
- // in order for the condition to trigger. If unspecified, then the
224
- // condition will trigger if the comparison is true for any of the
225
- // time series that have been identified by `filter` and `aggregations`,
226
- // or by the ratio, if `denominator_filter` and `denominator_aggregations`
227
- // are specified.
228
- Trigger trigger = 7;
229
-
230
- // A condition control that determines how metric-threshold conditions
231
- // are evaluated when data stops arriving.
232
- EvaluationMissingData evaluation_missing_data = 11;
233
- }
234
-
235
- // A condition type that checks that monitored resources
236
- // are reporting data. The configuration defines a metric and
237
- // a set of monitored resources. The predicate is considered in violation
238
- // when a time series for the specified metric of a monitored
239
- // resource does not include any data in the specified `duration`.
240
- message MetricAbsence {
241
- // Required. A
242
- // [filter](https://cloud.google.com/monitoring/api/v3/filters) that
243
- // identifies which time series should be compared with the threshold.
244
- //
245
- // The filter is similar to the one that is specified in the
246
- // [`ListTimeSeries`
247
- // request](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list)
248
- // (that call is useful to verify the time series that will be retrieved /
249
- // processed). The filter must specify the metric type and the resource
250
- // type. Optionally, it can specify resource labels and metric labels.
251
- // This field must not exceed 2048 Unicode characters in length.
252
- string filter = 1 [(google.api.field_behavior) = REQUIRED];
253
-
254
- // Specifies the alignment of data points in individual time series as
255
- // well as how to combine the retrieved time series together (such as
256
- // when aggregating multiple streams on each resource to a single
257
- // stream for each resource or when aggregating streams across all
258
- // members of a group of resources). Multiple aggregations
259
- // are applied in the order specified.
260
- //
261
- // This field is similar to the one in the [`ListTimeSeries`
262
- // request](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).
263
- // It is advisable to use the `ListTimeSeries` method when debugging this
264
- // field.
265
- repeated Aggregation aggregations = 5;
266
-
267
- // The amount of time that a time series must fail to report new
268
- // data to be considered failing. The minimum value of this field
269
- // is 120 seconds. Larger values that are a multiple of a
270
- // minute--for example, 240 or 300 seconds--are supported.
271
- // If an invalid value is given, an
272
- // error will be returned. The `Duration.nanos` field is
273
- // ignored.
274
- google.protobuf.Duration duration = 2;
275
-
276
- // The number/percent of time series for which the comparison must hold
277
- // in order for the condition to trigger. If unspecified, then the
278
- // condition will trigger if the comparison is true for any of the
279
- // time series that have been identified by `filter` and `aggregations`.
280
- Trigger trigger = 3;
281
- }
282
-
283
- // A condition type that checks whether a log message in the [scoping
284
- // project](https://cloud.google.com/monitoring/api/v3#project_name)
285
- // satisfies the given filter. Logs from other projects in the metrics
286
- // scope are not evaluated.
287
- message LogMatch {
288
- // Required. A logs-based filter. See [Advanced Logs
289
- // Queries](https://cloud.google.com/logging/docs/view/advanced-queries)
290
- // for how this filter should be constructed.
291
- string filter = 1 [(google.api.field_behavior) = REQUIRED];
292
-
293
- // Optional. A map from a label key to an extractor expression, which is
294
- // used to extract the value for this label key. Each entry in this map is
295
- // a specification for how data should be extracted from log entries that
296
- // match `filter`. Each combination of extracted values is treated as a
297
- // separate rule for the purposes of triggering notifications. Label keys
298
- // and corresponding values can be used in notifications generated by this
299
- // condition.
300
- //
301
- // Please see [the documentation on logs-based metric
302
- // `valueExtractor`s](https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.metrics#LogMetric.FIELDS.value_extractor)
303
- // for syntax and examples.
304
- map<string, string> label_extractors = 2;
305
- }
306
-
307
- // A condition type that allows alert policies to be defined using
308
- // [Monitoring Query Language](https://cloud.google.com/monitoring/mql).
309
- message MonitoringQueryLanguageCondition {
310
- // [Monitoring Query Language](https://cloud.google.com/monitoring/mql)
311
- // query that outputs a boolean stream.
312
- string query = 1;
313
-
314
- // The amount of time that a time series must violate the
315
- // threshold to be considered failing. Currently, only values
316
- // that are a multiple of a minute--e.g., 0, 60, 120, or 300
317
- // seconds--are supported. If an invalid value is given, an
318
- // error will be returned. When choosing a duration, it is useful to
319
- // keep in mind the frequency of the underlying time series data
320
- // (which may also be affected by any alignments specified in the
321
- // `aggregations` field); a good duration is long enough so that a single
322
- // outlier does not generate spurious alerts, but short enough that
323
- // unhealthy states are detected and alerted on quickly.
324
- google.protobuf.Duration duration = 2;
325
-
326
- // The number/percent of time series for which the comparison must hold
327
- // in order for the condition to trigger. If unspecified, then the
328
- // condition will trigger if the comparison is true for any of the
329
- // time series that have been identified by `filter` and `aggregations`,
330
- // or by the ratio, if `denominator_filter` and `denominator_aggregations`
331
- // are specified.
332
- Trigger trigger = 3;
333
-
334
- // A condition control that determines how metric-threshold conditions
335
- // are evaluated when data stops arriving.
336
- EvaluationMissingData evaluation_missing_data = 4;
337
- }
338
-
339
- // A condition type that allows alert policies to be defined using
340
- // [Prometheus Query Language
341
- // (PromQL)](https://prometheus.io/docs/prometheus/latest/querying/basics/).
342
- //
343
- // The PrometheusQueryLanguageCondition message contains information
344
- // from a Prometheus alerting rule and its associated rule group.
345
- //
346
- // A Prometheus alerting rule is described
347
- // [here](https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/).
348
- // The semantics of a Prometheus alerting rule is described
349
- // [here](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule).
350
- //
351
- // A Prometheus rule group is described
352
- // [here](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/).
353
- // The semantics of a Prometheus rule group is described
354
- // [here](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/#rule_group).
355
- //
356
- // Because Cloud Alerting has no representation of a Prometheus rule
357
- // group resource, we must embed the information of the parent rule
358
- // group inside each of the conditions that refer to it. We must also
359
- // update the contents of all Prometheus alerts in case the information
360
- // of their rule group changes.
361
- //
362
- // The PrometheusQueryLanguageCondition protocol buffer combines the
363
- // information of the corresponding rule group and alerting rule.
364
- // The structure of the PrometheusQueryLanguageCondition protocol buffer
365
- // does NOT mimic the structure of the Prometheus rule group and alerting
366
- // rule YAML declarations. The PrometheusQueryLanguageCondition protocol
367
- // buffer may change in the future to support future rule group and/or
368
- // alerting rule features. There are no new such features at the present
369
- // time (2023-06-26).
370
- message PrometheusQueryLanguageCondition {
371
- // Required. The PromQL expression to evaluate. Every evaluation cycle
372
- // this expression is evaluated at the current time, and all resultant
373
- // time series become pending/firing alerts. This field must not be empty.
374
- string query = 1 [(google.api.field_behavior) = REQUIRED];
375
-
376
- // Optional. Alerts are considered firing once their PromQL expression was
377
- // evaluated to be "true" for this long.
378
- // Alerts whose PromQL expression was not evaluated to be "true" for
379
- // long enough are considered pending.
380
- // Must be a non-negative duration or missing.
381
- // This field is optional. Its default value is zero.
382
- google.protobuf.Duration duration = 2
383
- [(google.api.field_behavior) = OPTIONAL];
384
-
385
- // Optional. How often this rule should be evaluated.
386
- // Must be a positive multiple of 30 seconds or missing.
387
- // This field is optional. Its default value is 30 seconds.
388
- // If this PrometheusQueryLanguageCondition was generated from a
389
- // Prometheus alerting rule, then this value should be taken from the
390
- // enclosing rule group.
391
- google.protobuf.Duration evaluation_interval = 3
392
- [(google.api.field_behavior) = OPTIONAL];
393
-
394
- // Optional. Labels to add to or overwrite in the PromQL query result.
395
- // Label names [must be
396
- // valid](https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels).
397
- // Label values can be [templatized by using
398
- // variables](https://cloud.google.com/monitoring/alerts/doc-variables).
399
- // The only available variable names are the names of the labels in the
400
- // PromQL result, including "__name__" and "value". "labels" may be empty.
401
- map<string, string> labels = 4 [(google.api.field_behavior) = OPTIONAL];
402
-
403
- // Optional. The rule group name of this alert in the corresponding
404
- // Prometheus configuration file.
405
- //
406
- // Some external tools may require this field to be populated correctly
407
- // in order to refer to the original Prometheus configuration file.
408
- // The rule group name and the alert name are necessary to update the
409
- // relevant AlertPolicies in case the definition of the rule group changes
410
- // in the future.
411
- //
412
- // This field is optional. If this field is not empty, then it must
413
- // contain a valid UTF-8 string.
414
- // This field may not exceed 2048 Unicode characters in length.
415
- string rule_group = 5 [(google.api.field_behavior) = OPTIONAL];
416
-
417
- // Optional. The alerting rule name of this alert in the corresponding
418
- // Prometheus configuration file.
419
- //
420
- // Some external tools may require this field to be populated correctly
421
- // in order to refer to the original Prometheus configuration file.
422
- // The rule group name and the alert name are necessary to update the
423
- // relevant AlertPolicies in case the definition of the rule group changes
424
- // in the future.
425
- //
426
- // This field is optional. If this field is not empty, then it must be a
427
- // [valid Prometheus label
428
- // name](https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels).
429
- // This field may not exceed 2048 Unicode characters in length.
430
- string alert_rule = 6 [(google.api.field_behavior) = OPTIONAL];
431
- }
432
-
433
- // Required if the condition exists. The unique resource name for this
434
- // condition. Its format is:
435
- //
436
- // projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[POLICY_ID]/conditions/[CONDITION_ID]
437
- //
438
- // `[CONDITION_ID]` is assigned by Cloud Monitoring when the
439
- // condition is created as part of a new or updated alerting policy.
440
- //
441
- // When calling the
442
- // [alertPolicies.create][google.monitoring.v3.AlertPolicyService.CreateAlertPolicy]
443
- // method, do not include the `name` field in the conditions of the
444
- // requested alerting policy. Cloud Monitoring creates the
445
- // condition identifiers and includes them in the new policy.
446
- //
447
- // When calling the
448
- // [alertPolicies.update][google.monitoring.v3.AlertPolicyService.UpdateAlertPolicy]
449
- // method to update a policy, including a condition `name` causes the
450
- // existing condition to be updated. Conditions without names are added to
451
- // the updated policy. Existing conditions are deleted if they are not
452
- // updated.
453
- //
454
- // Best practice is to preserve `[CONDITION_ID]` if you make only small
455
- // changes, such as those to condition thresholds, durations, or trigger
456
- // values. Otherwise, treat the change as a new condition and let the
457
- // existing condition be deleted.
458
- string name = 12;
459
-
460
- // A short name or phrase used to identify the condition in dashboards,
461
- // notifications, and incidents. To avoid confusion, don't use the same
462
- // display name for multiple conditions in the same policy.
463
- string display_name = 6;
464
-
465
- // Only one of the following condition types will be specified.
466
- oneof condition {
467
- // A condition that compares a time series against a threshold.
468
- MetricThreshold condition_threshold = 1;
469
-
470
- // A condition that checks that a time series continues to
471
- // receive new data points.
472
- MetricAbsence condition_absent = 2;
473
-
474
- // A condition that checks for log messages matching given constraints. If
475
- // set, no other conditions can be present.
476
- LogMatch condition_matched_log = 20;
477
-
478
- // A condition that uses the Monitoring Query Language to define
479
- // alerts.
480
- MonitoringQueryLanguageCondition condition_monitoring_query_language = 19;
481
-
482
- // A condition that uses the Prometheus query language to define alerts.
483
- PrometheusQueryLanguageCondition condition_prometheus_query_language = 21;
484
- }
485
- }
486
-
487
- // Operators for combining conditions.
488
- enum ConditionCombinerType {
489
- // An unspecified combiner.
490
- COMBINE_UNSPECIFIED = 0;
491
-
492
- // Combine conditions using the logical `AND` operator. An
493
- // incident is created only if all the conditions are met
494
- // simultaneously. This combiner is satisfied if all conditions are
495
- // met, even if they are met on completely different resources.
496
- AND = 1;
497
-
498
- // Combine conditions using the logical `OR` operator. An incident
499
- // is created if any of the listed conditions is met.
500
- OR = 2;
501
-
502
- // Combine conditions using logical `AND` operator, but unlike the regular
503
- // `AND` option, an incident is created only if all conditions are met
504
- // simultaneously on at least one resource.
505
- AND_WITH_MATCHING_RESOURCE = 3;
506
- }
507
-
508
- // Control over how the notification channels in `notification_channels`
509
- // are notified when this alert fires.
510
- message AlertStrategy {
511
- // Control over the rate of notifications sent to this alert policy's
512
- // notification channels.
513
- message NotificationRateLimit {
514
- // Not more than one notification per `period`.
515
- google.protobuf.Duration period = 1;
516
- }
517
-
518
- // Control over how the notification channels in `notification_channels`
519
- // are notified when this alert fires, on a per-channel basis.
520
- message NotificationChannelStrategy {
521
- // The full REST resource name for the notification channels that these
522
- // settings apply to. Each of these correspond to the name field in one
523
- // of the NotificationChannel objects referenced in the
524
- // notification_channels field of this AlertPolicy.
525
- // The format is:
526
- //
527
- // projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
528
- repeated string notification_channel_names = 1;
529
-
530
- // The frequency at which to send reminder notifications for open
531
- // incidents.
532
- google.protobuf.Duration renotify_interval = 2;
533
- }
534
-
535
- // Required for alert policies with a `LogMatch` condition.
536
- //
537
- // This limit is not implemented for alert policies that are not log-based.
538
- NotificationRateLimit notification_rate_limit = 1;
539
-
540
- // If an alert policy that was active has no data for this long, any open
541
- // incidents will close
542
- google.protobuf.Duration auto_close = 3;
543
-
544
- // Control how notifications will be sent out, on a per-channel basis.
545
- repeated NotificationChannelStrategy notification_channel_strategy = 4;
546
- }
547
-
548
- // An enumeration of possible severity level for an Alert Policy.
549
- enum Severity {
550
- // No severity is specified. This is the default value.
551
- SEVERITY_UNSPECIFIED = 0;
552
-
553
- // This is the highest severity level. Use this if the problem could
554
- // cause significant damage or downtime.
555
- CRITICAL = 1;
556
-
557
- // This is the medium severity level. Use this if the problem could
558
- // cause minor damage or downtime.
559
- ERROR = 2;
560
-
561
- // This is the lowest severity level. Use this if the problem is not causing
562
- // any damage or downtime, but could potentially lead to a problem in the
563
- // future.
564
- WARNING = 3;
565
- }
566
-
567
- // Required if the policy exists. The resource name for this policy. The
568
- // format is:
569
- //
570
- // projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
571
- //
572
- // `[ALERT_POLICY_ID]` is assigned by Cloud Monitoring when the policy
573
- // is created. When calling the
574
- // [alertPolicies.create][google.monitoring.v3.AlertPolicyService.CreateAlertPolicy]
575
- // method, do not include the `name` field in the alerting policy passed as
576
- // part of the request.
577
- string name = 1;
578
-
579
- // A short name or phrase used to identify the policy in dashboards,
580
- // notifications, and incidents. To avoid confusion, don't use the same
581
- // display name for multiple policies in the same project. The name is
582
- // limited to 512 Unicode characters.
583
- //
584
- // The convention for the display_name of a PrometheusQueryLanguageCondition
585
- // is "{rule group name}/{alert name}", where the {rule group name} and
586
- // {alert name} should be taken from the corresponding Prometheus
587
- // configuration file. This convention is not enforced.
588
- // In any case the display_name is not a unique key of the AlertPolicy.
589
- string display_name = 2;
590
-
591
- // Documentation that is included with notifications and incidents related to
592
- // this policy. Best practice is for the documentation to include information
593
- // to help responders understand, mitigate, escalate, and correct the
594
- // underlying problems detected by the alerting policy. Notification channels
595
- // that have limited capacity might not show this documentation.
596
- Documentation documentation = 13;
597
-
598
- // User-supplied key/value data to be used for organizing and
599
- // identifying the `AlertPolicy` objects.
600
- //
601
- // The field can contain up to 64 entries. Each key and value is limited to
602
- // 63 Unicode characters or 128 bytes, whichever is smaller. Labels and
603
- // values can contain only lowercase letters, numerals, underscores, and
604
- // dashes. Keys must begin with a letter.
605
- //
606
- // Note that Prometheus {alert name} is a
607
- // [valid Prometheus label
608
- // names](https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels),
609
- // whereas Prometheus {rule group} is an unrestricted UTF-8 string.
610
- // This means that they cannot be stored as-is in user labels, because
611
- // they may contain characters that are not allowed in user-label values.
612
- map<string, string> user_labels = 16;
613
-
614
- // A list of conditions for the policy. The conditions are combined by AND or
615
- // OR according to the `combiner` field. If the combined conditions evaluate
616
- // to true, then an incident is created. A policy can have from one to six
617
- // conditions.
618
- // If `condition_time_series_query_language` is present, it must be the only
619
- // `condition`.
620
- // If `condition_monitoring_query_language` is present, it must be the only
621
- // `condition`.
622
- repeated Condition conditions = 12;
623
-
624
- // How to combine the results of multiple conditions to determine if an
625
- // incident should be opened.
626
- // If `condition_time_series_query_language` is present, this must be
627
- // `COMBINE_UNSPECIFIED`.
628
- ConditionCombinerType combiner = 6;
629
-
630
- // Whether or not the policy is enabled. On write, the default interpretation
631
- // if unset is that the policy is enabled. On read, clients should not make
632
- // any assumption about the state if it has not been populated. The
633
- // field should always be populated on List and Get operations, unless
634
- // a field projection has been specified that strips it out.
635
- google.protobuf.BoolValue enabled = 17;
636
-
637
- // Read-only description of how the alert policy is invalid. This field is
638
- // only set when the alert policy is invalid. An invalid alert policy will not
639
- // generate incidents.
640
- google.rpc.Status validity = 18;
641
-
642
- // Identifies the notification channels to which notifications should be sent
643
- // when incidents are opened or closed or when new violations occur on
644
- // an already opened incident. Each element of this array corresponds to
645
- // the `name` field in each of the
646
- // [`NotificationChannel`][google.monitoring.v3.NotificationChannel]
647
- // objects that are returned from the [`ListNotificationChannels`]
648
- // [google.monitoring.v3.NotificationChannelService.ListNotificationChannels]
649
- // method. The format of the entries in this field is:
650
- //
651
- // projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
652
- repeated string notification_channels = 14;
653
-
654
- // A read-only record of the creation of the alerting policy. If provided
655
- // in a call to create or update, this field will be ignored.
656
- MutationRecord creation_record = 10;
657
-
658
- // A read-only record of the most recent change to the alerting policy. If
659
- // provided in a call to create or update, this field will be ignored.
660
- MutationRecord mutation_record = 11;
661
-
662
- // Control over how this alert policy's notification channels are notified.
663
- AlertStrategy alert_strategy = 21;
664
-
665
- // Optional. The severity of an alert policy indicates how important incidents
666
- // generated by that policy are. The severity level will be displayed on the
667
- // Incident detail page and in notifications.
668
- Severity severity = 22 [(google.api.field_behavior) = OPTIONAL];
669
- }