google-cloud-monitoring-v3 0.4.3 → 0.7.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (45) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/monitoring/v3/alert_policy_service/client.rb +113 -20
  3. data/lib/google/cloud/monitoring/v3/group_service/client.rb +142 -26
  4. data/lib/google/cloud/monitoring/v3/metric_service/client.rb +309 -38
  5. data/lib/google/cloud/monitoring/v3/notification_channel_service/client.rb +227 -41
  6. data/lib/google/cloud/monitoring/v3/query_service/client.rb +28 -4
  7. data/lib/google/cloud/monitoring/v3/service_monitoring_service/client.rb +222 -38
  8. data/lib/google/cloud/monitoring/v3/uptime_check_service/client.rb +135 -21
  9. data/lib/google/cloud/monitoring/v3/version.rb +1 -1
  10. data/lib/google/monitoring/v3/alert_pb.rb +18 -2
  11. data/lib/google/monitoring/v3/alert_service_pb.rb +2 -2
  12. data/lib/google/monitoring/v3/alert_service_services_pb.rb +1 -1
  13. data/lib/google/monitoring/v3/common_pb.rb +2 -2
  14. data/lib/google/monitoring/v3/group_pb.rb +1 -1
  15. data/lib/google/monitoring/v3/group_service_pb.rb +2 -2
  16. data/lib/google/monitoring/v3/group_service_services_pb.rb +1 -1
  17. data/lib/google/monitoring/v3/metric_pb.rb +2 -2
  18. data/lib/google/monitoring/v3/metric_service_pb.rb +2 -2
  19. data/lib/google/monitoring/v3/metric_service_services_pb.rb +13 -1
  20. data/lib/google/monitoring/v3/mutation_record_pb.rb +1 -1
  21. data/lib/google/monitoring/v3/notification_pb.rb +2 -2
  22. data/lib/google/monitoring/v3/notification_service_pb.rb +2 -2
  23. data/lib/google/monitoring/v3/notification_service_services_pb.rb +1 -1
  24. data/lib/google/monitoring/v3/query_service_pb.rb +2 -2
  25. data/lib/google/monitoring/v3/query_service_services_pb.rb +1 -1
  26. data/lib/google/monitoring/v3/service_pb.rb +5 -2
  27. data/lib/google/monitoring/v3/service_service_pb.rb +2 -2
  28. data/lib/google/monitoring/v3/service_service_services_pb.rb +1 -1
  29. data/lib/google/monitoring/v3/uptime_pb.rb +2 -2
  30. data/lib/google/monitoring/v3/uptime_service_pb.rb +3 -2
  31. data/lib/google/monitoring/v3/uptime_service_services_pb.rb +1 -1
  32. data/proto_docs/google/longrunning/operations.rb +164 -0
  33. data/proto_docs/google/monitoring/v3/alert.rb +72 -3
  34. data/proto_docs/google/monitoring/v3/alert_service.rb +4 -2
  35. data/proto_docs/google/monitoring/v3/common.rb +18 -6
  36. data/proto_docs/google/monitoring/v3/group_service.rb +4 -2
  37. data/proto_docs/google/monitoring/v3/metric.rb +3 -1
  38. data/proto_docs/google/monitoring/v3/metric_service.rb +13 -8
  39. data/proto_docs/google/monitoring/v3/notification_service.rb +8 -4
  40. data/proto_docs/google/monitoring/v3/service.rb +38 -6
  41. data/proto_docs/google/monitoring/v3/service_service.rb +4 -2
  42. data/proto_docs/google/monitoring/v3/span_context.rb +2 -2
  43. data/proto_docs/google/monitoring/v3/uptime.rb +5 -2
  44. data/proto_docs/google/monitoring/v3/uptime_service.rb +4 -2
  45. metadata +3 -2
@@ -1,11 +1,11 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/monitoring/v3/uptime.proto
3
3
 
4
- require 'google/protobuf'
5
-
6
4
  require 'google/api/monitored_resource_pb'
7
5
  require 'google/api/resource_pb'
8
6
  require 'google/protobuf/duration_pb'
7
+ require 'google/protobuf'
8
+
9
9
  Google::Protobuf::DescriptorPool.generated_pool.build do
10
10
  add_file("google/monitoring/v3/uptime.proto", :syntax => :proto3) do
11
11
  add_message "google.monitoring.v3.InternalChecker" do
@@ -1,16 +1,17 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/monitoring/v3/uptime_service.proto
3
3
 
4
- require 'google/protobuf'
5
-
6
4
  require 'google/api/annotations_pb'
7
5
  require 'google/api/client_pb'
8
6
  require 'google/api/field_behavior_pb'
9
7
  require 'google/api/resource_pb'
8
+ require 'google/longrunning/operations_pb'
10
9
  require 'google/monitoring/v3/uptime_pb'
11
10
  require 'google/protobuf/duration_pb'
12
11
  require 'google/protobuf/empty_pb'
13
12
  require 'google/protobuf/field_mask_pb'
13
+ require 'google/protobuf'
14
+
14
15
  Google::Protobuf::DescriptorPool.generated_pool.build do
15
16
  add_file("google/monitoring/v3/uptime_service.proto", :syntax => :proto3) do
16
17
  add_message "google.monitoring.v3.ListUptimeCheckConfigsRequest" do
@@ -34,7 +34,7 @@ module Google
34
34
  # and then clicking on "Uptime".
35
35
  class Service
36
36
 
37
- include GRPC::GenericService
37
+ include ::GRPC::GenericService
38
38
 
39
39
  self.marshal_class_method = :encode
40
40
  self.unmarshal_class_method = :decode
@@ -0,0 +1,164 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2021 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 Longrunning
22
+ # This resource represents a long-running operation that is the result of a
23
+ # network API call.
24
+ # @!attribute [rw] name
25
+ # @return [::String]
26
+ # The server-assigned name, which is only unique within the same service that
27
+ # originally returns it. If you use the default HTTP mapping, the
28
+ # `name` should be a resource name ending with `operations/{unique_id}`.
29
+ # @!attribute [rw] metadata
30
+ # @return [::Google::Protobuf::Any]
31
+ # Service-specific metadata associated with the operation. It typically
32
+ # contains progress information and common metadata such as create time.
33
+ # Some services might not provide such metadata. Any method that returns a
34
+ # long-running operation should document the metadata type, if any.
35
+ # @!attribute [rw] done
36
+ # @return [::Boolean]
37
+ # If the value is `false`, it means the operation is still in progress.
38
+ # If `true`, the operation is completed, and either `error` or `response` is
39
+ # available.
40
+ # @!attribute [rw] error
41
+ # @return [::Google::Rpc::Status]
42
+ # The error result of the operation in case of failure or cancellation.
43
+ # @!attribute [rw] response
44
+ # @return [::Google::Protobuf::Any]
45
+ # The normal response of the operation in case of success. If the original
46
+ # method returns no data on success, such as `Delete`, the response is
47
+ # `google.protobuf.Empty`. If the original method is standard
48
+ # `Get`/`Create`/`Update`, the response should be the resource. For other
49
+ # methods, the response should have the type `XxxResponse`, where `Xxx`
50
+ # is the original method name. For example, if the original method name
51
+ # is `TakeSnapshot()`, the inferred response type is
52
+ # `TakeSnapshotResponse`.
53
+ class Operation
54
+ include ::Google::Protobuf::MessageExts
55
+ extend ::Google::Protobuf::MessageExts::ClassMethods
56
+ end
57
+
58
+ # The request message for Operations.GetOperation.
59
+ # @!attribute [rw] name
60
+ # @return [::String]
61
+ # The name of the operation resource.
62
+ class GetOperationRequest
63
+ include ::Google::Protobuf::MessageExts
64
+ extend ::Google::Protobuf::MessageExts::ClassMethods
65
+ end
66
+
67
+ # The request message for Operations.ListOperations.
68
+ # @!attribute [rw] name
69
+ # @return [::String]
70
+ # The name of the operation's parent resource.
71
+ # @!attribute [rw] filter
72
+ # @return [::String]
73
+ # The standard list filter.
74
+ # @!attribute [rw] page_size
75
+ # @return [::Integer]
76
+ # The standard list page size.
77
+ # @!attribute [rw] page_token
78
+ # @return [::String]
79
+ # The standard list page token.
80
+ class ListOperationsRequest
81
+ include ::Google::Protobuf::MessageExts
82
+ extend ::Google::Protobuf::MessageExts::ClassMethods
83
+ end
84
+
85
+ # The response message for Operations.ListOperations.
86
+ # @!attribute [rw] operations
87
+ # @return [::Array<::Google::Longrunning::Operation>]
88
+ # A list of operations that matches the specified filter in the request.
89
+ # @!attribute [rw] next_page_token
90
+ # @return [::String]
91
+ # The standard List next-page token.
92
+ class ListOperationsResponse
93
+ include ::Google::Protobuf::MessageExts
94
+ extend ::Google::Protobuf::MessageExts::ClassMethods
95
+ end
96
+
97
+ # The request message for Operations.CancelOperation.
98
+ # @!attribute [rw] name
99
+ # @return [::String]
100
+ # The name of the operation resource to be cancelled.
101
+ class CancelOperationRequest
102
+ include ::Google::Protobuf::MessageExts
103
+ extend ::Google::Protobuf::MessageExts::ClassMethods
104
+ end
105
+
106
+ # The request message for Operations.DeleteOperation.
107
+ # @!attribute [rw] name
108
+ # @return [::String]
109
+ # The name of the operation resource to be deleted.
110
+ class DeleteOperationRequest
111
+ include ::Google::Protobuf::MessageExts
112
+ extend ::Google::Protobuf::MessageExts::ClassMethods
113
+ end
114
+
115
+ # The request message for Operations.WaitOperation.
116
+ # @!attribute [rw] name
117
+ # @return [::String]
118
+ # The name of the operation resource to wait on.
119
+ # @!attribute [rw] timeout
120
+ # @return [::Google::Protobuf::Duration]
121
+ # The maximum duration to wait before timing out. If left blank, the wait
122
+ # will be at most the time permitted by the underlying HTTP/RPC protocol.
123
+ # If RPC context deadline is also specified, the shorter one will be used.
124
+ class WaitOperationRequest
125
+ include ::Google::Protobuf::MessageExts
126
+ extend ::Google::Protobuf::MessageExts::ClassMethods
127
+ end
128
+
129
+ # A message representing the message types used by a long-running operation.
130
+ #
131
+ # Example:
132
+ #
133
+ # rpc LongRunningRecognize(LongRunningRecognizeRequest)
134
+ # returns (google.longrunning.Operation) {
135
+ # option (google.longrunning.operation_info) = {
136
+ # response_type: "LongRunningRecognizeResponse"
137
+ # metadata_type: "LongRunningRecognizeMetadata"
138
+ # };
139
+ # }
140
+ # @!attribute [rw] response_type
141
+ # @return [::String]
142
+ # Required. The message name of the primary return type for this
143
+ # long-running operation.
144
+ # This type will be used to deserialize the LRO's response.
145
+ #
146
+ # If the response is in a different package from the rpc, a fully-qualified
147
+ # message name must be used (e.g. `google.protobuf.Struct`).
148
+ #
149
+ # Note: Altering this value constitutes a breaking change.
150
+ # @!attribute [rw] metadata_type
151
+ # @return [::String]
152
+ # Required. The message name of the metadata type for this long-running
153
+ # operation.
154
+ #
155
+ # If the response is in a different package from the rpc, a fully-qualified
156
+ # message name must be used (e.g. `google.protobuf.Struct`).
157
+ #
158
+ # Note: Altering this value constitutes a breaking change.
159
+ class OperationInfo
160
+ include ::Google::Protobuf::MessageExts
161
+ extend ::Google::Protobuf::MessageExts::ClassMethods
162
+ end
163
+ end
164
+ end
@@ -33,7 +33,7 @@ module Google
33
33
  # projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID]
34
34
  #
35
35
  # `[ALERT_POLICY_ID]` is assigned by Stackdriver Monitoring when the policy
36
- # is created. When calling the
36
+ # is created. When calling the
37
37
  # {::Google::Cloud::Monitoring::V3::AlertPolicyService::Client#create_alert_policy alertPolicies.create}
38
38
  # method, do not include the `name` field in the alerting policy passed as
39
39
  # part of the request.
@@ -104,6 +104,9 @@ module Google
104
104
  # @return [::Google::Cloud::Monitoring::V3::MutationRecord]
105
105
  # A read-only record of the most recent change to the alerting policy. If
106
106
  # provided in a call to create or update, this field will be ignored.
107
+ # @!attribute [rw] alert_strategy
108
+ # @return [::Google::Cloud::Monitoring::V3::AlertPolicy::AlertStrategy]
109
+ # Control over how this alert policy's notification channels are notified.
107
110
  class AlertPolicy
108
111
  include ::Google::Protobuf::MessageExts
109
112
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -168,6 +171,10 @@ module Google
168
171
  # @return [::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::MetricAbsence]
169
172
  # A condition that checks that a time series continues to
170
173
  # receive new data points.
174
+ # @!attribute [rw] condition_matched_log
175
+ # @return [::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::LogMatch]
176
+ # A condition that checks for log messages matching given constraints. If
177
+ # set, no other conditions can be present.
171
178
  # @!attribute [rw] condition_monitoring_query_language
172
179
  # @return [::Google::Cloud::Monitoring::V3::AlertPolicy::Condition::MonitoringQueryLanguageCondition]
173
180
  # A condition that uses the Monitoring Query Language to define
@@ -211,7 +218,7 @@ module Google
211
218
  # well as how to combine the retrieved time series together (such as
212
219
  # when aggregating multiple streams on each resource to a single
213
220
  # stream for each resource or when aggregating streams across all
214
- # members of a group of resrouces). Multiple aggregations
221
+ # members of a group of resources). Multiple aggregations
215
222
  # are applied in the order specified.
216
223
  #
217
224
  # This field is similar to the one in the [`ListTimeSeries`
@@ -300,7 +307,7 @@ module Google
300
307
  # well as how to combine the retrieved time series together (such as
301
308
  # when aggregating multiple streams on each resource to a single
302
309
  # stream for each resource or when aggregating streams across all
303
- # members of a group of resrouces). Multiple aggregations
310
+ # members of a group of resources). Multiple aggregations
304
311
  # are applied in the order specified.
305
312
  #
306
313
  # This field is similar to the one in the [`ListTimeSeries`
@@ -327,6 +334,42 @@ module Google
327
334
  extend ::Google::Protobuf::MessageExts::ClassMethods
328
335
  end
329
336
 
337
+ # A condition type that checks whether a log message in the [scoping
338
+ # project](https://cloud.google.com/monitoring/api/v3#project_name)
339
+ # satisfies the given filter. Logs from other projects in the metrics
340
+ # scope are not evaluated.
341
+ # @!attribute [rw] filter
342
+ # @return [::String]
343
+ # Required. A logs-based filter. See [Advanced Logs
344
+ # Queries](https://cloud.google.com/logging/docs/view/advanced-queries)
345
+ # for how this filter should be constructed.
346
+ # @!attribute [rw] label_extractors
347
+ # @return [::Google::Protobuf::Map{::String => ::String}]
348
+ # Optional. A map from a label key to an extractor expression, which is
349
+ # used to extract the value for this label key. Each entry in this map is
350
+ # a specification for how data should be extracted from log entries that
351
+ # match `filter`. Each combination of extracted values is treated as a
352
+ # separate rule for the purposes of triggering notifications. Label keys
353
+ # and corresponding values can be used in notifications generated by this
354
+ # condition.
355
+ #
356
+ # Please see [the documentation on logs-based metric
357
+ # `valueExtractor`s](https://cloud.google.com/logging/docs/reference/v2/rest/v2/projects.metrics#LogMetric.FIELDS.value_extractor)
358
+ # for syntax and examples.
359
+ class LogMatch
360
+ include ::Google::Protobuf::MessageExts
361
+ extend ::Google::Protobuf::MessageExts::ClassMethods
362
+
363
+ # @!attribute [rw] key
364
+ # @return [::String]
365
+ # @!attribute [rw] value
366
+ # @return [::String]
367
+ class LabelExtractorsEntry
368
+ include ::Google::Protobuf::MessageExts
369
+ extend ::Google::Protobuf::MessageExts::ClassMethods
370
+ end
371
+ end
372
+
330
373
  # A condition type that allows alert policies to be defined using
331
374
  # [Monitoring Query Language](https://cloud.google.com/monitoring/mql).
332
375
  # @!attribute [rw] query
@@ -359,6 +402,32 @@ module Google
359
402
  end
360
403
  end
361
404
 
405
+ # Control over how the notification channels in `notification_channels`
406
+ # are notified when this alert fires.
407
+ # @!attribute [rw] notification_rate_limit
408
+ # @return [::Google::Cloud::Monitoring::V3::AlertPolicy::AlertStrategy::NotificationRateLimit]
409
+ # Required for alert policies with a `LogMatch` condition.
410
+ #
411
+ # This limit is not implemented for alert policies that are not log-based.
412
+ # @!attribute [rw] auto_close
413
+ # @return [::Google::Protobuf::Duration]
414
+ # If an alert policy that was active has no data for this long, any open
415
+ # incidents will close
416
+ class AlertStrategy
417
+ include ::Google::Protobuf::MessageExts
418
+ extend ::Google::Protobuf::MessageExts::ClassMethods
419
+
420
+ # Control over the rate of notifications sent to this alert policy's
421
+ # notification channels.
422
+ # @!attribute [rw] period
423
+ # @return [::Google::Protobuf::Duration]
424
+ # Not more than one notification per `period`.
425
+ class NotificationRateLimit
426
+ include ::Google::Protobuf::MessageExts
427
+ extend ::Google::Protobuf::MessageExts::ClassMethods
428
+ end
429
+ end
430
+
362
431
  # @!attribute [rw] key
363
432
  # @return [::String]
364
433
  # @!attribute [rw] value
@@ -24,7 +24,8 @@ module Google
24
24
  # The protocol for the `CreateAlertPolicy` request.
25
25
  # @!attribute [rw] name
26
26
  # @return [::String]
27
- # Required. The project in which to create the alerting policy. The format is:
27
+ # Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in
28
+ # which to create the alerting policy. The format is:
28
29
  #
29
30
  # projects/[PROJECT_ID_OR_NUMBER]
30
31
  #
@@ -59,7 +60,8 @@ module Google
59
60
  # The protocol for the `ListAlertPolicies` request.
60
61
  # @!attribute [rw] name
61
62
  # @return [::String]
62
- # Required. The project whose alert policies are to be listed. The format is:
63
+ # Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name)
64
+ # whose alert policies are to be listed. The format is:
63
65
  #
64
66
  # projects/[PROJECT_ID_OR_NUMBER]
65
67
  #
@@ -44,7 +44,7 @@ module Google
44
44
  extend ::Google::Protobuf::MessageExts::ClassMethods
45
45
  end
46
46
 
47
- # A closed time interval. It extends from the start time to the end time, and includes both: `[startTime, endTime]`. Valid time intervals depend on the [`MetricKind`](/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind) of the metric value. The end time must not be earlier than the start time. When writing data points, the start time must not be more than 25 hours in the past and the end time must not be more than five minutes in the future.
47
+ # A closed time interval. It extends from the start time to the end time, and includes both: `[startTime, endTime]`. Valid time intervals depend on the [`MetricKind`](https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricKind) of the metric value. The end time must not be earlier than the start time. When writing data points, the start time must not be more than 25 hours in the past and the end time must not be more than five minutes in the future.
48
48
  #
49
49
  # * For `GAUGE` metrics, the `startTime` value is technically optional; if
50
50
  # no value is specified, the start time defaults to the value of the
@@ -61,7 +61,7 @@ module Google
61
61
  # of the previous interval.
62
62
  #
63
63
  # * For `CUMULATIVE` metrics, the start time and end time must specify a
64
- # a non-zero interval, with subsequent points specifying the same
64
+ # non-zero interval, with subsequent points specifying the same
65
65
  # start time and increasing end times, until an event resets the
66
66
  # cumulative value to zero and sets a new start time for the following
67
67
  # points. The new start time must be at least a millisecond after the
@@ -460,15 +460,27 @@ module Google
460
460
  COMPARISON_NE = 6
461
461
  end
462
462
 
463
- # Obsolete.
463
+ # The tier of service for a Workspace. Please see the
464
+ # [service tiers
465
+ # documentation](https://cloud.google.com/monitoring/workspaces/tiers) for more
466
+ # details.
464
467
  module ServiceTier
465
- # Obsolete.
468
+ # An invalid sentinel value, used to indicate that a tier has not
469
+ # been provided explicitly.
466
470
  SERVICE_TIER_UNSPECIFIED = 0
467
471
 
468
- # Obsolete.
472
+ # The Stackdriver Basic tier, a free tier of service that provides basic
473
+ # features, a moderate allotment of logs, and access to built-in metrics.
474
+ # A number of features are not available in this tier. For more details,
475
+ # see [the service tiers
476
+ # documentation](https://cloud.google.com/monitoring/workspaces/tiers).
469
477
  SERVICE_TIER_BASIC = 1
470
478
 
471
- # Obsolete.
479
+ # The Stackdriver Premium tier, a higher, more expensive tier of service
480
+ # that provides access to all Stackdriver features, lets you use Stackdriver
481
+ # with AWS accounts, and has a larger allotments for logs and metrics. For
482
+ # more details, see [the service tiers
483
+ # documentation](https://cloud.google.com/monitoring/workspaces/tiers).
472
484
  SERVICE_TIER_PREMIUM = 2
473
485
  end
474
486
  end
@@ -24,7 +24,8 @@ module Google
24
24
  # The `ListGroup` request.
25
25
  # @!attribute [rw] name
26
26
  # @return [::String]
27
- # Required. The project whose groups are to be listed. The format is:
27
+ # Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name)
28
+ # whose groups are to be listed. The format is:
28
29
  #
29
30
  # projects/[PROJECT_ID_OR_NUMBER]
30
31
  # @!attribute [rw] children_of_group
@@ -95,7 +96,8 @@ module Google
95
96
  # The `CreateGroup` request.
96
97
  # @!attribute [rw] name
97
98
  # @return [::String]
98
- # Required. The project in which to create the group. The format is:
99
+ # Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) in
100
+ # which to create the group. The format is:
99
101
  #
100
102
  # projects/[PROJECT_ID_OR_NUMBER]
101
103
  # @!attribute [rw] group
@@ -52,7 +52,9 @@ module Google
52
52
  # @!attribute [rw] resource
53
53
  # @return [::Google::Api::MonitoredResource]
54
54
  # The associated monitored resource. Custom metrics can use only certain
55
- # monitored resource types in their time series data.
55
+ # monitored resource types in their time series data. For more information,
56
+ # see [Monitored resources for custom
57
+ # metrics](https://cloud.google.com/monitoring/custom-metrics/creating-metrics#custom-metric-resources).
56
58
  # @!attribute [rw] metadata
57
59
  # @return [::Google::Api::MonitoredResourceMetadata]
58
60
  # Output only. The associated monitored resource metadata. When reading a
@@ -24,7 +24,8 @@ module Google
24
24
  # The `ListMonitoredResourceDescriptors` request.
25
25
  # @!attribute [rw] name
26
26
  # @return [::String]
27
- # Required. The project on which to execute the request. The format is:
27
+ # Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
28
+ # which to execute the request. The format is:
28
29
  #
29
30
  # projects/[PROJECT_ID_OR_NUMBER]
30
31
  # @!attribute [rw] filter
@@ -80,7 +81,8 @@ module Google
80
81
  # The `ListMetricDescriptors` request.
81
82
  # @!attribute [rw] name
82
83
  # @return [::String]
83
- # Required. The project on which to execute the request. The format is:
84
+ # Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
85
+ # which to execute the request. The format is:
84
86
  #
85
87
  # projects/[PROJECT_ID_OR_NUMBER]
86
88
  # @!attribute [rw] filter
@@ -138,8 +140,9 @@ module Google
138
140
  # The `CreateMetricDescriptor` request.
139
141
  # @!attribute [rw] name
140
142
  # @return [::String]
141
- # Required. The project on which to execute the request. The format is:
142
- #
143
+ # Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
144
+ # which to execute the request. The format is:
145
+ # 4
143
146
  # projects/[PROJECT_ID_OR_NUMBER]
144
147
  # @!attribute [rw] metric_descriptor
145
148
  # @return [::Google::Api::MetricDescriptor]
@@ -167,8 +170,8 @@ module Google
167
170
  # The `ListTimeSeries` request.
168
171
  # @!attribute [rw] name
169
172
  # @return [::String]
170
- # Required. The project, organization or folder on which to execute the request. The
171
- # format is:
173
+ # Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name),
174
+ # organization or folder on which to execute the request. The format is:
172
175
  #
173
176
  # projects/[PROJECT_ID_OR_NUMBER]
174
177
  # organizations/[ORGANIZATION_ID]
@@ -262,7 +265,8 @@ module Google
262
265
  # The `CreateTimeSeries` request.
263
266
  # @!attribute [rw] name
264
267
  # @return [::String]
265
- # Required. The project on which to execute the request. The format is:
268
+ # Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
269
+ # which to execute the request. The format is:
266
270
  #
267
271
  # projects/[PROJECT_ID_OR_NUMBER]
268
272
  # @!attribute [rw] time_series
@@ -321,7 +325,8 @@ module Google
321
325
  # The `QueryTimeSeries` request.
322
326
  # @!attribute [rw] name
323
327
  # @return [::String]
324
- # Required. The project on which to execute the request. The format is:
328
+ # Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
329
+ # which to execute the request. The format is:
325
330
  #
326
331
  # projects/[PROJECT_ID_OR_NUMBER]
327
332
  # @!attribute [rw] query
@@ -29,8 +29,10 @@ module Google
29
29
  #
30
30
  # projects/[PROJECT_ID_OR_NUMBER]
31
31
  #
32
- # Note that this names the parent container in which to look for the
33
- # descriptors; to retrieve a single descriptor by name, use the
32
+ # Note that this
33
+ # [names](https://cloud.google.com/monitoring/api/v3#project_name) the parent
34
+ # container in which to look for the descriptors; to retrieve a single
35
+ # descriptor by name, use the
34
36
  # {::Google::Cloud::Monitoring::V3::NotificationChannelService::Client#get_notification_channel_descriptor GetNotificationChannelDescriptor}
35
37
  # operation, instead.
36
38
  # @!attribute [rw] page_size
@@ -78,7 +80,8 @@ module Google
78
80
  # The `CreateNotificationChannel` request.
79
81
  # @!attribute [rw] name
80
82
  # @return [::String]
81
- # Required. The project on which to execute the request. The format is:
83
+ # Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
84
+ # which to execute the request. The format is:
82
85
  #
83
86
  # projects/[PROJECT_ID_OR_NUMBER]
84
87
  #
@@ -97,7 +100,8 @@ module Google
97
100
  # The `ListNotificationChannels` request.
98
101
  # @!attribute [rw] name
99
102
  # @return [::String]
100
- # Required. The project on which to execute the request. The format is:
103
+ # Required. The [project](https://cloud.google.com/monitoring/api/v3#project_name) on
104
+ # which to execute the request. The format is:
101
105
  #
102
106
  # projects/[PROJECT_ID_OR_NUMBER]
103
107
  #
@@ -57,6 +57,14 @@ module Google
57
57
  # @!attribute [rw] telemetry
58
58
  # @return [::Google::Cloud::Monitoring::V3::Service::Telemetry]
59
59
  # Configuration for how to query telemetry on a Service.
60
+ # @!attribute [rw] user_labels
61
+ # @return [::Google::Protobuf::Map{::String => ::String}]
62
+ # Labels which have been used to annotate the service. Label keys must start
63
+ # with a letter. Label keys and values may contain lowercase letters,
64
+ # numbers, underscores, and dashes. Label keys and values have a maximum
65
+ # length of 63 characters, and must be less than 128 bytes in size. Up to 64
66
+ # label entries may be stored. For labels which do not have a semantic value,
67
+ # the empty string may be supplied for the label value.
60
68
  class Service
61
69
  include ::Google::Protobuf::MessageExts
62
70
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -168,6 +176,15 @@ module Google
168
176
  include ::Google::Protobuf::MessageExts
169
177
  extend ::Google::Protobuf::MessageExts::ClassMethods
170
178
  end
179
+
180
+ # @!attribute [rw] key
181
+ # @return [::String]
182
+ # @!attribute [rw] value
183
+ # @return [::String]
184
+ class UserLabelsEntry
185
+ include ::Google::Protobuf::MessageExts
186
+ extend ::Google::Protobuf::MessageExts::ClassMethods
187
+ end
171
188
  end
172
189
 
173
190
  # A Service-Level Objective (SLO) describes a level of desired good service. It
@@ -202,10 +219,27 @@ module Google
202
219
  # A calendar period, semantically "since the start of the current
203
220
  # `<calendar_period>`". At this time, only `DAY`, `WEEK`, `FORTNIGHT`, and
204
221
  # `MONTH` are supported.
222
+ # @!attribute [rw] user_labels
223
+ # @return [::Google::Protobuf::Map{::String => ::String}]
224
+ # Labels which have been used to annotate the service-level objective. Label
225
+ # keys must start with a letter. Label keys and values may contain lowercase
226
+ # letters, numbers, underscores, and dashes. Label keys and values have a
227
+ # maximum length of 63 characters, and must be less than 128 bytes in size.
228
+ # Up to 64 label entries may be stored. For labels which do not have a
229
+ # semantic value, the empty string may be supplied for the label value.
205
230
  class ServiceLevelObjective
206
231
  include ::Google::Protobuf::MessageExts
207
232
  extend ::Google::Protobuf::MessageExts::ClassMethods
208
233
 
234
+ # @!attribute [rw] key
235
+ # @return [::String]
236
+ # @!attribute [rw] value
237
+ # @return [::String]
238
+ class UserLabelsEntry
239
+ include ::Google::Protobuf::MessageExts
240
+ extend ::Google::Protobuf::MessageExts::ClassMethods
241
+ end
242
+
209
243
  # `ServiceLevelObjective.View` determines what form of
210
244
  # `ServiceLevelObjective` is returned from `GetServiceLevelObjective`,
211
245
  # `ListServiceLevelObjectives`, and `ListServiceLevelObjectiveVersions` RPCs.
@@ -309,9 +343,7 @@ module Google
309
343
  end
310
344
  end
311
345
 
312
- # Range of numerical values, inclusive of `min` and exclusive of `max`. If the
313
- # open range "< range.max" is desired, set `range.min = -infinity`. If the open
314
- # range ">= range.min" is desired, set `range.max = infinity`.
346
+ # Range of numerical values within `min` and `max`.
315
347
  # @!attribute [rw] min
316
348
  # @return [::Float]
317
349
  # Range minimum.
@@ -373,8 +405,8 @@ module Google
373
405
  # A `DistributionCut` defines a `TimeSeries` and thresholds used for measuring
374
406
  # good service and total service. The `TimeSeries` must have `ValueType =
375
407
  # DISTRIBUTION` and `MetricKind = DELTA` or `MetricKind = CUMULATIVE`. The
376
- # computed `good_service` will be the count of values x in the `Distribution`
377
- # such that `range.min <= x < range.max`.
408
+ # computed `good_service` will be the estimated count of values in the
409
+ # `Distribution` that fall within the specified `min` and `max`.
378
410
  # @!attribute [rw] distribution_filter
379
411
  # @return [::String]
380
412
  # A [monitoring filter](https://cloud.google.com/monitoring/api/v3/filters)
@@ -433,7 +465,7 @@ module Google
433
465
  end
434
466
 
435
467
  # A `MetricRange` is used when each window is good when the value x of a
436
- # single `TimeSeries` satisfies `range.min <= x < range.max`. The provided
468
+ # single `TimeSeries` satisfies `range.min <= x <= range.max`. The provided
437
469
  # `TimeSeries` must have `ValueType = INT64` or `ValueType = DOUBLE` and
438
470
  # `MetricKind = GAUGE`.
439
471
  # @!attribute [rw] time_series
@@ -24,7 +24,8 @@ module Google
24
24
  # The `CreateService` request.
25
25
  # @!attribute [rw] parent
26
26
  # @return [::String]
27
- # Required. Resource name of the parent workspace. The format is:
27
+ # Required. Resource [name](https://cloud.google.com/monitoring/api/v3#project_name) of
28
+ # the parent workspace. The format is:
28
29
  #
29
30
  # projects/[PROJECT_ID_OR_NUMBER]
30
31
  # @!attribute [rw] service_id
@@ -54,7 +55,8 @@ module Google
54
55
  # @!attribute [rw] parent
55
56
  # @return [::String]
56
57
  # Required. Resource name of the parent containing the listed services, either a
57
- # project or a Monitoring Workspace. The formats are:
58
+ # [project](https://cloud.google.com/monitoring/api/v3#project_name) or a
59
+ # Monitoring Workspace. The formats are:
58
60
  #
59
61
  # projects/[PROJECT_ID_OR_NUMBER]
60
62
  # workspaces/[HOST_PROJECT_ID_OR_NUMBER]
@@ -21,8 +21,8 @@ module Google
21
21
  module Cloud
22
22
  module Monitoring
23
23
  module V3
24
- # The context of a span, attached to
25
- # [Exemplars][google.api.Distribution.Exemplars]
24
+ # The context of a span. This is attached to an
25
+ # {::Google::Api::Distribution::Exemplar Exemplar}
26
26
  # in {::Google::Api::Distribution Distribution} values during aggregation.
27
27
  #
28
28
  # It contains the name of a span with format: