google-cloud-vision-v1 1.0.1 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (18) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +31 -21
  3. data/lib/google/cloud/vision/v1/image_annotator/client.rb +36 -5
  4. data/lib/google/cloud/vision/v1/image_annotator/helpers.rb +0 -12
  5. data/lib/google/cloud/vision/v1/image_annotator/operations.rb +19 -15
  6. data/lib/google/cloud/vision/v1/image_annotator/rest/client.rb +36 -5
  7. data/lib/google/cloud/vision/v1/image_annotator/rest/operations.rb +50 -38
  8. data/lib/google/cloud/vision/v1/image_annotator/rest/service_stub.rb +46 -26
  9. data/lib/google/cloud/vision/v1/product_search/client.rb +44 -20
  10. data/lib/google/cloud/vision/v1/product_search/operations.rb +19 -15
  11. data/lib/google/cloud/vision/v1/product_search/rest/client.rb +44 -20
  12. data/lib/google/cloud/vision/v1/product_search/rest/operations.rb +50 -38
  13. data/lib/google/cloud/vision/v1/product_search/rest/service_stub.rb +166 -116
  14. data/lib/google/cloud/vision/v1/version.rb +1 -1
  15. data/proto_docs/google/api/client.rb +39 -0
  16. data/proto_docs/google/cloud/vision/v1/product_search_service.rb +4 -0
  17. data/proto_docs/google/longrunning/operations.rb +23 -14
  18. metadata +6 -9
data/lib/google/cloud/vision/v1/image_annotator/rest/operations.rb CHANGED
@@ -115,14 +115,6 @@ module Google
115
115
  # Lists operations that match the specified filter in the request. If the
116
116
  # server doesn't support this method, it returns `UNIMPLEMENTED`.
117
117
  #
118
- # NOTE: the `name` binding allows API services to override the binding
119
- # to use different resource name schemes, such as `users/*/operations`. To
120
- # override the binding, API services can add a binding such as
121
- # `"/v1/{name=users/*}/operations"` to their service configuration.
122
- # For backwards compatibility, the default name includes the operations
123
- # collection id, however overriding users must ensure the name binding
124
- # is the parent resource, without the operations collection id.
125
- #
126
118
  # @overload list_operations(request, options = nil)
127
119
  # Pass arguments to `list_operations` via a request object, either of type
128
120
  # {::Google::Longrunning::ListOperationsRequest} or an equivalent Hash.
@@ -204,7 +196,7 @@ module Google
204
196
  @operations_stub.list_operations request, options do |result, operation|
205
197
  result = ::Gapic::Rest::PagedEnumerable.new @operations_stub, :list_operations, "operations", request, result, options
206
198
  yield result, operation if block_given?
207
- return result
199
+ throw :response, result
208
200
  end
209
201
  rescue ::Gapic::Rest::Error => e
210
202
  raise ::Google::Cloud::Error.from_error(e)
@@ -293,7 +285,7 @@ module Google
293
285
  @operations_stub.get_operation request, options do |result, operation|
294
286
  result = ::Gapic::Operation.new result, @operations_client, options: options
295
287
  yield result, operation if block_given?
296
- return result
288
+ throw :response, result
297
289
  end
298
290
  rescue ::Gapic::Rest::Error => e
299
291
  raise ::Google::Cloud::Error.from_error(e)
@@ -375,7 +367,6 @@ module Google
375
367
 
376
368
  @operations_stub.delete_operation request, options do |result, operation|
377
369
  yield result, operation if block_given?
378
- return result
379
370
  end
380
371
  rescue ::Gapic::Rest::Error => e
381
372
  raise ::Google::Cloud::Error.from_error(e)
@@ -390,8 +381,9 @@ module Google
390
381
  # other methods to check whether the cancellation succeeded or whether the
391
382
  # operation completed despite cancellation. On successful cancellation,
392
383
  # the operation is not deleted; instead, it becomes an operation with
393
- # an {::Google::Longrunning::Operation#error Operation.error} value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
394
- # corresponding to `Code.CANCELLED`.
384
+ # an {::Google::Longrunning::Operation#error Operation.error} value with a
385
+ # {::Google::Rpc::Status#code google.rpc.Status.code} of `1`, corresponding to
386
+ # `Code.CANCELLED`.
395
387
  #
396
388
  # @overload cancel_operation(request, options = nil)
397
389
  # Pass arguments to `cancel_operation` via a request object, either of type
@@ -463,7 +455,6 @@ module Google
463
455
 
464
456
  @operations_stub.cancel_operation request, options do |result, operation|
465
457
  yield result, operation if block_given?
466
- return result
467
458
  end
468
459
  rescue ::Gapic::Rest::Error => e
469
460
  raise ::Google::Cloud::Error.from_error(e)
@@ -511,6 +502,13 @@ module Google
511
502
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
512
503
  # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
513
504
  # * (`nil`) indicating no credentials
505
+ #
506
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
507
+ # external source for authentication to Google Cloud, you must validate it before
508
+ # providing it to a Google API client library. Providing an unvalidated credential
509
+ # configuration to Google APIs can compromise the security of your systems and data.
510
+ # For more information, refer to [Validate credential configurations from external
511
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
514
512
  # @return [::Object]
515
513
  # @!attribute [rw] scope
516
514
  # The OAuth scopes
@@ -543,6 +541,11 @@ module Google
543
541
  # default endpoint URL. The default value of nil uses the environment
544
542
  # universe (usually the default "googleapis.com" universe).
545
543
  # @return [::String,nil]
544
+ # @!attribute [rw] logger
545
+ # A custom logger to use for request/response debug logging, or the value
546
+ # `:default` (the default) to construct a default logger, or `nil` to
547
+ # explicitly disable logging.
548
+ # @return [::Logger,:default,nil]
546
549
  #
547
550
  class Configuration
548
551
  extend ::Gapic::Config
@@ -564,6 +567,7 @@ module Google
564
567
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
565
568
  config_attr :quota_project, nil, ::String, nil
566
569
  config_attr :universe_domain, nil, ::String, nil
570
+ config_attr :logger, :default, ::Logger, nil, :default
567
571
 
568
572
  # @private
569
573
  def initialize parent_config = nil
@@ -683,16 +687,18 @@ module Google
683
687
 
684
688
  response = @client_stub.make_http_request(
685
689
  verb,
686
- uri: uri,
687
- body: body || "",
688
- params: query_string_params,
690
+ uri: uri,
691
+ body: body || "",
692
+ params: query_string_params,
693
+ method_name: "list_operations",
689
694
  options: options
690
695
  )
691
696
  operation = ::Gapic::Rest::TransportOperation.new response
692
697
  result = ::Google::Longrunning::ListOperationsResponse.decode_json response.body, ignore_unknown_fields: true
693
-
694
- yield result, operation if block_given?
695
- result
698
+ catch :response do
699
+ yield result, operation if block_given?
700
+ result
701
+ end
696
702
  end
697
703
 
698
704
  ##
@@ -721,16 +727,18 @@ module Google
721
727
 
722
728
  response = @client_stub.make_http_request(
723
729
  verb,
724
- uri: uri,
725
- body: body || "",
726
- params: query_string_params,
730
+ uri: uri,
731
+ body: body || "",
732
+ params: query_string_params,
733
+ method_name: "get_operation",
727
734
  options: options
728
735
  )
729
736
  operation = ::Gapic::Rest::TransportOperation.new response
730
737
  result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
731
-
732
- yield result, operation if block_given?
733
- result
738
+ catch :response do
739
+ yield result, operation if block_given?
740
+ result
741
+ end
734
742
  end
735
743
 
736
744
  ##
@@ -759,16 +767,18 @@ module Google
759
767
 
760
768
  response = @client_stub.make_http_request(
761
769
  verb,
762
- uri: uri,
763
- body: body || "",
764
- params: query_string_params,
770
+ uri: uri,
771
+ body: body || "",
772
+ params: query_string_params,
773
+ method_name: "delete_operation",
765
774
  options: options
766
775
  )
767
776
  operation = ::Gapic::Rest::TransportOperation.new response
768
777
  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
769
-
770
- yield result, operation if block_given?
771
- result
778
+ catch :response do
779
+ yield result, operation if block_given?
780
+ result
781
+ end
772
782
  end
773
783
 
774
784
  ##
@@ -797,16 +807,18 @@ module Google
797
807
 
798
808
  response = @client_stub.make_http_request(
799
809
  verb,
800
- uri: uri,
801
- body: body || "",
802
- params: query_string_params,
810
+ uri: uri,
811
+ body: body || "",
812
+ params: query_string_params,
813
+ method_name: "cancel_operation",
803
814
  options: options
804
815
  )
805
816
  operation = ::Gapic::Rest::TransportOperation.new response
806
817
  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
807
-
808
- yield result, operation if block_given?
809
- result
818
+ catch :response do
819
+ yield result, operation if block_given?
820
+ result
821
+ end
810
822
  end
811
823
 
812
824
  ##
data/lib/google/cloud/vision/v1/image_annotator/rest/service_stub.rb CHANGED
@@ -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 batch_annotate_images 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: "batch_annotate_images",
93
106
  options: options
94
107
  )
95
108
  operation = ::Gapic::Rest::TransportOperation.new response
96
109
  result = ::Google::Cloud::Vision::V1::BatchAnnotateImagesResponse.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: "batch_annotate_files",
131
146
  options: options
132
147
  )
133
148
  operation = ::Gapic::Rest::TransportOperation.new response
134
149
  result = ::Google::Cloud::Vision::V1::BatchAnnotateFilesResponse.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: "async_batch_annotate_images",
169
186
  options: options
170
187
  )
171
188
  operation = ::Gapic::Rest::TransportOperation.new response
172
189
  result = ::Google::Longrunning::Operation.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: "async_batch_annotate_files",
207
226
  options: options
208
227
  )
209
228
  operation = ::Gapic::Rest::TransportOperation.new response
210
229
  result = ::Google::Longrunning::Operation.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
  ##
data/lib/google/cloud/vision/v1/product_search/client.rb CHANGED
@@ -274,8 +274,19 @@ module Google
274
274
  universe_domain: @config.universe_domain,
275
275
  channel_args: @config.channel_args,
276
276
  interceptors: @config.interceptors,
277
- channel_pool_config: @config.channel_pool
277
+ channel_pool_config: @config.channel_pool,
278
+ logger: @config.logger
278
279
  )
280
+
281
+ @product_search_stub.stub_logger&.info do |entry|
282
+ entry.set_system_name
283
+ entry.set_service
284
+ entry.message = "Created client for #{entry.service}"
285
+ entry.set_credentials_fields credentials
286
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
287
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
288
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
289
+ end
279
290
  end
280
291
 
281
292
  ##
@@ -285,6 +296,15 @@ module Google
285
296
  #
286
297
  attr_reader :operations_client
287
298
 
299
+ ##
300
+ # The logger used for request/response debug logging.
301
+ #
302
+ # @return [Logger]
303
+ #
304
+ def logger
305
+ @product_search_stub.logger
306
+ end
307
+
288
308
  # Service calls
289
309
 
290
310
  ##
@@ -381,7 +401,6 @@ module Google
381
401
 
382
402
  @product_search_stub.call_rpc :create_product_set, request, options: options do |response, operation|
383
403
  yield response, operation if block_given?
384
- return response
385
404
  end
386
405
  rescue ::GRPC::BadStatus => e
387
406
  raise ::Google::Cloud::Error.from_error(e)
@@ -483,7 +502,7 @@ module Google
483
502
  @product_search_stub.call_rpc :list_product_sets, request, options: options do |response, operation|
484
503
  response = ::Gapic::PagedEnumerable.new @product_search_stub, :list_product_sets, request, response, operation, options
485
504
  yield response, operation if block_given?
486
- return response
505
+ throw :response, response
487
506
  end
488
507
  rescue ::GRPC::BadStatus => e
489
508
  raise ::Google::Cloud::Error.from_error(e)
@@ -576,7 +595,6 @@ module Google
576
595
 
577
596
  @product_search_stub.call_rpc :get_product_set, request, options: options do |response, operation|
578
597
  yield response, operation if block_given?
579
- return response
580
598
  end
581
599
  rescue ::GRPC::BadStatus => e
582
600
  raise ::Google::Cloud::Error.from_error(e)
@@ -674,7 +692,6 @@ module Google
674
692
 
675
693
  @product_search_stub.call_rpc :update_product_set, request, options: options do |response, operation|
676
694
  yield response, operation if block_given?
677
- return response
678
695
  end
679
696
  rescue ::GRPC::BadStatus => e
680
697
  raise ::Google::Cloud::Error.from_error(e)
@@ -766,7 +783,6 @@ module Google
766
783
 
767
784
  @product_search_stub.call_rpc :delete_product_set, request, options: options do |response, operation|
768
785
  yield response, operation if block_given?
769
- return response
770
786
  end
771
787
  rescue ::GRPC::BadStatus => e
772
788
  raise ::Google::Cloud::Error.from_error(e)
@@ -869,7 +885,6 @@ module Google
869
885
 
870
886
  @product_search_stub.call_rpc :create_product, request, options: options do |response, operation|
871
887
  yield response, operation if block_given?
872
- return response
873
888
  end
874
889
  rescue ::GRPC::BadStatus => e
875
890
  raise ::Google::Cloud::Error.from_error(e)
@@ -971,7 +986,7 @@ module Google
971
986
  @product_search_stub.call_rpc :list_products, request, options: options do |response, operation|
972
987
  response = ::Gapic::PagedEnumerable.new @product_search_stub, :list_products, request, response, operation, options
973
988
  yield response, operation if block_given?
974
- return response
989
+ throw :response, response
975
990
  end
976
991
  rescue ::GRPC::BadStatus => e
977
992
  raise ::Google::Cloud::Error.from_error(e)
@@ -1064,7 +1079,6 @@ module Google
1064
1079
 
1065
1080
  @product_search_stub.call_rpc :get_product, request, options: options do |response, operation|
1066
1081
  yield response, operation if block_given?
1067
- return response
1068
1082
  end
1069
1083
  rescue ::GRPC::BadStatus => e
1070
1084
  raise ::Google::Cloud::Error.from_error(e)
@@ -1171,7 +1185,6 @@ module Google
1171
1185
 
1172
1186
  @product_search_stub.call_rpc :update_product, request, options: options do |response, operation|
1173
1187
  yield response, operation if block_given?
1174
- return response
1175
1188
  end
1176
1189
  rescue ::GRPC::BadStatus => e
1177
1190
  raise ::Google::Cloud::Error.from_error(e)
@@ -1264,7 +1277,6 @@ module Google
1264
1277
 
1265
1278
  @product_search_stub.call_rpc :delete_product, request, options: options do |response, operation|
1266
1279
  yield response, operation if block_given?
1267
- return response
1268
1280
  end
1269
1281
  rescue ::GRPC::BadStatus => e
1270
1282
  raise ::Google::Cloud::Error.from_error(e)
@@ -1380,7 +1392,6 @@ module Google
1380
1392
 
1381
1393
  @product_search_stub.call_rpc :create_reference_image, request, options: options do |response, operation|
1382
1394
  yield response, operation if block_given?
1383
- return response
1384
1395
  end
1385
1396
  rescue ::GRPC::BadStatus => e
1386
1397
  raise ::Google::Cloud::Error.from_error(e)
@@ -1475,7 +1486,6 @@ module Google
1475
1486
 
1476
1487
  @product_search_stub.call_rpc :delete_reference_image, request, options: options do |response, operation|
1477
1488
  yield response, operation if block_given?
1478
- return response
1479
1489
  end
1480
1490
  rescue ::GRPC::BadStatus => e
1481
1491
  raise ::Google::Cloud::Error.from_error(e)
@@ -1582,7 +1592,7 @@ module Google
1582
1592
  @product_search_stub.call_rpc :list_reference_images, request, options: options do |response, operation|
1583
1593
  response = ::Gapic::PagedEnumerable.new @product_search_stub, :list_reference_images, request, response, operation, options
1584
1594
  yield response, operation if block_given?
1585
- return response
1595
+ throw :response, response
1586
1596
  end
1587
1597
  rescue ::GRPC::BadStatus => e
1588
1598
  raise ::Google::Cloud::Error.from_error(e)
@@ -1675,7 +1685,6 @@ module Google
1675
1685
 
1676
1686
  @product_search_stub.call_rpc :get_reference_image, request, options: options do |response, operation|
1677
1687
  yield response, operation if block_given?
1678
- return response
1679
1688
  end
1680
1689
  rescue ::GRPC::BadStatus => e
1681
1690
  raise ::Google::Cloud::Error.from_error(e)
@@ -1776,7 +1785,6 @@ module Google
1776
1785
 
1777
1786
  @product_search_stub.call_rpc :add_product_to_product_set, request, options: options do |response, operation|
1778
1787
  yield response, operation if block_given?
1779
- return response
1780
1788
  end
1781
1789
  rescue ::GRPC::BadStatus => e
1782
1790
  raise ::Google::Cloud::Error.from_error(e)
@@ -1871,7 +1879,6 @@ module Google
1871
1879
 
1872
1880
  @product_search_stub.call_rpc :remove_product_from_product_set, request, options: options do |response, operation|
1873
1881
  yield response, operation if block_given?
1874
- return response
1875
1882
  end
1876
1883
  rescue ::GRPC::BadStatus => e
1877
1884
  raise ::Google::Cloud::Error.from_error(e)
@@ -1975,7 +1982,7 @@ module Google
1975
1982
  @product_search_stub.call_rpc :list_products_in_product_set, request, options: options do |response, operation|
1976
1983
  response = ::Gapic::PagedEnumerable.new @product_search_stub, :list_products_in_product_set, request, response, operation, options
1977
1984
  yield response, operation if block_given?
1978
- return response
1985
+ throw :response, response
1979
1986
  end
1980
1987
  rescue ::GRPC::BadStatus => e
1981
1988
  raise ::Google::Cloud::Error.from_error(e)
@@ -2083,7 +2090,7 @@ module Google
2083
2090
  @product_search_stub.call_rpc :import_product_sets, request, options: options do |response, operation|
2084
2091
  response = ::Gapic::Operation.new response, @operations_client, options: options
2085
2092
  yield response, operation if block_given?
2086
- return response
2093
+ throw :response, response
2087
2094
  end
2088
2095
  rescue ::GRPC::BadStatus => e
2089
2096
  raise ::Google::Cloud::Error.from_error(e)
@@ -2132,9 +2139,13 @@ module Google
2132
2139
  #
2133
2140
  # @param product_set_purge_config [::Google::Cloud::Vision::V1::ProductSetPurgeConfig, ::Hash]
2134
2141
  # Specify which ProductSet contains the Products to be deleted.
2142
+ #
2143
+ # Note: The following fields are mutually exclusive: `product_set_purge_config`, `delete_orphan_products`. If a field in that set is populated, all other fields in the set will automatically be cleared.
2135
2144
  # @param delete_orphan_products [::Boolean]
2136
2145
  # If delete_orphan_products is true, all Products that are not in any
2137
2146
  # ProductSet will be deleted.
2147
+ #
2148
+ # Note: The following fields are mutually exclusive: `delete_orphan_products`, `product_set_purge_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
2138
2149
  # @param parent [::String]
2139
2150
  # Required. The project and location in which the Products should be deleted.
2140
2151
  #
@@ -2210,7 +2221,7 @@ module Google
2210
2221
  @product_search_stub.call_rpc :purge_products, request, options: options do |response, operation|
2211
2222
  response = ::Gapic::Operation.new response, @operations_client, options: options
2212
2223
  yield response, operation if block_given?
2213
- return response
2224
+ throw :response, response
2214
2225
  end
2215
2226
  rescue ::GRPC::BadStatus => e
2216
2227
  raise ::Google::Cloud::Error.from_error(e)
@@ -2260,6 +2271,13 @@ module Google
2260
2271
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
2261
2272
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
2262
2273
  # * (`nil`) indicating no credentials
2274
+ #
2275
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
2276
+ # external source for authentication to Google Cloud, you must validate it before
2277
+ # providing it to a Google API client library. Providing an unvalidated credential
2278
+ # configuration to Google APIs can compromise the security of your systems and data.
2279
+ # For more information, refer to [Validate credential configurations from external
2280
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
2263
2281
  # @return [::Object]
2264
2282
  # @!attribute [rw] scope
2265
2283
  # The OAuth scopes
@@ -2299,6 +2317,11 @@ module Google
2299
2317
  # default endpoint URL. The default value of nil uses the environment
2300
2318
  # universe (usually the default "googleapis.com" universe).
2301
2319
  # @return [::String,nil]
2320
+ # @!attribute [rw] logger
2321
+ # A custom logger to use for request/response debug logging, or the value
2322
+ # `:default` (the default) to construct a default logger, or `nil` to
2323
+ # explicitly disable logging.
2324
+ # @return [::Logger,:default,nil]
2302
2325
  #
2303
2326
  class Configuration
2304
2327
  extend ::Gapic::Config
@@ -2323,6 +2346,7 @@ module Google
2323
2346
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
2324
2347
  config_attr :quota_project, nil, ::String, nil
2325
2348
  config_attr :universe_domain, nil, ::String, nil
2349
+ config_attr :logger, :default, ::Logger, nil, :default
2326
2350
 
2327
2351
  # @private
2328
2352
  def initialize parent_config = nil
data/lib/google/cloud/vision/v1/product_search/operations.rb CHANGED
@@ -124,14 +124,6 @@ module Google
124
124
  # Lists operations that match the specified filter in the request. If the
125
125
  # server doesn't support this method, it returns `UNIMPLEMENTED`.
126
126
  #
127
- # NOTE: the `name` binding allows API services to override the binding
128
- # to use different resource name schemes, such as `users/*/operations`. To
129
- # override the binding, API services can add a binding such as
130
- # `"/v1/{name=users/*}/operations"` to their service configuration.
131
- # For backwards compatibility, the default name includes the operations
132
- # collection id, however overriding users must ensure the name binding
133
- # is the parent resource, without the operations collection id.
134
- #
135
127
  # @overload list_operations(request, options = nil)
136
128
  # Pass arguments to `list_operations` via a request object, either of type
137
129
  # {::Google::Longrunning::ListOperationsRequest} or an equivalent Hash.
@@ -221,7 +213,7 @@ module Google
221
213
  wrap_lro_operation = ->(op_response) { ::Gapic::Operation.new op_response, @operations_client }
222
214
  response = ::Gapic::PagedEnumerable.new @operations_stub, :list_operations, request, response, operation, options, format_resource: wrap_lro_operation
223
215
  yield response, operation if block_given?
224
- return response
216
+ throw :response, response
225
217
  end
226
218
  rescue ::GRPC::BadStatus => e
227
219
  raise ::Google::Cloud::Error.from_error(e)
@@ -317,7 +309,7 @@ module Google
317
309
  @operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
318
310
  response = ::Gapic::Operation.new response, @operations_client, options: options
319
311
  yield response, operation if block_given?
320
- return response
312
+ throw :response, response
321
313
  end
322
314
  rescue ::GRPC::BadStatus => e
323
315
  raise ::Google::Cloud::Error.from_error(e)
@@ -406,7 +398,6 @@ module Google
406
398
 
407
399
  @operations_stub.call_rpc :delete_operation, request, options: options do |response, operation|
408
400
  yield response, operation if block_given?
409
- return response
410
401
  end
411
402
  rescue ::GRPC::BadStatus => e
412
403
  raise ::Google::Cloud::Error.from_error(e)
@@ -421,8 +412,9 @@ module Google
421
412
  # other methods to check whether the cancellation succeeded or whether the
422
413
  # operation completed despite cancellation. On successful cancellation,
423
414
  # the operation is not deleted; instead, it becomes an operation with
424
- # an {::Google::Longrunning::Operation#error Operation.error} value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1,
425
- # corresponding to `Code.CANCELLED`.
415
+ # an {::Google::Longrunning::Operation#error Operation.error} value with a
416
+ # {::Google::Rpc::Status#code google.rpc.Status.code} of `1`, corresponding to
417
+ # `Code.CANCELLED`.
426
418
  #
427
419
  # @overload cancel_operation(request, options = nil)
428
420
  # Pass arguments to `cancel_operation` via a request object, either of type
@@ -501,7 +493,6 @@ module Google
501
493
 
502
494
  @operations_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
503
495
  yield response, operation if block_given?
504
- return response
505
496
  end
506
497
  rescue ::GRPC::BadStatus => e
507
498
  raise ::Google::Cloud::Error.from_error(e)
@@ -599,7 +590,7 @@ module Google
599
590
  @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
600
591
  response = ::Gapic::Operation.new response, @operations_client, options: options
601
592
  yield response, operation if block_given?
602
- return response
593
+ throw :response, response
603
594
  end
604
595
  rescue ::GRPC::BadStatus => e
605
596
  raise ::Google::Cloud::Error.from_error(e)
@@ -649,6 +640,13 @@ module Google
649
640
  # * (`GRPC::Core::Channel`) a gRPC channel with included credentials
650
641
  # * (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
651
642
  # * (`nil`) indicating no credentials
643
+ #
644
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
645
+ # external source for authentication to Google Cloud, you must validate it before
646
+ # providing it to a Google API client library. Providing an unvalidated credential
647
+ # configuration to Google APIs can compromise the security of your systems and data.
648
+ # For more information, refer to [Validate credential configurations from external
649
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
652
650
  # @return [::Object]
653
651
  # @!attribute [rw] scope
654
652
  # The OAuth scopes
@@ -688,6 +686,11 @@ module Google
688
686
  # default endpoint URL. The default value of nil uses the environment
689
687
  # universe (usually the default "googleapis.com" universe).
690
688
  # @return [::String,nil]
689
+ # @!attribute [rw] logger
690
+ # A custom logger to use for request/response debug logging, or the value
691
+ # `:default` (the default) to construct a default logger, or `nil` to
692
+ # explicitly disable logging.
693
+ # @return [::Logger,:default,nil]
691
694
  #
692
695
  class Configuration
693
696
  extend ::Gapic::Config
@@ -712,6 +715,7 @@ module Google
712
715
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
713
716
  config_attr :quota_project, nil, ::String, nil
714
717
  config_attr :universe_domain, nil, ::String, nil
718
+ config_attr :logger, :default, ::Logger, nil, :default
715
719
 
716
720
  # @private
717
721
  def initialize parent_config = nil