google-cloud-recommender-v1 1.0.0 → 1.1.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: 13600da3830ecdc249469053d8d35364b9107b44c1974593ef9c0c8a24903792
4
- data.tar.gz: f89efd9e821ad938ceb82ff736badbd8d283a641459451092061a88abf0c4cee
3
+ metadata.gz: 773c0072502caff8d79a43cc632ba97dfbb6e6ebe1b2018adb27ae905bd5e840
4
+ data.tar.gz: 70110f08fcf12f37bba868f2948b60a17e83735dacbe52d94e07ae8ba3b2bab9
5
5
  SHA512:
6
- metadata.gz: b409ebb9bd8420e64f51da4152d7a20ac78770fde645ca89aba51f5b4971c8dcf7cd42ddda446912f1735340ea845b6aa9898849a3ce6799b518de0e813c2bd9
7
- data.tar.gz: 266fc5e337f1da2152e102af86ec4369df0a0152f653a7051ae76a4e8d49d2356ab17359eebfb0012c60ccfb5a73641a57388f503907928222fcffe6f99eb0d4
6
+ metadata.gz: 6baa8a6fffd971414be3486d34cb8375a696874f56f1df7ae8aaf95e5258754e8b576f009eae0f8def321a0f133bddd21af0f8d2e1f8e607cc840ef8b9ed8e36
7
+ data.tar.gz: ae01d668e06bb365dbcbd402f454d5f21b1bfd5580c0ca5ab6d92ddebafe684477c8ddb90d654853b62eaea35dcecddc9c914c5f194445702bad05e39ae808ee
data/README.md CHANGED
@@ -43,33 +43,43 @@ for class and method documentation.
43
43
  See also the [Product Documentation](https://cloud.google.com/recommender)
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/recommender/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::Recommender::V1::Recommender::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).
@@ -188,8 +188,28 @@ module Google
188
188
  universe_domain: @config.universe_domain,
189
189
  channel_args: @config.channel_args,
190
190
  interceptors: @config.interceptors,
191
- channel_pool_config: @config.channel_pool
191
+ channel_pool_config: @config.channel_pool,
192
+ logger: @config.logger
192
193
  )
194
+
195
+ @recommender_stub.stub_logger&.info do |entry|
196
+ entry.set_system_name
197
+ entry.set_service
198
+ entry.message = "Created client for #{entry.service}"
199
+ entry.set_credentials_fields credentials
200
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
201
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
202
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
203
+ end
204
+ end
205
+
206
+ ##
207
+ # The logger used for request/response debug logging.
208
+ #
209
+ # @return [Logger]
210
+ #
211
+ def logger
212
+ @recommender_stub.logger
193
213
  end
194
214
 
195
215
  # Service calls
@@ -334,7 +354,7 @@ module Google
334
354
  @recommender_stub.call_rpc :list_insights, request, options: options do |response, operation|
335
355
  response = ::Gapic::PagedEnumerable.new @recommender_stub, :list_insights, request, response, operation, options
336
356
  yield response, operation if block_given?
337
- return response
357
+ throw :response, response
338
358
  end
339
359
  rescue ::GRPC::BadStatus => e
340
360
  raise ::Google::Cloud::Error.from_error(e)
@@ -421,7 +441,6 @@ module Google
421
441
 
422
442
  @recommender_stub.call_rpc :get_insight, request, options: options do |response, operation|
423
443
  yield response, operation if block_given?
424
- return response
425
444
  end
426
445
  rescue ::GRPC::BadStatus => e
427
446
  raise ::Google::Cloud::Error.from_error(e)
@@ -517,7 +536,6 @@ module Google
517
536
 
518
537
  @recommender_stub.call_rpc :mark_insight_accepted, request, options: options do |response, operation|
519
538
  yield response, operation if block_given?
520
- return response
521
539
  end
522
540
  rescue ::GRPC::BadStatus => e
523
541
  raise ::Google::Cloud::Error.from_error(e)
@@ -663,7 +681,7 @@ module Google
663
681
  @recommender_stub.call_rpc :list_recommendations, request, options: options do |response, operation|
664
682
  response = ::Gapic::PagedEnumerable.new @recommender_stub, :list_recommendations, request, response, operation, options
665
683
  yield response, operation if block_given?
666
- return response
684
+ throw :response, response
667
685
  end
668
686
  rescue ::GRPC::BadStatus => e
669
687
  raise ::Google::Cloud::Error.from_error(e)
@@ -750,7 +768,6 @@ module Google
750
768
 
751
769
  @recommender_stub.call_rpc :get_recommendation, request, options: options do |response, operation|
752
770
  yield response, operation if block_given?
753
- return response
754
771
  end
755
772
  rescue ::GRPC::BadStatus => e
756
773
  raise ::Google::Cloud::Error.from_error(e)
@@ -846,7 +863,6 @@ module Google
846
863
 
847
864
  @recommender_stub.call_rpc :mark_recommendation_dismissed, request, options: options do |response, operation|
848
865
  yield response, operation if block_given?
849
- return response
850
866
  end
851
867
  rescue ::GRPC::BadStatus => e
852
868
  raise ::Google::Cloud::Error.from_error(e)
@@ -948,7 +964,6 @@ module Google
948
964
 
949
965
  @recommender_stub.call_rpc :mark_recommendation_claimed, request, options: options do |response, operation|
950
966
  yield response, operation if block_given?
951
- return response
952
967
  end
953
968
  rescue ::GRPC::BadStatus => e
954
969
  raise ::Google::Cloud::Error.from_error(e)
@@ -1051,7 +1066,6 @@ module Google
1051
1066
 
1052
1067
  @recommender_stub.call_rpc :mark_recommendation_succeeded, request, options: options do |response, operation|
1053
1068
  yield response, operation if block_given?
1054
- return response
1055
1069
  end
1056
1070
  rescue ::GRPC::BadStatus => e
1057
1071
  raise ::Google::Cloud::Error.from_error(e)
@@ -1154,7 +1168,6 @@ module Google
1154
1168
 
1155
1169
  @recommender_stub.call_rpc :mark_recommendation_failed, request, options: options do |response, operation|
1156
1170
  yield response, operation if block_given?
1157
- return response
1158
1171
  end
1159
1172
  rescue ::GRPC::BadStatus => e
1160
1173
  raise ::Google::Cloud::Error.from_error(e)
@@ -1251,7 +1264,6 @@ module Google
1251
1264
 
1252
1265
  @recommender_stub.call_rpc :get_recommender_config, request, options: options do |response, operation|
1253
1266
  yield response, operation if block_given?
1254
- return response
1255
1267
  end
1256
1268
  rescue ::GRPC::BadStatus => e
1257
1269
  raise ::Google::Cloud::Error.from_error(e)
@@ -1343,7 +1355,6 @@ module Google
1343
1355
 
1344
1356
  @recommender_stub.call_rpc :update_recommender_config, request, options: options do |response, operation|
1345
1357
  yield response, operation if block_given?
1346
- return response
1347
1358
  end
1348
1359
  rescue ::GRPC::BadStatus => e
1349
1360
  raise ::Google::Cloud::Error.from_error(e)
@@ -1440,7 +1451,6 @@ module Google
1440
1451
 
1441
1452
  @recommender_stub.call_rpc :get_insight_type_config, request, options: options do |response, operation|
1442
1453
  yield response, operation if block_given?
1443
- return response
1444
1454
  end
1445
1455
  rescue ::GRPC::BadStatus => e
1446
1456
  raise ::Google::Cloud::Error.from_error(e)
@@ -1532,7 +1542,6 @@ module Google
1532
1542
 
1533
1543
  @recommender_stub.call_rpc :update_insight_type_config, request, options: options do |response, operation|
1534
1544
  yield response, operation if block_given?
1535
- return response
1536
1545
  end
1537
1546
  rescue ::GRPC::BadStatus => e
1538
1547
  raise ::Google::Cloud::Error.from_error(e)
@@ -1621,6 +1630,11 @@ module Google
1621
1630
  # default endpoint URL. The default value of nil uses the environment
1622
1631
  # universe (usually the default "googleapis.com" universe).
1623
1632
  # @return [::String,nil]
1633
+ # @!attribute [rw] logger
1634
+ # A custom logger to use for request/response debug logging, or the value
1635
+ # `:default` (the default) to construct a default logger, or `nil` to
1636
+ # explicitly disable logging.
1637
+ # @return [::Logger,:default,nil]
1624
1638
  #
1625
1639
  class Configuration
1626
1640
  extend ::Gapic::Config
@@ -1645,6 +1659,7 @@ module Google
1645
1659
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1646
1660
  config_attr :quota_project, nil, ::String, nil
1647
1661
  config_attr :universe_domain, nil, ::String, nil
1662
+ config_attr :logger, :default, ::Logger, nil, :default
1648
1663
 
1649
1664
  # @private
1650
1665
  def initialize parent_config = nil
@@ -181,8 +181,28 @@ module Google
181
181
  endpoint: @config.endpoint,
182
182
  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
183
183
  universe_domain: @config.universe_domain,
184
- credentials: credentials
184
+ credentials: credentials,
185
+ logger: @config.logger
185
186
  )
187
+
188
+ @recommender_stub.logger(stub: true)&.info do |entry|
189
+ entry.set_system_name
190
+ entry.set_service
191
+ entry.message = "Created client for #{entry.service}"
192
+ entry.set_credentials_fields credentials
193
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
194
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
195
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
196
+ end
197
+ end
198
+
199
+ ##
200
+ # The logger used for request/response debug logging.
201
+ #
202
+ # @return [Logger]
203
+ #
204
+ def logger
205
+ @recommender_stub.logger
186
206
  end
187
207
 
188
208
  # Service calls
@@ -320,7 +340,7 @@ module Google
320
340
  @recommender_stub.list_insights request, options do |result, operation|
321
341
  result = ::Gapic::Rest::PagedEnumerable.new @recommender_stub, :list_insights, "insights", request, result, options
322
342
  yield result, operation if block_given?
323
- return result
343
+ throw :response, result
324
344
  end
325
345
  rescue ::Gapic::Rest::Error => e
326
346
  raise ::Google::Cloud::Error.from_error(e)
@@ -400,7 +420,6 @@ module Google
400
420
 
401
421
  @recommender_stub.get_insight request, options do |result, operation|
402
422
  yield result, operation if block_given?
403
- return result
404
423
  end
405
424
  rescue ::Gapic::Rest::Error => e
406
425
  raise ::Google::Cloud::Error.from_error(e)
@@ -489,7 +508,6 @@ module Google
489
508
 
490
509
  @recommender_stub.mark_insight_accepted request, options do |result, operation|
491
510
  yield result, operation if block_given?
492
- return result
493
511
  end
494
512
  rescue ::Gapic::Rest::Error => e
495
513
  raise ::Google::Cloud::Error.from_error(e)
@@ -628,7 +646,7 @@ module Google
628
646
  @recommender_stub.list_recommendations request, options do |result, operation|
629
647
  result = ::Gapic::Rest::PagedEnumerable.new @recommender_stub, :list_recommendations, "recommendations", request, result, options
630
648
  yield result, operation if block_given?
631
- return result
649
+ throw :response, result
632
650
  end
633
651
  rescue ::Gapic::Rest::Error => e
634
652
  raise ::Google::Cloud::Error.from_error(e)
@@ -708,7 +726,6 @@ module Google
708
726
 
709
727
  @recommender_stub.get_recommendation request, options do |result, operation|
710
728
  yield result, operation if block_given?
711
- return result
712
729
  end
713
730
  rescue ::Gapic::Rest::Error => e
714
731
  raise ::Google::Cloud::Error.from_error(e)
@@ -797,7 +814,6 @@ module Google
797
814
 
798
815
  @recommender_stub.mark_recommendation_dismissed request, options do |result, operation|
799
816
  yield result, operation if block_given?
800
- return result
801
817
  end
802
818
  rescue ::Gapic::Rest::Error => e
803
819
  raise ::Google::Cloud::Error.from_error(e)
@@ -892,7 +908,6 @@ module Google
892
908
 
893
909
  @recommender_stub.mark_recommendation_claimed request, options do |result, operation|
894
910
  yield result, operation if block_given?
895
- return result
896
911
  end
897
912
  rescue ::Gapic::Rest::Error => e
898
913
  raise ::Google::Cloud::Error.from_error(e)
@@ -988,7 +1003,6 @@ module Google
988
1003
 
989
1004
  @recommender_stub.mark_recommendation_succeeded request, options do |result, operation|
990
1005
  yield result, operation if block_given?
991
- return result
992
1006
  end
993
1007
  rescue ::Gapic::Rest::Error => e
994
1008
  raise ::Google::Cloud::Error.from_error(e)
@@ -1084,7 +1098,6 @@ module Google
1084
1098
 
1085
1099
  @recommender_stub.mark_recommendation_failed request, options do |result, operation|
1086
1100
  yield result, operation if block_given?
1087
- return result
1088
1101
  end
1089
1102
  rescue ::Gapic::Rest::Error => e
1090
1103
  raise ::Google::Cloud::Error.from_error(e)
@@ -1174,7 +1187,6 @@ module Google
1174
1187
 
1175
1188
  @recommender_stub.get_recommender_config request, options do |result, operation|
1176
1189
  yield result, operation if block_given?
1177
- return result
1178
1190
  end
1179
1191
  rescue ::Gapic::Rest::Error => e
1180
1192
  raise ::Google::Cloud::Error.from_error(e)
@@ -1259,7 +1271,6 @@ module Google
1259
1271
 
1260
1272
  @recommender_stub.update_recommender_config request, options do |result, operation|
1261
1273
  yield result, operation if block_given?
1262
- return result
1263
1274
  end
1264
1275
  rescue ::Gapic::Rest::Error => e
1265
1276
  raise ::Google::Cloud::Error.from_error(e)
@@ -1349,7 +1360,6 @@ module Google
1349
1360
 
1350
1361
  @recommender_stub.get_insight_type_config request, options do |result, operation|
1351
1362
  yield result, operation if block_given?
1352
- return result
1353
1363
  end
1354
1364
  rescue ::Gapic::Rest::Error => e
1355
1365
  raise ::Google::Cloud::Error.from_error(e)
@@ -1434,7 +1444,6 @@ module Google
1434
1444
 
1435
1445
  @recommender_stub.update_insight_type_config request, options do |result, operation|
1436
1446
  yield result, operation if block_given?
1437
- return result
1438
1447
  end
1439
1448
  rescue ::Gapic::Rest::Error => e
1440
1449
  raise ::Google::Cloud::Error.from_error(e)
@@ -1514,6 +1523,11 @@ module Google
1514
1523
  # default endpoint URL. The default value of nil uses the environment
1515
1524
  # universe (usually the default "googleapis.com" universe).
1516
1525
  # @return [::String,nil]
1526
+ # @!attribute [rw] logger
1527
+ # A custom logger to use for request/response debug logging, or the value
1528
+ # `:default` (the default) to construct a default logger, or `nil` to
1529
+ # explicitly disable logging.
1530
+ # @return [::Logger,:default,nil]
1517
1531
  #
1518
1532
  class Configuration
1519
1533
  extend ::Gapic::Config
@@ -1535,6 +1549,7 @@ module Google
1535
1549
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
1536
1550
  config_attr :quota_project, nil, ::String, nil
1537
1551
  config_attr :universe_domain, nil, ::String, nil
1552
+ config_attr :logger, :default, ::Logger, nil, :default
1538
1553
 
1539
1554
  # @private
1540
1555
  def initialize parent_config = nil
@@ -30,7 +30,8 @@ module Google
30
30
  # including transcoding, making the REST call, and deserialing the response.
31
31
  #
32
32
  class ServiceStub
33
- def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
33
+ # @private
34
+ def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
34
35
  # These require statements are intentionally placed here to initialize
35
36
  # the REST modules only when it's required.
36
37
  require "gapic/rest"
@@ -40,7 +41,9 @@ module Google
40
41
  universe_domain: universe_domain,
41
42
  credentials: credentials,
42
43
  numeric_enums: true,
43
- raise_faraday_errors: false
44
+ service_name: self.class,
45
+ raise_faraday_errors: false,
46
+ logger: logger
44
47
  end
45
48
 
46
49
  ##
@@ -61,6 +64,15 @@ module Google
61
64
  @client_stub.endpoint
62
65
  end
63
66
 
67
+ ##
68
+ # The logger used for request/response debug logging.
69
+ #
70
+ # @return [Logger]
71
+ #
72
+ def logger stub: false
73
+ stub ? @client_stub.stub_logger : @client_stub.logger
74
+ end
75
+
64
76
  ##
65
77
  # Baseline implementation for the list_insights REST call
66
78
  #
@@ -87,16 +99,18 @@ module Google
87
99
 
88
100
  response = @client_stub.make_http_request(
89
101
  verb,
90
- uri: uri,
91
- body: body || "",
92
- params: query_string_params,
102
+ uri: uri,
103
+ body: body || "",
104
+ params: query_string_params,
105
+ method_name: "list_insights",
93
106
  options: options
94
107
  )
95
108
  operation = ::Gapic::Rest::TransportOperation.new response
96
109
  result = ::Google::Cloud::Recommender::V1::ListInsightsResponse.decode_json response.body, ignore_unknown_fields: true
97
-
98
- yield result, operation if block_given?
99
- result
110
+ catch :response do
111
+ yield result, operation if block_given?
112
+ result
113
+ end
100
114
  end
101
115
 
102
116
  ##
@@ -125,16 +139,18 @@ module Google
125
139
 
126
140
  response = @client_stub.make_http_request(
127
141
  verb,
128
- uri: uri,
129
- body: body || "",
130
- params: query_string_params,
142
+ uri: uri,
143
+ body: body || "",
144
+ params: query_string_params,
145
+ method_name: "get_insight",
131
146
  options: options
132
147
  )
133
148
  operation = ::Gapic::Rest::TransportOperation.new response
134
149
  result = ::Google::Cloud::Recommender::V1::Insight.decode_json response.body, ignore_unknown_fields: true
135
-
136
- yield result, operation if block_given?
137
- result
150
+ catch :response do
151
+ yield result, operation if block_given?
152
+ result
153
+ end
138
154
  end
139
155
 
140
156
  ##
@@ -163,16 +179,18 @@ module Google
163
179
 
164
180
  response = @client_stub.make_http_request(
165
181
  verb,
166
- uri: uri,
167
- body: body || "",
168
- params: query_string_params,
182
+ uri: uri,
183
+ body: body || "",
184
+ params: query_string_params,
185
+ method_name: "mark_insight_accepted",
169
186
  options: options
170
187
  )
171
188
  operation = ::Gapic::Rest::TransportOperation.new response
172
189
  result = ::Google::Cloud::Recommender::V1::Insight.decode_json response.body, ignore_unknown_fields: true
173
-
174
- yield result, operation if block_given?
175
- result
190
+ catch :response do
191
+ yield result, operation if block_given?
192
+ result
193
+ end
176
194
  end
177
195
 
178
196
  ##
@@ -201,16 +219,18 @@ module Google
201
219
 
202
220
  response = @client_stub.make_http_request(
203
221
  verb,
204
- uri: uri,
205
- body: body || "",
206
- params: query_string_params,
222
+ uri: uri,
223
+ body: body || "",
224
+ params: query_string_params,
225
+ method_name: "list_recommendations",
207
226
  options: options
208
227
  )
209
228
  operation = ::Gapic::Rest::TransportOperation.new response
210
229
  result = ::Google::Cloud::Recommender::V1::ListRecommendationsResponse.decode_json response.body, ignore_unknown_fields: true
211
-
212
- yield result, operation if block_given?
213
- result
230
+ catch :response do
231
+ yield result, operation if block_given?
232
+ result
233
+ end
214
234
  end
215
235
 
216
236
  ##
@@ -239,16 +259,18 @@ module Google
239
259
 
240
260
  response = @client_stub.make_http_request(
241
261
  verb,
242
- uri: uri,
243
- body: body || "",
244
- params: query_string_params,
262
+ uri: uri,
263
+ body: body || "",
264
+ params: query_string_params,
265
+ method_name: "get_recommendation",
245
266
  options: options
246
267
  )
247
268
  operation = ::Gapic::Rest::TransportOperation.new response
248
269
  result = ::Google::Cloud::Recommender::V1::Recommendation.decode_json response.body, ignore_unknown_fields: true
249
-
250
- yield result, operation if block_given?
251
- result
270
+ catch :response do
271
+ yield result, operation if block_given?
272
+ result
273
+ end
252
274
  end
253
275
 
254
276
  ##
@@ -277,16 +299,18 @@ module Google
277
299
 
278
300
  response = @client_stub.make_http_request(
279
301
  verb,
280
- uri: uri,
281
- body: body || "",
282
- params: query_string_params,
302
+ uri: uri,
303
+ body: body || "",
304
+ params: query_string_params,
305
+ method_name: "mark_recommendation_dismissed",
283
306
  options: options
284
307
  )
285
308
  operation = ::Gapic::Rest::TransportOperation.new response
286
309
  result = ::Google::Cloud::Recommender::V1::Recommendation.decode_json response.body, ignore_unknown_fields: true
287
-
288
- yield result, operation if block_given?
289
- result
310
+ catch :response do
311
+ yield result, operation if block_given?
312
+ result
313
+ end
290
314
  end
291
315
 
292
316
  ##
@@ -315,16 +339,18 @@ module Google
315
339
 
316
340
  response = @client_stub.make_http_request(
317
341
  verb,
318
- uri: uri,
319
- body: body || "",
320
- params: query_string_params,
342
+ uri: uri,
343
+ body: body || "",
344
+ params: query_string_params,
345
+ method_name: "mark_recommendation_claimed",
321
346
  options: options
322
347
  )
323
348
  operation = ::Gapic::Rest::TransportOperation.new response
324
349
  result = ::Google::Cloud::Recommender::V1::Recommendation.decode_json response.body, ignore_unknown_fields: true
325
-
326
- yield result, operation if block_given?
327
- result
350
+ catch :response do
351
+ yield result, operation if block_given?
352
+ result
353
+ end
328
354
  end
329
355
 
330
356
  ##
@@ -353,16 +379,18 @@ module Google
353
379
 
354
380
  response = @client_stub.make_http_request(
355
381
  verb,
356
- uri: uri,
357
- body: body || "",
358
- params: query_string_params,
382
+ uri: uri,
383
+ body: body || "",
384
+ params: query_string_params,
385
+ method_name: "mark_recommendation_succeeded",
359
386
  options: options
360
387
  )
361
388
  operation = ::Gapic::Rest::TransportOperation.new response
362
389
  result = ::Google::Cloud::Recommender::V1::Recommendation.decode_json response.body, ignore_unknown_fields: true
363
-
364
- yield result, operation if block_given?
365
- result
390
+ catch :response do
391
+ yield result, operation if block_given?
392
+ result
393
+ end
366
394
  end
367
395
 
368
396
  ##
@@ -391,16 +419,18 @@ module Google
391
419
 
392
420
  response = @client_stub.make_http_request(
393
421
  verb,
394
- uri: uri,
395
- body: body || "",
396
- params: query_string_params,
422
+ uri: uri,
423
+ body: body || "",
424
+ params: query_string_params,
425
+ method_name: "mark_recommendation_failed",
397
426
  options: options
398
427
  )
399
428
  operation = ::Gapic::Rest::TransportOperation.new response
400
429
  result = ::Google::Cloud::Recommender::V1::Recommendation.decode_json response.body, ignore_unknown_fields: true
401
-
402
- yield result, operation if block_given?
403
- result
430
+ catch :response do
431
+ yield result, operation if block_given?
432
+ result
433
+ end
404
434
  end
405
435
 
406
436
  ##
@@ -429,16 +459,18 @@ module Google
429
459
 
430
460
  response = @client_stub.make_http_request(
431
461
  verb,
432
- uri: uri,
433
- body: body || "",
434
- params: query_string_params,
462
+ uri: uri,
463
+ body: body || "",
464
+ params: query_string_params,
465
+ method_name: "get_recommender_config",
435
466
  options: options
436
467
  )
437
468
  operation = ::Gapic::Rest::TransportOperation.new response
438
469
  result = ::Google::Cloud::Recommender::V1::RecommenderConfig.decode_json response.body, ignore_unknown_fields: true
439
-
440
- yield result, operation if block_given?
441
- result
470
+ catch :response do
471
+ yield result, operation if block_given?
472
+ result
473
+ end
442
474
  end
443
475
 
444
476
  ##
@@ -467,16 +499,18 @@ module Google
467
499
 
468
500
  response = @client_stub.make_http_request(
469
501
  verb,
470
- uri: uri,
471
- body: body || "",
472
- params: query_string_params,
502
+ uri: uri,
503
+ body: body || "",
504
+ params: query_string_params,
505
+ method_name: "update_recommender_config",
473
506
  options: options
474
507
  )
475
508
  operation = ::Gapic::Rest::TransportOperation.new response
476
509
  result = ::Google::Cloud::Recommender::V1::RecommenderConfig.decode_json response.body, ignore_unknown_fields: true
477
-
478
- yield result, operation if block_given?
479
- result
510
+ catch :response do
511
+ yield result, operation if block_given?
512
+ result
513
+ end
480
514
  end
481
515
 
482
516
  ##
@@ -505,16 +539,18 @@ module Google
505
539
 
506
540
  response = @client_stub.make_http_request(
507
541
  verb,
508
- uri: uri,
509
- body: body || "",
510
- params: query_string_params,
542
+ uri: uri,
543
+ body: body || "",
544
+ params: query_string_params,
545
+ method_name: "get_insight_type_config",
511
546
  options: options
512
547
  )
513
548
  operation = ::Gapic::Rest::TransportOperation.new response
514
549
  result = ::Google::Cloud::Recommender::V1::InsightTypeConfig.decode_json response.body, ignore_unknown_fields: true
515
-
516
- yield result, operation if block_given?
517
- result
550
+ catch :response do
551
+ yield result, operation if block_given?
552
+ result
553
+ end
518
554
  end
519
555
 
520
556
  ##
@@ -543,16 +579,18 @@ module Google
543
579
 
544
580
  response = @client_stub.make_http_request(
545
581
  verb,
546
- uri: uri,
547
- body: body || "",
548
- params: query_string_params,
582
+ uri: uri,
583
+ body: body || "",
584
+ params: query_string_params,
585
+ method_name: "update_insight_type_config",
549
586
  options: options
550
587
  )
551
588
  operation = ::Gapic::Rest::TransportOperation.new response
552
589
  result = ::Google::Cloud::Recommender::V1::InsightTypeConfig.decode_json response.body, ignore_unknown_fields: true
553
-
554
- yield result, operation if block_given?
555
- result
590
+ catch :response do
591
+ yield result, operation if block_given?
592
+ result
593
+ end
556
594
  end
557
595
 
558
596
  ##
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Recommender
23
23
  module V1
24
- VERSION = "1.0.0"
24
+ VERSION = "1.1.0"
25
25
  end
26
26
  end
27
27
  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
@@ -196,9 +199,32 @@ module Google
196
199
  # @!attribute [rw] common
197
200
  # @return [::Google::Api::CommonLanguageSettings]
198
201
  # Some settings.
202
+ # @!attribute [rw] experimental_features
203
+ # @return [::Google::Api::PythonSettings::ExperimentalFeatures]
204
+ # Experimental features to be included during client library generation.
199
205
  class PythonSettings
200
206
  include ::Google::Protobuf::MessageExts
201
207
  extend ::Google::Protobuf::MessageExts::ClassMethods
208
+
209
+ # Experimental features to be included during client library generation.
210
+ # These fields will be deprecated once the feature graduates and is enabled
211
+ # by default.
212
+ # @!attribute [rw] rest_async_io_enabled
213
+ # @return [::Boolean]
214
+ # Enables generation of asynchronous REST clients if `rest` transport is
215
+ # enabled. By default, asynchronous REST clients will not be generated.
216
+ # This feature will be enabled by default 1 month after launching the
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.
224
+ class ExperimentalFeatures
225
+ include ::Google::Protobuf::MessageExts
226
+ extend ::Google::Protobuf::MessageExts::ClassMethods
227
+ end
202
228
  end
203
229
 
204
230
  # Settings for Node client libraries.
@@ -280,9 +306,28 @@ module Google
280
306
  # @!attribute [rw] common
281
307
  # @return [::Google::Api::CommonLanguageSettings]
282
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
283
319
  class GoSettings
284
320
  include ::Google::Protobuf::MessageExts
285
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
286
331
  end
287
332
 
288
333
  # Describes the generator configuration for a method.
@@ -290,6 +335,13 @@ module Google
290
335
  # @return [::String]
291
336
  # The fully qualified name of the method, for which the options below apply.
292
337
  # This is used to find the method to apply the options.
338
+ #
339
+ # Example:
340
+ #
341
+ # publishing:
342
+ # method_settings:
343
+ # - selector: google.storage.control.v2.StorageControl.CreateFolder
344
+ # # method settings for CreateFolder...
293
345
  # @!attribute [rw] long_running
294
346
  # @return [::Google::Api::MethodSettings::LongRunning]
295
347
  # Describes settings to use for long-running operations when generating
@@ -298,17 +350,14 @@ module Google
298
350
  #
299
351
  # Example of a YAML configuration::
300
352
  #
301
- # publishing:
302
- # method_settings:
353
+ # publishing:
354
+ # method_settings:
303
355
  # - selector: google.cloud.speech.v2.Speech.BatchRecognize
304
356
  # long_running:
305
- # initial_poll_delay:
306
- # seconds: 60 # 1 minute
357
+ # initial_poll_delay: 60s # 1 minute
307
358
  # poll_delay_multiplier: 1.5
308
- # max_poll_delay:
309
- # seconds: 360 # 6 minutes
310
- # total_poll_timeout:
311
- # seconds: 54000 # 90 minutes
359
+ # max_poll_delay: 360s # 6 minutes
360
+ # total_poll_timeout: 54000s # 90 minutes
312
361
  # @!attribute [rw] auto_populated_fields
313
362
  # @return [::Array<::String>]
314
363
  # List of top-level fields of the request message, that should be
@@ -317,8 +366,8 @@ module Google
317
366
  #
318
367
  # Example of a YAML configuration:
319
368
  #
320
- # publishing:
321
- # method_settings:
369
+ # publishing:
370
+ # method_settings:
322
371
  # - selector: google.example.v1.ExampleService.CreateExample
323
372
  # auto_populated_fields:
324
373
  # - request_id
@@ -354,6 +403,17 @@ module Google
354
403
  end
355
404
  end
356
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
+
357
417
  # The organization for which the client libraries are being published.
358
418
  # Affects the url where generated docs are published, etc.
359
419
  module ClientLibraryOrganization
@@ -124,8 +124,13 @@ module Google
124
124
  # @return [::String]
125
125
  # The plural name used in the resource name and permission names, such as
126
126
  # 'projects' for the resource name of 'projects/\\{project}' and the permission
127
- # name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
128
- # concept of the `plural` field in k8s CRD spec
127
+ # name of 'cloudresourcemanager.googleapis.com/projects.get'. One exception
128
+ # to this is for Nested Collections that have stuttering names, as defined
129
+ # in [AIP-122](https://google.aip.dev/122#nested-collections), where the
130
+ # collection ID in the resource name pattern does not necessarily directly
131
+ # match the `plural` value.
132
+ #
133
+ # It is the same concept of the `plural` field in k8s CRD spec
129
134
  # https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
130
135
  #
131
136
  # Note: The plural form is required even for singleton resources. See
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-recommender-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.0.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-07-08 00:00:00.000000000 Z
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.21.1
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.21.1
29
+ version: 0.24.0
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
108
108
  - !ruby/object:Gem::Version
109
109
  version: '0'
110
110
  requirements: []
111
- rubygems_version: 3.5.6
111
+ rubygems_version: 3.5.23
112
112
  signing_key:
113
113
  specification_version: 4
114
114
  summary: API Client library for the Recommender V1 API