google-cloud-monitoring-dashboard-v1 1.0.1 → 1.2.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8602f4c37961d5d6993afdc16884ae442cb3bf3fb1b31dda8208cfd7c14df3a6
4
- data.tar.gz: d53a9ac4ae6750f48d9bc4bbe75435baebea1244bd593edab7ed66c6d864b2f1
3
+ metadata.gz: ff21b27ddbca357b05c629c3005548217f90ccac3c860bcdc691e7d2d280cafb
4
+ data.tar.gz: 909c87244c5afa90890efad0270d0fb5bfc4f531bc553876ad1266cac2dbe0f9
5
5
  SHA512:
6
- metadata.gz: ee562bb2f643af8c0c100160c4c5eb19e1427a579923c709aa44b11282d1a1f0e48cc5e113fac42275be51fdf98bfebdd51d5e534b13b0fd7cdcc9d0ba63ff81
7
- data.tar.gz: ffb17056ccfd2a291beb04c875d4e557d12fbfa22303049551978d46c4898c1c6cb993b148e3f6b38bdabce0d5097f193597d4a22b4421595f20c18062ac25bf
6
+ metadata.gz: 2908967d772f0693aa7525a3c0e18ba14699ccdedf67ff755a98170a28298f072e01bfe52a6664fead4e13192da9d223b63b53635b0b09c28aa98ff7c3909fe5
7
+ data.tar.gz: e0814a484424880bb0cc048459366f4f772b4dbdf6df0d862106fa7581dd523428e1d068e677836c983b778915ccd2afe7b0e985478dda0d3cda51881841dc24
data/README.md CHANGED
@@ -43,40 +43,50 @@ for class and method documentation.
43
43
  See also the [Product Documentation](https://cloud.google.com/monitoring)
44
44
  for general usage information.
45
45
 
46
- ## Enabling Logging
47
-
48
- To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
49
- The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
50
- or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
51
- that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
52
- and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
53
-
54
- Configuring a Ruby stdlib logger:
46
+ ## Debug Logging
47
+
48
+ This library comes with opt-in Debug Logging that can help you troubleshoot
49
+ your application's integration with the API. When logging is activated, key
50
+ events such as requests and responses, along with data payloads and metadata
51
+ such as headers and client configuration, are logged to the standard error
52
+ stream.
53
+
54
+ **WARNING:** Client Library Debug Logging includes your data payloads in
55
+ plaintext, which could include sensitive data such as PII for yourself or your
56
+ customers, private keys, or other security data that could be compromising if
57
+ leaked. Always practice good data hygiene with your application logs, and follow
58
+ the principle of least access. Google also recommends that Client Library Debug
59
+ Logging be enabled only temporarily during active debugging, and not used
60
+ permanently in production.
61
+
62
+ To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
63
+ to the value `all`. Alternatively, you can set the value to a comma-delimited
64
+ list of client library gem names. This will select the default logging behavior,
65
+ which writes logs to the standard error stream. On a local workstation, this may
66
+ result in logs appearing on the console. When running on a Google Cloud hosting
67
+ service such as [Google Cloud Run](https://cloud.google.com/run), this generally
68
+ results in logs appearing alongside your application logs in the
69
+ [Google Cloud Logging](https://cloud.google.com/logging/) service.
70
+
71
+ You can customize logging by modifying the `logger` configuration when
72
+ constructing a client object. For example:
55
73
 
56
74
  ```ruby
75
+ require "google/cloud/monitoring/dashboard/v1"
57
76
  require "logger"
58
77
 
59
- module MyLogger
60
- LOGGER = Logger.new $stderr, level: Logger::WARN
61
- def logger
62
- LOGGER
63
- end
64
- end
65
-
66
- # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
67
- module GRPC
68
- extend MyLogger
78
+ client = ::Google::Cloud::Monitoring::Dashboard::V1::DashboardsService::Client.new do |config|
79
+ config.logger = Logger.new "my-app.log"
69
80
  end
70
81
  ```
71
82
 
72
-
73
83
  ## Google Cloud Samples
74
84
 
75
85
  To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
76
86
 
77
87
  ## Supported Ruby Versions
78
88
 
79
- This library is supported on Ruby 2.7+.
89
+ This library is supported on Ruby 3.0+.
80
90
 
81
91
  Google provides official support for Ruby versions that are actively supported
82
92
  by Ruby Core—that is, Ruby versions that are either in normal maintenance or
@@ -170,8 +170,28 @@ module Google
170
170
  universe_domain: @config.universe_domain,
171
171
  channel_args: @config.channel_args,
172
172
  interceptors: @config.interceptors,
173
- channel_pool_config: @config.channel_pool
173
+ channel_pool_config: @config.channel_pool,
174
+ logger: @config.logger
174
175
  )
176
+
177
+ @dashboards_service_stub.stub_logger&.info do |entry|
178
+ entry.set_system_name
179
+ entry.set_service
180
+ entry.message = "Created client for #{entry.service}"
181
+ entry.set_credentials_fields credentials
182
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
183
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
184
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
185
+ end
186
+ end
187
+
188
+ ##
189
+ # The logger used for request/response debug logging.
190
+ #
191
+ # @return [Logger]
192
+ #
193
+ def logger
194
+ @dashboards_service_stub.logger
175
195
  end
176
196
 
177
197
  # Service calls
@@ -270,7 +290,6 @@ module Google
270
290
 
271
291
  @dashboards_service_stub.call_rpc :create_dashboard, request, options: options do |response, operation|
272
292
  yield response, operation if block_given?
273
- return response
274
293
  end
275
294
  rescue ::GRPC::BadStatus => e
276
295
  raise ::Google::Cloud::Error.from_error(e)
@@ -375,7 +394,7 @@ module Google
375
394
  @dashboards_service_stub.call_rpc :list_dashboards, request, options: options do |response, operation|
376
395
  response = ::Gapic::PagedEnumerable.new @dashboards_service_stub, :list_dashboards, request, response, operation, options
377
396
  yield response, operation if block_given?
378
- return response
397
+ throw :response, response
379
398
  end
380
399
  rescue ::GRPC::BadStatus => e
381
400
  raise ::Google::Cloud::Error.from_error(e)
@@ -469,7 +488,6 @@ module Google
469
488
 
470
489
  @dashboards_service_stub.call_rpc :get_dashboard, request, options: options do |response, operation|
471
490
  yield response, operation if block_given?
472
- return response
473
491
  end
474
492
  rescue ::GRPC::BadStatus => e
475
493
  raise ::Google::Cloud::Error.from_error(e)
@@ -561,7 +579,6 @@ module Google
561
579
 
562
580
  @dashboards_service_stub.call_rpc :delete_dashboard, request, options: options do |response, operation|
563
581
  yield response, operation if block_given?
564
- return response
565
582
  end
566
583
  rescue ::GRPC::BadStatus => e
567
584
  raise ::Google::Cloud::Error.from_error(e)
@@ -654,7 +671,6 @@ module Google
654
671
 
655
672
  @dashboards_service_stub.call_rpc :update_dashboard, request, options: options do |response, operation|
656
673
  yield response, operation if block_given?
657
- return response
658
674
  end
659
675
  rescue ::GRPC::BadStatus => e
660
676
  raise ::Google::Cloud::Error.from_error(e)
@@ -704,6 +720,13 @@ module Google
704
720
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
705
721
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
706
722
  # * (`nil`) indicating no credentials
723
+ #
724
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
725
+ # external source for authentication to Google Cloud, you must validate it before
726
+ # providing it to a Google API client library. Providing an unvalidated credential
727
+ # configuration to Google APIs can compromise the security of your systems and data.
728
+ # For more information, refer to [Validate credential configurations from external
729
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
707
730
  # @return [::Object]
708
731
  # @!attribute [rw] scope
709
732
  # The OAuth scopes
@@ -743,6 +766,11 @@ module Google
743
766
  # default endpoint URL. The default value of nil uses the environment
744
767
  # universe (usually the default "googleapis.com" universe).
745
768
  # @return [::String,nil]
769
+ # @!attribute [rw] logger
770
+ # A custom logger to use for request/response debug logging, or the value
771
+ # `:default` (the default) to construct a default logger, or `nil` to
772
+ # explicitly disable logging.
773
+ # @return [::Logger,:default,nil]
746
774
  #
747
775
  class Configuration
748
776
  extend ::Gapic::Config
@@ -767,6 +795,7 @@ module Google
767
795
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
768
796
  config_attr :quota_project, nil, ::String, nil
769
797
  config_attr :universe_domain, nil, ::String, nil
798
+ config_attr :logger, :default, ::Logger, nil, :default
770
799
 
771
800
  # @private
772
801
  def initialize parent_config = nil
@@ -163,8 +163,28 @@ module Google
163
163
  endpoint: @config.endpoint,
164
164
  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
165
165
  universe_domain: @config.universe_domain,
166
- credentials: credentials
166
+ credentials: credentials,
167
+ logger: @config.logger
167
168
  )
169
+
170
+ @dashboards_service_stub.logger(stub: true)&.info do |entry|
171
+ entry.set_system_name
172
+ entry.set_service
173
+ entry.message = "Created client for #{entry.service}"
174
+ entry.set_credentials_fields credentials
175
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
176
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
177
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
178
+ end
179
+ end
180
+
181
+ ##
182
+ # The logger used for request/response debug logging.
183
+ #
184
+ # @return [Logger]
185
+ #
186
+ def logger
187
+ @dashboards_service_stub.logger
168
188
  end
169
189
 
170
190
  # Service calls
@@ -256,7 +276,6 @@ module Google
256
276
 
257
277
  @dashboards_service_stub.create_dashboard request, options do |result, operation|
258
278
  yield result, operation if block_given?
259
- return result
260
279
  end
261
280
  rescue ::Gapic::Rest::Error => e
262
281
  raise ::Google::Cloud::Error.from_error(e)
@@ -354,7 +373,7 @@ module Google
354
373
  @dashboards_service_stub.list_dashboards request, options do |result, operation|
355
374
  result = ::Gapic::Rest::PagedEnumerable.new @dashboards_service_stub, :list_dashboards, "dashboards", request, result, options
356
375
  yield result, operation if block_given?
357
- return result
376
+ throw :response, result
358
377
  end
359
378
  rescue ::Gapic::Rest::Error => e
360
379
  raise ::Google::Cloud::Error.from_error(e)
@@ -441,7 +460,6 @@ module Google
441
460
 
442
461
  @dashboards_service_stub.get_dashboard request, options do |result, operation|
443
462
  yield result, operation if block_given?
444
- return result
445
463
  end
446
464
  rescue ::Gapic::Rest::Error => e
447
465
  raise ::Google::Cloud::Error.from_error(e)
@@ -526,7 +544,6 @@ module Google
526
544
 
527
545
  @dashboards_service_stub.delete_dashboard request, options do |result, operation|
528
546
  yield result, operation if block_given?
529
- return result
530
547
  end
531
548
  rescue ::Gapic::Rest::Error => e
532
549
  raise ::Google::Cloud::Error.from_error(e)
@@ -612,7 +629,6 @@ module Google
612
629
 
613
630
  @dashboards_service_stub.update_dashboard request, options do |result, operation|
614
631
  yield result, operation if block_given?
615
- return result
616
632
  end
617
633
  rescue ::Gapic::Rest::Error => e
618
634
  raise ::Google::Cloud::Error.from_error(e)
@@ -660,6 +676,13 @@ module Google
660
676
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
661
677
  # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
662
678
  # * (`nil`) indicating no credentials
679
+ #
680
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
681
+ # external source for authentication to Google Cloud, you must validate it before
682
+ # providing it to a Google API client library. Providing an unvalidated credential
683
+ # configuration to Google APIs can compromise the security of your systems and data.
684
+ # For more information, refer to [Validate credential configurations from external
685
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
663
686
  # @return [::Object]
664
687
  # @!attribute [rw] scope
665
688
  # The OAuth scopes
@@ -692,6 +715,11 @@ module Google
692
715
  # default endpoint URL. The default value of nil uses the environment
693
716
  # universe (usually the default "googleapis.com" universe).
694
717
  # @return [::String,nil]
718
+ # @!attribute [rw] logger
719
+ # A custom logger to use for request/response debug logging, or the value
720
+ # `:default` (the default) to construct a default logger, or `nil` to
721
+ # explicitly disable logging.
722
+ # @return [::Logger,:default,nil]
695
723
  #
696
724
  class Configuration
697
725
  extend ::Gapic::Config
@@ -713,6 +741,7 @@ module Google
713
741
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
714
742
  config_attr :quota_project, nil, ::String, nil
715
743
  config_attr :universe_domain, nil, ::String, nil
744
+ config_attr :logger, :default, ::Logger, nil, :default
716
745
 
717
746
  # @private
718
747
  def initialize parent_config = nil
@@ -31,7 +31,8 @@ module Google
31
31
  # including transcoding, making the REST call, and deserialing the response.
32
32
  #
33
33
  class ServiceStub
34
- def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
34
+ # @private
35
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
35
36
  # These require statements are intentionally placed here to initialize
36
37
  # the REST modules only when it's required.
37
38
  require "gapic/rest"
@@ -41,7 +42,9 @@ module Google
41
42
  universe_domain: universe_domain,
42
43
  credentials: credentials,
43
44
  numeric_enums: true,
44
- raise_faraday_errors: false
45
+ service_name: self.class,
46
+ raise_faraday_errors: false,
47
+ logger: logger
45
48
  end
46
49
 
47
50
  ##
@@ -62,6 +65,15 @@ module Google
62
65
  @client_stub.endpoint
63
66
  end
64
67
 
68
+ ##
69
+ # The logger used for request/response debug logging.
70
+ #
71
+ # @return [Logger]
72
+ #
73
+ def logger stub: false
74
+ stub ? @client_stub.stub_logger : @client_stub.logger
75
+ end
76
+
65
77
  ##
66
78
  # Baseline implementation for the create_dashboard REST call
67
79
  #
@@ -88,16 +100,18 @@ module Google
88
100
 
89
101
  response = @client_stub.make_http_request(
90
102
  verb,
91
- uri: uri,
92
- body: body || "",
93
- params: query_string_params,
103
+ uri: uri,
104
+ body: body || "",
105
+ params: query_string_params,
106
+ method_name: "create_dashboard",
94
107
  options: options
95
108
  )
96
109
  operation = ::Gapic::Rest::TransportOperation.new response
97
110
  result = ::Google::Cloud::Monitoring::Dashboard::V1::Dashboard.decode_json response.body, ignore_unknown_fields: true
98
-
99
- yield result, operation if block_given?
100
- result
111
+ catch :response do
112
+ yield result, operation if block_given?
113
+ result
114
+ end
101
115
  end
102
116
 
103
117
  ##
@@ -126,16 +140,18 @@ module Google
126
140
 
127
141
  response = @client_stub.make_http_request(
128
142
  verb,
129
- uri: uri,
130
- body: body || "",
131
- params: query_string_params,
143
+ uri: uri,
144
+ body: body || "",
145
+ params: query_string_params,
146
+ method_name: "list_dashboards",
132
147
  options: options
133
148
  )
134
149
  operation = ::Gapic::Rest::TransportOperation.new response
135
150
  result = ::Google::Cloud::Monitoring::Dashboard::V1::ListDashboardsResponse.decode_json response.body, ignore_unknown_fields: true
136
-
137
- yield result, operation if block_given?
138
- result
151
+ catch :response do
152
+ yield result, operation if block_given?
153
+ result
154
+ end
139
155
  end
140
156
 
141
157
  ##
@@ -164,16 +180,18 @@ module Google
164
180
 
165
181
  response = @client_stub.make_http_request(
166
182
  verb,
167
- uri: uri,
168
- body: body || "",
169
- params: query_string_params,
183
+ uri: uri,
184
+ body: body || "",
185
+ params: query_string_params,
186
+ method_name: "get_dashboard",
170
187
  options: options
171
188
  )
172
189
  operation = ::Gapic::Rest::TransportOperation.new response
173
190
  result = ::Google::Cloud::Monitoring::Dashboard::V1::Dashboard.decode_json response.body, ignore_unknown_fields: true
174
-
175
- yield result, operation if block_given?
176
- result
191
+ catch :response do
192
+ yield result, operation if block_given?
193
+ result
194
+ end
177
195
  end
178
196
 
179
197
  ##
@@ -202,16 +220,18 @@ module Google
202
220
 
203
221
  response = @client_stub.make_http_request(
204
222
  verb,
205
- uri: uri,
206
- body: body || "",
207
- params: query_string_params,
223
+ uri: uri,
224
+ body: body || "",
225
+ params: query_string_params,
226
+ method_name: "delete_dashboard",
208
227
  options: options
209
228
  )
210
229
  operation = ::Gapic::Rest::TransportOperation.new response
211
230
  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
212
-
213
- yield result, operation if block_given?
214
- result
231
+ catch :response do
232
+ yield result, operation if block_given?
233
+ result
234
+ end
215
235
  end
216
236
 
217
237
  ##
@@ -240,16 +260,18 @@ module Google
240
260
 
241
261
  response = @client_stub.make_http_request(
242
262
  verb,
243
- uri: uri,
244
- body: body || "",
245
- params: query_string_params,
263
+ uri: uri,
264
+ body: body || "",
265
+ params: query_string_params,
266
+ method_name: "update_dashboard",
246
267
  options: options
247
268
  )
248
269
  operation = ::Gapic::Rest::TransportOperation.new response
249
270
  result = ::Google::Cloud::Monitoring::Dashboard::V1::Dashboard.decode_json response.body, ignore_unknown_fields: true
250
-
251
- yield result, operation if block_given?
252
- result
271
+ catch :response do
272
+ yield result, operation if block_given?
273
+ result
274
+ end
253
275
  end
254
276
 
255
277
  ##
@@ -22,7 +22,7 @@ module Google
22
22
  module Monitoring
23
23
  module Dashboard
24
24
  module V1
25
- VERSION = "1.0.1"
25
+ VERSION = "1.2.0"
26
26
  end
27
27
  end
28
28
  end
@@ -28,6 +28,9 @@ module Google
28
28
  # @!attribute [rw] destinations
29
29
  # @return [::Array<::Google::Api::ClientLibraryDestination>]
30
30
  # The destination where API teams want this client library to be published.
31
+ # @!attribute [rw] selective_gapic_generation
32
+ # @return [::Google::Api::SelectiveGapicGeneration]
33
+ # Configuration for which RPCs should be generated in the GAPIC client.
31
34
  class CommonLanguageSettings
32
35
  include ::Google::Protobuf::MessageExts
33
36
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -212,6 +215,12 @@ module Google
212
215
  # enabled. By default, asynchronous REST clients will not be generated.
213
216
  # This feature will be enabled by default 1 month after launching the
214
217
  # feature in preview packages.
218
+ # @!attribute [rw] protobuf_pythonic_types_enabled
219
+ # @return [::Boolean]
220
+ # Enables generation of protobuf code using new types that are more
221
+ # Pythonic which are included in `protobuf>=5.29.x`. This feature will be
222
+ # enabled by default 1 month after launching the feature in preview
223
+ # packages.
215
224
  class ExperimentalFeatures
216
225
  include ::Google::Protobuf::MessageExts
217
226
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -297,9 +306,28 @@ module Google
297
306
  # @!attribute [rw] common
298
307
  # @return [::Google::Api::CommonLanguageSettings]
299
308
  # Some settings.
309
+ # @!attribute [rw] renamed_services
310
+ # @return [::Google::Protobuf::Map{::String => ::String}]
311
+ # Map of service names to renamed services. Keys are the package relative
312
+ # service names and values are the name to be used for the service client
313
+ # and call options.
314
+ #
315
+ # publishing:
316
+ # go_settings:
317
+ # renamed_services:
318
+ # Publisher: TopicAdmin
300
319
  class GoSettings
301
320
  include ::Google::Protobuf::MessageExts
302
321
  extend ::Google::Protobuf::MessageExts::ClassMethods
322
+
323
+ # @!attribute [rw] key
324
+ # @return [::String]
325
+ # @!attribute [rw] value
326
+ # @return [::String]
327
+ class RenamedServicesEntry
328
+ include ::Google::Protobuf::MessageExts
329
+ extend ::Google::Protobuf::MessageExts::ClassMethods
330
+ end
303
331
  end
304
332
 
305
333
  # Describes the generator configuration for a method.
@@ -375,6 +403,17 @@ module Google
375
403
  end
376
404
  end
377
405
 
406
+ # This message is used to configure the generation of a subset of the RPCs in
407
+ # a service for client libraries.
408
+ # @!attribute [rw] methods
409
+ # @return [::Array<::String>]
410
+ # An allowlist of the fully qualified names of RPCs that should be included
411
+ # on public client surfaces.
412
+ class SelectiveGapicGeneration
413
+ include ::Google::Protobuf::MessageExts
414
+ extend ::Google::Protobuf::MessageExts::ClassMethods
415
+ end
416
+
378
417
  # The organization for which the client libraries are being published.
379
418
  # Affects the url where generated docs are published, etc.
380
419
  module ClientLibraryOrganization
@@ -43,18 +43,26 @@ module Google
43
43
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::GridLayout]
44
44
  # Content is arranged with a basic layout that re-flows a simple list of
45
45
  # informational elements like widgets or tiles.
46
+ #
47
+ # Note: The following fields are mutually exclusive: `grid_layout`, `mosaic_layout`, `row_layout`, `column_layout`. If a field in that set is populated, all other fields in the set will automatically be cleared.
46
48
  # @!attribute [rw] mosaic_layout
47
49
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::MosaicLayout]
48
50
  # The content is arranged as a grid of tiles, with each content widget
49
51
  # occupying one or more grid blocks.
52
+ #
53
+ # Note: The following fields are mutually exclusive: `mosaic_layout`, `grid_layout`, `row_layout`, `column_layout`. If a field in that set is populated, all other fields in the set will automatically be cleared.
50
54
  # @!attribute [rw] row_layout
51
55
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::RowLayout]
52
56
  # The content is divided into equally spaced rows and the widgets are
53
57
  # arranged horizontally.
58
+ #
59
+ # Note: The following fields are mutually exclusive: `row_layout`, `grid_layout`, `mosaic_layout`, `column_layout`. If a field in that set is populated, all other fields in the set will automatically be cleared.
54
60
  # @!attribute [rw] column_layout
55
61
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::ColumnLayout]
56
62
  # The content is divided into equally spaced columns and the widgets are
57
63
  # arranged vertically.
64
+ #
65
+ # Note: The following fields are mutually exclusive: `column_layout`, `grid_layout`, `mosaic_layout`, `row_layout`. If a field in that set is populated, all other fields in the set will automatically be cleared.
58
66
  # @!attribute [rw] dashboard_filters
59
67
  # @return [::Array<::Google::Cloud::Monitoring::Dashboard::V1::DashboardFilter>]
60
68
  # Filters to reduce the amount of data charted based on the filter criteria.
@@ -27,15 +27,23 @@ module Google
27
27
  # @!attribute [rw] time_series_filter
28
28
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesFilter]
29
29
  # Filter parameters to fetch time series.
30
+ #
31
+ # Note: The following fields are mutually exclusive: `time_series_filter`, `time_series_filter_ratio`, `time_series_query_language`, `prometheus_query`. If a field in that set is populated, all other fields in the set will automatically be cleared.
30
32
  # @!attribute [rw] time_series_filter_ratio
31
33
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesFilterRatio]
32
34
  # Parameters to fetch a ratio between two time series filters.
35
+ #
36
+ # Note: The following fields are mutually exclusive: `time_series_filter_ratio`, `time_series_filter`, `time_series_query_language`, `prometheus_query`. If a field in that set is populated, all other fields in the set will automatically be cleared.
33
37
  # @!attribute [rw] time_series_query_language
34
38
  # @return [::String]
35
39
  # A query used to fetch time series with MQL.
40
+ #
41
+ # Note: The following fields are mutually exclusive: `time_series_query_language`, `time_series_filter`, `time_series_filter_ratio`, `prometheus_query`. If a field in that set is populated, all other fields in the set will automatically be cleared.
36
42
  # @!attribute [rw] prometheus_query
37
43
  # @return [::String]
38
44
  # A query used to fetch time series with PromQL.
45
+ #
46
+ # Note: The following fields are mutually exclusive: `prometheus_query`, `time_series_filter`, `time_series_filter_ratio`, `time_series_query_language`. If a field in that set is populated, all other fields in the set will automatically be cleared.
39
47
  # @!attribute [rw] unit_override
40
48
  # @return [::String]
41
49
  # The unit of data contained in fetched time series. If non-empty, this
@@ -77,11 +85,15 @@ module Google
77
85
  # @!attribute [rw] pick_time_series_filter
78
86
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::PickTimeSeriesFilter]
79
87
  # Ranking based time series filter.
88
+ #
89
+ # Note: The following fields are mutually exclusive: `pick_time_series_filter`, `statistical_time_series_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
80
90
  # @!attribute [rw] statistical_time_series_filter
81
91
  # @deprecated This field is deprecated and may be removed in the next major version update.
82
92
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::StatisticalTimeSeriesFilter]
83
93
  # Statistics based time series filter.
84
94
  # Note: This field is deprecated and completely ignored by the API.
95
+ #
96
+ # Note: The following fields are mutually exclusive: `statistical_time_series_filter`, `pick_time_series_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
85
97
  class TimeSeriesFilter
86
98
  include ::Google::Protobuf::MessageExts
87
99
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -102,11 +114,15 @@ module Google
102
114
  # @!attribute [rw] pick_time_series_filter
103
115
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::PickTimeSeriesFilter]
104
116
  # Ranking based time series filter.
117
+ #
118
+ # Note: The following fields are mutually exclusive: `pick_time_series_filter`, `statistical_time_series_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
105
119
  # @!attribute [rw] statistical_time_series_filter
106
120
  # @deprecated This field is deprecated and may be removed in the next major version update.
107
121
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::StatisticalTimeSeriesFilter]
108
122
  # Statistics based time series filter.
109
123
  # Note: This field is deprecated and completely ignored by the API.
124
+ #
125
+ # Note: The following fields are mutually exclusive: `statistical_time_series_filter`, `pick_time_series_filter`. If a field in that set is populated, all other fields in the set will automatically be cleared.
110
126
  class TimeSeriesFilterRatio
111
127
  include ::Google::Protobuf::MessageExts
112
128
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -31,13 +31,19 @@ module Google
31
31
  # @!attribute [rw] gauge_view
32
32
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::Scorecard::GaugeView]
33
33
  # Will cause the scorecard to show a gauge chart.
34
+ #
35
+ # Note: The following fields are mutually exclusive: `gauge_view`, `spark_chart_view`, `blank_view`. If a field in that set is populated, all other fields in the set will automatically be cleared.
34
36
  # @!attribute [rw] spark_chart_view
35
37
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::Scorecard::SparkChartView]
36
38
  # Will cause the scorecard to show a spark chart.
39
+ #
40
+ # Note: The following fields are mutually exclusive: `spark_chart_view`, `gauge_view`, `blank_view`. If a field in that set is populated, all other fields in the set will automatically be cleared.
37
41
  # @!attribute [rw] blank_view
38
42
  # @return [::Google::Protobuf::Empty]
39
43
  # Will cause the `Scorecard` to show only the value, with no indicator to
40
44
  # its value relative to its thresholds.
45
+ #
46
+ # Note: The following fields are mutually exclusive: `blank_view`, `gauge_view`, `spark_chart_view`. If a field in that set is populated, all other fields in the set will automatically be cleared.
41
47
  # @!attribute [rw] thresholds
42
48
  # @return [::Array<::Google::Cloud::Monitoring::Dashboard::V1::Threshold>]
43
49
  # The thresholds used to determine the state of the scorecard given the
@@ -30,44 +30,70 @@ module Google
30
30
  # @!attribute [rw] xy_chart
31
31
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::XyChart]
32
32
  # A chart of time series data.
33
+ #
34
+ # Note: The following fields are mutually exclusive: `xy_chart`, `scorecard`, `text`, `blank`, `alert_chart`, `time_series_table`, `collapsible_group`, `logs_panel`, `incident_list`, `pie_chart`, `error_reporting_panel`, `section_header`, `single_view_group`. If a field in that set is populated, all other fields in the set will automatically be cleared.
33
35
  # @!attribute [rw] scorecard
34
36
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::Scorecard]
35
37
  # A scorecard summarizing time series data.
38
+ #
39
+ # Note: The following fields are mutually exclusive: `scorecard`, `xy_chart`, `text`, `blank`, `alert_chart`, `time_series_table`, `collapsible_group`, `logs_panel`, `incident_list`, `pie_chart`, `error_reporting_panel`, `section_header`, `single_view_group`. If a field in that set is populated, all other fields in the set will automatically be cleared.
36
40
  # @!attribute [rw] text
37
41
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::Text]
38
42
  # A raw string or markdown displaying textual content.
43
+ #
44
+ # Note: The following fields are mutually exclusive: `text`, `xy_chart`, `scorecard`, `blank`, `alert_chart`, `time_series_table`, `collapsible_group`, `logs_panel`, `incident_list`, `pie_chart`, `error_reporting_panel`, `section_header`, `single_view_group`. If a field in that set is populated, all other fields in the set will automatically be cleared.
39
45
  # @!attribute [rw] blank
40
46
  # @return [::Google::Protobuf::Empty]
41
47
  # A blank space.
48
+ #
49
+ # Note: The following fields are mutually exclusive: `blank`, `xy_chart`, `scorecard`, `text`, `alert_chart`, `time_series_table`, `collapsible_group`, `logs_panel`, `incident_list`, `pie_chart`, `error_reporting_panel`, `section_header`, `single_view_group`. If a field in that set is populated, all other fields in the set will automatically be cleared.
42
50
  # @!attribute [rw] alert_chart
43
51
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::AlertChart]
44
52
  # A chart of alert policy data.
53
+ #
54
+ # Note: The following fields are mutually exclusive: `alert_chart`, `xy_chart`, `scorecard`, `text`, `blank`, `time_series_table`, `collapsible_group`, `logs_panel`, `incident_list`, `pie_chart`, `error_reporting_panel`, `section_header`, `single_view_group`. If a field in that set is populated, all other fields in the set will automatically be cleared.
45
55
  # @!attribute [rw] time_series_table
46
56
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::TimeSeriesTable]
47
57
  # A widget that displays time series data in a tabular format.
58
+ #
59
+ # Note: The following fields are mutually exclusive: `time_series_table`, `xy_chart`, `scorecard`, `text`, `blank`, `alert_chart`, `collapsible_group`, `logs_panel`, `incident_list`, `pie_chart`, `error_reporting_panel`, `section_header`, `single_view_group`. If a field in that set is populated, all other fields in the set will automatically be cleared.
48
60
  # @!attribute [rw] collapsible_group
49
61
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::CollapsibleGroup]
50
62
  # A widget that groups the other widgets. All widgets that are within
51
63
  # the area spanned by the grouping widget are considered member widgets.
64
+ #
65
+ # Note: The following fields are mutually exclusive: `collapsible_group`, `xy_chart`, `scorecard`, `text`, `blank`, `alert_chart`, `time_series_table`, `logs_panel`, `incident_list`, `pie_chart`, `error_reporting_panel`, `section_header`, `single_view_group`. If a field in that set is populated, all other fields in the set will automatically be cleared.
52
66
  # @!attribute [rw] logs_panel
53
67
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::LogsPanel]
54
68
  # A widget that shows a stream of logs.
69
+ #
70
+ # Note: The following fields are mutually exclusive: `logs_panel`, `xy_chart`, `scorecard`, `text`, `blank`, `alert_chart`, `time_series_table`, `collapsible_group`, `incident_list`, `pie_chart`, `error_reporting_panel`, `section_header`, `single_view_group`. If a field in that set is populated, all other fields in the set will automatically be cleared.
55
71
  # @!attribute [rw] incident_list
56
72
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::IncidentList]
57
73
  # A widget that shows list of incidents.
74
+ #
75
+ # Note: The following fields are mutually exclusive: `incident_list`, `xy_chart`, `scorecard`, `text`, `blank`, `alert_chart`, `time_series_table`, `collapsible_group`, `logs_panel`, `pie_chart`, `error_reporting_panel`, `section_header`, `single_view_group`. If a field in that set is populated, all other fields in the set will automatically be cleared.
58
76
  # @!attribute [rw] pie_chart
59
77
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::PieChart]
60
78
  # A widget that displays timeseries data as a pie chart.
79
+ #
80
+ # Note: The following fields are mutually exclusive: `pie_chart`, `xy_chart`, `scorecard`, `text`, `blank`, `alert_chart`, `time_series_table`, `collapsible_group`, `logs_panel`, `incident_list`, `error_reporting_panel`, `section_header`, `single_view_group`. If a field in that set is populated, all other fields in the set will automatically be cleared.
61
81
  # @!attribute [rw] error_reporting_panel
62
82
  # @return [::Google::Monitoring::Dashboard::V1::ErrorReportingPanel]
63
83
  # A widget that displays a list of error groups.
84
+ #
85
+ # Note: The following fields are mutually exclusive: `error_reporting_panel`, `xy_chart`, `scorecard`, `text`, `blank`, `alert_chart`, `time_series_table`, `collapsible_group`, `logs_panel`, `incident_list`, `pie_chart`, `section_header`, `single_view_group`. If a field in that set is populated, all other fields in the set will automatically be cleared.
64
86
  # @!attribute [rw] section_header
65
87
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::SectionHeader]
66
88
  # A widget that defines a section header for easier navigation of the
67
89
  # dashboard.
90
+ #
91
+ # Note: The following fields are mutually exclusive: `section_header`, `xy_chart`, `scorecard`, `text`, `blank`, `alert_chart`, `time_series_table`, `collapsible_group`, `logs_panel`, `incident_list`, `pie_chart`, `error_reporting_panel`, `single_view_group`. If a field in that set is populated, all other fields in the set will automatically be cleared.
68
92
  # @!attribute [rw] single_view_group
69
93
  # @return [::Google::Cloud::Monitoring::Dashboard::V1::SingleViewGroup]
70
94
  # A widget that groups the other widgets by using a dropdown menu.
95
+ #
96
+ # Note: The following fields are mutually exclusive: `single_view_group`, `xy_chart`, `scorecard`, `text`, `blank`, `alert_chart`, `time_series_table`, `collapsible_group`, `logs_panel`, `incident_list`, `pie_chart`, `error_reporting_panel`, `section_header`. If a field in that set is populated, all other fields in the set will automatically be cleared.
71
97
  # @!attribute [rw] id
72
98
  # @return [::String]
73
99
  # Optional. The widget id. Ids may be made up of alphanumerics, dashes and
@@ -53,21 +53,33 @@ module Google
53
53
  # @!attribute [rw] null_value
54
54
  # @return [::Google::Protobuf::NullValue]
55
55
  # Represents a null value.
56
+ #
57
+ # Note: The following fields are mutually exclusive: `null_value`, `number_value`, `string_value`, `bool_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
56
58
  # @!attribute [rw] number_value
57
59
  # @return [::Float]
58
60
  # Represents a double value.
61
+ #
62
+ # Note: The following fields are mutually exclusive: `number_value`, `null_value`, `string_value`, `bool_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
59
63
  # @!attribute [rw] string_value
60
64
  # @return [::String]
61
65
  # Represents a string value.
66
+ #
67
+ # Note: The following fields are mutually exclusive: `string_value`, `null_value`, `number_value`, `bool_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
62
68
  # @!attribute [rw] bool_value
63
69
  # @return [::Boolean]
64
70
  # Represents a boolean value.
71
+ #
72
+ # Note: The following fields are mutually exclusive: `bool_value`, `null_value`, `number_value`, `string_value`, `struct_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
65
73
  # @!attribute [rw] struct_value
66
74
  # @return [::Google::Protobuf::Struct]
67
75
  # Represents a structured value.
76
+ #
77
+ # Note: The following fields are mutually exclusive: `struct_value`, `null_value`, `number_value`, `string_value`, `bool_value`, `list_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
68
78
  # @!attribute [rw] list_value
69
79
  # @return [::Google::Protobuf::ListValue]
70
80
  # Represents a repeated `Value`.
81
+ #
82
+ # Note: The following fields are mutually exclusive: `list_value`, `null_value`, `number_value`, `string_value`, `bool_value`, `struct_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
71
83
  class Value
72
84
  include ::Google::Protobuf::MessageExts
73
85
  extend ::Google::Protobuf::MessageExts::ClassMethods
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-monitoring-dashboard-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.1
4
+ version: 1.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
- autorequire:
9
8
  bindir: bin
10
9
  cert_chain: []
11
- date: 2024-08-30 00:00:00.000000000 Z
10
+ date: 2025-01-29 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: gapic-common
@@ -16,7 +15,7 @@ dependencies:
16
15
  requirements:
17
16
  - - ">="
18
17
  - !ruby/object:Gem::Version
19
- version: 0.21.1
18
+ version: 0.25.0
20
19
  - - "<"
21
20
  - !ruby/object:Gem::Version
22
21
  version: 2.a
@@ -26,7 +25,7 @@ dependencies:
26
25
  requirements:
27
26
  - - ">="
28
27
  - !ruby/object:Gem::Version
29
- version: 0.21.1
28
+ version: 0.25.0
30
29
  - - "<"
31
30
  - !ruby/object:Gem::Version
32
31
  version: 2.a
@@ -128,7 +127,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
128
127
  licenses:
129
128
  - Apache-2.0
130
129
  metadata: {}
131
- post_install_message:
132
130
  rdoc_options: []
133
131
  require_paths:
134
132
  - lib
@@ -136,15 +134,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
136
134
  requirements:
137
135
  - - ">="
138
136
  - !ruby/object:Gem::Version
139
- version: '2.7'
137
+ version: '3.0'
140
138
  required_rubygems_version: !ruby/object:Gem::Requirement
141
139
  requirements:
142
140
  - - ">="
143
141
  - !ruby/object:Gem::Version
144
142
  version: '0'
145
143
  requirements: []
146
- rubygems_version: 3.5.6
147
- signing_key:
144
+ rubygems_version: 3.6.2
148
145
  specification_version: 4
149
146
  summary: Manages your Cloud Monitoring data and configurations.
150
147
  test_files: []