google-cloud-vision-v1 1.0.1 → 1.2.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -267,8 +267,19 @@ module Google
267
267
  endpoint: @config.endpoint,
268
268
  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
269
269
  universe_domain: @config.universe_domain,
270
- credentials: credentials
270
+ credentials: credentials,
271
+ logger: @config.logger
271
272
  )
273
+
274
+ @product_search_stub.logger(stub: true)&.info do |entry|
275
+ entry.set_system_name
276
+ entry.set_service
277
+ entry.message = "Created client for #{entry.service}"
278
+ entry.set_credentials_fields credentials
279
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
280
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
281
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
282
+ end
272
283
  end
273
284
 
274
285
  ##
@@ -278,6 +289,15 @@ module Google
278
289
  #
279
290
  attr_reader :operations_client
280
291
 
292
+ ##
293
+ # The logger used for request/response debug logging.
294
+ #
295
+ # @return [Logger]
296
+ #
297
+ def logger
298
+ @product_search_stub.logger
299
+ end
300
+
281
301
  # Service calls
282
302
 
283
303
  ##
@@ -367,7 +387,6 @@ module Google
367
387
 
368
388
  @product_search_stub.create_product_set request, options do |result, operation|
369
389
  yield result, operation if block_given?
370
- return result
371
390
  end
372
391
  rescue ::Gapic::Rest::Error => e
373
392
  raise ::Google::Cloud::Error.from_error(e)
@@ -462,7 +481,7 @@ module Google
462
481
  @product_search_stub.list_product_sets request, options do |result, operation|
463
482
  result = ::Gapic::Rest::PagedEnumerable.new @product_search_stub, :list_product_sets, "product_sets", request, result, options
464
483
  yield result, operation if block_given?
465
- return result
484
+ throw :response, result
466
485
  end
467
486
  rescue ::Gapic::Rest::Error => e
468
487
  raise ::Google::Cloud::Error.from_error(e)
@@ -548,7 +567,6 @@ module Google
548
567
 
549
568
  @product_search_stub.get_product_set request, options do |result, operation|
550
569
  yield result, operation if block_given?
551
- return result
552
570
  end
553
571
  rescue ::Gapic::Rest::Error => e
554
572
  raise ::Google::Cloud::Error.from_error(e)
@@ -639,7 +657,6 @@ module Google
639
657
 
640
658
  @product_search_stub.update_product_set request, options do |result, operation|
641
659
  yield result, operation if block_given?
642
- return result
643
660
  end
644
661
  rescue ::Gapic::Rest::Error => e
645
662
  raise ::Google::Cloud::Error.from_error(e)
@@ -724,7 +741,6 @@ module Google
724
741
 
725
742
  @product_search_stub.delete_product_set request, options do |result, operation|
726
743
  yield result, operation if block_given?
727
- return result
728
744
  end
729
745
  rescue ::Gapic::Rest::Error => e
730
746
  raise ::Google::Cloud::Error.from_error(e)
@@ -820,7 +836,6 @@ module Google
820
836
 
821
837
  @product_search_stub.create_product request, options do |result, operation|
822
838
  yield result, operation if block_given?
823
- return result
824
839
  end
825
840
  rescue ::Gapic::Rest::Error => e
826
841
  raise ::Google::Cloud::Error.from_error(e)
@@ -915,7 +930,7 @@ module Google
915
930
  @product_search_stub.list_products request, options do |result, operation|
916
931
  result = ::Gapic::Rest::PagedEnumerable.new @product_search_stub, :list_products, "products", request, result, options
917
932
  yield result, operation if block_given?
918
- return result
933
+ throw :response, result
919
934
  end
920
935
  rescue ::Gapic::Rest::Error => e
921
936
  raise ::Google::Cloud::Error.from_error(e)
@@ -1001,7 +1016,6 @@ module Google
1001
1016
 
1002
1017
  @product_search_stub.get_product request, options do |result, operation|
1003
1018
  yield result, operation if block_given?
1004
- return result
1005
1019
  end
1006
1020
  rescue ::Gapic::Rest::Error => e
1007
1021
  raise ::Google::Cloud::Error.from_error(e)
@@ -1101,7 +1115,6 @@ module Google
1101
1115
 
1102
1116
  @product_search_stub.update_product request, options do |result, operation|
1103
1117
  yield result, operation if block_given?
1104
- return result
1105
1118
  end
1106
1119
  rescue ::Gapic::Rest::Error => e
1107
1120
  raise ::Google::Cloud::Error.from_error(e)
@@ -1187,7 +1200,6 @@ module Google
1187
1200
 
1188
1201
  @product_search_stub.delete_product request, options do |result, operation|
1189
1202
  yield result, operation if block_given?
1190
- return result
1191
1203
  end
1192
1204
  rescue ::Gapic::Rest::Error => e
1193
1205
  raise ::Google::Cloud::Error.from_error(e)
@@ -1296,7 +1308,6 @@ module Google
1296
1308
 
1297
1309
  @product_search_stub.create_reference_image request, options do |result, operation|
1298
1310
  yield result, operation if block_given?
1299
- return result
1300
1311
  end
1301
1312
  rescue ::Gapic::Rest::Error => e
1302
1313
  raise ::Google::Cloud::Error.from_error(e)
@@ -1384,7 +1395,6 @@ module Google
1384
1395
 
1385
1396
  @product_search_stub.delete_reference_image request, options do |result, operation|
1386
1397
  yield result, operation if block_given?
1387
- return result
1388
1398
  end
1389
1399
  rescue ::Gapic::Rest::Error => e
1390
1400
  raise ::Google::Cloud::Error.from_error(e)
@@ -1484,7 +1494,7 @@ module Google
1484
1494
  @product_search_stub.list_reference_images request, options do |result, operation|
1485
1495
  result = ::Gapic::Rest::PagedEnumerable.new @product_search_stub, :list_reference_images, "reference_images", request, result, options
1486
1496
  yield result, operation if block_given?
1487
- return result
1497
+ throw :response, result
1488
1498
  end
1489
1499
  rescue ::Gapic::Rest::Error => e
1490
1500
  raise ::Google::Cloud::Error.from_error(e)
@@ -1570,7 +1580,6 @@ module Google
1570
1580
 
1571
1581
  @product_search_stub.get_reference_image request, options do |result, operation|
1572
1582
  yield result, operation if block_given?
1573
- return result
1574
1583
  end
1575
1584
  rescue ::Gapic::Rest::Error => e
1576
1585
  raise ::Google::Cloud::Error.from_error(e)
@@ -1664,7 +1673,6 @@ module Google
1664
1673
 
1665
1674
  @product_search_stub.add_product_to_product_set request, options do |result, operation|
1666
1675
  yield result, operation if block_given?
1667
- return result
1668
1676
  end
1669
1677
  rescue ::Gapic::Rest::Error => e
1670
1678
  raise ::Google::Cloud::Error.from_error(e)
@@ -1752,7 +1760,6 @@ module Google
1752
1760
 
1753
1761
  @product_search_stub.remove_product_from_product_set request, options do |result, operation|
1754
1762
  yield result, operation if block_given?
1755
- return result
1756
1763
  end
1757
1764
  rescue ::Gapic::Rest::Error => e
1758
1765
  raise ::Google::Cloud::Error.from_error(e)
@@ -1849,7 +1856,7 @@ module Google
1849
1856
  @product_search_stub.list_products_in_product_set request, options do |result, operation|
1850
1857
  result = ::Gapic::Rest::PagedEnumerable.new @product_search_stub, :list_products_in_product_set, "products", request, result, options
1851
1858
  yield result, operation if block_given?
1852
- return result
1859
+ throw :response, result
1853
1860
  end
1854
1861
  rescue ::Gapic::Rest::Error => e
1855
1862
  raise ::Google::Cloud::Error.from_error(e)
@@ -1950,7 +1957,7 @@ module Google
1950
1957
  @product_search_stub.import_product_sets request, options do |result, operation|
1951
1958
  result = ::Gapic::Operation.new result, @operations_client, options: options
1952
1959
  yield result, operation if block_given?
1953
- return result
1960
+ throw :response, result
1954
1961
  end
1955
1962
  rescue ::Gapic::Rest::Error => e
1956
1963
  raise ::Google::Cloud::Error.from_error(e)
@@ -1999,9 +2006,13 @@ module Google
1999
2006
  #
2000
2007
  # @param product_set_purge_config [::Google::Cloud::Vision::V1::ProductSetPurgeConfig, ::Hash]
2001
2008
  # Specify which ProductSet contains the Products to be deleted.
2009
+ #
2010
+ # 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.
2002
2011
  # @param delete_orphan_products [::Boolean]
2003
2012
  # If delete_orphan_products is true, all Products that are not in any
2004
2013
  # ProductSet will be deleted.
2014
+ #
2015
+ # 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.
2005
2016
  # @param parent [::String]
2006
2017
  # Required. The project and location in which the Products should be deleted.
2007
2018
  #
@@ -2070,7 +2081,7 @@ module Google
2070
2081
  @product_search_stub.purge_products request, options do |result, operation|
2071
2082
  result = ::Gapic::Operation.new result, @operations_client, options: options
2072
2083
  yield result, operation if block_given?
2073
- return result
2084
+ throw :response, result
2074
2085
  end
2075
2086
  rescue ::Gapic::Rest::Error => e
2076
2087
  raise ::Google::Cloud::Error.from_error(e)
@@ -2118,6 +2129,13 @@ module Google
2118
2129
  # * (`Signet::OAuth2::Client`) A signet oauth2 client object
2119
2130
  # (see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
2120
2131
  # * (`nil`) indicating no credentials
2132
+ #
2133
+ # Warning: If you accept a credential configuration (JSON file or Hash) from an
2134
+ # external source for authentication to Google Cloud, you must validate it before
2135
+ # providing it to a Google API client library. Providing an unvalidated credential
2136
+ # configuration to Google APIs can compromise the security of your systems and data.
2137
+ # For more information, refer to [Validate credential configurations from external
2138
+ # sources](https://cloud.google.com/docs/authentication/external/externally-sourced-credentials).
2121
2139
  # @return [::Object]
2122
2140
  # @!attribute [rw] scope
2123
2141
  # The OAuth scopes
@@ -2150,6 +2168,11 @@ module Google
2150
2168
  # default endpoint URL. The default value of nil uses the environment
2151
2169
  # universe (usually the default "googleapis.com" universe).
2152
2170
  # @return [::String,nil]
2171
+ # @!attribute [rw] logger
2172
+ # A custom logger to use for request/response debug logging, or the value
2173
+ # `:default` (the default) to construct a default logger, or `nil` to
2174
+ # explicitly disable logging.
2175
+ # @return [::Logger,:default,nil]
2153
2176
  #
2154
2177
  class Configuration
2155
2178
  extend ::Gapic::Config
@@ -2171,6 +2194,7 @@ module Google
2171
2194
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
2172
2195
  config_attr :quota_project, nil, ::String, nil
2173
2196
  config_attr :universe_domain, nil, ::String, nil
2197
+ config_attr :logger, :default, ::Logger, nil, :default
2174
2198
 
2175
2199
  # @private
2176
2200
  def initialize parent_config = nil
@@ -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
  ##