google-cloud-language-v1beta2 0.11.0 → 0.12.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3ed4c296c2364d4d580ee27df8d1e538664a3cf9d25685f6a6b1ef520f984665
4
- data.tar.gz: 0ad77c4c60772be86522bfd1a9713f40875d1ff97023e876ac3502b4efbe24d9
3
+ metadata.gz: f9fa73d531286cb58d982defab1159a6d726fd4ce471f9ca847b12a8f34a93c2
4
+ data.tar.gz: 27b08c92d6778bcb8807bc3f9a02e3139a3c5ea98131d87aa98048651ae72dc3
5
5
  SHA512:
6
- metadata.gz: e6ea5fc6e36b59362760b3a4cd2d01de1848f3af2920e2147d0acf869cb3c2c7c0d2f04e9b203bf6a735e91880d653a59e14dfee0dd7d95b42bef1b649da3124
7
- data.tar.gz: af20370916c1204efde8e888c1eba0921cdeb6f7be0be798e16a4a207f809b04fc74b1c688232fa1fcd6c7b3d09529ac0ba0d89ebdfb9a18a60de32f6dc21f38
6
+ metadata.gz: 15b843d67914c06f16e7de71c8442950802720957224783aca122096ce3bc4e6f0080be776aa14a360fb2603c89749d4c0a8b652e7fd548e698c57b8a7331588
7
+ data.tar.gz: 147dc7b2e4eb8d672dbaa2e9f328fc43a90c29ade503589b93fdf5c2b9f4375ac4d19e9c242187b4c5f8f45c3498d43c1070bbf267743be6915002d03fbd7e1a
data/README.md CHANGED
@@ -43,33 +43,43 @@ for class and method documentation.
43
43
  See also the [Product Documentation](https://cloud.google.com/natural-language)
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/language/v1beta2"
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::Language::V1beta2::LanguageService::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).
@@ -31,6 +31,9 @@ module Google
31
31
  # recognition.
32
32
  #
33
33
  class Client
34
+ # @private
35
+ API_VERSION = ""
36
+
34
37
  # @private
35
38
  DEFAULT_ENDPOINT_TEMPLATE = "language.$UNIVERSE_DOMAIN$"
36
39
 
@@ -183,8 +186,28 @@ module Google
183
186
  universe_domain: @config.universe_domain,
184
187
  channel_args: @config.channel_args,
185
188
  interceptors: @config.interceptors,
186
- channel_pool_config: @config.channel_pool
189
+ channel_pool_config: @config.channel_pool,
190
+ logger: @config.logger
187
191
  )
192
+
193
+ @language_service_stub.stub_logger&.info do |entry|
194
+ entry.set_system_name
195
+ entry.set_service
196
+ entry.message = "Created client for #{entry.service}"
197
+ entry.set_credentials_fields credentials
198
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
199
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
200
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
201
+ end
202
+ end
203
+
204
+ ##
205
+ # The logger used for request/response debug logging.
206
+ #
207
+ # @return [Logger]
208
+ #
209
+ def logger
210
+ @language_service_stub.logger
188
211
  end
189
212
 
190
213
  # Service calls
@@ -247,10 +270,11 @@ module Google
247
270
  # Customize the options with defaults
248
271
  metadata = @config.rpcs.analyze_sentiment.metadata.to_h
249
272
 
250
- # Set x-goog-api-client and x-goog-user-project headers
273
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
251
274
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
252
275
  lib_name: @config.lib_name, lib_version: @config.lib_version,
253
276
  gapic_version: ::Google::Cloud::Language::V1beta2::VERSION
277
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
254
278
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
255
279
 
256
280
  options.apply_defaults timeout: @config.rpcs.analyze_sentiment.timeout,
@@ -263,7 +287,6 @@ module Google
263
287
 
264
288
  @language_service_stub.call_rpc :analyze_sentiment, request, options: options do |response, operation|
265
289
  yield response, operation if block_given?
266
- return response
267
290
  end
268
291
  rescue ::GRPC::BadStatus => e
269
292
  raise ::Google::Cloud::Error.from_error(e)
@@ -328,10 +351,11 @@ module Google
328
351
  # Customize the options with defaults
329
352
  metadata = @config.rpcs.analyze_entities.metadata.to_h
330
353
 
331
- # Set x-goog-api-client and x-goog-user-project headers
354
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
332
355
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
333
356
  lib_name: @config.lib_name, lib_version: @config.lib_version,
334
357
  gapic_version: ::Google::Cloud::Language::V1beta2::VERSION
358
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
335
359
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
336
360
 
337
361
  options.apply_defaults timeout: @config.rpcs.analyze_entities.timeout,
@@ -344,7 +368,6 @@ module Google
344
368
 
345
369
  @language_service_stub.call_rpc :analyze_entities, request, options: options do |response, operation|
346
370
  yield response, operation if block_given?
347
- return response
348
371
  end
349
372
  rescue ::GRPC::BadStatus => e
350
373
  raise ::Google::Cloud::Error.from_error(e)
@@ -410,10 +433,11 @@ module Google
410
433
  # Customize the options with defaults
411
434
  metadata = @config.rpcs.analyze_entity_sentiment.metadata.to_h
412
435
 
413
- # Set x-goog-api-client and x-goog-user-project headers
436
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
414
437
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
415
438
  lib_name: @config.lib_name, lib_version: @config.lib_version,
416
439
  gapic_version: ::Google::Cloud::Language::V1beta2::VERSION
440
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
417
441
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
418
442
 
419
443
  options.apply_defaults timeout: @config.rpcs.analyze_entity_sentiment.timeout,
@@ -426,7 +450,6 @@ module Google
426
450
 
427
451
  @language_service_stub.call_rpc :analyze_entity_sentiment, request, options: options do |response, operation|
428
452
  yield response, operation if block_given?
429
- return response
430
453
  end
431
454
  rescue ::GRPC::BadStatus => e
432
455
  raise ::Google::Cloud::Error.from_error(e)
@@ -491,10 +514,11 @@ module Google
491
514
  # Customize the options with defaults
492
515
  metadata = @config.rpcs.analyze_syntax.metadata.to_h
493
516
 
494
- # Set x-goog-api-client and x-goog-user-project headers
517
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
495
518
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
496
519
  lib_name: @config.lib_name, lib_version: @config.lib_version,
497
520
  gapic_version: ::Google::Cloud::Language::V1beta2::VERSION
521
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
498
522
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
499
523
 
500
524
  options.apply_defaults timeout: @config.rpcs.analyze_syntax.timeout,
@@ -507,7 +531,6 @@ module Google
507
531
 
508
532
  @language_service_stub.call_rpc :analyze_syntax, request, options: options do |response, operation|
509
533
  yield response, operation if block_given?
510
- return response
511
534
  end
512
535
  rescue ::GRPC::BadStatus => e
513
536
  raise ::Google::Cloud::Error.from_error(e)
@@ -571,10 +594,11 @@ module Google
571
594
  # Customize the options with defaults
572
595
  metadata = @config.rpcs.classify_text.metadata.to_h
573
596
 
574
- # Set x-goog-api-client and x-goog-user-project headers
597
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
575
598
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
576
599
  lib_name: @config.lib_name, lib_version: @config.lib_version,
577
600
  gapic_version: ::Google::Cloud::Language::V1beta2::VERSION
601
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
578
602
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
579
603
 
580
604
  options.apply_defaults timeout: @config.rpcs.classify_text.timeout,
@@ -587,7 +611,6 @@ module Google
587
611
 
588
612
  @language_service_stub.call_rpc :classify_text, request, options: options do |response, operation|
589
613
  yield response, operation if block_given?
590
- return response
591
614
  end
592
615
  rescue ::GRPC::BadStatus => e
593
616
  raise ::Google::Cloud::Error.from_error(e)
@@ -648,10 +671,11 @@ module Google
648
671
  # Customize the options with defaults
649
672
  metadata = @config.rpcs.moderate_text.metadata.to_h
650
673
 
651
- # Set x-goog-api-client and x-goog-user-project headers
674
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
652
675
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
653
676
  lib_name: @config.lib_name, lib_version: @config.lib_version,
654
677
  gapic_version: ::Google::Cloud::Language::V1beta2::VERSION
678
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
655
679
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
656
680
 
657
681
  options.apply_defaults timeout: @config.rpcs.moderate_text.timeout,
@@ -664,7 +688,6 @@ module Google
664
688
 
665
689
  @language_service_stub.call_rpc :moderate_text, request, options: options do |response, operation|
666
690
  yield response, operation if block_given?
667
- return response
668
691
  end
669
692
  rescue ::GRPC::BadStatus => e
670
693
  raise ::Google::Cloud::Error.from_error(e)
@@ -730,10 +753,11 @@ module Google
730
753
  # Customize the options with defaults
731
754
  metadata = @config.rpcs.annotate_text.metadata.to_h
732
755
 
733
- # Set x-goog-api-client and x-goog-user-project headers
756
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
734
757
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
735
758
  lib_name: @config.lib_name, lib_version: @config.lib_version,
736
759
  gapic_version: ::Google::Cloud::Language::V1beta2::VERSION
760
+ metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
737
761
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
738
762
 
739
763
  options.apply_defaults timeout: @config.rpcs.annotate_text.timeout,
@@ -746,7 +770,6 @@ module Google
746
770
 
747
771
  @language_service_stub.call_rpc :annotate_text, request, options: options do |response, operation|
748
772
  yield response, operation if block_given?
749
- return response
750
773
  end
751
774
  rescue ::GRPC::BadStatus => e
752
775
  raise ::Google::Cloud::Error.from_error(e)
@@ -835,6 +858,11 @@ module Google
835
858
  # default endpoint URL. The default value of nil uses the environment
836
859
  # universe (usually the default "googleapis.com" universe).
837
860
  # @return [::String,nil]
861
+ # @!attribute [rw] logger
862
+ # A custom logger to use for request/response debug logging, or the value
863
+ # `:default` (the default) to construct a default logger, or `nil` to
864
+ # explicitly disable logging.
865
+ # @return [::Logger,:default,nil]
838
866
  #
839
867
  class Configuration
840
868
  extend ::Gapic::Config
@@ -859,6 +887,7 @@ module Google
859
887
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
860
888
  config_attr :quota_project, nil, ::String, nil
861
889
  config_attr :universe_domain, nil, ::String, nil
890
+ config_attr :logger, :default, ::Logger, nil, :default
862
891
 
863
892
  # @private
864
893
  def initialize parent_config = nil
@@ -33,6 +33,9 @@ module Google
33
33
  # recognition.
34
34
  #
35
35
  class Client
36
+ # @private
37
+ API_VERSION = ""
38
+
36
39
  # @private
37
40
  DEFAULT_ENDPOINT_TEMPLATE = "language.$UNIVERSE_DOMAIN$"
38
41
 
@@ -176,8 +179,28 @@ module Google
176
179
  endpoint: @config.endpoint,
177
180
  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
178
181
  universe_domain: @config.universe_domain,
179
- credentials: credentials
182
+ credentials: credentials,
183
+ logger: @config.logger
180
184
  )
185
+
186
+ @language_service_stub.logger(stub: true)&.info do |entry|
187
+ entry.set_system_name
188
+ entry.set_service
189
+ entry.message = "Created client for #{entry.service}"
190
+ entry.set_credentials_fields credentials
191
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
192
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
193
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
194
+ end
195
+ end
196
+
197
+ ##
198
+ # The logger used for request/response debug logging.
199
+ #
200
+ # @return [Logger]
201
+ #
202
+ def logger
203
+ @language_service_stub.logger
181
204
  end
182
205
 
183
206
  # Service calls
@@ -239,12 +262,13 @@ module Google
239
262
  # Customize the options with defaults
240
263
  call_metadata = @config.rpcs.analyze_sentiment.metadata.to_h
241
264
 
242
- # Set x-goog-api-client and x-goog-user-project headers
265
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
243
266
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
244
267
  lib_name: @config.lib_name, lib_version: @config.lib_version,
245
268
  gapic_version: ::Google::Cloud::Language::V1beta2::VERSION,
246
269
  transports_version_send: [:rest]
247
270
 
271
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
248
272
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
249
273
 
250
274
  options.apply_defaults timeout: @config.rpcs.analyze_sentiment.timeout,
@@ -257,7 +281,6 @@ module Google
257
281
 
258
282
  @language_service_stub.analyze_sentiment request, options do |result, operation|
259
283
  yield result, operation if block_given?
260
- return result
261
284
  end
262
285
  rescue ::Gapic::Rest::Error => e
263
286
  raise ::Google::Cloud::Error.from_error(e)
@@ -321,12 +344,13 @@ module Google
321
344
  # Customize the options with defaults
322
345
  call_metadata = @config.rpcs.analyze_entities.metadata.to_h
323
346
 
324
- # Set x-goog-api-client and x-goog-user-project headers
347
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
325
348
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
326
349
  lib_name: @config.lib_name, lib_version: @config.lib_version,
327
350
  gapic_version: ::Google::Cloud::Language::V1beta2::VERSION,
328
351
  transports_version_send: [:rest]
329
352
 
353
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
330
354
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
331
355
 
332
356
  options.apply_defaults timeout: @config.rpcs.analyze_entities.timeout,
@@ -339,7 +363,6 @@ module Google
339
363
 
340
364
  @language_service_stub.analyze_entities request, options do |result, operation|
341
365
  yield result, operation if block_given?
342
- return result
343
366
  end
344
367
  rescue ::Gapic::Rest::Error => e
345
368
  raise ::Google::Cloud::Error.from_error(e)
@@ -404,12 +427,13 @@ module Google
404
427
  # Customize the options with defaults
405
428
  call_metadata = @config.rpcs.analyze_entity_sentiment.metadata.to_h
406
429
 
407
- # Set x-goog-api-client and x-goog-user-project headers
430
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
408
431
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
409
432
  lib_name: @config.lib_name, lib_version: @config.lib_version,
410
433
  gapic_version: ::Google::Cloud::Language::V1beta2::VERSION,
411
434
  transports_version_send: [:rest]
412
435
 
436
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
413
437
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
414
438
 
415
439
  options.apply_defaults timeout: @config.rpcs.analyze_entity_sentiment.timeout,
@@ -422,7 +446,6 @@ module Google
422
446
 
423
447
  @language_service_stub.analyze_entity_sentiment request, options do |result, operation|
424
448
  yield result, operation if block_given?
425
- return result
426
449
  end
427
450
  rescue ::Gapic::Rest::Error => e
428
451
  raise ::Google::Cloud::Error.from_error(e)
@@ -486,12 +509,13 @@ module Google
486
509
  # Customize the options with defaults
487
510
  call_metadata = @config.rpcs.analyze_syntax.metadata.to_h
488
511
 
489
- # Set x-goog-api-client and x-goog-user-project headers
512
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
490
513
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
491
514
  lib_name: @config.lib_name, lib_version: @config.lib_version,
492
515
  gapic_version: ::Google::Cloud::Language::V1beta2::VERSION,
493
516
  transports_version_send: [:rest]
494
517
 
518
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
495
519
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
496
520
 
497
521
  options.apply_defaults timeout: @config.rpcs.analyze_syntax.timeout,
@@ -504,7 +528,6 @@ module Google
504
528
 
505
529
  @language_service_stub.analyze_syntax request, options do |result, operation|
506
530
  yield result, operation if block_given?
507
- return result
508
531
  end
509
532
  rescue ::Gapic::Rest::Error => e
510
533
  raise ::Google::Cloud::Error.from_error(e)
@@ -567,12 +590,13 @@ module Google
567
590
  # Customize the options with defaults
568
591
  call_metadata = @config.rpcs.classify_text.metadata.to_h
569
592
 
570
- # Set x-goog-api-client and x-goog-user-project headers
593
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
571
594
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
572
595
  lib_name: @config.lib_name, lib_version: @config.lib_version,
573
596
  gapic_version: ::Google::Cloud::Language::V1beta2::VERSION,
574
597
  transports_version_send: [:rest]
575
598
 
599
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
576
600
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
577
601
 
578
602
  options.apply_defaults timeout: @config.rpcs.classify_text.timeout,
@@ -585,7 +609,6 @@ module Google
585
609
 
586
610
  @language_service_stub.classify_text request, options do |result, operation|
587
611
  yield result, operation if block_given?
588
- return result
589
612
  end
590
613
  rescue ::Gapic::Rest::Error => e
591
614
  raise ::Google::Cloud::Error.from_error(e)
@@ -645,12 +668,13 @@ module Google
645
668
  # Customize the options with defaults
646
669
  call_metadata = @config.rpcs.moderate_text.metadata.to_h
647
670
 
648
- # Set x-goog-api-client and x-goog-user-project headers
671
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
649
672
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
650
673
  lib_name: @config.lib_name, lib_version: @config.lib_version,
651
674
  gapic_version: ::Google::Cloud::Language::V1beta2::VERSION,
652
675
  transports_version_send: [:rest]
653
676
 
677
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
654
678
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
655
679
 
656
680
  options.apply_defaults timeout: @config.rpcs.moderate_text.timeout,
@@ -663,7 +687,6 @@ module Google
663
687
 
664
688
  @language_service_stub.moderate_text request, options do |result, operation|
665
689
  yield result, operation if block_given?
666
- return result
667
690
  end
668
691
  rescue ::Gapic::Rest::Error => e
669
692
  raise ::Google::Cloud::Error.from_error(e)
@@ -728,12 +751,13 @@ module Google
728
751
  # Customize the options with defaults
729
752
  call_metadata = @config.rpcs.annotate_text.metadata.to_h
730
753
 
731
- # Set x-goog-api-client and x-goog-user-project headers
754
+ # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
732
755
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
733
756
  lib_name: @config.lib_name, lib_version: @config.lib_version,
734
757
  gapic_version: ::Google::Cloud::Language::V1beta2::VERSION,
735
758
  transports_version_send: [:rest]
736
759
 
760
+ call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
737
761
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
738
762
 
739
763
  options.apply_defaults timeout: @config.rpcs.annotate_text.timeout,
@@ -746,7 +770,6 @@ module Google
746
770
 
747
771
  @language_service_stub.annotate_text request, options do |result, operation|
748
772
  yield result, operation if block_given?
749
- return result
750
773
  end
751
774
  rescue ::Gapic::Rest::Error => e
752
775
  raise ::Google::Cloud::Error.from_error(e)
@@ -826,6 +849,11 @@ module Google
826
849
  # default endpoint URL. The default value of nil uses the environment
827
850
  # universe (usually the default "googleapis.com" universe).
828
851
  # @return [::String,nil]
852
+ # @!attribute [rw] logger
853
+ # A custom logger to use for request/response debug logging, or the value
854
+ # `:default` (the default) to construct a default logger, or `nil` to
855
+ # explicitly disable logging.
856
+ # @return [::Logger,:default,nil]
829
857
  #
830
858
  class Configuration
831
859
  extend ::Gapic::Config
@@ -847,6 +875,7 @@ module Google
847
875
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
848
876
  config_attr :quota_project, nil, ::String, nil
849
877
  config_attr :universe_domain, nil, ::String, nil
878
+ config_attr :logger, :default, ::Logger, nil, :default
850
879
 
851
880
  # @private
852
881
  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 analyze_sentiment 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: "analyze_sentiment",
93
106
  options: options
94
107
  )
95
108
  operation = ::Gapic::Rest::TransportOperation.new response
96
109
  result = ::Google::Cloud::Language::V1beta2::AnalyzeSentimentResponse.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: "analyze_entities",
131
146
  options: options
132
147
  )
133
148
  operation = ::Gapic::Rest::TransportOperation.new response
134
149
  result = ::Google::Cloud::Language::V1beta2::AnalyzeEntitiesResponse.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: "analyze_entity_sentiment",
169
186
  options: options
170
187
  )
171
188
  operation = ::Gapic::Rest::TransportOperation.new response
172
189
  result = ::Google::Cloud::Language::V1beta2::AnalyzeEntitySentimentResponse.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: "analyze_syntax",
207
226
  options: options
208
227
  )
209
228
  operation = ::Gapic::Rest::TransportOperation.new response
210
229
  result = ::Google::Cloud::Language::V1beta2::AnalyzeSyntaxResponse.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: "classify_text",
245
266
  options: options
246
267
  )
247
268
  operation = ::Gapic::Rest::TransportOperation.new response
248
269
  result = ::Google::Cloud::Language::V1beta2::ClassifyTextResponse.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: "moderate_text",
283
306
  options: options
284
307
  )
285
308
  operation = ::Gapic::Rest::TransportOperation.new response
286
309
  result = ::Google::Cloud::Language::V1beta2::ModerateTextResponse.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: "annotate_text",
321
346
  options: options
322
347
  )
323
348
  operation = ::Gapic::Rest::TransportOperation.new response
324
349
  result = ::Google::Cloud::Language::V1beta2::AnnotateTextResponse.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
  ##
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Language
23
23
  module V1beta2
24
- VERSION = "0.11.0"
24
+ VERSION = "0.12.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
@@ -118,6 +121,10 @@ module Google
118
121
  # @return [::String]
119
122
  # Optional link to proto reference documentation. Example:
120
123
  # https://cloud.google.com/pubsub/lite/docs/reference/rpc
124
+ # @!attribute [rw] rest_reference_documentation_uri
125
+ # @return [::String]
126
+ # Optional link to REST reference documentation. Example:
127
+ # https://cloud.google.com/pubsub/lite/docs/reference/rest
121
128
  class Publishing
122
129
  include ::Google::Protobuf::MessageExts
123
130
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -192,9 +199,32 @@ module Google
192
199
  # @!attribute [rw] common
193
200
  # @return [::Google::Api::CommonLanguageSettings]
194
201
  # Some settings.
202
+ # @!attribute [rw] experimental_features
203
+ # @return [::Google::Api::PythonSettings::ExperimentalFeatures]
204
+ # Experimental features to be included during client library generation.
195
205
  class PythonSettings
196
206
  include ::Google::Protobuf::MessageExts
197
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
198
228
  end
199
229
 
200
230
  # Settings for Node client libraries.
@@ -276,9 +306,28 @@ module Google
276
306
  # @!attribute [rw] common
277
307
  # @return [::Google::Api::CommonLanguageSettings]
278
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
279
319
  class GoSettings
280
320
  include ::Google::Protobuf::MessageExts
281
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
282
331
  end
283
332
 
284
333
  # Describes the generator configuration for a method.
@@ -286,6 +335,13 @@ module Google
286
335
  # @return [::String]
287
336
  # The fully qualified name of the method, for which the options below apply.
288
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...
289
345
  # @!attribute [rw] long_running
290
346
  # @return [::Google::Api::MethodSettings::LongRunning]
291
347
  # Describes settings to use for long-running operations when generating
@@ -294,17 +350,14 @@ module Google
294
350
  #
295
351
  # Example of a YAML configuration::
296
352
  #
297
- # publishing:
298
- # method_settings:
353
+ # publishing:
354
+ # method_settings:
299
355
  # - selector: google.cloud.speech.v2.Speech.BatchRecognize
300
356
  # long_running:
301
- # initial_poll_delay:
302
- # seconds: 60 # 1 minute
357
+ # initial_poll_delay: 60s # 1 minute
303
358
  # poll_delay_multiplier: 1.5
304
- # max_poll_delay:
305
- # seconds: 360 # 6 minutes
306
- # total_poll_timeout:
307
- # seconds: 54000 # 90 minutes
359
+ # max_poll_delay: 360s # 6 minutes
360
+ # total_poll_timeout: 54000s # 90 minutes
308
361
  # @!attribute [rw] auto_populated_fields
309
362
  # @return [::Array<::String>]
310
363
  # List of top-level fields of the request message, that should be
@@ -313,8 +366,8 @@ module Google
313
366
  #
314
367
  # Example of a YAML configuration:
315
368
  #
316
- # publishing:
317
- # method_settings:
369
+ # publishing:
370
+ # method_settings:
318
371
  # - selector: google.example.v1.ExampleService.CreateExample
319
372
  # auto_populated_fields:
320
373
  # - request_id
@@ -350,6 +403,17 @@ module Google
350
403
  end
351
404
  end
352
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
+
353
417
  # The organization for which the client libraries are being published.
354
418
  # Affects the url where generated docs are published, etc.
355
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-language-v1beta2
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.11.0
4
+ version: 0.12.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-02-26 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
@@ -96,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
96
96
  - !ruby/object:Gem::Version
97
97
  version: '0'
98
98
  requirements: []
99
- rubygems_version: 3.5.6
99
+ rubygems_version: 3.5.23
100
100
  signing_key:
101
101
  specification_version: 4
102
102
  summary: Provides natural language understanding technologies, such as sentiment analysis,