google-cloud-service_usage-v1 0.1.2 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3bbccb18517f1b0b49d58328c88d2087e90a10405e1adbb1f0fe56ce7fb0a790
4
- data.tar.gz: 95c245cfaae16dbb6dd0982fa5d1b3605c0ab6b1c169ef1bfb7c071b19daba28
3
+ metadata.gz: '018f6980a30a2b6eab63c409408de4c22f66ba9bbf31517a28457207b637e7b6'
4
+ data.tar.gz: e58bf640dfb360d9c0a2222871f38e65889d026b82455683319f51e541850e30
5
5
  SHA512:
6
- metadata.gz: bc2f319ba8762fbad74693bc5458ca2e995a34b5e1f93a95f2f57de93c24333b2a99dfa83b1d21583dabc06efb1b4cd85005016f8de02945fb94657a5daf42f9
7
- data.tar.gz: 5c0169dd8c4b2b7447f8120abfc47f81db51b9d727fab372d6ab92ca5848d582e9fd6e8dc4064b3598211ebf5cf7017ca182798c0eea15ed57d8030341a42213
6
+ metadata.gz: eca80a4188fbcba9b3ec0ebe00d035c1c191a8f1cae04b22bbc17288112c59962f7a6343db27f884c01ac2e5a239d100a5af8e8cbdbedc3231afeb6a897d6ec9
7
+ data.tar.gz: f9792857c43f3a28340aba99d4ad3fd2b66954289a5c62ab278bb0d7b62bee2073a231066980fc2d5a8e16b96b45210d48f95274993dd1ab0c3ecbcb6b3def21
data/.yardopts CHANGED
@@ -1,5 +1,5 @@
1
1
  --no-private
2
- --title=Service Usage V1 API
2
+ --title="Service Usage V1 API"
3
3
  --exclude _pb\.rb$
4
4
  --markup markdown
5
5
  --markup-provider redcarpet
data/AUTHENTICATION.md CHANGED
@@ -120,15 +120,6 @@ To configure your system for this, simply:
120
120
  **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
121
121
  *should* only be used during development.
122
122
 
123
- [gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
124
- [dev-console]: https://console.cloud.google.com/project
125
-
126
- [enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
127
-
128
- [create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
129
- [create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
130
- [reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
131
-
132
123
  ## Creating a Service Account
133
124
 
134
125
  Google Cloud requires **Service Account Credentials** to
@@ -139,31 +130,22 @@ If you are not running this client within
139
130
  [Google Cloud Platform environments](#google-cloud-platform-environments), you
140
131
  need a Google Developers service account.
141
132
 
142
- 1. Visit the [Google Developers Console][dev-console].
133
+ 1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
143
134
  2. Create a new project or click on an existing project.
144
- 3. Activate the slide-out navigation tray and select **API Manager**. From
135
+ 3. Activate the menu in the upper left and select **APIs & Services**. From
145
136
  here, you will enable the APIs that your application requires.
146
137
 
147
- ![Enable the APIs that your application requires][enable-apis]
148
-
149
138
  *Note: You may need to enable billing in order to use these services.*
150
139
 
151
140
  4. Select **Credentials** from the side navigation.
152
141
 
153
- You should see a screen like one of the following.
154
-
155
- ![Create a new service account][create-new-service-account]
156
-
157
- ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
158
-
159
- Find the "Add credentials" drop down and select "Service account" to be
160
- guided through downloading a new JSON key file.
142
+ Find the "Create credentials" drop down near the top of the page, and select
143
+ "Service account" to be guided through downloading a new JSON key file.
161
144
 
162
145
  If you want to re-use an existing service account, you can easily generate a
163
- new key file. Just select the account you wish to re-use, and click "Generate
164
- new JSON key":
165
-
166
- ![Re-use an existing service account][reuse-service-account]
146
+ new key file. Just select the account you wish to re-use, click the pencil
147
+ tool on the right side to edit the service account, select the **Keys** tab,
148
+ and then select **Add Key**.
167
149
 
168
150
  The key file you download will be used by this library to authenticate API
169
151
  requests and should be stored in a secure location.
data/README.md CHANGED
@@ -37,7 +37,7 @@ request = ::Google::Cloud::ServiceUsage::V1::EnableServiceRequest.new # (request
37
37
  response = client.enable_service request
38
38
  ```
39
39
 
40
- View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-service_usage-v1/latest)
40
+ View the [Client Library Documentation](https://cloud.google.com/ruby/docs/reference/google-cloud-service_usage-v1/latest)
41
41
  for class and method documentation.
42
42
 
43
43
  See also the [Product Documentation](https://cloud.google.com/service-usage/)
@@ -69,16 +69,21 @@ module GRPC
69
69
  end
70
70
  ```
71
71
 
72
+
73
+ ## Google Cloud Samples
74
+
75
+ To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).
76
+
72
77
  ## Supported Ruby Versions
73
78
 
74
- This library is supported on Ruby 2.5+.
79
+ This library is supported on Ruby 2.6+.
75
80
 
76
81
  Google provides official support for Ruby versions that are actively supported
77
82
  by Ruby Core—that is, Ruby versions that are either in normal maintenance or
78
- in security maintenance, and not end of life. Currently, this means Ruby 2.5
79
- and later. Older versions of Ruby _may_ still work, but are unsupported and not
80
- recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
81
- about the Ruby support schedule.
83
+ in security maintenance, and not end of life. Older versions of Ruby _may_
84
+ still work, but are unsupported and not recommended. See
85
+ https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby
86
+ support schedule.
82
87
 
83
88
  ## Which client should I use?
84
89
 
@@ -12,6 +12,7 @@ require 'google/api/quota_pb'
12
12
  require 'google/api/usage_pb'
13
13
  require 'google/protobuf/api_pb'
14
14
  require 'google/api/annotations_pb'
15
+
15
16
  Google::Protobuf::DescriptorPool.generated_pool.build do
16
17
  add_file("google/api/serviceusage/v1/resources.proto", :syntax => :proto3) do
17
18
  add_message "google.api.serviceusage.v1.Service" do
@@ -7,6 +7,7 @@ require 'google/api/annotations_pb'
7
7
  require 'google/api/serviceusage/v1/resources_pb'
8
8
  require 'google/longrunning/operations_pb'
9
9
  require 'google/api/client_pb'
10
+
10
11
  Google::Protobuf::DescriptorPool.generated_pool.build do
11
12
  add_file("google/api/serviceusage/v1/serviceusage.proto", :syntax => :proto3) do
12
13
  add_message "google.api.serviceusage.v1.EnableServiceRequest" do
@@ -31,7 +31,7 @@ module Google
31
31
  # See [Service Usage API](https://cloud.google.com/service-usage/docs/overview)
32
32
  class Service
33
33
 
34
- include GRPC::GenericService
34
+ include ::GRPC::GenericService
35
35
 
36
36
  self.marshal_class_method = :encode
37
37
  self.unmarshal_class_method = :decode
@@ -139,6 +139,7 @@ module Google
139
139
 
140
140
  @operations_client = Operations.new do |config|
141
141
  config.credentials = credentials
142
+ config.quota_project = @quota_project_id
142
143
  config.endpoint = @config.endpoint
143
144
  end
144
145
 
@@ -199,6 +200,28 @@ module Google
199
200
  #
200
201
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
201
202
  #
203
+ # @example Basic example
204
+ # require "google/cloud/service_usage/v1"
205
+ #
206
+ # # Create a client object. The client can be reused for multiple calls.
207
+ # client = Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.new
208
+ #
209
+ # # Create a request. To set request fields, pass in keyword arguments.
210
+ # request = Google::Cloud::ServiceUsage::V1::EnableServiceRequest.new
211
+ #
212
+ # # Call the enable_service method.
213
+ # result = client.enable_service request
214
+ #
215
+ # # The returned object is of type Gapic::Operation. You can use this
216
+ # # object to check the status of an operation, cancel it, or wait
217
+ # # for results. Here is how to block until completion:
218
+ # result.wait_until_done! timeout: 60
219
+ # if result.response?
220
+ # p result.response
221
+ # else
222
+ # puts "Error!"
223
+ # end
224
+ #
202
225
  def enable_service request, options = nil
203
226
  raise ::ArgumentError, "request must be provided" if request.nil?
204
227
 
@@ -216,9 +239,11 @@ module Google
216
239
  gapic_version: ::Google::Cloud::ServiceUsage::V1::VERSION
217
240
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
218
241
 
219
- header_params = {
220
- "name" => request.name
221
- }
242
+ header_params = {}
243
+ if request.name
244
+ header_params["name"] = request.name
245
+ end
246
+
222
247
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
223
248
  metadata[:"x-goog-request-params"] ||= request_params_header
224
249
 
@@ -288,6 +313,28 @@ module Google
288
313
  #
289
314
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
290
315
  #
316
+ # @example Basic example
317
+ # require "google/cloud/service_usage/v1"
318
+ #
319
+ # # Create a client object. The client can be reused for multiple calls.
320
+ # client = Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.new
321
+ #
322
+ # # Create a request. To set request fields, pass in keyword arguments.
323
+ # request = Google::Cloud::ServiceUsage::V1::DisableServiceRequest.new
324
+ #
325
+ # # Call the disable_service method.
326
+ # result = client.disable_service request
327
+ #
328
+ # # The returned object is of type Gapic::Operation. You can use this
329
+ # # object to check the status of an operation, cancel it, or wait
330
+ # # for results. Here is how to block until completion:
331
+ # result.wait_until_done! timeout: 60
332
+ # if result.response?
333
+ # p result.response
334
+ # else
335
+ # puts "Error!"
336
+ # end
337
+ #
291
338
  def disable_service request, options = nil
292
339
  raise ::ArgumentError, "request must be provided" if request.nil?
293
340
 
@@ -305,9 +352,11 @@ module Google
305
352
  gapic_version: ::Google::Cloud::ServiceUsage::V1::VERSION
306
353
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
307
354
 
308
- header_params = {
309
- "name" => request.name
310
- }
355
+ header_params = {}
356
+ if request.name
357
+ header_params["name"] = request.name
358
+ end
359
+
311
360
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
312
361
  metadata[:"x-goog-request-params"] ||= request_params_header
313
362
 
@@ -361,6 +410,21 @@ module Google
361
410
  #
362
411
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
363
412
  #
413
+ # @example Basic example
414
+ # require "google/cloud/service_usage/v1"
415
+ #
416
+ # # Create a client object. The client can be reused for multiple calls.
417
+ # client = Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.new
418
+ #
419
+ # # Create a request. To set request fields, pass in keyword arguments.
420
+ # request = Google::Cloud::ServiceUsage::V1::GetServiceRequest.new
421
+ #
422
+ # # Call the get_service method.
423
+ # result = client.get_service request
424
+ #
425
+ # # The returned object is of type Google::Cloud::ServiceUsage::V1::Service.
426
+ # p result
427
+ #
364
428
  def get_service request, options = nil
365
429
  raise ::ArgumentError, "request must be provided" if request.nil?
366
430
 
@@ -378,9 +442,11 @@ module Google
378
442
  gapic_version: ::Google::Cloud::ServiceUsage::V1::VERSION
379
443
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
380
444
 
381
- header_params = {
382
- "name" => request.name
383
- }
445
+ header_params = {}
446
+ if request.name
447
+ header_params["name"] = request.name
448
+ end
449
+
384
450
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
385
451
  metadata[:"x-goog-request-params"] ||= request_params_header
386
452
 
@@ -438,7 +504,7 @@ module Google
438
504
  # @param page_size [::Integer]
439
505
  # Requested size of the next page of data.
440
506
  # Requested page size cannot exceed 200.
441
- # If not set, the default page size is 50.
507
+ # If not set, the default page size is 50.
442
508
  # @param page_token [::String]
443
509
  # Token identifying which result to start with, which is returned by a
444
510
  # previous list call.
@@ -454,6 +520,27 @@ module Google
454
520
  #
455
521
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
456
522
  #
523
+ # @example Basic example
524
+ # require "google/cloud/service_usage/v1"
525
+ #
526
+ # # Create a client object. The client can be reused for multiple calls.
527
+ # client = Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.new
528
+ #
529
+ # # Create a request. To set request fields, pass in keyword arguments.
530
+ # request = Google::Cloud::ServiceUsage::V1::ListServicesRequest.new
531
+ #
532
+ # # Call the list_services method.
533
+ # result = client.list_services request
534
+ #
535
+ # # The returned object is of type Gapic::PagedEnumerable. You can
536
+ # # iterate over all elements by calling #each, and the enumerable
537
+ # # will lazily make API calls to fetch subsequent pages. Other
538
+ # # methods are also available for managing paging directly.
539
+ # result.each do |response|
540
+ # # Each element is of type ::Google::Cloud::ServiceUsage::V1::Service.
541
+ # p response
542
+ # end
543
+ #
457
544
  def list_services request, options = nil
458
545
  raise ::ArgumentError, "request must be provided" if request.nil?
459
546
 
@@ -471,9 +558,11 @@ module Google
471
558
  gapic_version: ::Google::Cloud::ServiceUsage::V1::VERSION
472
559
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
473
560
 
474
- header_params = {
475
- "parent" => request.parent
476
- }
561
+ header_params = {}
562
+ if request.parent
563
+ header_params["parent"] = request.parent
564
+ end
565
+
477
566
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
478
567
  metadata[:"x-goog-request-params"] ||= request_params_header
479
568
 
@@ -542,6 +631,28 @@ module Google
542
631
  #
543
632
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
544
633
  #
634
+ # @example Basic example
635
+ # require "google/cloud/service_usage/v1"
636
+ #
637
+ # # Create a client object. The client can be reused for multiple calls.
638
+ # client = Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.new
639
+ #
640
+ # # Create a request. To set request fields, pass in keyword arguments.
641
+ # request = Google::Cloud::ServiceUsage::V1::BatchEnableServicesRequest.new
642
+ #
643
+ # # Call the batch_enable_services method.
644
+ # result = client.batch_enable_services request
645
+ #
646
+ # # The returned object is of type Gapic::Operation. You can use this
647
+ # # object to check the status of an operation, cancel it, or wait
648
+ # # for results. Here is how to block until completion:
649
+ # result.wait_until_done! timeout: 60
650
+ # if result.response?
651
+ # p result.response
652
+ # else
653
+ # puts "Error!"
654
+ # end
655
+ #
545
656
  def batch_enable_services request, options = nil
546
657
  raise ::ArgumentError, "request must be provided" if request.nil?
547
658
 
@@ -559,9 +670,11 @@ module Google
559
670
  gapic_version: ::Google::Cloud::ServiceUsage::V1::VERSION
560
671
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
561
672
 
562
- header_params = {
563
- "parent" => request.parent
564
- }
673
+ header_params = {}
674
+ if request.parent
675
+ header_params["parent"] = request.parent
676
+ end
677
+
565
678
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
566
679
  metadata[:"x-goog-request-params"] ||= request_params_header
567
680
 
@@ -623,6 +736,21 @@ module Google
623
736
  #
624
737
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
625
738
  #
739
+ # @example Basic example
740
+ # require "google/cloud/service_usage/v1"
741
+ #
742
+ # # Create a client object. The client can be reused for multiple calls.
743
+ # client = Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.new
744
+ #
745
+ # # Create a request. To set request fields, pass in keyword arguments.
746
+ # request = Google::Cloud::ServiceUsage::V1::BatchGetServicesRequest.new
747
+ #
748
+ # # Call the batch_get_services method.
749
+ # result = client.batch_get_services request
750
+ #
751
+ # # The returned object is of type Google::Cloud::ServiceUsage::V1::BatchGetServicesResponse.
752
+ # p result
753
+ #
626
754
  def batch_get_services request, options = nil
627
755
  raise ::ArgumentError, "request must be provided" if request.nil?
628
756
 
@@ -640,9 +768,11 @@ module Google
640
768
  gapic_version: ::Google::Cloud::ServiceUsage::V1::VERSION
641
769
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
642
770
 
643
- header_params = {
644
- "parent" => request.parent
645
- }
771
+ header_params = {}
772
+ if request.parent
773
+ header_params["parent"] = request.parent
774
+ end
775
+
646
776
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
647
777
  metadata[:"x-goog-request-params"] ||= request_params_header
648
778
 
@@ -95,6 +95,9 @@ module Google
95
95
  channel_args: @config.channel_args,
96
96
  interceptors: @config.interceptors
97
97
  )
98
+
99
+ # Used by an LRO wrapper for some methods of this service
100
+ @operations_client = self
98
101
  end
99
102
 
100
103
  # Service calls
@@ -143,6 +146,27 @@ module Google
143
146
  #
144
147
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
145
148
  #
149
+ # @example Basic example
150
+ # require "google/longrunning"
151
+ #
152
+ # # Create a client object. The client can be reused for multiple calls.
153
+ # client = Google::Longrunning::Operations::Client.new
154
+ #
155
+ # # Create a request. To set request fields, pass in keyword arguments.
156
+ # request = Google::Longrunning::ListOperationsRequest.new
157
+ #
158
+ # # Call the list_operations method.
159
+ # result = client.list_operations request
160
+ #
161
+ # # The returned object is of type Gapic::PagedEnumerable. You can
162
+ # # iterate over all elements by calling #each, and the enumerable
163
+ # # will lazily make API calls to fetch subsequent pages. Other
164
+ # # methods are also available for managing paging directly.
165
+ # result.each do |response|
166
+ # # Each element is of type ::Google::Longrunning::Operation.
167
+ # p response
168
+ # end
169
+ #
146
170
  def list_operations request, options = nil
147
171
  raise ::ArgumentError, "request must be provided" if request.nil?
148
172
 
@@ -160,9 +184,11 @@ module Google
160
184
  gapic_version: ::Google::Cloud::ServiceUsage::V1::VERSION
161
185
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
162
186
 
163
- header_params = {
164
- "name" => request.name
165
- }
187
+ header_params = {}
188
+ if request.name
189
+ header_params["name"] = request.name
190
+ end
191
+
166
192
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
167
193
  metadata[:"x-goog-request-params"] ||= request_params_header
168
194
 
@@ -215,6 +241,28 @@ module Google
215
241
  #
216
242
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
217
243
  #
244
+ # @example Basic example
245
+ # require "google/longrunning"
246
+ #
247
+ # # Create a client object. The client can be reused for multiple calls.
248
+ # client = Google::Longrunning::Operations::Client.new
249
+ #
250
+ # # Create a request. To set request fields, pass in keyword arguments.
251
+ # request = Google::Longrunning::GetOperationRequest.new
252
+ #
253
+ # # Call the get_operation method.
254
+ # result = client.get_operation request
255
+ #
256
+ # # The returned object is of type Gapic::Operation. You can use this
257
+ # # object to check the status of an operation, cancel it, or wait
258
+ # # for results. Here is how to block until completion:
259
+ # result.wait_until_done! timeout: 60
260
+ # if result.response?
261
+ # p result.response
262
+ # else
263
+ # puts "Error!"
264
+ # end
265
+ #
218
266
  def get_operation request, options = nil
219
267
  raise ::ArgumentError, "request must be provided" if request.nil?
220
268
 
@@ -232,9 +280,11 @@ module Google
232
280
  gapic_version: ::Google::Cloud::ServiceUsage::V1::VERSION
233
281
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
234
282
 
235
- header_params = {
236
- "name" => request.name
237
- }
283
+ header_params = {}
284
+ if request.name
285
+ header_params["name"] = request.name
286
+ end
287
+
238
288
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
239
289
  metadata[:"x-goog-request-params"] ||= request_params_header
240
290
 
@@ -287,6 +337,21 @@ module Google
287
337
  #
288
338
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
289
339
  #
340
+ # @example Basic example
341
+ # require "google/longrunning"
342
+ #
343
+ # # Create a client object. The client can be reused for multiple calls.
344
+ # client = Google::Longrunning::Operations::Client.new
345
+ #
346
+ # # Create a request. To set request fields, pass in keyword arguments.
347
+ # request = Google::Longrunning::DeleteOperationRequest.new
348
+ #
349
+ # # Call the delete_operation method.
350
+ # result = client.delete_operation request
351
+ #
352
+ # # The returned object is of type Google::Protobuf::Empty.
353
+ # p result
354
+ #
290
355
  def delete_operation request, options = nil
291
356
  raise ::ArgumentError, "request must be provided" if request.nil?
292
357
 
@@ -304,9 +369,11 @@ module Google
304
369
  gapic_version: ::Google::Cloud::ServiceUsage::V1::VERSION
305
370
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
306
371
 
307
- header_params = {
308
- "name" => request.name
309
- }
372
+ header_params = {}
373
+ if request.name
374
+ header_params["name"] = request.name
375
+ end
376
+
310
377
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
311
378
  metadata[:"x-goog-request-params"] ||= request_params_header
312
379
 
@@ -364,6 +431,21 @@ module Google
364
431
  #
365
432
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
366
433
  #
434
+ # @example Basic example
435
+ # require "google/longrunning"
436
+ #
437
+ # # Create a client object. The client can be reused for multiple calls.
438
+ # client = Google::Longrunning::Operations::Client.new
439
+ #
440
+ # # Create a request. To set request fields, pass in keyword arguments.
441
+ # request = Google::Longrunning::CancelOperationRequest.new
442
+ #
443
+ # # Call the cancel_operation method.
444
+ # result = client.cancel_operation request
445
+ #
446
+ # # The returned object is of type Google::Protobuf::Empty.
447
+ # p result
448
+ #
367
449
  def cancel_operation request, options = nil
368
450
  raise ::ArgumentError, "request must be provided" if request.nil?
369
451
 
@@ -381,9 +463,11 @@ module Google
381
463
  gapic_version: ::Google::Cloud::ServiceUsage::V1::VERSION
382
464
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
383
465
 
384
- header_params = {
385
- "name" => request.name
386
- }
466
+ header_params = {}
467
+ if request.name
468
+ header_params["name"] = request.name
469
+ end
470
+
387
471
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
388
472
  metadata[:"x-goog-request-params"] ||= request_params_header
389
473
 
@@ -444,6 +528,28 @@ module Google
444
528
  #
445
529
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
446
530
  #
531
+ # @example Basic example
532
+ # require "google/longrunning"
533
+ #
534
+ # # Create a client object. The client can be reused for multiple calls.
535
+ # client = Google::Longrunning::Operations::Client.new
536
+ #
537
+ # # Create a request. To set request fields, pass in keyword arguments.
538
+ # request = Google::Longrunning::WaitOperationRequest.new
539
+ #
540
+ # # Call the wait_operation method.
541
+ # result = client.wait_operation request
542
+ #
543
+ # # The returned object is of type Gapic::Operation. You can use this
544
+ # # object to check the status of an operation, cancel it, or wait
545
+ # # for results. Here is how to block until completion:
546
+ # result.wait_until_done! timeout: 60
547
+ # if result.response?
548
+ # p result.response
549
+ # else
550
+ # puts "Error!"
551
+ # end
552
+ #
447
553
  def wait_operation request, options = nil
448
554
  raise ::ArgumentError, "request must be provided" if request.nil?
449
555
 
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module ServiceUsage
23
23
  module V1
24
- VERSION = "0.1.2"
24
+ VERSION = "0.2.0"
25
25
  end
26
26
  end
27
27
  end
@@ -25,6 +25,8 @@ module Google
25
25
  ##
26
26
  # To load this package, including all its services, and instantiate a client:
27
27
  #
28
+ # @example
29
+ #
28
30
  # require "google/cloud/service_usage/v1"
29
31
  # client = ::Google::Cloud::ServiceUsage::V1::ServiceUsage::Client.new
30
32
  #
@@ -33,11 +33,7 @@ module Google
33
33
  # // For Kubernetes resources, the format is {api group}/{kind}.
34
34
  # option (google.api.resource) = {
35
35
  # type: "pubsub.googleapis.com/Topic"
36
- # name_descriptor: {
37
- # pattern: "projects/{project}/topics/{topic}"
38
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
39
- # parent_name_extractor: "projects/{project}"
40
- # }
36
+ # pattern: "projects/{project}/topics/{topic}"
41
37
  # };
42
38
  # }
43
39
  #
@@ -45,10 +41,7 @@ module Google
45
41
  #
46
42
  # resources:
47
43
  # - type: "pubsub.googleapis.com/Topic"
48
- # name_descriptor:
49
- # - pattern: "projects/{project}/topics/{topic}"
50
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
51
- # parent_name_extractor: "projects/{project}"
44
+ # pattern: "projects/{project}/topics/{topic}"
52
45
  #
53
46
  # Sometimes, resources have multiple patterns, typically because they can
54
47
  # live under multiple parents.
@@ -58,26 +51,10 @@ module Google
58
51
  # message LogEntry {
59
52
  # option (google.api.resource) = {
60
53
  # type: "logging.googleapis.com/LogEntry"
61
- # name_descriptor: {
62
- # pattern: "projects/{project}/logs/{log}"
63
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
64
- # parent_name_extractor: "projects/{project}"
65
- # }
66
- # name_descriptor: {
67
- # pattern: "folders/{folder}/logs/{log}"
68
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
69
- # parent_name_extractor: "folders/{folder}"
70
- # }
71
- # name_descriptor: {
72
- # pattern: "organizations/{organization}/logs/{log}"
73
- # parent_type: "cloudresourcemanager.googleapis.com/Organization"
74
- # parent_name_extractor: "organizations/{organization}"
75
- # }
76
- # name_descriptor: {
77
- # pattern: "billingAccounts/{billing_account}/logs/{log}"
78
- # parent_type: "billing.googleapis.com/BillingAccount"
79
- # parent_name_extractor: "billingAccounts/{billing_account}"
80
- # }
54
+ # pattern: "projects/{project}/logs/{log}"
55
+ # pattern: "folders/{folder}/logs/{log}"
56
+ # pattern: "organizations/{organization}/logs/{log}"
57
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
81
58
  # };
82
59
  # }
83
60
  #
@@ -85,48 +62,10 @@ module Google
85
62
  #
86
63
  # resources:
87
64
  # - type: 'logging.googleapis.com/LogEntry'
88
- # name_descriptor:
89
- # - pattern: "projects/{project}/logs/{log}"
90
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
91
- # parent_name_extractor: "projects/{project}"
92
- # - pattern: "folders/{folder}/logs/{log}"
93
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
94
- # parent_name_extractor: "folders/{folder}"
95
- # - pattern: "organizations/{organization}/logs/{log}"
96
- # parent_type: "cloudresourcemanager.googleapis.com/Organization"
97
- # parent_name_extractor: "organizations/{organization}"
98
- # - pattern: "billingAccounts/{billing_account}/logs/{log}"
99
- # parent_type: "billing.googleapis.com/BillingAccount"
100
- # parent_name_extractor: "billingAccounts/{billing_account}"
101
- #
102
- # For flexible resources, the resource name doesn't contain parent names, but
103
- # the resource itself has parents for policy evaluation.
104
- #
105
- # Example:
106
- #
107
- # message Shelf {
108
- # option (google.api.resource) = {
109
- # type: "library.googleapis.com/Shelf"
110
- # name_descriptor: {
111
- # pattern: "shelves/{shelf}"
112
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
113
- # }
114
- # name_descriptor: {
115
- # pattern: "shelves/{shelf}"
116
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
117
- # }
118
- # };
119
- # }
120
- #
121
- # The ResourceDescriptor Yaml config will look like:
122
- #
123
- # resources:
124
- # - type: 'library.googleapis.com/Shelf'
125
- # name_descriptor:
126
- # - pattern: "shelves/{shelf}"
127
- # parent_type: "cloudresourcemanager.googleapis.com/Project"
128
- # - pattern: "shelves/{shelf}"
129
- # parent_type: "cloudresourcemanager.googleapis.com/Folder"
65
+ # pattern: "projects/{project}/logs/{log}"
66
+ # pattern: "folders/{folder}/logs/{log}"
67
+ # pattern: "organizations/{organization}/logs/{log}"
68
+ # pattern: "billingAccounts/{billing_account}/logs/{log}"
130
69
  # @!attribute [rw] type
131
70
  # @return [::String]
132
71
  # The resource type. It must be in the format of
@@ -126,7 +126,7 @@ module Google
126
126
  # @return [::Integer]
127
127
  # Requested size of the next page of data.
128
128
  # Requested page size cannot exceed 200.
129
- # If not set, the default page size is 50.
129
+ # If not set, the default page size is 50.
130
130
  # @!attribute [rw] page_token
131
131
  # @return [::String]
132
132
  # Token identifying which result to start with, which is returned by a
@@ -44,7 +44,7 @@ module Google
44
44
  # foo = any.unpack(Foo.class);
45
45
  # }
46
46
  #
47
- # Example 3: Pack and unpack a message in Python.
47
+ # Example 3: Pack and unpack a message in Python.
48
48
  #
49
49
  # foo = Foo(...)
50
50
  # any = Any()
@@ -54,7 +54,7 @@ module Google
54
54
  # any.Unpack(foo)
55
55
  # ...
56
56
  #
57
- # Example 4: Pack and unpack a message in Go
57
+ # Example 4: Pack and unpack a message in Go
58
58
  #
59
59
  # foo := &pb.Foo{...}
60
60
  # any, err := anypb.New(foo)
@@ -75,7 +75,7 @@ module Google
75
75
  #
76
76
  #
77
77
  # JSON
78
- # ====
78
+ #
79
79
  # The JSON representation of an `Any` value uses the regular
80
80
  # representation of the deserialized, embedded message, with an
81
81
  # additional field `@type` which contains the type URL. Example:
@@ -46,8 +46,8 @@ module Google
46
46
 
47
47
  # `Value` represents a dynamically typed value which can be either
48
48
  # null, a number, a string, a boolean, a recursive struct value, or a
49
- # list of values. A producer of value is expected to set one of that
50
- # variants, absence of any variant indicates an error.
49
+ # list of values. A producer of value is expected to set one of these
50
+ # variants. Absence of any variant indicates an error.
51
51
  #
52
52
  # The JSON representation for `Value` is JSON value.
53
53
  # @!attribute [rw] null_value
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-service_usage-v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.2
4
+ version: 0.2.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: 2021-08-11 00:00:00.000000000 Z
11
+ date: 2022-07-08 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.7'
19
+ version: '0.10'
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.7'
29
+ version: '0.10'
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a
@@ -50,28 +50,28 @@ dependencies:
50
50
  requirements:
51
51
  - - "~>"
52
52
  - !ruby/object:Gem::Version
53
- version: 1.25.1
53
+ version: 1.26.1
54
54
  type: :development
55
55
  prerelease: false
56
56
  version_requirements: !ruby/object:Gem::Requirement
57
57
  requirements:
58
58
  - - "~>"
59
59
  - !ruby/object:Gem::Version
60
- version: 1.25.1
60
+ version: 1.26.1
61
61
  - !ruby/object:Gem::Dependency
62
62
  name: minitest
63
63
  requirement: !ruby/object:Gem::Requirement
64
64
  requirements:
65
65
  - - "~>"
66
66
  - !ruby/object:Gem::Version
67
- version: '5.14'
67
+ version: '5.16'
68
68
  type: :development
69
69
  prerelease: false
70
70
  version_requirements: !ruby/object:Gem::Requirement
71
71
  requirements:
72
72
  - - "~>"
73
73
  - !ruby/object:Gem::Version
74
- version: '5.14'
74
+ version: '5.16'
75
75
  - !ruby/object:Gem::Dependency
76
76
  name: minitest-focus
77
77
  requirement: !ruby/object:Gem::Requirement
@@ -106,14 +106,14 @@ dependencies:
106
106
  requirements:
107
107
  - - ">="
108
108
  - !ruby/object:Gem::Version
109
- version: '12.0'
109
+ version: '13.0'
110
110
  type: :development
111
111
  prerelease: false
112
112
  version_requirements: !ruby/object:Gem::Requirement
113
113
  requirements:
114
114
  - - ">="
115
115
  - !ruby/object:Gem::Version
116
- version: '12.0'
116
+ version: '13.0'
117
117
  - !ruby/object:Gem::Dependency
118
118
  name: redcarpet
119
119
  requirement: !ruby/object:Gem::Requirement
@@ -215,14 +215,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
215
215
  requirements:
216
216
  - - ">="
217
217
  - !ruby/object:Gem::Version
218
- version: '2.5'
218
+ version: '2.6'
219
219
  required_rubygems_version: !ruby/object:Gem::Requirement
220
220
  requirements:
221
221
  - - ">="
222
222
  - !ruby/object:Gem::Version
223
223
  version: '0'
224
224
  requirements: []
225
- rubygems_version: 3.2.17
225
+ rubygems_version: 3.3.14
226
226
  signing_key:
227
227
  specification_version: 4
228
228
  summary: API Client library for the Service Usage V1 API