google-cloud-tasks-v2 1.0.0 → 1.1.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: e705c867e17701d0776d74b1488febe33193467c4d7f08f85cf34e06c4431ebc
4
- data.tar.gz: f64675a7220f117d5af095c507bcc9967baf2f6799d9485a93450b4bde2fcc09
3
+ metadata.gz: fa0be99b5c099a002465d74ada08e49ed088edf60358b10c129df19057fc9f89
4
+ data.tar.gz: 938101762fabe22787a8c73b77d0cb66c0e7edb6785643f439597586b376d9e4
5
5
  SHA512:
6
- metadata.gz: c77a5ff61771240aebc388700a7789d79b18a083f3f396f2015640f7634d613bc186f65ed8eefc243ce2a015de70c93a55c2d412328388e04a317a4fddbab92b
7
- data.tar.gz: b8a0e8561b0c75919999540ae6cacbd3773228fb15e668fe563c48f5b35da15904b389b505e90938968a5cb1a348dbb9253ce219909b2b503fb2e5d60c18f74d
6
+ metadata.gz: d5e37ab84a7307d838cea090182609bac5e7ce2fc215d85f90a553deadeff29d474b856df68049b5cd08052d7ac637d0309ee5c7295292a5bdb47a8d83d7e5a8
7
+ data.tar.gz: fe3b5b86241af4f96d74ee8ce78d7bde8cf6627d49dee1f59ca7bf5ae9e51ce3821d8e869e40b7df64fdfdd17a3b2036a654b4536b6412241c1eba73588a6302
data/README.md CHANGED
@@ -43,33 +43,43 @@ for class and method documentation.
43
43
  See also the [Product Documentation](https://cloud.google.com/tasks)
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/tasks/v2"
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::Tasks::V2::CloudTasks::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).
@@ -215,14 +215,26 @@ module Google
215
215
  universe_domain: @config.universe_domain,
216
216
  channel_args: @config.channel_args,
217
217
  interceptors: @config.interceptors,
218
- channel_pool_config: @config.channel_pool
218
+ channel_pool_config: @config.channel_pool,
219
+ logger: @config.logger
219
220
  )
220
221
 
222
+ @cloud_tasks_stub.stub_logger&.info do |entry|
223
+ entry.set_system_name
224
+ entry.set_service
225
+ entry.message = "Created client for #{entry.service}"
226
+ entry.set_credentials_fields credentials
227
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
228
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
229
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
230
+ end
231
+
221
232
  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
222
233
  config.credentials = credentials
223
234
  config.quota_project = @quota_project_id
224
235
  config.endpoint = @cloud_tasks_stub.endpoint
225
236
  config.universe_domain = @cloud_tasks_stub.universe_domain
237
+ config.logger = @cloud_tasks_stub.logger if config.respond_to? :logger=
226
238
  end
227
239
  end
228
240
 
@@ -233,6 +245,15 @@ module Google
233
245
  #
234
246
  attr_reader :location_client
235
247
 
248
+ ##
249
+ # The logger used for request/response debug logging.
250
+ #
251
+ # @return [Logger]
252
+ #
253
+ def logger
254
+ @cloud_tasks_stub.logger
255
+ end
256
+
236
257
  # Service calls
237
258
 
238
259
  ##
@@ -353,7 +374,7 @@ module Google
353
374
  @cloud_tasks_stub.call_rpc :list_queues, request, options: options do |response, operation|
354
375
  response = ::Gapic::PagedEnumerable.new @cloud_tasks_stub, :list_queues, request, response, operation, options
355
376
  yield response, operation if block_given?
356
- return response
377
+ throw :response, response
357
378
  end
358
379
  rescue ::GRPC::BadStatus => e
359
380
  raise ::Google::Cloud::Error.from_error(e)
@@ -440,7 +461,6 @@ module Google
440
461
 
441
462
  @cloud_tasks_stub.call_rpc :get_queue, request, options: options do |response, operation|
442
463
  yield response, operation if block_given?
443
- return response
444
464
  end
445
465
  rescue ::GRPC::BadStatus => e
446
466
  raise ::Google::Cloud::Error.from_error(e)
@@ -547,7 +567,6 @@ module Google
547
567
 
548
568
  @cloud_tasks_stub.call_rpc :create_queue, request, options: options do |response, operation|
549
569
  yield response, operation if block_given?
550
- return response
551
570
  end
552
571
  rescue ::GRPC::BadStatus => e
553
572
  raise ::Google::Cloud::Error.from_error(e)
@@ -657,7 +676,6 @@ module Google
657
676
 
658
677
  @cloud_tasks_stub.call_rpc :update_queue, request, options: options do |response, operation|
659
678
  yield response, operation if block_given?
660
- return response
661
679
  end
662
680
  rescue ::GRPC::BadStatus => e
663
681
  raise ::Google::Cloud::Error.from_error(e)
@@ -756,7 +774,6 @@ module Google
756
774
 
757
775
  @cloud_tasks_stub.call_rpc :delete_queue, request, options: options do |response, operation|
758
776
  yield response, operation if block_given?
759
- return response
760
777
  end
761
778
  rescue ::GRPC::BadStatus => e
762
779
  raise ::Google::Cloud::Error.from_error(e)
@@ -848,7 +865,6 @@ module Google
848
865
 
849
866
  @cloud_tasks_stub.call_rpc :purge_queue, request, options: options do |response, operation|
850
867
  yield response, operation if block_given?
851
- return response
852
868
  end
853
869
  rescue ::GRPC::BadStatus => e
854
870
  raise ::Google::Cloud::Error.from_error(e)
@@ -942,7 +958,6 @@ module Google
942
958
 
943
959
  @cloud_tasks_stub.call_rpc :pause_queue, request, options: options do |response, operation|
944
960
  yield response, operation if block_given?
945
- return response
946
961
  end
947
962
  rescue ::GRPC::BadStatus => e
948
963
  raise ::Google::Cloud::Error.from_error(e)
@@ -1042,7 +1057,6 @@ module Google
1042
1057
 
1043
1058
  @cloud_tasks_stub.call_rpc :resume_queue, request, options: options do |response, operation|
1044
1059
  yield response, operation if block_given?
1045
- return response
1046
1060
  end
1047
1061
  rescue ::GRPC::BadStatus => e
1048
1062
  raise ::Google::Cloud::Error.from_error(e)
@@ -1140,7 +1154,6 @@ module Google
1140
1154
 
1141
1155
  @cloud_tasks_stub.call_rpc :get_iam_policy, request, options: options do |response, operation|
1142
1156
  yield response, operation if block_given?
1143
- return response
1144
1157
  end
1145
1158
  rescue ::GRPC::BadStatus => e
1146
1159
  raise ::Google::Cloud::Error.from_error(e)
@@ -1248,7 +1261,6 @@ module Google
1248
1261
 
1249
1262
  @cloud_tasks_stub.call_rpc :set_iam_policy, request, options: options do |response, operation|
1250
1263
  yield response, operation if block_given?
1251
- return response
1252
1264
  end
1253
1265
  rescue ::GRPC::BadStatus => e
1254
1266
  raise ::Google::Cloud::Error.from_error(e)
@@ -1347,7 +1359,6 @@ module Google
1347
1359
 
1348
1360
  @cloud_tasks_stub.call_rpc :test_iam_permissions, request, options: options do |response, operation|
1349
1361
  yield response, operation if block_given?
1350
- return response
1351
1362
  end
1352
1363
  rescue ::GRPC::BadStatus => e
1353
1364
  raise ::Google::Cloud::Error.from_error(e)
@@ -1479,7 +1490,7 @@ module Google
1479
1490
  @cloud_tasks_stub.call_rpc :list_tasks, request, options: options do |response, operation|
1480
1491
  response = ::Gapic::PagedEnumerable.new @cloud_tasks_stub, :list_tasks, request, response, operation, options
1481
1492
  yield response, operation if block_given?
1482
- return response
1493
+ throw :response, response
1483
1494
  end
1484
1495
  rescue ::GRPC::BadStatus => e
1485
1496
  raise ::Google::Cloud::Error.from_error(e)
@@ -1579,7 +1590,6 @@ module Google
1579
1590
 
1580
1591
  @cloud_tasks_stub.call_rpc :get_task, request, options: options do |response, operation|
1581
1592
  yield response, operation if block_given?
1582
- return response
1583
1593
  end
1584
1594
  rescue ::GRPC::BadStatus => e
1585
1595
  raise ::Google::Cloud::Error.from_error(e)
@@ -1719,7 +1729,6 @@ module Google
1719
1729
 
1720
1730
  @cloud_tasks_stub.call_rpc :create_task, request, options: options do |response, operation|
1721
1731
  yield response, operation if block_given?
1722
- return response
1723
1732
  end
1724
1733
  rescue ::GRPC::BadStatus => e
1725
1734
  raise ::Google::Cloud::Error.from_error(e)
@@ -1810,7 +1819,6 @@ module Google
1810
1819
 
1811
1820
  @cloud_tasks_stub.call_rpc :delete_task, request, options: options do |response, operation|
1812
1821
  yield response, operation if block_given?
1813
- return response
1814
1822
  end
1815
1823
  rescue ::GRPC::BadStatus => e
1816
1824
  raise ::Google::Cloud::Error.from_error(e)
@@ -1935,7 +1943,6 @@ module Google
1935
1943
 
1936
1944
  @cloud_tasks_stub.call_rpc :run_task, request, options: options do |response, operation|
1937
1945
  yield response, operation if block_given?
1938
- return response
1939
1946
  end
1940
1947
  rescue ::GRPC::BadStatus => e
1941
1948
  raise ::Google::Cloud::Error.from_error(e)
@@ -2024,6 +2031,11 @@ module Google
2024
2031
  # default endpoint URL. The default value of nil uses the environment
2025
2032
  # universe (usually the default "googleapis.com" universe).
2026
2033
  # @return [::String,nil]
2034
+ # @!attribute [rw] logger
2035
+ # A custom logger to use for request/response debug logging, or the value
2036
+ # `:default` (the default) to construct a default logger, or `nil` to
2037
+ # explicitly disable logging.
2038
+ # @return [::Logger,:default,nil]
2027
2039
  #
2028
2040
  class Configuration
2029
2041
  extend ::Gapic::Config
@@ -2048,6 +2060,7 @@ module Google
2048
2060
  config_attr :retry_policy, nil, ::Hash, ::Proc, nil
2049
2061
  config_attr :quota_project, nil, ::String, nil
2050
2062
  config_attr :universe_domain, nil, ::String, nil
2063
+ config_attr :logger, :default, ::Logger, nil, :default
2051
2064
 
2052
2065
  # @private
2053
2066
  def initialize parent_config = nil
@@ -208,15 +208,27 @@ module Google
208
208
  endpoint: @config.endpoint,
209
209
  endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
210
210
  universe_domain: @config.universe_domain,
211
- credentials: credentials
211
+ credentials: credentials,
212
+ logger: @config.logger
212
213
  )
213
214
 
215
+ @cloud_tasks_stub.logger(stub: true)&.info do |entry|
216
+ entry.set_system_name
217
+ entry.set_service
218
+ entry.message = "Created client for #{entry.service}"
219
+ entry.set_credentials_fields credentials
220
+ entry.set "customEndpoint", @config.endpoint if @config.endpoint
221
+ entry.set "defaultTimeout", @config.timeout if @config.timeout
222
+ entry.set "quotaProject", @quota_project_id if @quota_project_id
223
+ end
224
+
214
225
  @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
215
226
  config.credentials = credentials
216
227
  config.quota_project = @quota_project_id
217
228
  config.endpoint = @cloud_tasks_stub.endpoint
218
229
  config.universe_domain = @cloud_tasks_stub.universe_domain
219
230
  config.bindings_override = @config.bindings_override
231
+ config.logger = @cloud_tasks_stub.logger if config.respond_to? :logger=
220
232
  end
221
233
  end
222
234
 
@@ -227,6 +239,15 @@ module Google
227
239
  #
228
240
  attr_reader :location_client
229
241
 
242
+ ##
243
+ # The logger used for request/response debug logging.
244
+ #
245
+ # @return [Logger]
246
+ #
247
+ def logger
248
+ @cloud_tasks_stub.logger
249
+ end
250
+
230
251
  # Service calls
231
252
 
232
253
  ##
@@ -340,7 +361,7 @@ module Google
340
361
  @cloud_tasks_stub.list_queues request, options do |result, operation|
341
362
  result = ::Gapic::Rest::PagedEnumerable.new @cloud_tasks_stub, :list_queues, "queues", request, result, options
342
363
  yield result, operation if block_given?
343
- return result
364
+ throw :response, result
344
365
  end
345
366
  rescue ::Gapic::Rest::Error => e
346
367
  raise ::Google::Cloud::Error.from_error(e)
@@ -420,7 +441,6 @@ module Google
420
441
 
421
442
  @cloud_tasks_stub.get_queue request, options do |result, operation|
422
443
  yield result, operation if block_given?
423
- return result
424
444
  end
425
445
  rescue ::Gapic::Rest::Error => e
426
446
  raise ::Google::Cloud::Error.from_error(e)
@@ -520,7 +540,6 @@ module Google
520
540
 
521
541
  @cloud_tasks_stub.create_queue request, options do |result, operation|
522
542
  yield result, operation if block_given?
523
- return result
524
543
  end
525
544
  rescue ::Gapic::Rest::Error => e
526
545
  raise ::Google::Cloud::Error.from_error(e)
@@ -623,7 +642,6 @@ module Google
623
642
 
624
643
  @cloud_tasks_stub.update_queue request, options do |result, operation|
625
644
  yield result, operation if block_given?
626
- return result
627
645
  end
628
646
  rescue ::Gapic::Rest::Error => e
629
647
  raise ::Google::Cloud::Error.from_error(e)
@@ -715,7 +733,6 @@ module Google
715
733
 
716
734
  @cloud_tasks_stub.delete_queue request, options do |result, operation|
717
735
  yield result, operation if block_given?
718
- return result
719
736
  end
720
737
  rescue ::Gapic::Rest::Error => e
721
738
  raise ::Google::Cloud::Error.from_error(e)
@@ -800,7 +817,6 @@ module Google
800
817
 
801
818
  @cloud_tasks_stub.purge_queue request, options do |result, operation|
802
819
  yield result, operation if block_given?
803
- return result
804
820
  end
805
821
  rescue ::Gapic::Rest::Error => e
806
822
  raise ::Google::Cloud::Error.from_error(e)
@@ -887,7 +903,6 @@ module Google
887
903
 
888
904
  @cloud_tasks_stub.pause_queue request, options do |result, operation|
889
905
  yield result, operation if block_given?
890
- return result
891
906
  end
892
907
  rescue ::Gapic::Rest::Error => e
893
908
  raise ::Google::Cloud::Error.from_error(e)
@@ -980,7 +995,6 @@ module Google
980
995
 
981
996
  @cloud_tasks_stub.resume_queue request, options do |result, operation|
982
997
  yield result, operation if block_given?
983
- return result
984
998
  end
985
999
  rescue ::Gapic::Rest::Error => e
986
1000
  raise ::Google::Cloud::Error.from_error(e)
@@ -1071,7 +1085,6 @@ module Google
1071
1085
 
1072
1086
  @cloud_tasks_stub.get_iam_policy request, options do |result, operation|
1073
1087
  yield result, operation if block_given?
1074
- return result
1075
1088
  end
1076
1089
  rescue ::Gapic::Rest::Error => e
1077
1090
  raise ::Google::Cloud::Error.from_error(e)
@@ -1172,7 +1185,6 @@ module Google
1172
1185
 
1173
1186
  @cloud_tasks_stub.set_iam_policy request, options do |result, operation|
1174
1187
  yield result, operation if block_given?
1175
- return result
1176
1188
  end
1177
1189
  rescue ::Gapic::Rest::Error => e
1178
1190
  raise ::Google::Cloud::Error.from_error(e)
@@ -1264,7 +1276,6 @@ module Google
1264
1276
 
1265
1277
  @cloud_tasks_stub.test_iam_permissions request, options do |result, operation|
1266
1278
  yield result, operation if block_given?
1267
- return result
1268
1279
  end
1269
1280
  rescue ::Gapic::Rest::Error => e
1270
1281
  raise ::Google::Cloud::Error.from_error(e)
@@ -1389,7 +1400,7 @@ module Google
1389
1400
  @cloud_tasks_stub.list_tasks request, options do |result, operation|
1390
1401
  result = ::Gapic::Rest::PagedEnumerable.new @cloud_tasks_stub, :list_tasks, "tasks", request, result, options
1391
1402
  yield result, operation if block_given?
1392
- return result
1403
+ throw :response, result
1393
1404
  end
1394
1405
  rescue ::Gapic::Rest::Error => e
1395
1406
  raise ::Google::Cloud::Error.from_error(e)
@@ -1482,7 +1493,6 @@ module Google
1482
1493
 
1483
1494
  @cloud_tasks_stub.get_task request, options do |result, operation|
1484
1495
  yield result, operation if block_given?
1485
- return result
1486
1496
  end
1487
1497
  rescue ::Gapic::Rest::Error => e
1488
1498
  raise ::Google::Cloud::Error.from_error(e)
@@ -1615,7 +1625,6 @@ module Google
1615
1625
 
1616
1626
  @cloud_tasks_stub.create_task request, options do |result, operation|
1617
1627
  yield result, operation if block_given?
1618
- return result
1619
1628
  end
1620
1629
  rescue ::Gapic::Rest::Error => e
1621
1630
  raise ::Google::Cloud::Error.from_error(e)
@@ -1699,7 +1708,6 @@ module Google
1699
1708
 
1700
1709
  @cloud_tasks_stub.delete_task request, options do |result, operation|
1701
1710
  yield result, operation if block_given?
1702
- return result
1703
1711
  end
1704
1712
  rescue ::Gapic::Rest::Error => e
1705
1713
  raise ::Google::Cloud::Error.from_error(e)
@@ -1817,7 +1825,6 @@ module Google
1817
1825
 
1818
1826
  @cloud_tasks_stub.run_task request, options do |result, operation|
1819
1827
  yield result, operation if block_given?
1820
- return result
1821
1828
  end
1822
1829
  rescue ::Gapic::Rest::Error => e
1823
1830
  raise ::Google::Cloud::Error.from_error(e)
@@ -1897,6 +1904,11 @@ module Google
1897
1904
  # default endpoint URL. The default value of nil uses the environment
1898
1905
  # universe (usually the default "googleapis.com" universe).
1899
1906
  # @return [::String,nil]
1907
+ # @!attribute [rw] logger
1908
+ # A custom logger to use for request/response debug logging, or the value
1909
+ # `:default` (the default) to construct a default logger, or `nil` to
1910
+ # explicitly disable logging.
1911
+ # @return [::Logger,:default,nil]
1900
1912
  #
1901
1913
  class Configuration
1902
1914
  extend ::Gapic::Config
@@ -1925,6 +1937,7 @@ module Google
1925
1937
  # by the host service.
1926
1938
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
1927
1939
  config_attr :bindings_override, {}, ::Hash, nil
1940
+ config_attr :logger, :default, ::Logger, nil, :default
1928
1941
 
1929
1942
  # @private
1930
1943
  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_queues 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_queues",
93
106
  options: options
94
107
  )
95
108
  operation = ::Gapic::Rest::TransportOperation.new response
96
109
  result = ::Google::Cloud::Tasks::V2::ListQueuesResponse.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_queue",
131
146
  options: options
132
147
  )
133
148
  operation = ::Gapic::Rest::TransportOperation.new response
134
149
  result = ::Google::Cloud::Tasks::V2::Queue.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: "create_queue",
169
186
  options: options
170
187
  )
171
188
  operation = ::Gapic::Rest::TransportOperation.new response
172
189
  result = ::Google::Cloud::Tasks::V2::Queue.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: "update_queue",
207
226
  options: options
208
227
  )
209
228
  operation = ::Gapic::Rest::TransportOperation.new response
210
229
  result = ::Google::Cloud::Tasks::V2::Queue.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: "delete_queue",
245
266
  options: options
246
267
  )
247
268
  operation = ::Gapic::Rest::TransportOperation.new response
248
269
  result = ::Google::Protobuf::Empty.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: "purge_queue",
283
306
  options: options
284
307
  )
285
308
  operation = ::Gapic::Rest::TransportOperation.new response
286
309
  result = ::Google::Cloud::Tasks::V2::Queue.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: "pause_queue",
321
346
  options: options
322
347
  )
323
348
  operation = ::Gapic::Rest::TransportOperation.new response
324
349
  result = ::Google::Cloud::Tasks::V2::Queue.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: "resume_queue",
359
386
  options: options
360
387
  )
361
388
  operation = ::Gapic::Rest::TransportOperation.new response
362
389
  result = ::Google::Cloud::Tasks::V2::Queue.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: "get_iam_policy",
397
426
  options: options
398
427
  )
399
428
  operation = ::Gapic::Rest::TransportOperation.new response
400
429
  result = ::Google::Iam::V1::Policy.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: "set_iam_policy",
435
466
  options: options
436
467
  )
437
468
  operation = ::Gapic::Rest::TransportOperation.new response
438
469
  result = ::Google::Iam::V1::Policy.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: "test_iam_permissions",
473
506
  options: options
474
507
  )
475
508
  operation = ::Gapic::Rest::TransportOperation.new response
476
509
  result = ::Google::Iam::V1::TestIamPermissionsResponse.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: "list_tasks",
511
546
  options: options
512
547
  )
513
548
  operation = ::Gapic::Rest::TransportOperation.new response
514
549
  result = ::Google::Cloud::Tasks::V2::ListTasksResponse.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: "get_task",
549
586
  options: options
550
587
  )
551
588
  operation = ::Gapic::Rest::TransportOperation.new response
552
589
  result = ::Google::Cloud::Tasks::V2::Task.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
  ##
@@ -581,16 +619,18 @@ module Google
581
619
 
582
620
  response = @client_stub.make_http_request(
583
621
  verb,
584
- uri: uri,
585
- body: body || "",
586
- params: query_string_params,
622
+ uri: uri,
623
+ body: body || "",
624
+ params: query_string_params,
625
+ method_name: "create_task",
587
626
  options: options
588
627
  )
589
628
  operation = ::Gapic::Rest::TransportOperation.new response
590
629
  result = ::Google::Cloud::Tasks::V2::Task.decode_json response.body, ignore_unknown_fields: true
591
-
592
- yield result, operation if block_given?
593
- result
630
+ catch :response do
631
+ yield result, operation if block_given?
632
+ result
633
+ end
594
634
  end
595
635
 
596
636
  ##
@@ -619,16 +659,18 @@ module Google
619
659
 
620
660
  response = @client_stub.make_http_request(
621
661
  verb,
622
- uri: uri,
623
- body: body || "",
624
- params: query_string_params,
662
+ uri: uri,
663
+ body: body || "",
664
+ params: query_string_params,
665
+ method_name: "delete_task",
625
666
  options: options
626
667
  )
627
668
  operation = ::Gapic::Rest::TransportOperation.new response
628
669
  result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
629
-
630
- yield result, operation if block_given?
631
- result
670
+ catch :response do
671
+ yield result, operation if block_given?
672
+ result
673
+ end
632
674
  end
633
675
 
634
676
  ##
@@ -657,16 +699,18 @@ module Google
657
699
 
658
700
  response = @client_stub.make_http_request(
659
701
  verb,
660
- uri: uri,
661
- body: body || "",
662
- params: query_string_params,
702
+ uri: uri,
703
+ body: body || "",
704
+ params: query_string_params,
705
+ method_name: "run_task",
663
706
  options: options
664
707
  )
665
708
  operation = ::Gapic::Rest::TransportOperation.new response
666
709
  result = ::Google::Cloud::Tasks::V2::Task.decode_json response.body, ignore_unknown_fields: true
667
-
668
- yield result, operation if block_given?
669
- result
710
+ catch :response do
711
+ yield result, operation if block_given?
712
+ result
713
+ end
670
714
  end
671
715
 
672
716
  ##
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Tasks
23
23
  module V2
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-tasks-v2
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
@@ -148,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
148
148
  - !ruby/object:Gem::Version
149
149
  version: '0'
150
150
  requirements: []
151
- rubygems_version: 3.5.6
151
+ rubygems_version: 3.5.23
152
152
  signing_key:
153
153
  specification_version: 4
154
154
  summary: Manages the execution of large numbers of distributed requests.