google-cloud-monitoring-v3 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (88) hide show
  1. checksums.yaml +7 -0
  2. data/.yardopts +12 -0
  3. data/AUTHENTICATION.md +169 -0
  4. data/LICENSE.md +203 -0
  5. data/README.md +71 -0
  6. data/lib/google-cloud-monitoring-v3.rb +21 -0
  7. data/lib/google/cloud/monitoring/v3.rb +40 -0
  8. data/lib/google/cloud/monitoring/v3/alert_policy_service.rb +57 -0
  9. data/lib/google/cloud/monitoring/v3/alert_policy_service/client.rb +772 -0
  10. data/lib/google/cloud/monitoring/v3/alert_policy_service/credentials.rb +53 -0
  11. data/lib/google/cloud/monitoring/v3/alert_policy_service/paths.rb +185 -0
  12. data/lib/google/cloud/monitoring/v3/group_service.rb +60 -0
  13. data/lib/google/cloud/monitoring/v3/group_service/client.rb +862 -0
  14. data/lib/google/cloud/monitoring/v3/group_service/credentials.rb +53 -0
  15. data/lib/google/cloud/monitoring/v3/group_service/paths.rb +127 -0
  16. data/lib/google/cloud/monitoring/v3/metric_service.rb +50 -0
  17. data/lib/google/cloud/monitoring/v3/metric_service/client.rb +1040 -0
  18. data/lib/google/cloud/monitoring/v3/metric_service/credentials.rb +54 -0
  19. data/lib/google/cloud/monitoring/v3/metric_service/paths.rb +179 -0
  20. data/lib/google/cloud/monitoring/v3/notification_channel_service.rb +50 -0
  21. data/lib/google/cloud/monitoring/v3/notification_channel_service/client.rb +1213 -0
  22. data/lib/google/cloud/monitoring/v3/notification_channel_service/credentials.rb +53 -0
  23. data/lib/google/cloud/monitoring/v3/notification_channel_service/paths.rb +179 -0
  24. data/lib/google/cloud/monitoring/v3/service_monitoring_service.rb +52 -0
  25. data/lib/google/cloud/monitoring/v3/service_monitoring_service/client.rb +1168 -0
  26. data/lib/google/cloud/monitoring/v3/service_monitoring_service/credentials.rb +53 -0
  27. data/lib/google/cloud/monitoring/v3/service_monitoring_service/paths.rb +185 -0
  28. data/lib/google/cloud/monitoring/v3/uptime_check_service.rb +56 -0
  29. data/lib/google/cloud/monitoring/v3/uptime_check_service/client.rb +822 -0
  30. data/lib/google/cloud/monitoring/v3/uptime_check_service/credentials.rb +53 -0
  31. data/lib/google/cloud/monitoring/v3/uptime_check_service/paths.rb +127 -0
  32. data/lib/google/cloud/monitoring/v3/version.rb +28 -0
  33. data/lib/google/monitoring/v3/alert_pb.rb +84 -0
  34. data/lib/google/monitoring/v3/alert_service_pb.rb +56 -0
  35. data/lib/google/monitoring/v3/alert_service_services_pb.rb +64 -0
  36. data/lib/google/monitoring/v3/common_pb.rb +98 -0
  37. data/lib/google/monitoring/v3/dropped_labels_pb.rb +22 -0
  38. data/lib/google/monitoring/v3/group_pb.rb +27 -0
  39. data/lib/google/monitoring/v3/group_service_pb.rb +76 -0
  40. data/lib/google/monitoring/v3/group_service_services_pb.rb +67 -0
  41. data/lib/google/monitoring/v3/metric_pb.rb +85 -0
  42. data/lib/google/monitoring/v3/metric_service_pb.rb +133 -0
  43. data/lib/google/monitoring/v3/metric_service_services_pb.rb +67 -0
  44. data/lib/google/monitoring/v3/mutation_record_pb.rb +24 -0
  45. data/lib/google/monitoring/v3/notification_pb.rb +50 -0
  46. data/lib/google/monitoring/v3/notification_service_pb.rb +93 -0
  47. data/lib/google/monitoring/v3/notification_service_services_pb.rb +95 -0
  48. data/lib/google/monitoring/v3/service_pb.rb +152 -0
  49. data/lib/google/monitoring/v3/service_service_pb.rb +89 -0
  50. data/lib/google/monitoring/v3/service_service_services_pb.rb +66 -0
  51. data/lib/google/monitoring/v3/span_context_pb.rb +22 -0
  52. data/lib/google/monitoring/v3/uptime_pb.rb +126 -0
  53. data/lib/google/monitoring/v3/uptime_service_pb.rb +66 -0
  54. data/lib/google/monitoring/v3/uptime_service_services_pb.rb +68 -0
  55. data/proto_docs/README.md +4 -0
  56. data/proto_docs/google/api/distribution.rb +225 -0
  57. data/proto_docs/google/api/field_behavior.rb +59 -0
  58. data/proto_docs/google/api/label.rb +49 -0
  59. data/proto_docs/google/api/launch_stage.rb +65 -0
  60. data/proto_docs/google/api/metric.rb +203 -0
  61. data/proto_docs/google/api/monitored_resource.rb +137 -0
  62. data/proto_docs/google/api/resource.rb +247 -0
  63. data/proto_docs/google/monitoring/v3/alert.rb +359 -0
  64. data/proto_docs/google/monitoring/v3/alert_service.rb +162 -0
  65. data/proto_docs/google/monitoring/v3/common.rb +464 -0
  66. data/proto_docs/google/monitoring/v3/dropped_labels.rb +58 -0
  67. data/proto_docs/google/monitoring/v3/group.rb +84 -0
  68. data/proto_docs/google/monitoring/v3/group_service.rb +197 -0
  69. data/proto_docs/google/monitoring/v3/metric.rb +249 -0
  70. data/proto_docs/google/monitoring/v3/metric_service.rb +366 -0
  71. data/proto_docs/google/monitoring/v3/mutation_record.rb +38 -0
  72. data/proto_docs/google/monitoring/v3/notification.rb +186 -0
  73. data/proto_docs/google/monitoring/v3/notification_service.rb +266 -0
  74. data/proto_docs/google/monitoring/v3/service.rb +424 -0
  75. data/proto_docs/google/monitoring/v3/service_service.rb +239 -0
  76. data/proto_docs/google/monitoring/v3/span_context.rb +49 -0
  77. data/proto_docs/google/monitoring/v3/uptime.rb +403 -0
  78. data/proto_docs/google/monitoring/v3/uptime_service.rb +166 -0
  79. data/proto_docs/google/protobuf/any.rb +138 -0
  80. data/proto_docs/google/protobuf/duration.rb +98 -0
  81. data/proto_docs/google/protobuf/empty.rb +36 -0
  82. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  83. data/proto_docs/google/protobuf/struct.rb +96 -0
  84. data/proto_docs/google/protobuf/timestamp.rb +120 -0
  85. data/proto_docs/google/protobuf/wrappers.rb +121 -0
  86. data/proto_docs/google/rpc/status.rb +46 -0
  87. data/proto_docs/google/type/calendar_period.rb +55 -0
  88. metadata +269 -0
@@ -0,0 +1,366 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Monitoring
23
+ module V3
24
+ # The `ListMonitoredResourceDescriptors` request.
25
+ # @!attribute [rw] name
26
+ # @return [::String]
27
+ # Required. The project on which to execute the request. The format is:
28
+ #
29
+ # projects/[PROJECT_ID_OR_NUMBER]
30
+ # @!attribute [rw] filter
31
+ # @return [::String]
32
+ # An optional [filter](https://cloud.google.com/monitoring/api/v3/filters)
33
+ # describing the descriptors to be returned. The filter can reference the
34
+ # descriptor's type and labels. For example, the following filter returns
35
+ # only Google Compute Engine descriptors that have an `id` label:
36
+ #
37
+ # resource.type = starts_with("gce_") AND resource.label:id
38
+ # @!attribute [rw] page_size
39
+ # @return [::Integer]
40
+ # A positive number that is the maximum number of results to return.
41
+ # @!attribute [rw] page_token
42
+ # @return [::String]
43
+ # If this field is not empty then it must contain the `nextPageToken` value
44
+ # returned by a previous call to this method. Using this field causes the
45
+ # method to return additional results from the previous method call.
46
+ class ListMonitoredResourceDescriptorsRequest
47
+ include ::Google::Protobuf::MessageExts
48
+ extend ::Google::Protobuf::MessageExts::ClassMethods
49
+ end
50
+
51
+ # The `ListMonitoredResourceDescriptors` response.
52
+ # @!attribute [rw] resource_descriptors
53
+ # @return [::Array<::Google::Api::MonitoredResourceDescriptor>]
54
+ # The monitored resource descriptors that are available to this project
55
+ # and that match `filter`, if present.
56
+ # @!attribute [rw] next_page_token
57
+ # @return [::String]
58
+ # If there are more results than have been returned, then this field is set
59
+ # to a non-empty value. To see the additional results,
60
+ # use that value as `page_token` in the next call to this method.
61
+ class ListMonitoredResourceDescriptorsResponse
62
+ include ::Google::Protobuf::MessageExts
63
+ extend ::Google::Protobuf::MessageExts::ClassMethods
64
+ end
65
+
66
+ # The `GetMonitoredResourceDescriptor` request.
67
+ # @!attribute [rw] name
68
+ # @return [::String]
69
+ # Required. The monitored resource descriptor to get. The format is:
70
+ #
71
+ # projects/[PROJECT_ID_OR_NUMBER]/monitoredResourceDescriptors/[RESOURCE_TYPE]
72
+ #
73
+ # The `[RESOURCE_TYPE]` is a predefined type, such as
74
+ # `cloudsql_database`.
75
+ class GetMonitoredResourceDescriptorRequest
76
+ include ::Google::Protobuf::MessageExts
77
+ extend ::Google::Protobuf::MessageExts::ClassMethods
78
+ end
79
+
80
+ # The `ListMetricDescriptors` request.
81
+ # @!attribute [rw] name
82
+ # @return [::String]
83
+ # Required. The project on which to execute the request. The format is:
84
+ #
85
+ # projects/[PROJECT_ID_OR_NUMBER]
86
+ # @!attribute [rw] filter
87
+ # @return [::String]
88
+ # If this field is empty, all custom and
89
+ # system-defined metric descriptors are returned.
90
+ # Otherwise, the [filter](https://cloud.google.com/monitoring/api/v3/filters)
91
+ # specifies which metric descriptors are to be
92
+ # returned. For example, the following filter matches all
93
+ # [custom metrics](https://cloud.google.com/monitoring/custom-metrics):
94
+ #
95
+ # metric.type = starts_with("custom.googleapis.com/")
96
+ # @!attribute [rw] page_size
97
+ # @return [::Integer]
98
+ # A positive number that is the maximum number of results to return.
99
+ # @!attribute [rw] page_token
100
+ # @return [::String]
101
+ # If this field is not empty then it must contain the `nextPageToken` value
102
+ # returned by a previous call to this method. Using this field causes the
103
+ # method to return additional results from the previous method call.
104
+ class ListMetricDescriptorsRequest
105
+ include ::Google::Protobuf::MessageExts
106
+ extend ::Google::Protobuf::MessageExts::ClassMethods
107
+ end
108
+
109
+ # The `ListMetricDescriptors` response.
110
+ # @!attribute [rw] metric_descriptors
111
+ # @return [::Array<::Google::Api::MetricDescriptor>]
112
+ # The metric descriptors that are available to the project
113
+ # and that match the value of `filter`, if present.
114
+ # @!attribute [rw] next_page_token
115
+ # @return [::String]
116
+ # If there are more results than have been returned, then this field is set
117
+ # to a non-empty value. To see the additional results,
118
+ # use that value as `page_token` in the next call to this method.
119
+ class ListMetricDescriptorsResponse
120
+ include ::Google::Protobuf::MessageExts
121
+ extend ::Google::Protobuf::MessageExts::ClassMethods
122
+ end
123
+
124
+ # The `GetMetricDescriptor` request.
125
+ # @!attribute [rw] name
126
+ # @return [::String]
127
+ # Required. The metric descriptor on which to execute the request. The format is:
128
+ #
129
+ # projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID]
130
+ #
131
+ # An example value of `[METRIC_ID]` is
132
+ # `"compute.googleapis.com/instance/disk/read_bytes_count"`.
133
+ class GetMetricDescriptorRequest
134
+ include ::Google::Protobuf::MessageExts
135
+ extend ::Google::Protobuf::MessageExts::ClassMethods
136
+ end
137
+
138
+ # The `CreateMetricDescriptor` request.
139
+ # @!attribute [rw] name
140
+ # @return [::String]
141
+ # Required. The project on which to execute the request. The format is:
142
+ #
143
+ # projects/[PROJECT_ID_OR_NUMBER]
144
+ # @!attribute [rw] metric_descriptor
145
+ # @return [::Google::Api::MetricDescriptor]
146
+ # Required. The new [custom metric](https://cloud.google.com/monitoring/custom-metrics)
147
+ # descriptor.
148
+ class CreateMetricDescriptorRequest
149
+ include ::Google::Protobuf::MessageExts
150
+ extend ::Google::Protobuf::MessageExts::ClassMethods
151
+ end
152
+
153
+ # The `DeleteMetricDescriptor` request.
154
+ # @!attribute [rw] name
155
+ # @return [::String]
156
+ # Required. The metric descriptor on which to execute the request. The format is:
157
+ #
158
+ # projects/[PROJECT_ID_OR_NUMBER]/metricDescriptors/[METRIC_ID]
159
+ #
160
+ # An example of `[METRIC_ID]` is:
161
+ # `"custom.googleapis.com/my_test_metric"`.
162
+ class DeleteMetricDescriptorRequest
163
+ include ::Google::Protobuf::MessageExts
164
+ extend ::Google::Protobuf::MessageExts::ClassMethods
165
+ end
166
+
167
+ # The `ListTimeSeries` request.
168
+ # @!attribute [rw] name
169
+ # @return [::String]
170
+ # Required. The project on which to execute the request. The format is:
171
+ #
172
+ # projects/[PROJECT_ID_OR_NUMBER]
173
+ # @!attribute [rw] filter
174
+ # @return [::String]
175
+ # Required. A [monitoring filter](https://cloud.google.com/monitoring/api/v3/filters)
176
+ # that specifies which time series should be returned. The filter must
177
+ # specify a single metric type, and can additionally specify metric labels
178
+ # and other information. For example:
179
+ #
180
+ # metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
181
+ # metric.labels.instance_name = "my-instance-name"
182
+ # @!attribute [rw] interval
183
+ # @return [::Google::Cloud::Monitoring::V3::TimeInterval]
184
+ # Required. The time interval for which results should be returned. Only time series
185
+ # that contain data points in the specified interval are included
186
+ # in the response.
187
+ # @!attribute [rw] aggregation
188
+ # @return [::Google::Cloud::Monitoring::V3::Aggregation]
189
+ # Specifies the alignment of data points in individual time series as
190
+ # well as how to combine the retrieved time series across specified labels.
191
+ #
192
+ # By default (if no `aggregation` is explicitly specified), the raw time
193
+ # series data is returned.
194
+ # @!attribute [rw] order_by
195
+ # @return [::String]
196
+ # Unsupported: must be left blank. The points in each time series are
197
+ # currently returned in reverse time order (most recent to oldest).
198
+ # @!attribute [rw] view
199
+ # @return [::Google::Cloud::Monitoring::V3::ListTimeSeriesRequest::TimeSeriesView]
200
+ # Required. Specifies which information is returned about the time series.
201
+ # @!attribute [rw] page_size
202
+ # @return [::Integer]
203
+ # A positive number that is the maximum number of results to return. If
204
+ # `page_size` is empty or more than 100,000 results, the effective
205
+ # `page_size` is 100,000 results. If `view` is set to `FULL`, this is the
206
+ # maximum number of `Points` returned. If `view` is set to `HEADERS`, this is
207
+ # the maximum number of `TimeSeries` returned.
208
+ # @!attribute [rw] page_token
209
+ # @return [::String]
210
+ # If this field is not empty then it must contain the `nextPageToken` value
211
+ # returned by a previous call to this method. Using this field causes the
212
+ # method to return additional results from the previous method call.
213
+ class ListTimeSeriesRequest
214
+ include ::Google::Protobuf::MessageExts
215
+ extend ::Google::Protobuf::MessageExts::ClassMethods
216
+
217
+ # Controls which fields are returned by `ListTimeSeries`.
218
+ module TimeSeriesView
219
+ # Returns the identity of the metric(s), the time series,
220
+ # and the time series data.
221
+ FULL = 0
222
+
223
+ # Returns the identity of the metric and the time series resource,
224
+ # but not the time series data.
225
+ HEADERS = 1
226
+ end
227
+ end
228
+
229
+ # The `ListTimeSeries` response.
230
+ # @!attribute [rw] time_series
231
+ # @return [::Array<::Google::Cloud::Monitoring::V3::TimeSeries>]
232
+ # One or more time series that match the filter included in the request.
233
+ # @!attribute [rw] next_page_token
234
+ # @return [::String]
235
+ # If there are more results than have been returned, then this field is set
236
+ # to a non-empty value. To see the additional results,
237
+ # use that value as `page_token` in the next call to this method.
238
+ # @!attribute [rw] execution_errors
239
+ # @return [::Array<::Google::Rpc::Status>]
240
+ # Query execution errors that may have caused the time series data returned
241
+ # to be incomplete.
242
+ class ListTimeSeriesResponse
243
+ include ::Google::Protobuf::MessageExts
244
+ extend ::Google::Protobuf::MessageExts::ClassMethods
245
+ end
246
+
247
+ # The `CreateTimeSeries` request.
248
+ # @!attribute [rw] name
249
+ # @return [::String]
250
+ # Required. The project on which to execute the request. The format is:
251
+ #
252
+ # projects/[PROJECT_ID_OR_NUMBER]
253
+ # @!attribute [rw] time_series
254
+ # @return [::Array<::Google::Cloud::Monitoring::V3::TimeSeries>]
255
+ # Required. The new data to be added to a list of time series.
256
+ # Adds at most one data point to each of several time series. The new data
257
+ # point must be more recent than any other point in its time series. Each
258
+ # `TimeSeries` value must fully specify a unique time series by supplying
259
+ # all label values for the metric and the monitored resource.
260
+ #
261
+ # The maximum number of `TimeSeries` objects per `Create` request is 200.
262
+ class CreateTimeSeriesRequest
263
+ include ::Google::Protobuf::MessageExts
264
+ extend ::Google::Protobuf::MessageExts::ClassMethods
265
+ end
266
+
267
+ # DEPRECATED. Used to hold per-time-series error status.
268
+ # @!attribute [rw] time_series
269
+ # @return [::Google::Cloud::Monitoring::V3::TimeSeries]
270
+ # DEPRECATED. Time series ID that resulted in the `status` error.
271
+ # @!attribute [rw] status
272
+ # @return [::Google::Rpc::Status]
273
+ # DEPRECATED. The status of the requested write operation for `time_series`.
274
+ class CreateTimeSeriesError
275
+ include ::Google::Protobuf::MessageExts
276
+ extend ::Google::Protobuf::MessageExts::ClassMethods
277
+ end
278
+
279
+ # Summary of the result of a failed request to write data to a time series.
280
+ # @!attribute [rw] total_point_count
281
+ # @return [::Integer]
282
+ # The number of points in the request.
283
+ # @!attribute [rw] success_point_count
284
+ # @return [::Integer]
285
+ # The number of points that were successfully written.
286
+ # @!attribute [rw] errors
287
+ # @return [::Array<::Google::Cloud::Monitoring::V3::CreateTimeSeriesSummary::Error>]
288
+ # The number of points that failed to be written. Order is not guaranteed.
289
+ class CreateTimeSeriesSummary
290
+ include ::Google::Protobuf::MessageExts
291
+ extend ::Google::Protobuf::MessageExts::ClassMethods
292
+
293
+ # Detailed information about an error category.
294
+ # @!attribute [rw] status
295
+ # @return [::Google::Rpc::Status]
296
+ # The status of the requested write operation.
297
+ # @!attribute [rw] point_count
298
+ # @return [::Integer]
299
+ # The number of points that couldn't be written because of `status`.
300
+ class Error
301
+ include ::Google::Protobuf::MessageExts
302
+ extend ::Google::Protobuf::MessageExts::ClassMethods
303
+ end
304
+ end
305
+
306
+ # The `QueryTimeSeries` request.
307
+ # @!attribute [rw] name
308
+ # @return [::String]
309
+ # Required. The project on which to execute the request. The format is:
310
+ #
311
+ # projects/[PROJECT_ID_OR_NUMBER]
312
+ # @!attribute [rw] query
313
+ # @return [::String]
314
+ # Required. The query in the monitoring query language format. The default
315
+ # time zone is in UTC.
316
+ # @!attribute [rw] page_size
317
+ # @return [::Integer]
318
+ # A positive number that is the maximum number of time_series_data to return.
319
+ # @!attribute [rw] page_token
320
+ # @return [::String]
321
+ # If this field is not empty then it must contain the `nextPageToken` value
322
+ # returned by a previous call to this method. Using this field causes the
323
+ # method to return additional results from the previous method call.
324
+ class QueryTimeSeriesRequest
325
+ include ::Google::Protobuf::MessageExts
326
+ extend ::Google::Protobuf::MessageExts::ClassMethods
327
+ end
328
+
329
+ # The `QueryTimeSeries` response.
330
+ # @!attribute [rw] time_series_descriptor
331
+ # @return [::Google::Cloud::Monitoring::V3::TimeSeriesDescriptor]
332
+ # The descriptor for the time series data.
333
+ # @!attribute [rw] time_series_data
334
+ # @return [::Array<::Google::Cloud::Monitoring::V3::TimeSeriesData>]
335
+ # The time series data.
336
+ # @!attribute [rw] next_page_token
337
+ # @return [::String]
338
+ # If there are more results than have been returned, then this field is set
339
+ # to a non-empty value. To see the additional results, use that value as
340
+ # `page_token` in the next call to this method.
341
+ # @!attribute [rw] partial_errors
342
+ # @return [::Array<::Google::Rpc::Status>]
343
+ # Query execution errors that may have caused the time series data returned
344
+ # to be incomplete. The available data will be available in the
345
+ # response.
346
+ class QueryTimeSeriesResponse
347
+ include ::Google::Protobuf::MessageExts
348
+ extend ::Google::Protobuf::MessageExts::ClassMethods
349
+ end
350
+
351
+ # This is an error detail intended to be used with INVALID_ARGUMENT errors.
352
+ # @!attribute [rw] errors
353
+ # @return [::Array<::Google::Cloud::Monitoring::V3::QueryError>]
354
+ # Errors in parsing the time series query language text. The number of errors
355
+ # in the response may be limited.
356
+ # @!attribute [rw] error_summary
357
+ # @return [::String]
358
+ # A summary of all the errors.
359
+ class QueryErrorList
360
+ include ::Google::Protobuf::MessageExts
361
+ extend ::Google::Protobuf::MessageExts::ClassMethods
362
+ end
363
+ end
364
+ end
365
+ end
366
+ end
@@ -0,0 +1,38 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Monitoring
23
+ module V3
24
+ # Describes a change made to a configuration.
25
+ # @!attribute [rw] mutate_time
26
+ # @return [::Google::Protobuf::Timestamp]
27
+ # When the change occurred.
28
+ # @!attribute [rw] mutated_by
29
+ # @return [::String]
30
+ # The email address of the user making the change.
31
+ class MutationRecord
32
+ include ::Google::Protobuf::MessageExts
33
+ extend ::Google::Protobuf::MessageExts::ClassMethods
34
+ end
35
+ end
36
+ end
37
+ end
38
+ end
@@ -0,0 +1,186 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2020 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module Monitoring
23
+ module V3
24
+ # A description of a notification channel. The descriptor includes
25
+ # the properties of the channel and the set of labels or fields that
26
+ # must be specified to configure channels of a given type.
27
+ # @!attribute [rw] name
28
+ # @return [::String]
29
+ # The full REST resource name for this descriptor. The format is:
30
+ #
31
+ # projects/[PROJECT_ID_OR_NUMBER]/notificationChannelDescriptors/[TYPE]
32
+ #
33
+ # In the above, `[TYPE]` is the value of the `type` field.
34
+ # @!attribute [rw] type
35
+ # @return [::String]
36
+ # The type of notification channel, such as "email", "sms", etc.
37
+ # Notification channel types are globally unique.
38
+ # @!attribute [rw] display_name
39
+ # @return [::String]
40
+ # A human-readable name for the notification channel type. This
41
+ # form of the name is suitable for a user interface.
42
+ # @!attribute [rw] description
43
+ # @return [::String]
44
+ # A human-readable description of the notification channel
45
+ # type. The description may include a description of the properties
46
+ # of the channel and pointers to external documentation.
47
+ # @!attribute [rw] labels
48
+ # @return [::Array<::Google::Api::LabelDescriptor>]
49
+ # The set of labels that must be defined to identify a particular
50
+ # channel of the corresponding type. Each label includes a
51
+ # description for how that field should be populated.
52
+ # @!attribute [rw] supported_tiers
53
+ # @return [::Array<::Google::Cloud::Monitoring::V3::ServiceTier>]
54
+ # The tiers that support this notification channel; the project service tier
55
+ # must be one of the supported_tiers.
56
+ # @!attribute [rw] launch_stage
57
+ # @return [::Google::Api::LaunchStage]
58
+ # The product launch stage for channels of this type.
59
+ class NotificationChannelDescriptor
60
+ include ::Google::Protobuf::MessageExts
61
+ extend ::Google::Protobuf::MessageExts::ClassMethods
62
+ end
63
+
64
+ # A `NotificationChannel` is a medium through which an alert is
65
+ # delivered when a policy violation is detected. Examples of channels
66
+ # include email, SMS, and third-party messaging applications. Fields
67
+ # containing sensitive information like authentication tokens or
68
+ # contact info are only partially populated on retrieval.
69
+ # @!attribute [rw] type
70
+ # @return [::String]
71
+ # The type of the notification channel. This field matches the
72
+ # value of the {::Google::Cloud::Monitoring::V3::NotificationChannelDescriptor#type NotificationChannelDescriptor.type} field.
73
+ # @!attribute [rw] name
74
+ # @return [::String]
75
+ # The full REST resource name for this channel. The format is:
76
+ #
77
+ # projects/[PROJECT_ID_OR_NUMBER]/notificationChannels/[CHANNEL_ID]
78
+ #
79
+ # The `[CHANNEL_ID]` is automatically assigned by the server on creation.
80
+ # @!attribute [rw] display_name
81
+ # @return [::String]
82
+ # An optional human-readable name for this notification channel. It is
83
+ # recommended that you specify a non-empty and unique name in order to
84
+ # make it easier to identify the channels in your project, though this is
85
+ # not enforced. The display name is limited to 512 Unicode characters.
86
+ # @!attribute [rw] description
87
+ # @return [::String]
88
+ # An optional human-readable description of this notification channel. This
89
+ # description may provide additional details, beyond the display
90
+ # name, for the channel. This may not exceed 1024 Unicode characters.
91
+ # @!attribute [rw] labels
92
+ # @return [::Google::Protobuf::Map{::String => ::String}]
93
+ # Configuration fields that define the channel and its behavior. The
94
+ # permissible and required labels are specified in the
95
+ # {::Google::Cloud::Monitoring::V3::NotificationChannelDescriptor#labels NotificationChannelDescriptor.labels} of the
96
+ # `NotificationChannelDescriptor` corresponding to the `type` field.
97
+ # @!attribute [rw] user_labels
98
+ # @return [::Google::Protobuf::Map{::String => ::String}]
99
+ # User-supplied key/value data that does not need to conform to
100
+ # the corresponding `NotificationChannelDescriptor`'s schema, unlike
101
+ # the `labels` field. This field is intended to be used for organizing
102
+ # and identifying the `NotificationChannel` objects.
103
+ #
104
+ # The field can contain up to 64 entries. Each key and value is limited to
105
+ # 63 Unicode characters or 128 bytes, whichever is smaller. Labels and
106
+ # values can contain only lowercase letters, numerals, underscores, and
107
+ # dashes. Keys must begin with a letter.
108
+ # @!attribute [rw] verification_status
109
+ # @return [::Google::Cloud::Monitoring::V3::NotificationChannel::VerificationStatus]
110
+ # Indicates whether this channel has been verified or not. On a
111
+ # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#list_notification_channels `ListNotificationChannels`}
112
+ # or
113
+ # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#get_notification_channel `GetNotificationChannel`}
114
+ # operation, this field is expected to be populated.
115
+ #
116
+ # If the value is `UNVERIFIED`, then it indicates that the channel is
117
+ # non-functioning (it both requires verification and lacks verification);
118
+ # otherwise, it is assumed that the channel works.
119
+ #
120
+ # If the channel is neither `VERIFIED` nor `UNVERIFIED`, it implies that
121
+ # the channel is of a type that does not require verification or that
122
+ # this specific channel has been exempted from verification because it was
123
+ # created prior to verification being required for channels of this type.
124
+ #
125
+ # This field cannot be modified using a standard
126
+ # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#update_notification_channel `UpdateNotificationChannel`}
127
+ # operation. To change the value of this field, you must call
128
+ # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#verify_notification_channel `VerifyNotificationChannel`}.
129
+ # @!attribute [rw] enabled
130
+ # @return [::Google::Protobuf::BoolValue]
131
+ # Whether notifications are forwarded to the described channel. This makes
132
+ # it possible to disable delivery of notifications to a particular channel
133
+ # without removing the channel from all alerting policies that reference
134
+ # the channel. This is a more convenient approach when the change is
135
+ # temporary and you want to receive notifications from the same set
136
+ # of alerting policies on the channel at some point in the future.
137
+ class NotificationChannel
138
+ include ::Google::Protobuf::MessageExts
139
+ extend ::Google::Protobuf::MessageExts::ClassMethods
140
+
141
+ # @!attribute [rw] key
142
+ # @return [::String]
143
+ # @!attribute [rw] value
144
+ # @return [::String]
145
+ class LabelsEntry
146
+ include ::Google::Protobuf::MessageExts
147
+ extend ::Google::Protobuf::MessageExts::ClassMethods
148
+ end
149
+
150
+ # @!attribute [rw] key
151
+ # @return [::String]
152
+ # @!attribute [rw] value
153
+ # @return [::String]
154
+ class UserLabelsEntry
155
+ include ::Google::Protobuf::MessageExts
156
+ extend ::Google::Protobuf::MessageExts::ClassMethods
157
+ end
158
+
159
+ # Indicates whether the channel has been verified or not. It is illegal
160
+ # to specify this field in a
161
+ # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#create_notification_channel `CreateNotificationChannel`}
162
+ # or an
163
+ # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#update_notification_channel `UpdateNotificationChannel`}
164
+ # operation.
165
+ module VerificationStatus
166
+ # Sentinel value used to indicate that the state is unknown, omitted, or
167
+ # is not applicable (as in the case of channels that neither support
168
+ # nor require verification in order to function).
169
+ VERIFICATION_STATUS_UNSPECIFIED = 0
170
+
171
+ # The channel has yet to be verified and requires verification to function.
172
+ # Note that this state also applies to the case where the verification
173
+ # process has been initiated by sending a verification code but where
174
+ # the verification code has not been submitted to complete the process.
175
+ UNVERIFIED = 1
176
+
177
+ # It has been proven that notifications can be received on this
178
+ # notification channel and that someone on the project has access
179
+ # to messages that are delivered to that channel.
180
+ VERIFIED = 2
181
+ end
182
+ end
183
+ end
184
+ end
185
+ end
186
+ end