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
@@ -334,7 +334,7 @@ module Google
334
334
  #
335
335
  # @param name [String]
336
336
  # The channel type for which to execute the request. The format is
337
- # +projects/[PROJECT_ID]/notificationChannelDescriptors/\\{channel_type}+.
337
+ # `projects/[PROJECT_ID]/notificationChannelDescriptors/{channel_type}`.
338
338
  # @param options [Google::Gax::CallOptions]
339
339
  # Overrides the default settings for this call, e.g, timeout,
340
340
  # retries, etc.
@@ -365,11 +365,11 @@ module Google
365
365
  #
366
366
  # @param name [String]
367
367
  # The project on which to execute the request. The format is
368
- # +projects/[PROJECT_ID]+. That is, this names the container
368
+ # `projects/[PROJECT_ID]`. That is, this names the container
369
369
  # in which to look for the notification channels; it does not name a
370
370
  # specific channel. To query a specific channel by REST resource name, use
371
371
  # the
372
- # {Google::Monitoring::V3::NotificationChannelService::GetNotificationChannel +GetNotificationChannel+} operation.
372
+ # {Google::Monitoring::V3::NotificationChannelService::GetNotificationChannel `GetNotificationChannel`} operation.
373
373
  # @param filter [String]
374
374
  # If provided, this field specifies the criteria that must be met by
375
375
  # notification channels to be included in the response.
@@ -378,7 +378,7 @@ module Google
378
378
  # filtering](/monitoring/api/v3/sorting-and-filtering).
379
379
  # @param order_by [String]
380
380
  # A comma-separated list of fields by which to sort the result. Supports
381
- # the same set of fields as in +filter+. Entries can be prefixed with
381
+ # the same set of fields as in `filter`. Entries can be prefixed with
382
382
  # a minus sign to sort in descending rather than ascending order.
383
383
  #
384
384
  # For more details, see [sorting and
@@ -445,7 +445,7 @@ module Google
445
445
  #
446
446
  # @param name [String]
447
447
  # The channel for which to execute the request. The format is
448
- # +projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]+.
448
+ # `projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]`.
449
449
  # @param options [Google::Gax::CallOptions]
450
450
  # Overrides the default settings for this call, e.g, timeout,
451
451
  # retries, etc.
@@ -483,9 +483,9 @@ module Google
483
483
  # Note that this names the container into which the channel will be
484
484
  # written. This does not name the newly created channel. The resulting
485
485
  # channel's name will have a normalized version of this field as a prefix,
486
- # but will add +/notificationChannels/[CHANNEL_ID]+ to identify the channel.
486
+ # but will add `/notificationChannels/[CHANNEL_ID]` to identify the channel.
487
487
  # @param notification_channel [Google::Monitoring::V3::NotificationChannel | Hash]
488
- # The definition of the +NotificationChannel+ to create.
488
+ # The definition of the `NotificationChannel` to create.
489
489
  # A hash of the same form as `Google::Monitoring::V3::NotificationChannel`
490
490
  # can also be provided.
491
491
  # @param options [Google::Gax::CallOptions]
@@ -502,7 +502,7 @@ module Google
502
502
  # notification_channel_service_client = Google::Cloud::Monitoring::NotificationChannel.new(version: :v3)
503
503
  # formatted_name = Google::Cloud::Monitoring::V3::NotificationChannelServiceClient.project_path("[PROJECT]")
504
504
  #
505
- # # TODO: Initialize +notification_channel+:
505
+ # # TODO: Initialize `notification_channel`:
506
506
  # notification_channel = {}
507
507
  # response = notification_channel_service_client.create_notification_channel(formatted_name, notification_channel)
508
508
 
@@ -526,7 +526,7 @@ module Google
526
526
  # A description of the changes to be applied to the specified
527
527
  # notification channel. The description must provide a definition for
528
528
  # fields to be updated; the names of these fields should also be
529
- # included in the +update_mask+.
529
+ # included in the `update_mask`.
530
530
  # A hash of the same form as `Google::Monitoring::V3::NotificationChannel`
531
531
  # can also be provided.
532
532
  # @param update_mask [Google::Protobuf::FieldMask | Hash]
@@ -546,7 +546,7 @@ module Google
546
546
  #
547
547
  # notification_channel_service_client = Google::Cloud::Monitoring::NotificationChannel.new(version: :v3)
548
548
  #
549
- # # TODO: Initialize +notification_channel+:
549
+ # # TODO: Initialize `notification_channel`:
550
550
  # notification_channel = {}
551
551
  # response = notification_channel_service_client.update_notification_channel(notification_channel)
552
552
 
@@ -567,7 +567,7 @@ module Google
567
567
  #
568
568
  # @param name [String]
569
569
  # The channel for which to execute the request. The format is
570
- # +projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]+.
570
+ # `projects/[PROJECT_ID]/notificationChannels/[CHANNEL_ID]`.
571
571
  # @param force [true, false]
572
572
  # If true, the notification channel will be deleted regardless of its
573
573
  # use in alert policies (the policies will be updated to remove the
@@ -255,7 +255,7 @@ module Google
255
255
  #
256
256
  # @param parent [String]
257
257
  # The project whose uptime check configurations are listed. The format
258
- # is +projects/[PROJECT_ID]+.
258
+ # is `projects/[PROJECT_ID]`.
259
259
  # @param page_size [Integer]
260
260
  # The maximum number of resources contained in the underlying API
261
261
  # response. If page streaming is performed per-resource, this
@@ -310,7 +310,7 @@ module Google
310
310
  #
311
311
  # @param name [String]
312
312
  # The uptime check configuration to retrieve. The format
313
- # is +projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]+.
313
+ # is `projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]`.
314
314
  # @param options [Google::Gax::CallOptions]
315
315
  # Overrides the default settings for this call, e.g, timeout,
316
316
  # retries, etc.
@@ -341,7 +341,7 @@ module Google
341
341
  #
342
342
  # @param parent [String]
343
343
  # The project in which to create the uptime check. The format
344
- # is +projects/[PROJECT_ID]+.
344
+ # is `projects/[PROJECT_ID]`.
345
345
  # @param uptime_check_config [Google::Monitoring::V3::UptimeCheckConfig | Hash]
346
346
  # The new uptime check configuration.
347
347
  # A hash of the same form as `Google::Monitoring::V3::UptimeCheckConfig`
@@ -360,7 +360,7 @@ module Google
360
360
  # uptime_check_service_client = Google::Cloud::Monitoring::UptimeCheck.new(version: :v3)
361
361
  # formatted_parent = Google::Cloud::Monitoring::V3::UptimeCheckServiceClient.project_path("[PROJECT]")
362
362
  #
363
- # # TODO: Initialize +uptime_check_config+:
363
+ # # TODO: Initialize `uptime_check_config`:
364
364
  # uptime_check_config = {}
365
365
  # response = uptime_check_service_client.create_uptime_check_config(formatted_parent, uptime_check_config)
366
366
 
@@ -379,21 +379,21 @@ module Google
379
379
 
380
380
  # Updates an uptime check configuration. You can either replace the entire
381
381
  # configuration with a new one or replace only certain fields in the current
382
- # configuration by specifying the fields to be updated via +"updateMask"+.
382
+ # configuration by specifying the fields to be updated via `"updateMask"`.
383
383
  # Returns the updated configuration.
384
384
  #
385
385
  # @param uptime_check_config [Google::Monitoring::V3::UptimeCheckConfig | Hash]
386
- # Required. If an +"updateMask"+ has been specified, this field gives
387
- # the values for the set of fields mentioned in the +"updateMask"+. If an
388
- # +"updateMask"+ has not been given, this uptime check configuration replaces
389
- # the current configuration. If a field is mentioned in +"updateMask"+ but
386
+ # Required. If an `"updateMask"` has been specified, this field gives
387
+ # the values for the set of fields mentioned in the `"updateMask"`. If an
388
+ # `"updateMask"` has not been given, this uptime check configuration replaces
389
+ # the current configuration. If a field is mentioned in `"updateMask"` but
390
390
  # the corresonding field is omitted in this partial uptime check
391
391
  # configuration, it has the effect of deleting/clearing the field from the
392
392
  # configuration on the server.
393
393
  #
394
- # The following fields can be updated: +display_name+,
395
- # +http_check+, +tcp_check+, +timeout+, +content_matchers+, and
396
- # +selected_regions+.
394
+ # The following fields can be updated: `display_name`,
395
+ # `http_check`, `tcp_check`, `timeout`, `content_matchers`, and
396
+ # `selected_regions`.
397
397
  # A hash of the same form as `Google::Monitoring::V3::UptimeCheckConfig`
398
398
  # can also be provided.
399
399
  # @param update_mask [Google::Protobuf::FieldMask | Hash]
@@ -416,7 +416,7 @@ module Google
416
416
  #
417
417
  # uptime_check_service_client = Google::Cloud::Monitoring::UptimeCheck.new(version: :v3)
418
418
  #
419
- # # TODO: Initialize +uptime_check_config+:
419
+ # # TODO: Initialize `uptime_check_config`:
420
420
  # uptime_check_config = {}
421
421
  # response = uptime_check_service_client.update_uptime_check_config(uptime_check_config)
422
422
 
@@ -439,7 +439,7 @@ module Google
439
439
  #
440
440
  # @param name [String]
441
441
  # The uptime check configuration to delete. The format
442
- # is +projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]+.
442
+ # is `projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID]`.
443
443
  # @param options [Google::Gax::CallOptions]
444
444
  # Overrides the default settings for this call, e.g, timeout,
445
445
  # retries, etc.
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-monitoring
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.29.1
4
+ version: 0.29.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2018-09-10 00:00:00.000000000 Z
11
+ date: 2018-09-21 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-gax
@@ -148,7 +148,6 @@ files:
148
148
  - lib/google/cloud/monitoring/v3/doc/google/protobuf/timestamp.rb
149
149
  - lib/google/cloud/monitoring/v3/doc/google/protobuf/wrappers.rb
150
150
  - lib/google/cloud/monitoring/v3/doc/google/rpc/status.rb
151
- - lib/google/cloud/monitoring/v3/doc/overview.rb
152
151
  - lib/google/cloud/monitoring/v3/group_service_client.rb
153
152
  - lib/google/cloud/monitoring/v3/group_service_client_config.json
154
153
  - lib/google/cloud/monitoring/v3/metric_service_client.rb
@@ -176,7 +175,7 @@ files:
176
175
  - lib/google/monitoring/v3/uptime_pb.rb
177
176
  - lib/google/monitoring/v3/uptime_service_pb.rb
178
177
  - lib/google/monitoring/v3/uptime_service_services_pb.rb
179
- homepage: https://github.com/GoogleCloudPlatform/google-cloud-ruby/tree/master/google-cloud-monitoring
178
+ homepage: https://github.com/googleapis/google-cloud-ruby/tree/master/google-cloud-monitoring
180
179
  licenses:
181
180
  - Apache-2.0
182
181
  metadata: {}
@@ -1,104 +0,0 @@
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
-
16
- module Google
17
- module Cloud
18
- # rubocop:disable LineLength
19
-
20
- ##
21
- # # Ruby Client for Stackdriver Monitoring API ([Beta](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
22
- #
23
- # [Stackdriver Monitoring API][Product Documentation]:
24
- # Manages your Stackdriver Monitoring data and configurations. Most projects
25
- # must be associated with a Stackdriver account, with a few exceptions as
26
- # noted on the individual method pages.
27
- # - [Product Documentation][]
28
- #
29
- # ## Quick Start
30
- # In order to use this library, you first need to go through the following
31
- # steps:
32
- #
33
- # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
34
- # 2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project)
35
- # 3. [Enable the Stackdriver Monitoring API.](https://console.cloud.google.com/apis/library/monitoring.googleapis.com)
36
- # 4. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
37
- #
38
- # ### Installation
39
- # ```
40
- # $ gem install google-cloud-monitoring
41
- # ```
42
- #
43
- # ### Preview
44
- # #### MetricServiceClient
45
- # ```rb
46
- # require "google/cloud/monitoring"
47
- #
48
- # metric_service_client = Google::Cloud::Monitoring::Metric.new
49
- # formatted_name = Google::Cloud::Monitoring::V3::MetricServiceClient.project_path(project_id)
50
- #
51
- # # Iterate over all results.
52
- # metric_service_client.list_monitored_resource_descriptors(formatted_name).each do |element|
53
- # # Process element.
54
- # end
55
- #
56
- # # Or iterate over results one page at a time.
57
- # metric_service_client.list_monitored_resource_descriptors(formatted_name).each_page do |page|
58
- # # Process each page at a time.
59
- # page.each do |element|
60
- # # Process element.
61
- # end
62
- # end
63
- # ```
64
- #
65
- # ### Next Steps
66
- # - Read the [Stackdriver Monitoring API Product documentation][Product Documentation]
67
- # to learn more about the product and see How-to Guides.
68
- # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
69
- # to see the full list of Cloud APIs that we cover.
70
- #
71
- # [Product Documentation]: https://cloud.google.com/monitoring
72
- #
73
- # ## Enabling Logging
74
- #
75
- # To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
76
- # 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,
77
- # or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
78
- # 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)
79
- # and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
80
- #
81
- # Configuring a Ruby stdlib logger:
82
- #
83
- # ```ruby
84
- # require "logger"
85
- #
86
- # module MyLogger
87
- # LOGGER = Logger.new $stderr, level: Logger::WARN
88
- # def logger
89
- # LOGGER
90
- # end
91
- # end
92
- #
93
- # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
94
- # module GRPC
95
- # extend MyLogger
96
- # end
97
- # ```
98
- #
99
- module Monitoring
100
- module V3
101
- end
102
- end
103
- end
104
- end