@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,195 +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/label.proto";
20
- import "google/api/launch_stage.proto";
21
- import "google/api/resource.proto";
22
- import "google/monitoring/v3/common.proto";
23
- import "google/monitoring/v3/mutation_record.proto";
24
- import "google/protobuf/wrappers.proto";
25
-
26
- option csharp_namespace = "Google.Cloud.Monitoring.V3";
27
- option go_package = "cloud.google.com/go/monitoring/apiv3/v2/monitoringpb;monitoringpb";
28
- option java_multiple_files = true;
29
- option java_outer_classname = "NotificationProto";
30
- option java_package = "com.google.monitoring.v3";
31
- option php_namespace = "Google\\Cloud\\Monitoring\\V3";
32
- option ruby_package = "Google::Cloud::Monitoring::V3";
33
-
34
- // A description of a notification channel. The descriptor includes
35
- // the properties of the channel and the set of labels or fields that
36
- // must be specified to configure channels of a given type.
37
- message NotificationChannelDescriptor {
38
- option (google.api.resource) = {
39
- type: "monitoring.googleapis.com/NotificationChannelDescriptor"
40
- pattern: "projects/{project}/notificationChannelDescriptors/{channel_descriptor}"
41
- pattern: "organizations/{organization}/notificationChannelDescriptors/{channel_descriptor}"
42
- pattern: "folders/{folder}/notificationChannelDescriptors/{channel_descriptor}"
43
- pattern: "*"
44
- };
45
-
46
- // The full REST resource name for this descriptor. The format is:
47
- //
48
- // projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[TYPE]
49
- //
50
- // In the above, `[TYPE]` is the value of the `type` field.
51
- string name = 6;
52
-
53
- // The type of notification channel, such as "email" and "sms". To view the
54
- // full list of channels, see
55
- // [Channel
56
- // descriptors](https://cloud.google.com/monitoring/alerts/using-channels-api#ncd).
57
- // Notification channel types are globally unique.
58
- string type = 1;
59
-
60
- // A human-readable name for the notification channel type. This
61
- // form of the name is suitable for a user interface.
62
- string display_name = 2;
63
-
64
- // A human-readable description of the notification channel
65
- // type. The description may include a description of the properties
66
- // of the channel and pointers to external documentation.
67
- string description = 3;
68
-
69
- // The set of labels that must be defined to identify a particular
70
- // channel of the corresponding type. Each label includes a
71
- // description for how that field should be populated.
72
- repeated google.api.LabelDescriptor labels = 4;
73
-
74
- // The tiers that support this notification channel; the project service tier
75
- // must be one of the supported_tiers.
76
- repeated ServiceTier supported_tiers = 5 [deprecated = true];
77
-
78
- // The product launch stage for channels of this type.
79
- google.api.LaunchStage launch_stage = 7;
80
- }
81
-
82
- // A `NotificationChannel` is a medium through which an alert is
83
- // delivered when a policy violation is detected. Examples of channels
84
- // include email, SMS, and third-party messaging applications. Fields
85
- // containing sensitive information like authentication tokens or
86
- // contact info are only partially populated on retrieval.
87
- message NotificationChannel {
88
- option (google.api.resource) = {
89
- type: "monitoring.googleapis.com/NotificationChannel"
90
- pattern: "projects/{project}/notificationChannels/{notification_channel}"
91
- pattern: "organizations/{organization}/notificationChannels/{notification_channel}"
92
- pattern: "folders/{folder}/notificationChannels/{notification_channel}"
93
- pattern: "*"
94
- };
95
-
96
- // Indicates whether the channel has been verified or not. It is illegal
97
- // to specify this field in a
98
- // [`CreateNotificationChannel`][google.monitoring.v3.NotificationChannelService.CreateNotificationChannel]
99
- // or an
100
- // [`UpdateNotificationChannel`][google.monitoring.v3.NotificationChannelService.UpdateNotificationChannel]
101
- // operation.
102
- enum VerificationStatus {
103
- // Sentinel value used to indicate that the state is unknown, omitted, or
104
- // is not applicable (as in the case of channels that neither support
105
- // nor require verification in order to function).
106
- VERIFICATION_STATUS_UNSPECIFIED = 0;
107
-
108
- // The channel has yet to be verified and requires verification to function.
109
- // Note that this state also applies to the case where the verification
110
- // process has been initiated by sending a verification code but where
111
- // the verification code has not been submitted to complete the process.
112
- UNVERIFIED = 1;
113
-
114
- // It has been proven that notifications can be received on this
115
- // notification channel and that someone on the project has access
116
- // to messages that are delivered to that channel.
117
- VERIFIED = 2;
118
- }
119
-
120
- // The type of the notification channel. This field matches the
121
- // value of the
122
- // [NotificationChannelDescriptor.type][google.monitoring.v3.NotificationChannelDescriptor.type]
123
- // field.
124
- string type = 1;
125
-
126
- // The full REST resource name for this channel. The format is:
127
- //
128
- // projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
129
- //
130
- // The `[CHANNEL_ID]` is automatically assigned by the server on creation.
131
- string name = 6;
132
-
133
- // An optional human-readable name for this notification channel. It is
134
- // recommended that you specify a non-empty and unique name in order to
135
- // make it easier to identify the channels in your project, though this is
136
- // not enforced. The display name is limited to 512 Unicode characters.
137
- string display_name = 3;
138
-
139
- // An optional human-readable description of this notification channel. This
140
- // description may provide additional details, beyond the display
141
- // name, for the channel. This may not exceed 1024 Unicode characters.
142
- string description = 4;
143
-
144
- // Configuration fields that define the channel and its behavior. The
145
- // permissible and required labels are specified in the
146
- // [NotificationChannelDescriptor.labels][google.monitoring.v3.NotificationChannelDescriptor.labels]
147
- // of the `NotificationChannelDescriptor` corresponding to the `type` field.
148
- map<string, string> labels = 5;
149
-
150
- // User-supplied key/value data that does not need to conform to
151
- // the corresponding `NotificationChannelDescriptor`'s schema, unlike
152
- // the `labels` field. This field is intended to be used for organizing
153
- // and identifying the `NotificationChannel` objects.
154
- //
155
- // The field can contain up to 64 entries. Each key and value is limited to
156
- // 63 Unicode characters or 128 bytes, whichever is smaller. Labels and
157
- // values can contain only lowercase letters, numerals, underscores, and
158
- // dashes. Keys must begin with a letter.
159
- map<string, string> user_labels = 8;
160
-
161
- // Indicates whether this channel has been verified or not. On a
162
- // [`ListNotificationChannels`][google.monitoring.v3.NotificationChannelService.ListNotificationChannels]
163
- // or
164
- // [`GetNotificationChannel`][google.monitoring.v3.NotificationChannelService.GetNotificationChannel]
165
- // operation, this field is expected to be populated.
166
- //
167
- // If the value is `UNVERIFIED`, then it indicates that the channel is
168
- // non-functioning (it both requires verification and lacks verification);
169
- // otherwise, it is assumed that the channel works.
170
- //
171
- // If the channel is neither `VERIFIED` nor `UNVERIFIED`, it implies that
172
- // the channel is of a type that does not require verification or that
173
- // this specific channel has been exempted from verification because it was
174
- // created prior to verification being required for channels of this type.
175
- //
176
- // This field cannot be modified using a standard
177
- // [`UpdateNotificationChannel`][google.monitoring.v3.NotificationChannelService.UpdateNotificationChannel]
178
- // operation. To change the value of this field, you must call
179
- // [`VerifyNotificationChannel`][google.monitoring.v3.NotificationChannelService.VerifyNotificationChannel].
180
- VerificationStatus verification_status = 9;
181
-
182
- // Whether notifications are forwarded to the described channel. This makes
183
- // it possible to disable delivery of notifications to a particular channel
184
- // without removing the channel from all alerting policies that reference
185
- // the channel. This is a more convenient approach when the change is
186
- // temporary and you want to receive notifications from the same set
187
- // of alerting policies on the channel at some point in the future.
188
- google.protobuf.BoolValue enabled = 11;
189
-
190
- // Record of the creation of this channel.
191
- MutationRecord creation_record = 12;
192
-
193
- // Records of the modification of this channel.
194
- repeated MutationRecord mutation_records = 13;
195
- }
@@ -1,448 +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/annotations.proto";
20
- import "google/api/client.proto";
21
- import "google/api/field_behavior.proto";
22
- import "google/api/resource.proto";
23
- import "google/monitoring/v3/notification.proto";
24
- import "google/protobuf/empty.proto";
25
- import "google/protobuf/field_mask.proto";
26
- import "google/protobuf/timestamp.proto";
27
-
28
- option csharp_namespace = "Google.Cloud.Monitoring.V3";
29
- option go_package = "cloud.google.com/go/monitoring/apiv3/v2/monitoringpb;monitoringpb";
30
- option java_multiple_files = true;
31
- option java_outer_classname = "NotificationServiceProto";
32
- option java_package = "com.google.monitoring.v3";
33
- option php_namespace = "Google\\Cloud\\Monitoring\\V3";
34
- option ruby_package = "Google::Cloud::Monitoring::V3";
35
-
36
- // The Notification Channel API provides access to configuration that
37
- // controls how messages related to incidents are sent.
38
- service NotificationChannelService {
39
- option (google.api.default_host) = "monitoring.googleapis.com";
40
- option (google.api.oauth_scopes) =
41
- "https://www.googleapis.com/auth/cloud-platform,"
42
- "https://www.googleapis.com/auth/monitoring,"
43
- "https://www.googleapis.com/auth/monitoring.read";
44
-
45
- // Lists the descriptors for supported channel types. The use of descriptors
46
- // makes it possible for new channel types to be dynamically added.
47
- rpc ListNotificationChannelDescriptors(
48
- ListNotificationChannelDescriptorsRequest)
49
- returns (ListNotificationChannelDescriptorsResponse) {
50
- option (google.api.http) = {
51
- get: "/v3/{name=projects/*}/notificationChannelDescriptors"
52
- };
53
- option (google.api.method_signature) = "name";
54
- }
55
-
56
- // Gets a single channel descriptor. The descriptor indicates which fields
57
- // are expected / permitted for a notification channel of the given type.
58
- rpc GetNotificationChannelDescriptor(GetNotificationChannelDescriptorRequest)
59
- returns (NotificationChannelDescriptor) {
60
- option (google.api.http) = {
61
- get: "/v3/{name=projects/*/notificationChannelDescriptors/*}"
62
- };
63
- option (google.api.method_signature) = "name";
64
- }
65
-
66
- // Lists the notification channels that have been created for the project.
67
- // To list the types of notification channels that are supported, use
68
- // the `ListNotificationChannelDescriptors` method.
69
- rpc ListNotificationChannels(ListNotificationChannelsRequest)
70
- returns (ListNotificationChannelsResponse) {
71
- option (google.api.http) = {
72
- get: "/v3/{name=projects/*}/notificationChannels"
73
- };
74
- option (google.api.method_signature) = "name";
75
- }
76
-
77
- // Gets a single notification channel. The channel includes the relevant
78
- // configuration details with which the channel was created. However, the
79
- // response may truncate or omit passwords, API keys, or other private key
80
- // matter and thus the response may not be 100% identical to the information
81
- // that was supplied in the call to the create method.
82
- rpc GetNotificationChannel(GetNotificationChannelRequest)
83
- returns (NotificationChannel) {
84
- option (google.api.http) = {
85
- get: "/v3/{name=projects/*/notificationChannels/*}"
86
- };
87
- option (google.api.method_signature) = "name";
88
- }
89
-
90
- // Creates a new notification channel, representing a single notification
91
- // endpoint such as an email address, SMS number, or PagerDuty service.
92
- //
93
- // Design your application to single-thread API calls that modify the state of
94
- // notification channels in a single project. This includes calls to
95
- // CreateNotificationChannel, DeleteNotificationChannel and
96
- // UpdateNotificationChannel.
97
- rpc CreateNotificationChannel(CreateNotificationChannelRequest)
98
- returns (NotificationChannel) {
99
- option (google.api.http) = {
100
- post: "/v3/{name=projects/*}/notificationChannels"
101
- body: "notification_channel"
102
- };
103
- option (google.api.method_signature) = "name,notification_channel";
104
- }
105
-
106
- // Updates a notification channel. Fields not specified in the field mask
107
- // remain unchanged.
108
- //
109
- // Design your application to single-thread API calls that modify the state of
110
- // notification channels in a single project. This includes calls to
111
- // CreateNotificationChannel, DeleteNotificationChannel and
112
- // UpdateNotificationChannel.
113
- rpc UpdateNotificationChannel(UpdateNotificationChannelRequest)
114
- returns (NotificationChannel) {
115
- option (google.api.http) = {
116
- patch: "/v3/{notification_channel.name=projects/*/notificationChannels/*}"
117
- body: "notification_channel"
118
- };
119
- option (google.api.method_signature) = "update_mask,notification_channel";
120
- }
121
-
122
- // Deletes a notification channel.
123
- //
124
- // Design your application to single-thread API calls that modify the state of
125
- // notification channels in a single project. This includes calls to
126
- // CreateNotificationChannel, DeleteNotificationChannel and
127
- // UpdateNotificationChannel.
128
- rpc DeleteNotificationChannel(DeleteNotificationChannelRequest)
129
- returns (google.protobuf.Empty) {
130
- option (google.api.http) = {
131
- delete: "/v3/{name=projects/*/notificationChannels/*}"
132
- };
133
- option (google.api.method_signature) = "name,force";
134
- }
135
-
136
- // Causes a verification code to be delivered to the channel. The code
137
- // can then be supplied in `VerifyNotificationChannel` to verify the channel.
138
- rpc SendNotificationChannelVerificationCode(
139
- SendNotificationChannelVerificationCodeRequest)
140
- returns (google.protobuf.Empty) {
141
- option (google.api.http) = {
142
- post: "/v3/{name=projects/*/notificationChannels/*}:sendVerificationCode"
143
- body: "*"
144
- };
145
- option (google.api.method_signature) = "name";
146
- }
147
-
148
- // Requests a verification code for an already verified channel that can then
149
- // be used in a call to VerifyNotificationChannel() on a different channel
150
- // with an equivalent identity in the same or in a different project. This
151
- // makes it possible to copy a channel between projects without requiring
152
- // manual reverification of the channel. If the channel is not in the
153
- // verified state, this method will fail (in other words, this may only be
154
- // used if the SendNotificationChannelVerificationCode and
155
- // VerifyNotificationChannel paths have already been used to put the given
156
- // channel into the verified state).
157
- //
158
- // There is no guarantee that the verification codes returned by this method
159
- // will be of a similar structure or form as the ones that are delivered
160
- // to the channel via SendNotificationChannelVerificationCode; while
161
- // VerifyNotificationChannel() will recognize both the codes delivered via
162
- // SendNotificationChannelVerificationCode() and returned from
163
- // GetNotificationChannelVerificationCode(), it is typically the case that
164
- // the verification codes delivered via
165
- // SendNotificationChannelVerificationCode() will be shorter and also
166
- // have a shorter expiration (e.g. codes such as "G-123456") whereas
167
- // GetVerificationCode() will typically return a much longer, websafe base
168
- // 64 encoded string that has a longer expiration time.
169
- rpc GetNotificationChannelVerificationCode(
170
- GetNotificationChannelVerificationCodeRequest)
171
- returns (GetNotificationChannelVerificationCodeResponse) {
172
- option (google.api.http) = {
173
- post: "/v3/{name=projects/*/notificationChannels/*}:getVerificationCode"
174
- body: "*"
175
- };
176
- option (google.api.method_signature) = "name";
177
- }
178
-
179
- // Verifies a `NotificationChannel` by proving receipt of the code
180
- // delivered to the channel as a result of calling
181
- // `SendNotificationChannelVerificationCode`.
182
- rpc VerifyNotificationChannel(VerifyNotificationChannelRequest)
183
- returns (NotificationChannel) {
184
- option (google.api.http) = {
185
- post: "/v3/{name=projects/*/notificationChannels/*}:verify"
186
- body: "*"
187
- };
188
- option (google.api.method_signature) = "name,code";
189
- }
190
- }
191
-
192
- // The `ListNotificationChannelDescriptors` request.
193
- message ListNotificationChannelDescriptorsRequest {
194
- // Required. The REST resource name of the parent from which to retrieve
195
- // the notification channel descriptors. The expected syntax is:
196
- //
197
- // projects/[PROJECT_ID_OR_NUMBER]
198
- //
199
- // Note that this
200
- // [names](https://cloud.google.com/monitoring/api/v3#project_name) the parent
201
- // container in which to look for the descriptors; to retrieve a single
202
- // descriptor by name, use the
203
- // [GetNotificationChannelDescriptor][google.monitoring.v3.NotificationChannelService.GetNotificationChannelDescriptor]
204
- // operation, instead.
205
- string name = 4 [
206
- (google.api.field_behavior) = REQUIRED,
207
- (google.api.resource_reference) = {
208
- child_type: "monitoring.googleapis.com/NotificationChannelDescriptor"
209
- }
210
- ];
211
-
212
- // The maximum number of results to return in a single response. If
213
- // not set to a positive number, a reasonable value will be chosen by the
214
- // service.
215
- int32 page_size = 2;
216
-
217
- // If non-empty, `page_token` must contain a value returned as the
218
- // `next_page_token` in a previous response to request the next set
219
- // of results.
220
- string page_token = 3;
221
- }
222
-
223
- // The `ListNotificationChannelDescriptors` response.
224
- message ListNotificationChannelDescriptorsResponse {
225
- // The monitored resource descriptors supported for the specified
226
- // project, optionally filtered.
227
- repeated NotificationChannelDescriptor channel_descriptors = 1;
228
-
229
- // If not empty, indicates that there may be more results that match
230
- // the request. Use the value in the `page_token` field in a
231
- // subsequent request to fetch the next set of results. If empty,
232
- // all results have been returned.
233
- string next_page_token = 2;
234
- }
235
-
236
- // The `GetNotificationChannelDescriptor` response.
237
- message GetNotificationChannelDescriptorRequest {
238
- // Required. The channel type for which to execute the request. The format is:
239
- //
240
- // projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[CHANNEL_TYPE]
241
- string name = 3 [
242
- (google.api.field_behavior) = REQUIRED,
243
- (google.api.resource_reference) = {
244
- type: "monitoring.googleapis.com/NotificationChannelDescriptor"
245
- }
246
- ];
247
- }
248
-
249
- // The `CreateNotificationChannel` request.
250
- message CreateNotificationChannelRequest {
251
- // Required. The
252
- // [project](https://cloud.google.com/monitoring/api/v3#project_name) on which
253
- // to execute the request. The format is:
254
- //
255
- // projects/[PROJECT_ID_OR_NUMBER]
256
- //
257
- // This names the container into which the channel will be
258
- // written, this does not name the newly created channel. The resulting
259
- // channel's name will have a normalized version of this field as a prefix,
260
- // but will add `/notificationChannels/[CHANNEL_ID]` to identify the channel.
261
- string name = 3 [
262
- (google.api.field_behavior) = REQUIRED,
263
- (google.api.resource_reference) = {
264
- child_type: "monitoring.googleapis.com/NotificationChannel"
265
- }
266
- ];
267
-
268
- // Required. The definition of the `NotificationChannel` to create.
269
- NotificationChannel notification_channel = 2
270
- [(google.api.field_behavior) = REQUIRED];
271
- }
272
-
273
- // The `ListNotificationChannels` request.
274
- message ListNotificationChannelsRequest {
275
- // Required. The
276
- // [project](https://cloud.google.com/monitoring/api/v3#project_name) on which
277
- // to execute the request. The format is:
278
- //
279
- // projects/[PROJECT_ID_OR_NUMBER]
280
- //
281
- // This names the container
282
- // in which to look for the notification channels; it does not name a
283
- // specific channel. To query a specific channel by REST resource name, use
284
- // the
285
- // [`GetNotificationChannel`][google.monitoring.v3.NotificationChannelService.GetNotificationChannel]
286
- // operation.
287
- string name = 5 [
288
- (google.api.field_behavior) = REQUIRED,
289
- (google.api.resource_reference) = {
290
- child_type: "monitoring.googleapis.com/NotificationChannel"
291
- }
292
- ];
293
-
294
- // If provided, this field specifies the criteria that must be met by
295
- // notification channels to be included in the response.
296
- //
297
- // For more details, see [sorting and
298
- // filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
299
- string filter = 6;
300
-
301
- // A comma-separated list of fields by which to sort the result. Supports
302
- // the same set of fields as in `filter`. Entries can be prefixed with
303
- // a minus sign to sort in descending rather than ascending order.
304
- //
305
- // For more details, see [sorting and
306
- // filtering](https://cloud.google.com/monitoring/api/v3/sorting-and-filtering).
307
- string order_by = 7;
308
-
309
- // The maximum number of results to return in a single response. If
310
- // not set to a positive number, a reasonable value will be chosen by the
311
- // service.
312
- int32 page_size = 3;
313
-
314
- // If non-empty, `page_token` must contain a value returned as the
315
- // `next_page_token` in a previous response to request the next set
316
- // of results.
317
- string page_token = 4;
318
- }
319
-
320
- // The `ListNotificationChannels` response.
321
- message ListNotificationChannelsResponse {
322
- // The notification channels defined for the specified project.
323
- repeated NotificationChannel notification_channels = 3;
324
-
325
- // If not empty, indicates that there may be more results that match
326
- // the request. Use the value in the `page_token` field in a
327
- // subsequent request to fetch the next set of results. If empty,
328
- // all results have been returned.
329
- string next_page_token = 2;
330
-
331
- // The total number of notification channels in all pages. This number is only
332
- // an estimate, and may change in subsequent pages. https://aip.dev/158
333
- int32 total_size = 4;
334
- }
335
-
336
- // The `GetNotificationChannel` request.
337
- message GetNotificationChannelRequest {
338
- // Required. The channel for which to execute the request. The format is:
339
- //
340
- // projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
341
- string name = 3 [
342
- (google.api.field_behavior) = REQUIRED,
343
- (google.api.resource_reference) = {
344
- type: "monitoring.googleapis.com/NotificationChannel"
345
- }
346
- ];
347
- }
348
-
349
- // The `UpdateNotificationChannel` request.
350
- message UpdateNotificationChannelRequest {
351
- // The fields to update.
352
- google.protobuf.FieldMask update_mask = 2;
353
-
354
- // Required. A description of the changes to be applied to the specified
355
- // notification channel. The description must provide a definition for
356
- // fields to be updated; the names of these fields should also be
357
- // included in the `update_mask`.
358
- NotificationChannel notification_channel = 3
359
- [(google.api.field_behavior) = REQUIRED];
360
- }
361
-
362
- // The `DeleteNotificationChannel` request.
363
- message DeleteNotificationChannelRequest {
364
- // Required. The channel for which to execute the request. The format is:
365
- //
366
- // projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
367
- string name = 3 [
368
- (google.api.field_behavior) = REQUIRED,
369
- (google.api.resource_reference) = {
370
- type: "monitoring.googleapis.com/NotificationChannel"
371
- }
372
- ];
373
-
374
- // If true, the notification channel will be deleted regardless of its
375
- // use in alert policies (the policies will be updated to remove the
376
- // channel). If false, channels that are still referenced by an existing
377
- // alerting policy will fail to be deleted in a delete operation.
378
- bool force = 5;
379
- }
380
-
381
- // The `SendNotificationChannelVerificationCode` request.
382
- message SendNotificationChannelVerificationCodeRequest {
383
- // Required. The notification channel to which to send a verification code.
384
- string name = 1 [
385
- (google.api.field_behavior) = REQUIRED,
386
- (google.api.resource_reference) = {
387
- type: "monitoring.googleapis.com/NotificationChannel"
388
- }
389
- ];
390
- }
391
-
392
- // The `GetNotificationChannelVerificationCode` request.
393
- message GetNotificationChannelVerificationCodeRequest {
394
- // Required. The notification channel for which a verification code is to be
395
- // generated and retrieved. This must name a channel that is already verified;
396
- // if the specified channel is not verified, the request will fail.
397
- string name = 1 [
398
- (google.api.field_behavior) = REQUIRED,
399
- (google.api.resource_reference) = {
400
- type: "monitoring.googleapis.com/NotificationChannel"
401
- }
402
- ];
403
-
404
- // The desired expiration time. If specified, the API will guarantee that
405
- // the returned code will not be valid after the specified timestamp;
406
- // however, the API cannot guarantee that the returned code will be
407
- // valid for at least as long as the requested time (the API puts an upper
408
- // bound on the amount of time for which a code may be valid). If omitted,
409
- // a default expiration will be used, which may be less than the max
410
- // permissible expiration (so specifying an expiration may extend the
411
- // code's lifetime over omitting an expiration, even though the API does
412
- // impose an upper limit on the maximum expiration that is permitted).
413
- google.protobuf.Timestamp expire_time = 2;
414
- }
415
-
416
- // The `GetNotificationChannelVerificationCode` request.
417
- message GetNotificationChannelVerificationCodeResponse {
418
- // The verification code, which may be used to verify other channels
419
- // that have an equivalent identity (i.e. other channels of the same
420
- // type with the same fingerprint such as other email channels with
421
- // the same email address or other sms channels with the same number).
422
- string code = 1;
423
-
424
- // The expiration time associated with the code that was returned. If
425
- // an expiration was provided in the request, this is the minimum of the
426
- // requested expiration in the request and the max permitted expiration.
427
- google.protobuf.Timestamp expire_time = 2;
428
- }
429
-
430
- // The `VerifyNotificationChannel` request.
431
- message VerifyNotificationChannelRequest {
432
- // Required. The notification channel to verify.
433
- string name = 1 [
434
- (google.api.field_behavior) = REQUIRED,
435
- (google.api.resource_reference) = {
436
- type: "monitoring.googleapis.com/NotificationChannel"
437
- }
438
- ];
439
-
440
- // Required. The verification code that was delivered to the channel as
441
- // a result of invoking the `SendNotificationChannelVerificationCode` API
442
- // method or that was retrieved from a verified channel via
443
- // `GetNotificationChannelVerificationCode`. For example, one might have
444
- // "G-123456" or "TKNZGhhd2EyN3I1MnRnMjRv" (in general, one is only
445
- // guaranteed that the code is valid UTF-8; one should not
446
- // make any assumptions regarding the structure or format of the code).
447
- string code = 2 [(google.api.field_behavior) = REQUIRED];
448
- }