google-cloud-monitoring 0.28.0 → 0.29.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (39) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +1 -0
  3. data/README.md +38 -12
  4. data/lib/google/cloud/monitoring.rb +52 -2
  5. data/lib/google/cloud/monitoring/v3.rb +124 -52
  6. data/lib/google/cloud/monitoring/v3/alert_policy_service_client.rb +67 -29
  7. data/lib/google/cloud/monitoring/v3/credentials.rb +43 -0
  8. data/lib/google/cloud/monitoring/v3/doc/google/api/metric.rb +7 -11
  9. data/lib/google/cloud/monitoring/v3/doc/google/api/monitored_resource.rb +27 -3
  10. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert.rb +7 -8
  11. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert_service.rb +135 -0
  12. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/group_service.rb +145 -0
  13. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric.rb +17 -12
  14. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric_service.rb +227 -0
  15. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification_service.rb +213 -0
  16. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb +49 -29
  17. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime_service.rb +131 -0
  18. data/lib/google/cloud/monitoring/v3/doc/google/protobuf/any.rb +124 -0
  19. data/lib/google/cloud/monitoring/v3/doc/google/protobuf/empty.rb +28 -0
  20. data/lib/google/cloud/monitoring/v3/doc/google/protobuf/struct.rb +73 -0
  21. data/lib/google/cloud/monitoring/v3/doc/google/rpc/status.rb +83 -0
  22. data/lib/google/cloud/monitoring/v3/doc/overview.rb +26 -1
  23. data/lib/google/cloud/monitoring/v3/group_service_client.rb +78 -35
  24. data/lib/google/cloud/monitoring/v3/metric_service_client.rb +99 -47
  25. data/lib/google/cloud/monitoring/v3/notification_channel_service_client.rb +87 -39
  26. data/lib/google/cloud/monitoring/v3/uptime_check_service_client.rb +90 -47
  27. data/lib/google/monitoring/v3/alert_service_services_pb.rb +1 -1
  28. data/lib/google/monitoring/v3/dropped_labels_pb.rb +19 -0
  29. data/lib/google/monitoring/v3/group_service_services_pb.rb +2 -2
  30. data/lib/google/monitoring/v3/metric_pb.rb +3 -0
  31. data/lib/google/monitoring/v3/metric_service_pb.rb +2 -0
  32. data/lib/google/monitoring/v3/metric_service_services_pb.rb +1 -1
  33. data/lib/google/monitoring/v3/notification_service_services_pb.rb +1 -1
  34. data/lib/google/monitoring/v3/span_context_pb.rb +18 -0
  35. data/lib/google/monitoring/v3/uptime_pb.rb +10 -9
  36. data/lib/google/monitoring/v3/uptime_service_pb.rb +1 -0
  37. data/lib/google/monitoring/v3/uptime_service_services_pb.rb +1 -1
  38. metadata +59 -6
  39. data/lib/google/cloud/monitoring/credentials.rb +0 -33
@@ -0,0 +1,145 @@
1
+ # Copyright 2018 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
+ # https://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
+ module Google
16
+ module Monitoring
17
+ module V3
18
+ # The +ListGroup+ request.
19
+ # @!attribute [rw] name
20
+ # @return [String]
21
+ # The project whose groups are to be listed. The format is
22
+ # +"projects/{project_id_or_number}"+.
23
+ # @!attribute [rw] children_of_group
24
+ # @return [String]
25
+ # A group name: +"projects/{project_id_or_number}/groups/{group_id}"+.
26
+ # Returns groups whose +parentName+ field contains the group
27
+ # name. If no groups have this parent, the results are empty.
28
+ # @!attribute [rw] ancestors_of_group
29
+ # @return [String]
30
+ # A group name: +"projects/{project_id_or_number}/groups/{group_id}"+.
31
+ # Returns groups that are ancestors of the specified group.
32
+ # The groups are returned in order, starting with the immediate parent and
33
+ # ending with the most distant ancestor. If the specified group has no
34
+ # immediate parent, the results are empty.
35
+ # @!attribute [rw] descendants_of_group
36
+ # @return [String]
37
+ # A group name: +"projects/{project_id_or_number}/groups/{group_id}"+.
38
+ # Returns the descendants of the specified group. This is a superset of
39
+ # the results returned by the +childrenOfGroup+ filter, and includes
40
+ # children-of-children, and so forth.
41
+ # @!attribute [rw] page_size
42
+ # @return [Integer]
43
+ # A positive number that is the maximum number of results to return.
44
+ # @!attribute [rw] page_token
45
+ # @return [String]
46
+ # If this field is not empty then it must contain the +nextPageToken+ value
47
+ # returned by a previous call to this method. Using this field causes the
48
+ # method to return additional results from the previous method call.
49
+ class ListGroupsRequest; end
50
+
51
+ # The +ListGroups+ response.
52
+ # @!attribute [rw] group
53
+ # @return [Array<Google::Monitoring::V3::Group>]
54
+ # The groups that match the specified filters.
55
+ # @!attribute [rw] next_page_token
56
+ # @return [String]
57
+ # If there are more results than have been returned, then this field is set
58
+ # to a non-empty value. To see the additional results,
59
+ # use that value as +pageToken+ in the next call to this method.
60
+ class ListGroupsResponse; end
61
+
62
+ # The +GetGroup+ request.
63
+ # @!attribute [rw] name
64
+ # @return [String]
65
+ # The group to retrieve. The format is
66
+ # +"projects/{project_id_or_number}/groups/{group_id}"+.
67
+ class GetGroupRequest; end
68
+
69
+ # The +CreateGroup+ request.
70
+ # @!attribute [rw] name
71
+ # @return [String]
72
+ # The project in which to create the group. The format is
73
+ # +"projects/{project_id_or_number}"+.
74
+ # @!attribute [rw] group
75
+ # @return [Google::Monitoring::V3::Group]
76
+ # A group definition. It is an error to define the +name+ field because
77
+ # the system assigns the name.
78
+ # @!attribute [rw] validate_only
79
+ # @return [true, false]
80
+ # If true, validate this request but do not create the group.
81
+ class CreateGroupRequest; end
82
+
83
+ # The +UpdateGroup+ request.
84
+ # @!attribute [rw] group
85
+ # @return [Google::Monitoring::V3::Group]
86
+ # The new definition of the group. All fields of the existing group,
87
+ # excepting +name+, are replaced with the corresponding fields of this group.
88
+ # @!attribute [rw] validate_only
89
+ # @return [true, false]
90
+ # If true, validate this request but do not update the existing group.
91
+ class UpdateGroupRequest; end
92
+
93
+ # The +DeleteGroup+ request. You can only delete a group if it has no children.
94
+ # @!attribute [rw] name
95
+ # @return [String]
96
+ # The group to delete. The format is
97
+ # +"projects/{project_id_or_number}/groups/{group_id}"+.
98
+ class DeleteGroupRequest; end
99
+
100
+ # The +ListGroupMembers+ request.
101
+ # @!attribute [rw] name
102
+ # @return [String]
103
+ # The group whose members are listed. The format is
104
+ # +"projects/{project_id_or_number}/groups/{group_id}"+.
105
+ # @!attribute [rw] page_size
106
+ # @return [Integer]
107
+ # A positive number that is the maximum number of results to return.
108
+ # @!attribute [rw] page_token
109
+ # @return [String]
110
+ # If this field is not empty then it must contain the +nextPageToken+ value
111
+ # returned by a previous call to this method. Using this field causes the
112
+ # method to return additional results from the previous method call.
113
+ # @!attribute [rw] filter
114
+ # @return [String]
115
+ # An optional [list filter](https://cloud.google.com/monitoring/api/learn_more#filtering) describing
116
+ # the members to be returned. The filter may reference the type, labels, and
117
+ # metadata of monitored resources that comprise the group.
118
+ # For example, to return only resources representing Compute Engine VM
119
+ # instances, use this filter:
120
+ #
121
+ # resource.type = "gce_instance"
122
+ # @!attribute [rw] interval
123
+ # @return [Google::Monitoring::V3::TimeInterval]
124
+ # An optional time interval for which results should be returned. Only
125
+ # members that were part of the group during the specified interval are
126
+ # included in the response. If no interval is provided then the group
127
+ # membership over the last minute is returned.
128
+ class ListGroupMembersRequest; end
129
+
130
+ # The +ListGroupMembers+ response.
131
+ # @!attribute [rw] members
132
+ # @return [Array<Google::Api::MonitoredResource>]
133
+ # A set of monitored resources in the group.
134
+ # @!attribute [rw] next_page_token
135
+ # @return [String]
136
+ # If there are more results than have been returned, then this field is
137
+ # set to a non-empty value. To see the additional results, use that value as
138
+ # +pageToken+ in the next call to this method.
139
+ # @!attribute [rw] total_size
140
+ # @return [Integer]
141
+ # The total number of elements matching this request.
142
+ class ListGroupMembersResponse; end
143
+ end
144
+ end
145
+ end
@@ -18,14 +18,14 @@ module Google
18
18
  # A single data point in a time series.
19
19
  # @!attribute [rw] interval
20
20
  # @return [Google::Monitoring::V3::TimeInterval]
21
- # The time interval to which the data point applies. For GAUGE metrics, only
22
- # the end time of the interval is used. For DELTA metrics, the start and end
23
- # time should specify a non-zero interval, with subsequent points specifying
24
- # contiguous and non-overlapping intervals. For CUMULATIVE metrics, the
25
- # start and end time should specify a non-zero interval, with subsequent
26
- # points specifying the same start time and increasing end times, until an
27
- # event resets the cumulative value to zero and sets a new start time for the
28
- # following points.
21
+ # The time interval to which the data point applies. For +GAUGE+ metrics,
22
+ # only the end time of the interval is used. For +DELTA+ metrics, the start
23
+ # and end time should specify a non-zero interval, with subsequent points
24
+ # specifying contiguous and non-overlapping intervals. For +CUMULATIVE+
25
+ # metrics, the start and end time should specify a non-zero interval, with
26
+ # subsequent points specifying the same start time and increasing end times,
27
+ # until an event resets the cumulative value to zero and sets a new start
28
+ # time for the following points.
29
29
  # @!attribute [rw] value
30
30
  # @return [Google::Monitoring::V3::TypedValue]
31
31
  # The value of the data point.
@@ -41,8 +41,13 @@ module Google
41
41
  # series.
42
42
  # @!attribute [rw] resource
43
43
  # @return [Google::Api::MonitoredResource]
44
- # The associated resource. A fully-specified monitored resource used to
45
- # identify the time series.
44
+ # The associated monitored resource. Custom metrics can use only certain
45
+ # monitored resource types in their time series data.
46
+ # @!attribute [rw] metadata
47
+ # @return [Google::Api::MonitoredResourceMetadata]
48
+ # Output only. The associated monitored resource metadata. When reading a
49
+ # a timeseries, this field will include metadata labels that are explicitly
50
+ # named in the reduction. When creating a timeseries, this field is ignored.
46
51
  # @!attribute [rw] metric_kind
47
52
  # @return [Google::Api::MetricDescriptor::MetricKind]
48
53
  # The metric kind of the time series. When listing time series, this metric
@@ -64,8 +69,8 @@ module Google
64
69
  # the same as the type of the data in the +points+ field.
65
70
  # @!attribute [rw] points
66
71
  # @return [Array<Google::Monitoring::V3::Point>]
67
- # The data points of this time series. When listing time series, the order of
68
- # the points is specified by the list method.
72
+ # The data points of this time series. When listing time series, points are
73
+ # returned in reverse time order.
69
74
  #
70
75
  # When creating a time series, this field must contain exactly one point and
71
76
  # the point's type must be the same as the value type of the associated
@@ -0,0 +1,227 @@
1
+ # Copyright 2018 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
+ # https://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
+ module Google
16
+ module Monitoring
17
+ module V3
18
+ # The +ListMonitoredResourceDescriptors+ request.
19
+ # @!attribute [rw] name
20
+ # @return [String]
21
+ # The project on which to execute the request. The format is
22
+ # +"projects/{project_id_or_number}"+.
23
+ # @!attribute [rw] filter
24
+ # @return [String]
25
+ # An optional [filter](https://cloud.google.com/monitoring/api/v3/filters) describing
26
+ # the descriptors to be returned. The filter can reference
27
+ # the descriptor's type and labels. For example, the
28
+ # following filter returns only Google Compute Engine descriptors
29
+ # that have an +id+ label:
30
+ #
31
+ # resource.type = starts_with("gce_") AND resource.label:id
32
+ # @!attribute [rw] page_size
33
+ # @return [Integer]
34
+ # A positive number that is the maximum number of results to return.
35
+ # @!attribute [rw] page_token
36
+ # @return [String]
37
+ # If this field is not empty then it must contain the +nextPageToken+ value
38
+ # returned by a previous call to this method. Using this field causes the
39
+ # method to return additional results from the previous method call.
40
+ class ListMonitoredResourceDescriptorsRequest; end
41
+
42
+ # The +ListMonitoredResourceDescriptors+ response.
43
+ # @!attribute [rw] resource_descriptors
44
+ # @return [Array<Google::Api::MonitoredResourceDescriptor>]
45
+ # The monitored resource descriptors that are available to this project
46
+ # and that match +filter+, if present.
47
+ # @!attribute [rw] next_page_token
48
+ # @return [String]
49
+ # If there are more results than have been returned, then this field is set
50
+ # to a non-empty value. To see the additional results,
51
+ # use that value as +pageToken+ in the next call to this method.
52
+ class ListMonitoredResourceDescriptorsResponse; end
53
+
54
+ # The +GetMonitoredResourceDescriptor+ request.
55
+ # @!attribute [rw] name
56
+ # @return [String]
57
+ # The monitored resource descriptor to get. The format is
58
+ # +"projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}"+.
59
+ # The +{resource_type}+ is a predefined type, such as
60
+ # +cloudsql_database+.
61
+ class GetMonitoredResourceDescriptorRequest; end
62
+
63
+ # The +ListMetricDescriptors+ request.
64
+ # @!attribute [rw] name
65
+ # @return [String]
66
+ # The project on which to execute the request. The format is
67
+ # +"projects/{project_id_or_number}"+.
68
+ # @!attribute [rw] filter
69
+ # @return [String]
70
+ # If this field is empty, all custom and
71
+ # system-defined metric descriptors are returned.
72
+ # Otherwise, the [filter](https://cloud.google.com/monitoring/api/v3/filters)
73
+ # specifies which metric descriptors are to be
74
+ # returned. For example, the following filter matches all
75
+ # [custom metrics](https://cloud.google.com/monitoring/custom-metrics):
76
+ #
77
+ # metric.type = starts_with("custom.googleapis.com/")
78
+ # @!attribute [rw] page_size
79
+ # @return [Integer]
80
+ # A positive number that is the maximum number of results to return.
81
+ # @!attribute [rw] page_token
82
+ # @return [String]
83
+ # If this field is not empty then it must contain the +nextPageToken+ value
84
+ # returned by a previous call to this method. Using this field causes the
85
+ # method to return additional results from the previous method call.
86
+ class ListMetricDescriptorsRequest; end
87
+
88
+ # The +ListMetricDescriptors+ response.
89
+ # @!attribute [rw] metric_descriptors
90
+ # @return [Array<Google::Api::MetricDescriptor>]
91
+ # The metric descriptors that are available to the project
92
+ # and that match the value of +filter+, if present.
93
+ # @!attribute [rw] next_page_token
94
+ # @return [String]
95
+ # If there are more results than have been returned, then this field is set
96
+ # to a non-empty value. To see the additional results,
97
+ # use that value as +pageToken+ in the next call to this method.
98
+ class ListMetricDescriptorsResponse; end
99
+
100
+ # The +GetMetricDescriptor+ request.
101
+ # @!attribute [rw] name
102
+ # @return [String]
103
+ # The metric descriptor on which to execute the request. The format is
104
+ # +"projects/{project_id_or_number}/metricDescriptors/{metric_id}"+.
105
+ # An example value of +{metric_id}+ is
106
+ # +"compute.googleapis.com/instance/disk/read_bytes_count"+.
107
+ class GetMetricDescriptorRequest; end
108
+
109
+ # The +CreateMetricDescriptor+ request.
110
+ # @!attribute [rw] name
111
+ # @return [String]
112
+ # The project on which to execute the request. The format is
113
+ # +"projects/{project_id_or_number}"+.
114
+ # @!attribute [rw] metric_descriptor
115
+ # @return [Google::Api::MetricDescriptor]
116
+ # The new [custom metric](https://cloud.google.com/monitoring/custom-metrics)
117
+ # descriptor.
118
+ class CreateMetricDescriptorRequest; end
119
+
120
+ # The +DeleteMetricDescriptor+ request.
121
+ # @!attribute [rw] name
122
+ # @return [String]
123
+ # The metric descriptor on which to execute the request. The format is
124
+ # +"projects/{project_id_or_number}/metricDescriptors/{metric_id}"+.
125
+ # An example of +{metric_id}+ is:
126
+ # +"custom.googleapis.com/my_test_metric"+.
127
+ class DeleteMetricDescriptorRequest; end
128
+
129
+ # The +ListTimeSeries+ request.
130
+ # @!attribute [rw] name
131
+ # @return [String]
132
+ # The project on which to execute the request. The format is
133
+ # "projects/{project_id_or_number}".
134
+ # @!attribute [rw] filter
135
+ # @return [String]
136
+ # A [monitoring filter](https://cloud.google.com/monitoring/api/v3/filters) that specifies which time
137
+ # series should be returned. The filter must specify a single metric type,
138
+ # and can additionally specify metric labels and other information. For
139
+ # example:
140
+ #
141
+ # metric.type = "compute.googleapis.com/instance/cpu/usage_time" AND
142
+ # metric.label.instance_name = "my-instance-name"
143
+ # @!attribute [rw] interval
144
+ # @return [Google::Monitoring::V3::TimeInterval]
145
+ # The time interval for which results should be returned. Only time series
146
+ # that contain data points in the specified interval are included
147
+ # in the response.
148
+ # @!attribute [rw] aggregation
149
+ # @return [Google::Monitoring::V3::Aggregation]
150
+ # By default, the raw time series data is returned.
151
+ # Use this field to combine multiple time series for different
152
+ # views of the data.
153
+ # @!attribute [rw] order_by
154
+ # @return [String]
155
+ # Unsupported: must be left blank. The points in each time series are
156
+ # returned in reverse time order.
157
+ # @!attribute [rw] view
158
+ # @return [Google::Monitoring::V3::ListTimeSeriesRequest::TimeSeriesView]
159
+ # Specifies which information is returned about the time series.
160
+ # @!attribute [rw] page_size
161
+ # @return [Integer]
162
+ # A positive number that is the maximum number of results to return. If
163
+ # +page_size+ is empty or more than 100,000 results, the effective
164
+ # +page_size+ is 100,000 results. If +view+ is set to +FULL+, this is the
165
+ # maximum number of +Points+ returned. If +view+ is set to +HEADERS+, this is
166
+ # the maximum number of +TimeSeries+ returned.
167
+ # @!attribute [rw] page_token
168
+ # @return [String]
169
+ # If this field is not empty then it must contain the +nextPageToken+ value
170
+ # returned by a previous call to this method. Using this field causes the
171
+ # method to return additional results from the previous method call.
172
+ class ListTimeSeriesRequest
173
+ # Controls which fields are returned by +ListTimeSeries+.
174
+ module TimeSeriesView
175
+ # Returns the identity of the metric(s), the time series,
176
+ # and the time series data.
177
+ FULL = 0
178
+
179
+ # Returns the identity of the metric and the time series resource,
180
+ # but not the time series data.
181
+ HEADERS = 1
182
+ end
183
+ end
184
+
185
+ # The +ListTimeSeries+ response.
186
+ # @!attribute [rw] time_series
187
+ # @return [Array<Google::Monitoring::V3::TimeSeries>]
188
+ # One or more time series that match the filter included in the request.
189
+ # @!attribute [rw] next_page_token
190
+ # @return [String]
191
+ # If there are more results than have been returned, then this field is set
192
+ # to a non-empty value. To see the additional results,
193
+ # use that value as +pageToken+ in the next call to this method.
194
+ # @!attribute [rw] execution_errors
195
+ # @return [Array<Google::Rpc::Status>]
196
+ # Query execution errors that may have caused the time series data returned
197
+ # to be incomplete.
198
+ class ListTimeSeriesResponse; end
199
+
200
+ # The +CreateTimeSeries+ request.
201
+ # @!attribute [rw] name
202
+ # @return [String]
203
+ # The project on which to execute the request. The format is
204
+ # +"projects/{project_id_or_number}"+.
205
+ # @!attribute [rw] time_series
206
+ # @return [Array<Google::Monitoring::V3::TimeSeries>]
207
+ # The new data to be added to a list of time series.
208
+ # Adds at most one data point to each of several time series. The new data
209
+ # point must be more recent than any other point in its time series. Each
210
+ # +TimeSeries+ value must fully specify a unique time series by supplying
211
+ # all label values for the metric and the monitored resource.
212
+ class CreateTimeSeriesRequest; end
213
+
214
+ # Describes the result of a failed request to write data to a time series.
215
+ # @!attribute [rw] time_series
216
+ # @return [Google::Monitoring::V3::TimeSeries]
217
+ # The time series, including the +Metric+, +MonitoredResource+,
218
+ # and +Point+s (including timestamp and value) that resulted
219
+ # in the error. This field provides all of the context that
220
+ # would be needed to retry the operation.
221
+ # @!attribute [rw] status
222
+ # @return [Google::Rpc::Status]
223
+ # The status of the requested write operation.
224
+ class CreateTimeSeriesError; end
225
+ end
226
+ end
227
+ end
@@ -0,0 +1,213 @@
1
+ # Copyright 2018 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
+ # https://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
+ module Google
16
+ module Monitoring
17
+ module V3
18
+ # The +ListNotificationChannelDescriptors+ request.
19
+ # @!attribute [rw] name
20
+ # @return [String]
21
+ # The REST resource name of the parent from which to retrieve
22
+ # the notification channel descriptors. The expected syntax is:
23
+ #
24
+ # projects/[PROJECT_ID]
25
+ #
26
+ # Note that this names the parent container in which to look for the
27
+ # descriptors; to retrieve a single descriptor by name, use the
28
+ # {Google::Monitoring::V3::NotificationChannelService::GetNotificationChannelDescriptor GetNotificationChannelDescriptor}
29
+ # operation, instead.
30
+ # @!attribute [rw] page_size
31
+ # @return [Integer]
32
+ # The maximum number of results to return in a single response. If
33
+ # not set to a positive number, a reasonable value will be chosen by the
34
+ # service.
35
+ # @!attribute [rw] page_token
36
+ # @return [String]
37
+ # If non-empty, +page_token+ must contain a value returned as the
38
+ # +next_page_token+ in a previous response to request the next set
39
+ # of results.
40
+ class ListNotificationChannelDescriptorsRequest; end
41
+
42
+ # The +ListNotificationChannelDescriptors+ response.
43
+ # @!attribute [rw] channel_descriptors
44
+ # @return [Array<Google::Monitoring::V3::NotificationChannelDescriptor>]
45
+ # The monitored resource descriptors supported for the specified
46
+ # project, optionally filtered.
47
+ # @!attribute [rw] next_page_token
48
+ # @return [String]
49
+ # If not empty, indicates that there may be more results that match
50
+ # the request. Use the value in the +page_token+ field in a
51
+ # subsequent request to fetch the next set of results. If empty,
52
+ # all results have been returned.
53
+ class ListNotificationChannelDescriptorsResponse; end
54
+
55
+ # The +GetNotificationChannelDescriptor+ response.
56
+ # @!attribute [rw] name
57
+ # @return [String]
58
+ # The channel type for which to execute the request. The format is
59
+ # +projects/[PROJECT_ID]/notificationChannelDescriptors/{channel_type}+.
60
+ class GetNotificationChannelDescriptorRequest; end
61
+
62
+ # The +CreateNotificationChannel+ request.
63
+ # @!attribute [rw] name
64
+ # @return [String]
65
+ # The project on which to execute the request. The format is:
66
+ #
67
+ # projects/[PROJECT_ID]
68
+ #
69
+ # Note that this names the container into which the channel will be
70
+ # written. This does not name the newly created channel. The resulting
71
+ # channel's name will have a normalized version of this field as a prefix,
72
+ # but will add +/notificationChannels/[CHANNEL_ID]+ to identify the channel.
73
+ # @!attribute [rw] notification_channel
74
+ # @return [Google::Monitoring::V3::NotificationChannel]
75
+ # The definition of the +NotificationChannel+ to create.
76
+ class CreateNotificationChannelRequest; end
77
+
78
+ # The +ListNotificationChannels+ request.
79
+ # @!attribute [rw] name
80
+ # @return [String]
81
+ # The project on which to execute the request. The format is
82
+ # +projects/[PROJECT_ID]+. That is, this names the container
83
+ # in which to look for the notification channels; it does not name a
84
+ # specific channel. To query a specific channel by REST resource name, use
85
+ # the
86
+ # {Google::Monitoring::V3::NotificationChannelService::GetNotificationChannel +GetNotificationChannel+} operation.
87
+ # @!attribute [rw] filter
88
+ # @return [String]
89
+ # If provided, this field specifies the criteria that must be met by
90
+ # notification channels to be included in the response.
91
+ #
92
+ # For more details, see [sorting and
93
+ # filtering](/monitoring/api/v3/sorting-and-filtering).
94
+ # @!attribute [rw] order_by
95
+ # @return [String]
96
+ # A comma-separated list of fields by which to sort the result. Supports
97
+ # the same set of fields as in +filter+. Entries can be prefixed with
98
+ # a minus sign to sort in descending rather than ascending order.
99
+ #
100
+ # For more details, see [sorting and
101
+ # filtering](/monitoring/api/v3/sorting-and-filtering).
102
+ # @!attribute [rw] page_size
103
+ # @return [Integer]
104
+ # The maximum number of results to return in a single response. If
105
+ # not set to a positive number, a reasonable value will be chosen by the
106
+ # service.
107
+ # @!attribute [rw] page_token
108
+ # @return [String]
109
+ # If non-empty, +page_token+ must contain a value returned as the
110
+ # +next_page_token+ in a previous response to request the next set
111
+ # of results.
112
+ class ListNotificationChannelsRequest; end
113
+
114
+ # The +ListNotificationChannels+ response.
115
+ # @!attribute [rw] notification_channels
116
+ # @return [Array<Google::Monitoring::V3::NotificationChannel>]
117
+ # The notification channels defined for the specified project.
118
+ # @!attribute [rw] next_page_token
119
+ # @return [String]
120
+ # If not empty, indicates that there may be more results that match
121
+ # the request. Use the value in the +page_token+ field in a
122
+ # subsequent request to fetch the next set of results. If empty,
123
+ # all results have been returned.
124
+ class ListNotificationChannelsResponse; end
125
+
126
+ # The +GetNotificationChannel+ request.
127
+ # @!attribute [rw] name
128
+ # @return [String]
129
+ # The channel for which to execute the request. The format is
130
+ # +projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]+.
131
+ class GetNotificationChannelRequest; end
132
+
133
+ # The +UpdateNotificationChannel+ request.
134
+ # @!attribute [rw] update_mask
135
+ # @return [Google::Protobuf::FieldMask]
136
+ # The fields to update.
137
+ # @!attribute [rw] notification_channel
138
+ # @return [Google::Monitoring::V3::NotificationChannel]
139
+ # A description of the changes to be applied to the specified
140
+ # notification channel. The description must provide a definition for
141
+ # fields to be updated; the names of these fields should also be
142
+ # included in the +update_mask+.
143
+ class UpdateNotificationChannelRequest; end
144
+
145
+ # The +DeleteNotificationChannel+ request.
146
+ # @!attribute [rw] name
147
+ # @return [String]
148
+ # The channel for which to execute the request. The format is
149
+ # +projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]+.
150
+ # @!attribute [rw] force
151
+ # @return [true, false]
152
+ # If true, the notification channel will be deleted regardless of its
153
+ # use in alert policies (the policies will be updated to remove the
154
+ # channel). If false, channels that are still referenced by an existing
155
+ # alerting policy will fail to be deleted in a delete operation.
156
+ class DeleteNotificationChannelRequest; end
157
+
158
+ # The +SendNotificationChannelVerificationCode+ request.
159
+ # @!attribute [rw] name
160
+ # @return [String]
161
+ # The notification channel to which to send a verification code.
162
+ class SendNotificationChannelVerificationCodeRequest; end
163
+
164
+ # The +GetNotificationChannelVerificationCode+ request.
165
+ # @!attribute [rw] name
166
+ # @return [String]
167
+ # The notification channel for which a verification code is to be generated
168
+ # and retrieved. This must name a channel that is already verified; if
169
+ # the specified channel is not verified, the request will fail.
170
+ # @!attribute [rw] expire_time
171
+ # @return [Google::Protobuf::Timestamp]
172
+ # The desired expiration time. If specified, the API will guarantee that
173
+ # the returned code will not be valid after the specified timestamp;
174
+ # however, the API cannot guarantee that the returned code will be
175
+ # valid for at least as long as the requested time (the API puts an upper
176
+ # bound on the amount of time for which a code may be valid). If omitted,
177
+ # a default expiration will be used, which may be less than the max
178
+ # permissible expiration (so specifying an expiration may extend the
179
+ # code's lifetime over omitting an expiration, even though the API does
180
+ # impose an upper limit on the maximum expiration that is permitted).
181
+ class GetNotificationChannelVerificationCodeRequest; end
182
+
183
+ # The +GetNotificationChannelVerificationCode+ request.
184
+ # @!attribute [rw] code
185
+ # @return [String]
186
+ # The verification code, which may be used to verify other channels
187
+ # that have an equivalent identity (i.e. other channels of the same
188
+ # type with the same fingerprint such as other email channels with
189
+ # the same email address or other sms channels with the same number).
190
+ # @!attribute [rw] expire_time
191
+ # @return [Google::Protobuf::Timestamp]
192
+ # The expiration time associated with the code that was returned. If
193
+ # an expiration was provided in the request, this is the minimum of the
194
+ # requested expiration in the request and the max permitted expiration.
195
+ class GetNotificationChannelVerificationCodeResponse; end
196
+
197
+ # The +VerifyNotificationChannel+ request.
198
+ # @!attribute [rw] name
199
+ # @return [String]
200
+ # The notification channel to verify.
201
+ # @!attribute [rw] code
202
+ # @return [String]
203
+ # The verification code that was delivered to the channel as
204
+ # a result of invoking the +SendNotificationChannelVerificationCode+ API
205
+ # method or that was retrieved from a verified channel via
206
+ # +GetNotificationChannelVerificationCode+. For example, one might have
207
+ # "G-123456" or "TKNZGhhd2EyN3I1MnRnMjRv" (in general, one is only
208
+ # guaranteed that the code is valid UTF-8; one should not
209
+ # make any assumptions regarding the structure or format of the code).
210
+ class VerifyNotificationChannelRequest; end
211
+ end
212
+ end
213
+ end