google-cloud-monitoring 0.29.1 → 0.29.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (33) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +5 -5
  3. data/lib/google/cloud/monitoring.rb +4 -4
  4. data/lib/google/cloud/monitoring/v3.rb +4 -4
  5. data/lib/google/cloud/monitoring/v3/alert_policy_service_client.rb +19 -19
  6. data/lib/google/cloud/monitoring/v3/doc/google/api/distribution.rb +18 -18
  7. data/lib/google/cloud/monitoring/v3/doc/google/api/metric.rb +69 -48
  8. data/lib/google/cloud/monitoring/v3/doc/google/api/monitored_resource.rb +20 -21
  9. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert.rb +42 -42
  10. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/alert_service.rb +24 -24
  11. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/common.rb +21 -21
  12. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/group.rb +9 -9
  13. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/group_service.rb +24 -24
  14. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric.rb +7 -7
  15. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/metric_service.rb +41 -41
  16. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification.rb +15 -15
  17. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/notification_service.rb +30 -30
  18. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime.rb +8 -8
  19. data/lib/google/cloud/monitoring/v3/doc/google/monitoring/v3/uptime_service.rb +21 -21
  20. data/lib/google/cloud/monitoring/v3/doc/google/protobuf/any.rb +8 -8
  21. data/lib/google/cloud/monitoring/v3/doc/google/protobuf/duration.rb +3 -3
  22. data/lib/google/cloud/monitoring/v3/doc/google/protobuf/empty.rb +1 -1
  23. data/lib/google/cloud/monitoring/v3/doc/google/protobuf/field_mask.rb +7 -7
  24. data/lib/google/cloud/monitoring/v3/doc/google/protobuf/struct.rb +11 -11
  25. data/lib/google/cloud/monitoring/v3/doc/google/protobuf/timestamp.rb +7 -7
  26. data/lib/google/cloud/monitoring/v3/doc/google/protobuf/wrappers.rb +18 -18
  27. data/lib/google/cloud/monitoring/v3/doc/google/rpc/status.rb +11 -11
  28. data/lib/google/cloud/monitoring/v3/group_service_client.rb +15 -15
  29. data/lib/google/cloud/monitoring/v3/metric_service_client.rb +20 -20
  30. data/lib/google/cloud/monitoring/v3/notification_channel_service_client.rb +11 -11
  31. data/lib/google/cloud/monitoring/v3/uptime_check_service_client.rb +14 -14
  32. metadata +3 -4
  33. data/lib/google/cloud/monitoring/v3/doc/overview.rb +0 -104
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4e4067b3f7c24bf08c04598f75184399e1571bae95a57f708aec1bef4a2f4d77
4
- data.tar.gz: 892886b02ae559030fa86948e511582f3ab88b18ef4373e8a939c96a9d704d68
3
+ metadata.gz: 0dc9702d88ed808406c4c6234cf8a3be58a428ee47b8d4f0baadfe632f173570
4
+ data.tar.gz: f181b871afd82fd55048777d67d2440c6629543481ae67c314e1dd47029c40e0
5
5
  SHA512:
6
- metadata.gz: 6a1b4796c751068776f4a62c4255f15bb3275f49de6fac228caee06a7ba0447f41238c526aa7e2647fe5d4c23a71456058a9d9d3dfb86139f1402c40376ac9e7
7
- data.tar.gz: 6e6b8d005be26b43c7f00e8a309fd4c5c59545c88517e86df519915f0131fda2dc5a6bb7ed91b4453602677b93de6ef92cdca07362614810e096e617aead9e89
6
+ metadata.gz: f7bb3c18bad2de64f222c4753248227c3cbc92104265312f330f5fe02423fdf5a4ba58fab26397aa7aa71c8c84fbb318c07cef51c42b21230ad159f5f630d3ec
7
+ data.tar.gz: dc4381615c7afbc448b451c4b2497b96a56634907cedfe4d22641470de02d931bf70ccdd6e887471c60f1dc0c7a659da98802e51ece0e09abaefca9259d745ea
data/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # Ruby Client for Stackdriver Monitoring API ([Beta](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
1
+ # Ruby Client for Stackdriver Monitoring API ([Beta](https://github.com/googleapis/google-cloud-ruby#versioning))
2
2
 
3
3
  [Stackdriver Monitoring API][Product Documentation]:
4
4
  Manages your Stackdriver Monitoring data and configurations. Most projects
@@ -14,7 +14,7 @@ steps:
14
14
  1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
15
15
  2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
16
16
  3. [Enable the Stackdriver Monitoring API.](https://console.cloud.google.com/apis/library/monitoring.googleapis.com)
17
- 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
17
+ 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
18
18
 
19
19
  ### Installation
20
20
  ```
@@ -48,17 +48,17 @@ end
48
48
  to see other available methods on the client.
49
49
  - Read the [Stackdriver Monitoring API Product documentation][Product Documentation]
50
50
  to learn more about the product and see How-to Guides.
51
- - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
51
+ - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
52
52
  to see the full list of Cloud APIs that we cover.
53
53
 
54
- [Client Library Documentation]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-monitoring/latest/google/monitoring/v3
54
+ [Client Library Documentation]: https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-monitoring/latest/google/monitoring/v3
55
55
  [Product Documentation]: https://cloud.google.com/monitoring
56
56
 
57
57
  ## Enabling Logging
58
58
 
59
59
  To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
60
60
  The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
61
- or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
61
+ or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
62
62
  that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
63
63
  and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
64
64
 
@@ -21,7 +21,7 @@ module Google
21
21
  # rubocop:disable LineLength
22
22
 
23
23
  ##
24
- # # Ruby Client for Stackdriver Monitoring API ([Beta](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
24
+ # # Ruby Client for Stackdriver Monitoring API ([Beta](https://github.com/googleapis/google-cloud-ruby#versioning))
25
25
  #
26
26
  # [Stackdriver Monitoring API][Product Documentation]:
27
27
  # Manages your Stackdriver Monitoring data and configurations. Most projects
@@ -36,7 +36,7 @@ module Google
36
36
  # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
37
37
  # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
38
38
  # 3. [Enable the Stackdriver Monitoring API.](https://console.cloud.google.com/apis/library/monitoring.googleapis.com)
39
- # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
39
+ # 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
40
40
  #
41
41
  # ### Installation
42
42
  # ```
@@ -68,7 +68,7 @@ module Google
68
68
  # ### Next Steps
69
69
  # - Read the [Stackdriver Monitoring API Product documentation][Product Documentation]
70
70
  # to learn more about the product and see How-to Guides.
71
- # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
71
+ # - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
72
72
  # to see the full list of Cloud APIs that we cover.
73
73
  #
74
74
  # [Product Documentation]: https://cloud.google.com/monitoring
@@ -77,7 +77,7 @@ module Google
77
77
  #
78
78
  # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
79
79
  # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
80
- # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
80
+ # or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
81
81
  # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
82
82
  # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
83
83
  #
@@ -27,7 +27,7 @@ module Google
27
27
  # rubocop:disable LineLength
28
28
 
29
29
  ##
30
- # # Ruby Client for Stackdriver Monitoring API ([Beta](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
30
+ # # Ruby Client for Stackdriver Monitoring API ([Beta](https://github.com/googleapis/google-cloud-ruby#versioning))
31
31
  #
32
32
  # [Stackdriver Monitoring API][Product Documentation]:
33
33
  # Manages your Stackdriver Monitoring data and configurations. Most projects
@@ -42,7 +42,7 @@ module Google
42
42
  # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
43
43
  # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
44
44
  # 3. [Enable the Stackdriver Monitoring API.](https://console.cloud.google.com/apis/library/monitoring.googleapis.com)
45
- # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
45
+ # 4. [Setup Authentication.](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
46
46
  #
47
47
  # ### Installation
48
48
  # ```
@@ -74,7 +74,7 @@ module Google
74
74
  # ### Next Steps
75
75
  # - Read the [Stackdriver Monitoring API Product documentation][Product Documentation]
76
76
  # to learn more about the product and see How-to Guides.
77
- # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
77
+ # - View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md)
78
78
  # to see the full list of Cloud APIs that we cover.
79
79
  #
80
80
  # [Product Documentation]: https://cloud.google.com/monitoring
@@ -83,7 +83,7 @@ module Google
83
83
  #
84
84
  # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
85
85
  # The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below,
86
- # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
86
+ # or a [`Google::Cloud::Logging::Logger`](https://googleapis.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
87
87
  # that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
88
88
  # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
89
89
  #
@@ -281,7 +281,7 @@ module Google
281
281
  # filtering](/monitoring/api/v3/sorting-and-filtering).
282
282
  # @param order_by [String]
283
283
  # A comma-separated list of fields by which to sort the result. Supports
284
- # the same set of field references as the +filter+ field. Entries can be
284
+ # the same set of field references as the `filter` field. Entries can be
285
285
  # prefixed with a minus sign to sort by the field in descending order.
286
286
  #
287
287
  # For more details, see [sorting and
@@ -376,15 +376,15 @@ module Google
376
376
  #
377
377
  # @param name [String]
378
378
  # The project in which to create the alerting policy. The format is
379
- # +projects/[PROJECT_ID]+.
379
+ # `projects/[PROJECT_ID]`.
380
380
  #
381
381
  # Note that this field names the parent container in which the alerting
382
382
  # policy will be written, not the name of the created policy. The alerting
383
383
  # policy that is returned will have a name that contains a normalized
384
384
  # representation of this name as a prefix but adds a suffix of the form
385
- # +/alertPolicies/[POLICY_ID]+, identifying the policy in the container.
385
+ # `/alertPolicies/[POLICY_ID]`, identifying the policy in the container.
386
386
  # @param alert_policy [Google::Monitoring::V3::AlertPolicy | Hash]
387
- # The requested alerting policy. You should omit the +name+ field in this
387
+ # The requested alerting policy. You should omit the `name` field in this
388
388
  # policy. The name will be returned in the new policy, including
389
389
  # a new [ALERT_POLICY_ID] value.
390
390
  # A hash of the same form as `Google::Monitoring::V3::AlertPolicy`
@@ -403,7 +403,7 @@ module Google
403
403
  # alert_policy_service_client = Google::Cloud::Monitoring::AlertPolicy.new(version: :v3)
404
404
  # formatted_name = Google::Cloud::Monitoring::V3::AlertPolicyServiceClient.project_path("[PROJECT]")
405
405
  #
406
- # # TODO: Initialize +alert_policy+:
406
+ # # TODO: Initialize `alert_policy`:
407
407
  # alert_policy = {}
408
408
  # response = alert_policy_service_client.create_alert_policy(formatted_name, alert_policy)
409
409
 
@@ -456,38 +456,38 @@ module Google
456
456
 
457
457
  # Updates an alerting policy. You can either replace the entire policy with
458
458
  # a new one or replace only certain fields in the current alerting policy by
459
- # specifying the fields to be updated via +updateMask+. Returns the
459
+ # specifying the fields to be updated via `updateMask`. Returns the
460
460
  # updated alerting policy.
461
461
  #
462
462
  # @param alert_policy [Google::Monitoring::V3::AlertPolicy | Hash]
463
463
  # Required. The updated alerting policy or the updated values for the
464
- # fields listed in +update_mask+.
465
- # If +update_mask+ is not empty, any fields in this policy that are
466
- # not in +update_mask+ are ignored.
464
+ # fields listed in `update_mask`.
465
+ # If `update_mask` is not empty, any fields in this policy that are
466
+ # not in `update_mask` are ignored.
467
467
  # A hash of the same form as `Google::Monitoring::V3::AlertPolicy`
468
468
  # can also be provided.
469
469
  # @param update_mask [Google::Protobuf::FieldMask | Hash]
470
470
  # Optional. A list of alerting policy field names. If this field is not
471
471
  # empty, each listed field in the existing alerting policy is set to the
472
- # value of the corresponding field in the supplied policy (+alert_policy+),
472
+ # value of the corresponding field in the supplied policy (`alert_policy`),
473
473
  # or to the field's default value if the field is not in the supplied
474
474
  # alerting policy. Fields not listed retain their previous value.
475
475
  #
476
- # Examples of valid field masks include +display_name+, +documentation+,
477
- # +documentation.content+, +documentation.mime_type+, +user_labels+,
478
- # +user_label.nameofkey+, +enabled+, +conditions+, +combiner+, etc.
476
+ # Examples of valid field masks include `display_name`, `documentation`,
477
+ # `documentation.content`, `documentation.mime_type`, `user_labels`,
478
+ # `user_label.nameofkey`, `enabled`, `conditions`, `combiner`, etc.
479
479
  #
480
480
  # If this field is empty, then the supplied alerting policy replaces the
481
481
  # existing policy. It is the same as deleting the existing policy and
482
482
  # adding the supplied policy, except for the following:
483
483
  #
484
- # * The new policy will have the same +[ALERT_POLICY_ID]+ as the former
484
+ # * The new policy will have the same `[ALERT_POLICY_ID]` as the former
485
485
  # policy. This gives you continuity with the former policy in your
486
486
  # notifications and incidents.
487
- # * Conditions in the new policy will keep their former +[CONDITION_ID]+ if
488
- # the supplied condition includes the +name+ field with that
489
- # +[CONDITION_ID]+. If the supplied condition omits the +name+ field,
490
- # then a new +[CONDITION_ID]+ is created.
487
+ # * Conditions in the new policy will keep their former `[CONDITION_ID]` if
488
+ # the supplied condition includes the `name` field with that
489
+ # `[CONDITION_ID]`. If the supplied condition omits the `name` field,
490
+ # then a new `[CONDITION_ID]` is created.
491
491
  # A hash of the same form as `Google::Protobuf::FieldMask`
492
492
  # can also be provided.
493
493
  # @param options [Google::Gax::CallOptions]
@@ -503,7 +503,7 @@ module Google
503
503
  #
504
504
  # alert_policy_service_client = Google::Cloud::Monitoring::AlertPolicy.new(version: :v3)
505
505
  #
506
- # # TODO: Initialize +alert_policy+:
506
+ # # TODO: Initialize `alert_policy`:
507
507
  # alert_policy = {}
508
508
  # response = alert_policy_service_client.update_alert_policy(alert_policy)
509
509
 
@@ -29,13 +29,13 @@ module Google
29
29
  #
30
30
  # Although it is not forbidden, it is generally a bad idea to include
31
31
  # non-finite values (infinities or NaNs) in the population of values, as this
32
- # will render the +mean+ and +sum_of_squared_deviation+ fields meaningless.
32
+ # will render the `mean` and `sum_of_squared_deviation` fields meaningless.
33
33
  # @!attribute [rw] count
34
34
  # @return [Integer]
35
35
  # The number of values in the population. Must be non-negative.
36
36
  # @!attribute [rw] mean
37
37
  # @return [Float]
38
- # The arithmetic mean of the values in the population. If +count+ is zero
38
+ # The arithmetic mean of the values in the population. If `count` is zero
39
39
  # then this field must be zero.
40
40
  # @!attribute [rw] sum_of_squared_deviation
41
41
  # @return [Float]
@@ -47,26 +47,26 @@ module Google
47
47
  # Knuth, "The Art of Computer Programming", Vol. 2, page 323, 3rd edition
48
48
  # describes Welford's method for accumulating this sum in one pass.
49
49
  #
50
- # If +count+ is zero then this field must be zero.
50
+ # If `count` is zero then this field must be zero.
51
51
  # @!attribute [rw] range
52
52
  # @return [Google::Api::Distribution::Range]
53
53
  # If specified, contains the range of the population values. The field
54
- # must not be present if the +count+ is zero.
54
+ # must not be present if the `count` is zero.
55
55
  # @!attribute [rw] bucket_options
56
56
  # @return [Google::Api::Distribution::BucketOptions]
57
57
  # Defines the histogram bucket boundaries.
58
58
  # @!attribute [rw] bucket_counts
59
59
  # @return [Array<Integer>]
60
- # If +bucket_options+ is given, then the sum of the values in +bucket_counts+
61
- # must equal the value in +count+. If +bucket_options+ is not given, no
62
- # +bucket_counts+ fields may be given.
60
+ # If `bucket_options` is given, then the sum of the values in `bucket_counts`
61
+ # must equal the value in `count`. If `bucket_options` is not given, no
62
+ # `bucket_counts` fields may be given.
63
63
  #
64
64
  # Bucket counts are given in order under the numbering scheme described
65
65
  # above (the underflow bucket has number 0; the finite buckets, if any,
66
66
  # have numbers 1 through N-2; the overflow bucket has number N-1).
67
67
  #
68
- # The size of +bucket_counts+ must be no greater than N as defined in
69
- # +bucket_options+.
68
+ # The size of `bucket_counts` must be no greater than N as defined in
69
+ # `bucket_options`.
70
70
  #
71
71
  # Any suffix of trailing zero bucket_count fields may be omitted.
72
72
  class Distribution
@@ -80,9 +80,9 @@ module Google
80
80
  class Range; end
81
81
 
82
82
  # A Distribution may optionally contain a histogram of the values in the
83
- # population. The histogram is given in +bucket_counts+ as counts of values
83
+ # population. The histogram is given in `bucket_counts` as counts of values
84
84
  # that fall into one of a sequence of non-overlapping buckets. The sequence
85
- # of buckets is described by +bucket_options+.
85
+ # of buckets is described by `bucket_options`.
86
86
  #
87
87
  # A bucket specifies an inclusive lower bound and exclusive upper bound for
88
88
  # the values that are counted for that bucket. The upper bound of a bucket
@@ -97,11 +97,11 @@ module Google
97
97
  # +infinity. The finite buckets are so-called because both bounds are
98
98
  # finite.
99
99
  #
100
- # +BucketOptions+ describes bucket boundaries in one of three ways. Two
100
+ # `BucketOptions` describes bucket boundaries in one of three ways. Two
101
101
  # describe the boundaries by giving parameters for a formula to generate
102
102
  # boundaries and one gives the bucket boundaries explicitly.
103
103
  #
104
- # If +bucket_boundaries+ is not given, then no +bucket_counts+ may be given.
104
+ # If `bucket_boundaries` is not given, then no `bucket_counts` may be given.
105
105
  # @!attribute [rw] linear_buckets
106
106
  # @return [Google::Api::Distribution::BucketOptions::Linear]
107
107
  # The linear bucket.
@@ -116,8 +116,8 @@ module Google
116
116
  # overflow and underflow). Each bucket represents a constant absolute
117
117
  # uncertainty on the specific value in the bucket.
118
118
  #
119
- # Defines +num_finite_buckets + 2+ (= N) buckets with these boundaries for
120
- # bucket +i+:
119
+ # Defines `num_finite_buckets + 2` (= N) buckets with these boundaries for
120
+ # bucket `i`:
121
121
  #
122
122
  # Upper bound (0 <= i < N-1): offset + (width * i).
123
123
  # Lower bound (1 <= i < N): offset + (width * (i - 1)).
@@ -136,7 +136,7 @@ module Google
136
136
  # the value of the lower bound. Each bucket represents a constant relative
137
137
  # uncertainty on a specific value in the bucket.
138
138
  #
139
- # Defines +num_finite_buckets + 2+ (= N) buckets with these boundaries for
139
+ # Defines `num_finite_buckets + 2` (= N) buckets with these boundaries for
140
140
  # bucket i:
141
141
  #
142
142
  # Upper bound (0 <= i < N-1): scale * (growth_factor ^ i).
@@ -154,13 +154,13 @@ module Google
154
154
 
155
155
  # A set of buckets with arbitrary widths.
156
156
  #
157
- # Defines +size(bounds) + 1+ (= N) buckets with these boundaries for
157
+ # Defines `size(bounds) + 1` (= N) buckets with these boundaries for
158
158
  # bucket i:
159
159
  #
160
160
  # Upper bound (0 <= i < N-1): bounds[i]
161
161
  # Lower bound (1 <= i < N); bounds[i - 1]
162
162
  #
163
- # There must be at least one element in +bounds+. If +bounds+ has only one
163
+ # There must be at least one element in `bounds`. If `bounds` has only one
164
164
  # element, there are no finite buckets, and that single element is the
165
165
  # common boundary of the overflow and underflow buckets.
166
166
  # @!attribute [rw] bounds
@@ -24,73 +24,74 @@ module Google
24
24
  # @!attribute [rw] type
25
25
  # @return [String]
26
26
  # The metric type, including its DNS name prefix. The type is not
27
- # URL-encoded. All user-defined custom metric types have the DNS name
28
- # +custom.googleapis.com+. Metric types should use a natural hierarchical
29
- # grouping. For example:
27
+ # URL-encoded. All user-defined metric types have the DNS name
28
+ # `custom.googleapis.com` or `external.googleapis.com`. Metric types should
29
+ # use a natural hierarchical grouping. For example:
30
30
  #
31
31
  # "custom.googleapis.com/invoice/paid/amount"
32
+ # "external.googleapis.com/prometheus/up"
32
33
  # "appengine.googleapis.com/http/server/response_latencies"
33
34
  # @!attribute [rw] labels
34
35
  # @return [Array<Google::Api::LabelDescriptor>]
35
36
  # The set of labels that can be used to describe a specific
36
37
  # instance of this metric type. For example, the
37
- # +appengine.googleapis.com/http/server/response_latencies+ metric
38
- # type has a label for the HTTP response code, +response_code+, so
38
+ # `appengine.googleapis.com/http/server/response_latencies` metric
39
+ # type has a label for the HTTP response code, `response_code`, so
39
40
  # you can look at latencies for successful responses or just
40
41
  # for responses that failed.
41
42
  # @!attribute [rw] metric_kind
42
43
  # @return [Google::Api::MetricDescriptor::MetricKind]
43
44
  # Whether the metric records instantaneous values, changes to a value, etc.
44
- # Some combinations of +metric_kind+ and +value_type+ might not be supported.
45
+ # Some combinations of `metric_kind` and `value_type` might not be supported.
45
46
  # @!attribute [rw] value_type
46
47
  # @return [Google::Api::MetricDescriptor::ValueType]
47
48
  # Whether the measurement is an integer, a floating-point number, etc.
48
- # Some combinations of +metric_kind+ and +value_type+ might not be supported.
49
+ # Some combinations of `metric_kind` and `value_type` might not be supported.
49
50
  # @!attribute [rw] unit
50
51
  # @return [String]
51
52
  # The unit in which the metric value is reported. It is only applicable
52
- # if the +value_type+ is +INT64+, +DOUBLE+, or +DISTRIBUTION+. The
53
+ # if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The
53
54
  # supported units are a subset of [The Unified Code for Units of
54
55
  # Measure](http://unitsofmeasure.org/ucum.html) standard:
55
56
  #
56
57
  # **Basic units (UNIT)**
57
58
  #
58
- # * +bit+ bit
59
- # * +By+ byte
60
- # * +s+ second
61
- # * +min+ minute
62
- # * +h+ hour
63
- # * +d+ day
59
+ # * `bit` bit
60
+ # * `By` byte
61
+ # * `s` second
62
+ # * `min` minute
63
+ # * `h` hour
64
+ # * `d` day
64
65
  #
65
66
  # **Prefixes (PREFIX)**
66
67
  #
67
- # * +k+ kilo (10**3)
68
- # * +M+ mega (10**6)
69
- # * +G+ giga (10**9)
70
- # * +T+ tera (10**12)
71
- # * +P+ peta (10**15)
72
- # * +E+ exa (10**18)
73
- # * +Z+ zetta (10**21)
74
- # * +Y+ yotta (10**24)
75
- # * +m+ milli (10**-3)
76
- # * +u+ micro (10**-6)
77
- # * +n+ nano (10**-9)
78
- # * +p+ pico (10**-12)
79
- # * +f+ femto (10**-15)
80
- # * +a+ atto (10**-18)
81
- # * +z+ zepto (10**-21)
82
- # * +y+ yocto (10**-24)
83
- # * +Ki+ kibi (2**10)
84
- # * +Mi+ mebi (2**20)
85
- # * +Gi+ gibi (2**30)
86
- # * +Ti+ tebi (2**40)
68
+ # * `k` kilo (10**3)
69
+ # * `M` mega (10**6)
70
+ # * `G` giga (10**9)
71
+ # * `T` tera (10**12)
72
+ # * `P` peta (10**15)
73
+ # * `E` exa (10**18)
74
+ # * `Z` zetta (10**21)
75
+ # * `Y` yotta (10**24)
76
+ # * `m` milli (10**-3)
77
+ # * `u` micro (10**-6)
78
+ # * `n` nano (10**-9)
79
+ # * `p` pico (10**-12)
80
+ # * `f` femto (10**-15)
81
+ # * `a` atto (10**-18)
82
+ # * `z` zepto (10**-21)
83
+ # * `y` yocto (10**-24)
84
+ # * `Ki` kibi (2**10)
85
+ # * `Mi` mebi (2**20)
86
+ # * `Gi` gibi (2**30)
87
+ # * `Ti` tebi (2**40)
87
88
  #
88
89
  # **Grammar**
89
90
  #
90
91
  # The grammar also includes these connectors:
91
92
  #
92
- # * +/+ division (as an infix operator, e.g. +1/s+).
93
- # * +.+ multiplication (as an infix operator, e.g. +GBy.d+)
93
+ # * `/` division (as an infix operator, e.g. `1/s`).
94
+ # * `.` multiplication (as an infix operator, e.g. `GBy.d`)
94
95
  #
95
96
  # The grammar for a unit is as follows:
96
97
  #
@@ -105,13 +106,13 @@ module Google
105
106
  #
106
107
  # Notes:
107
108
  #
108
- # * +Annotation+ is just a comment if it follows a +UNIT+ and is
109
- # equivalent to +1+ if it is used alone. For examples,
110
- # +\\{requests}/s == 1/s+, +By\\{transmitted}/s == By/s+.
111
- # * +NAME+ is a sequence of non-blank printable ASCII characters not
109
+ # * `Annotation` is just a comment if it follows a `UNIT` and is
110
+ # equivalent to `1` if it is used alone. For examples,
111
+ # `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.
112
+ # * `NAME` is a sequence of non-blank printable ASCII characters not
112
113
  # containing '{' or '}'.
113
- # * +1+ represents dimensionless value 1, such as in +1/s+.
114
- # * +%+ represents dimensionless value 1/100, and annotates values giving
114
+ # * `1` represents dimensionless value 1, such as in `1/s`.
115
+ # * `%` represents dimensionless value 1/100, and annotates values giving
115
116
  # a percentage.
116
117
  # @!attribute [rw] description
117
118
  # @return [String]
@@ -122,7 +123,27 @@ module Google
122
123
  # Use sentence case without an ending period, for example "Request count".
123
124
  # This field is optional but it is recommended to be set for any metrics
124
125
  # associated with user-visible concepts, such as Quota.
126
+ # @!attribute [rw] metadata
127
+ # @return [Google::Api::MetricDescriptor::MetricDescriptorMetadata]
128
+ # Optional. Metadata which can be used to guide usage of the metric.
125
129
  class MetricDescriptor
130
+ # Additional annotations that can be used to guide the usage of a metric.
131
+ # @!attribute [rw] launch_stage
132
+ # @return [Google::Api::LaunchStage]
133
+ # The launch stage of the metric definition.
134
+ # @!attribute [rw] sample_period
135
+ # @return [Google::Protobuf::Duration]
136
+ # The sampling period of metric data points. For metrics which are written
137
+ # periodically, consecutive data points are stored at this time interval,
138
+ # excluding data loss due to errors. Metrics with a higher granularity have
139
+ # a smaller sampling period.
140
+ # @!attribute [rw] ingest_delay
141
+ # @return [Google::Protobuf::Duration]
142
+ # The delay of data points caused by ingestion. Data points older than this
143
+ # age are guaranteed to be ingested and available to be read, excluding
144
+ # data loss due to errors.
145
+ class MetricDescriptorMetadata; end
146
+
126
147
  # The kind of measurement. It describes how the data is reported.
127
148
  module MetricKind
128
149
  # Do not use this default value.
@@ -148,7 +169,7 @@ module Google
148
169
  VALUE_TYPE_UNSPECIFIED = 0
149
170
 
150
171
  # The value is a boolean.
151
- # This value type can be used only if the metric kind is +GAUGE+.
172
+ # This value type can be used only if the metric kind is `GAUGE`.
152
173
  BOOL = 1
153
174
 
154
175
  # The value is a signed 64-bit integer.
@@ -158,10 +179,10 @@ module Google
158
179
  DOUBLE = 3
159
180
 
160
181
  # The value is a text string.
161
- # This value type can be used only if the metric kind is +GAUGE+.
182
+ # This value type can be used only if the metric kind is `GAUGE`.
162
183
  STRING = 4
163
184
 
164
- # The value is a {Google::Api::Distribution +Distribution+}.
185
+ # The value is a {Google::Api::Distribution `Distribution`}.
165
186
  DISTRIBUTION = 5
166
187
 
167
188
  # The value is money.
@@ -170,15 +191,15 @@ module Google
170
191
  end
171
192
 
172
193
  # A specific metric, identified by specifying values for all of the
173
- # labels of a {Google::Api::MetricDescriptor +MetricDescriptor+}.
194
+ # labels of a {Google::Api::MetricDescriptor `MetricDescriptor`}.
174
195
  # @!attribute [rw] type
175
196
  # @return [String]
176
197
  # An existing metric type, see {Google::Api::MetricDescriptor}.
177
- # For example, +custom.googleapis.com/invoice/paid/amount+.
198
+ # For example, `custom.googleapis.com/invoice/paid/amount`.
178
199
  # @!attribute [rw] labels
179
200
  # @return [Hash{String => String}]
180
201
  # The set of label values that uniquely identify this metric. All
181
- # labels listed in the +MetricDescriptor+ must be assigned values.
202
+ # labels listed in the `MetricDescriptor` must be assigned values.
182
203
  class Metric; end
183
204
  end
184
205
  end