google-cloud-monitoring-metrics_scope-v1 1.0.1 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +30 -20
- data/lib/google/cloud/monitoring/metrics_scope/v1/metrics_scopes/client.rb +29 -5
- data/lib/google/cloud/monitoring/metrics_scope/v1/metrics_scopes/operations.rb +12 -15
- data/lib/google/cloud/monitoring/metrics_scope/v1/version.rb +1 -1
- data/proto_docs/google/api/client.rb +39 -0
- data/proto_docs/google/longrunning/operations.rb +19 -14
- metadata +5 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 5f219886ad55c9d2cef84a76fadcf690e3a22f0cba3e8db71bdf32b378fadc66
|
4
|
+
data.tar.gz: 13beaceb1b0f44321330dc30e5593d8c7476697dfdc7b4c592e187e0c05d6abd
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 22b3a558f9813fd637fdab1a249aef2cb1c2a63d6130839c3fc8d023109556a271f36cf2a9f142fff3b4142acc4d32d780e62ecdacd49fc5d08d16b4c9613e9e
|
7
|
+
data.tar.gz: 974e7c93adc03b273b20dcddfed13ddf8ec822fcf044dc01a87ac8edaa2b1012d3503ed694f9988447bc3be3441ce5bb4ac58cd2bc1346a42e5e7054761a36c0
|
data/README.md
CHANGED
@@ -43,33 +43,43 @@ for class and method documentation.
|
|
43
43
|
See also the [Product Documentation](https://cloud.google.com/monitoring/settings/manage-api)
|
44
44
|
for general usage information.
|
45
45
|
|
46
|
-
##
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
|
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/metrics_scope/v1"
|
57
76
|
require "logger"
|
58
77
|
|
59
|
-
|
60
|
-
|
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::MetricsScope::V1::MetricsScopes::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).
|
@@ -166,8 +166,19 @@ module Google
|
|
166
166
|
universe_domain: @config.universe_domain,
|
167
167
|
channel_args: @config.channel_args,
|
168
168
|
interceptors: @config.interceptors,
|
169
|
-
channel_pool_config: @config.channel_pool
|
169
|
+
channel_pool_config: @config.channel_pool,
|
170
|
+
logger: @config.logger
|
170
171
|
)
|
172
|
+
|
173
|
+
@metrics_scopes_stub.stub_logger&.info do |entry|
|
174
|
+
entry.set_system_name
|
175
|
+
entry.set_service
|
176
|
+
entry.message = "Created client for #{entry.service}"
|
177
|
+
entry.set_credentials_fields credentials
|
178
|
+
entry.set "customEndpoint", @config.endpoint if @config.endpoint
|
179
|
+
entry.set "defaultTimeout", @config.timeout if @config.timeout
|
180
|
+
entry.set "quotaProject", @quota_project_id if @quota_project_id
|
181
|
+
end
|
171
182
|
end
|
172
183
|
|
173
184
|
##
|
@@ -177,6 +188,15 @@ module Google
|
|
177
188
|
#
|
178
189
|
attr_reader :operations_client
|
179
190
|
|
191
|
+
##
|
192
|
+
# The logger used for request/response debug logging.
|
193
|
+
#
|
194
|
+
# @return [Logger]
|
195
|
+
#
|
196
|
+
def logger
|
197
|
+
@metrics_scopes_stub.logger
|
198
|
+
end
|
199
|
+
|
180
200
|
# Service calls
|
181
201
|
|
182
202
|
##
|
@@ -261,7 +281,6 @@ module Google
|
|
261
281
|
|
262
282
|
@metrics_scopes_stub.call_rpc :get_metrics_scope, request, options: options do |response, operation|
|
263
283
|
yield response, operation if block_given?
|
264
|
-
return response
|
265
284
|
end
|
266
285
|
rescue ::GRPC::BadStatus => e
|
267
286
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -343,7 +362,6 @@ module Google
|
|
343
362
|
|
344
363
|
@metrics_scopes_stub.call_rpc :list_metrics_scopes_by_monitored_project, request, options: options do |response, operation|
|
345
364
|
yield response, operation if block_given?
|
346
|
-
return response
|
347
365
|
end
|
348
366
|
rescue ::GRPC::BadStatus => e
|
349
367
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -446,7 +464,7 @@ module Google
|
|
446
464
|
@metrics_scopes_stub.call_rpc :create_monitored_project, request, options: options do |response, operation|
|
447
465
|
response = ::Gapic::Operation.new response, @operations_client, options: options
|
448
466
|
yield response, operation if block_given?
|
449
|
-
|
467
|
+
throw :response, response
|
450
468
|
end
|
451
469
|
rescue ::GRPC::BadStatus => e
|
452
470
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -546,7 +564,7 @@ module Google
|
|
546
564
|
@metrics_scopes_stub.call_rpc :delete_monitored_project, request, options: options do |response, operation|
|
547
565
|
response = ::Gapic::Operation.new response, @operations_client, options: options
|
548
566
|
yield response, operation if block_given?
|
549
|
-
|
567
|
+
throw :response, response
|
550
568
|
end
|
551
569
|
rescue ::GRPC::BadStatus => e
|
552
570
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -635,6 +653,11 @@ module Google
|
|
635
653
|
# default endpoint URL. The default value of nil uses the environment
|
636
654
|
# universe (usually the default "googleapis.com" universe).
|
637
655
|
# @return [::String,nil]
|
656
|
+
# @!attribute [rw] logger
|
657
|
+
# A custom logger to use for request/response debug logging, or the value
|
658
|
+
# `:default` (the default) to construct a default logger, or `nil` to
|
659
|
+
# explicitly disable logging.
|
660
|
+
# @return [::Logger,:default,nil]
|
638
661
|
#
|
639
662
|
class Configuration
|
640
663
|
extend ::Gapic::Config
|
@@ -659,6 +682,7 @@ module Google
|
|
659
682
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
660
683
|
config_attr :quota_project, nil, ::String, nil
|
661
684
|
config_attr :universe_domain, nil, ::String, nil
|
685
|
+
config_attr :logger, :default, ::Logger, nil, :default
|
662
686
|
|
663
687
|
# @private
|
664
688
|
def initialize parent_config = nil
|
@@ -125,14 +125,6 @@ module Google
|
|
125
125
|
# Lists operations that match the specified filter in the request. If the
|
126
126
|
# server doesn't support this method, it returns `UNIMPLEMENTED`.
|
127
127
|
#
|
128
|
-
# NOTE: the `name` binding allows API services to override the binding
|
129
|
-
# to use different resource name schemes, such as `users/*/operations`. To
|
130
|
-
# override the binding, API services can add a binding such as
|
131
|
-
# `"/v1/{name=users/*}/operations"` to their service configuration.
|
132
|
-
# For backwards compatibility, the default name includes the operations
|
133
|
-
# collection id, however overriding users must ensure the name binding
|
134
|
-
# is the parent resource, without the operations collection id.
|
135
|
-
#
|
136
128
|
# @overload list_operations(request, options = nil)
|
137
129
|
# Pass arguments to `list_operations` via a request object, either of type
|
138
130
|
# {::Google::Longrunning::ListOperationsRequest} or an equivalent Hash.
|
@@ -222,7 +214,7 @@ module Google
|
|
222
214
|
wrap_lro_operation = ->(op_response) { ::Gapic::Operation.new op_response, @operations_client }
|
223
215
|
response = ::Gapic::PagedEnumerable.new @operations_stub, :list_operations, request, response, operation, options, format_resource: wrap_lro_operation
|
224
216
|
yield response, operation if block_given?
|
225
|
-
|
217
|
+
throw :response, response
|
226
218
|
end
|
227
219
|
rescue ::GRPC::BadStatus => e
|
228
220
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -318,7 +310,7 @@ module Google
|
|
318
310
|
@operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
|
319
311
|
response = ::Gapic::Operation.new response, @operations_client, options: options
|
320
312
|
yield response, operation if block_given?
|
321
|
-
|
313
|
+
throw :response, response
|
322
314
|
end
|
323
315
|
rescue ::GRPC::BadStatus => e
|
324
316
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -407,7 +399,6 @@ module Google
|
|
407
399
|
|
408
400
|
@operations_stub.call_rpc :delete_operation, request, options: options do |response, operation|
|
409
401
|
yield response, operation if block_given?
|
410
|
-
return response
|
411
402
|
end
|
412
403
|
rescue ::GRPC::BadStatus => e
|
413
404
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -422,8 +413,9 @@ module Google
|
|
422
413
|
# other methods to check whether the cancellation succeeded or whether the
|
423
414
|
# operation completed despite cancellation. On successful cancellation,
|
424
415
|
# the operation is not deleted; instead, it becomes an operation with
|
425
|
-
# an {::Google::Longrunning::Operation#error Operation.error} value with a
|
426
|
-
# corresponding to
|
416
|
+
# an {::Google::Longrunning::Operation#error Operation.error} value with a
|
417
|
+
# {::Google::Rpc::Status#code google.rpc.Status.code} of `1`, corresponding to
|
418
|
+
# `Code.CANCELLED`.
|
427
419
|
#
|
428
420
|
# @overload cancel_operation(request, options = nil)
|
429
421
|
# Pass arguments to `cancel_operation` via a request object, either of type
|
@@ -502,7 +494,6 @@ module Google
|
|
502
494
|
|
503
495
|
@operations_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
|
504
496
|
yield response, operation if block_given?
|
505
|
-
return response
|
506
497
|
end
|
507
498
|
rescue ::GRPC::BadStatus => e
|
508
499
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -600,7 +591,7 @@ module Google
|
|
600
591
|
@operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
|
601
592
|
response = ::Gapic::Operation.new response, @operations_client, options: options
|
602
593
|
yield response, operation if block_given?
|
603
|
-
|
594
|
+
throw :response, response
|
604
595
|
end
|
605
596
|
rescue ::GRPC::BadStatus => e
|
606
597
|
raise ::Google::Cloud::Error.from_error(e)
|
@@ -689,6 +680,11 @@ module Google
|
|
689
680
|
# default endpoint URL. The default value of nil uses the environment
|
690
681
|
# universe (usually the default "googleapis.com" universe).
|
691
682
|
# @return [::String,nil]
|
683
|
+
# @!attribute [rw] logger
|
684
|
+
# A custom logger to use for request/response debug logging, or the value
|
685
|
+
# `:default` (the default) to construct a default logger, or `nil` to
|
686
|
+
# explicitly disable logging.
|
687
|
+
# @return [::Logger,:default,nil]
|
692
688
|
#
|
693
689
|
class Configuration
|
694
690
|
extend ::Gapic::Config
|
@@ -713,6 +709,7 @@ module Google
|
|
713
709
|
config_attr :retry_policy, nil, ::Hash, ::Proc, nil
|
714
710
|
config_attr :quota_project, nil, ::String, nil
|
715
711
|
config_attr :universe_domain, nil, ::String, nil
|
712
|
+
config_attr :logger, :default, ::Logger, nil, :default
|
716
713
|
|
717
714
|
# @private
|
718
715
|
def initialize parent_config = nil
|
@@ -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
|
@@ -42,7 +42,7 @@ module Google
|
|
42
42
|
# The error result of the operation in case of failure or cancellation.
|
43
43
|
# @!attribute [rw] response
|
44
44
|
# @return [::Google::Protobuf::Any]
|
45
|
-
# The normal response of the operation
|
45
|
+
# The normal, successful response of the operation. If the original
|
46
46
|
# method returns no data on success, such as `Delete`, the response is
|
47
47
|
# `google.protobuf.Empty`. If the original method is standard
|
48
48
|
# `Get`/`Create`/`Update`, the response should be the resource. For other
|
@@ -55,7 +55,8 @@ module Google
|
|
55
55
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
56
56
|
end
|
57
57
|
|
58
|
-
# The request message for
|
58
|
+
# The request message for
|
59
|
+
# Operations.GetOperation.
|
59
60
|
# @!attribute [rw] name
|
60
61
|
# @return [::String]
|
61
62
|
# The name of the operation resource.
|
@@ -64,7 +65,8 @@ module Google
|
|
64
65
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
65
66
|
end
|
66
67
|
|
67
|
-
# The request message for
|
68
|
+
# The request message for
|
69
|
+
# Operations.ListOperations.
|
68
70
|
# @!attribute [rw] name
|
69
71
|
# @return [::String]
|
70
72
|
# The name of the operation's parent resource.
|
@@ -82,7 +84,8 @@ module Google
|
|
82
84
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
83
85
|
end
|
84
86
|
|
85
|
-
# The response message for
|
87
|
+
# The response message for
|
88
|
+
# Operations.ListOperations.
|
86
89
|
# @!attribute [rw] operations
|
87
90
|
# @return [::Array<::Google::Longrunning::Operation>]
|
88
91
|
# A list of operations that matches the specified filter in the request.
|
@@ -94,7 +97,8 @@ module Google
|
|
94
97
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
95
98
|
end
|
96
99
|
|
97
|
-
# The request message for
|
100
|
+
# The request message for
|
101
|
+
# Operations.CancelOperation.
|
98
102
|
# @!attribute [rw] name
|
99
103
|
# @return [::String]
|
100
104
|
# The name of the operation resource to be cancelled.
|
@@ -103,7 +107,8 @@ module Google
|
|
103
107
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
104
108
|
end
|
105
109
|
|
106
|
-
# The request message for
|
110
|
+
# The request message for
|
111
|
+
# Operations.DeleteOperation.
|
107
112
|
# @!attribute [rw] name
|
108
113
|
# @return [::String]
|
109
114
|
# The name of the operation resource to be deleted.
|
@@ -112,7 +117,8 @@ module Google
|
|
112
117
|
extend ::Google::Protobuf::MessageExts::ClassMethods
|
113
118
|
end
|
114
119
|
|
115
|
-
# The request message for
|
120
|
+
# The request message for
|
121
|
+
# Operations.WaitOperation.
|
116
122
|
# @!attribute [rw] name
|
117
123
|
# @return [::String]
|
118
124
|
# The name of the operation resource to wait on.
|
@@ -130,13 +136,12 @@ module Google
|
|
130
136
|
#
|
131
137
|
# Example:
|
132
138
|
#
|
133
|
-
#
|
134
|
-
#
|
135
|
-
#
|
136
|
-
#
|
137
|
-
#
|
138
|
-
# }
|
139
|
-
# }
|
139
|
+
# rpc Export(ExportRequest) returns (google.longrunning.Operation) {
|
140
|
+
# option (google.longrunning.operation_info) = {
|
141
|
+
# response_type: "ExportResponse"
|
142
|
+
# metadata_type: "ExportMetadata"
|
143
|
+
# };
|
144
|
+
# }
|
140
145
|
# @!attribute [rw] response_type
|
141
146
|
# @return [::String]
|
142
147
|
# Required. The message name of the primary return type for this
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-cloud-monitoring-metrics_scope-v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.0
|
4
|
+
version: 1.1.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-
|
11
|
+
date: 2024-12-10 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: gapic-common
|
@@ -16,7 +16,7 @@ dependencies:
|
|
16
16
|
requirements:
|
17
17
|
- - ">="
|
18
18
|
- !ruby/object:Gem::Version
|
19
|
-
version: 0.
|
19
|
+
version: 0.24.0
|
20
20
|
- - "<"
|
21
21
|
- !ruby/object:Gem::Version
|
22
22
|
version: 2.a
|
@@ -26,7 +26,7 @@ dependencies:
|
|
26
26
|
requirements:
|
27
27
|
- - ">="
|
28
28
|
- !ruby/object:Gem::Version
|
29
|
-
version: 0.
|
29
|
+
version: 0.24.0
|
30
30
|
- - "<"
|
31
31
|
- !ruby/object:Gem::Version
|
32
32
|
version: 2.a
|
@@ -102,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
102
102
|
- !ruby/object:Gem::Version
|
103
103
|
version: '0'
|
104
104
|
requirements: []
|
105
|
-
rubygems_version: 3.5.
|
105
|
+
rubygems_version: 3.5.23
|
106
106
|
signing_key:
|
107
107
|
specification_version: 4
|
108
108
|
summary: Manages your Cloud Monitoring data and configurations. Most projects must
|