google-cloud-app_engine-v1 0.3.2 → 0.3.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +1 -1
  3. data/AUTHENTICATION.md +7 -25
  4. data/README.md +1 -1
  5. data/lib/google/appengine/v1/app_yaml_pb.rb +1 -2
  6. data/lib/google/appengine/v1/appengine_pb.rb +2 -2
  7. data/lib/google/appengine/v1/appengine_services_pb.rb +8 -8
  8. data/lib/google/appengine/v1/application_pb.rb +1 -2
  9. data/lib/google/appengine/v1/audit_data_pb.rb +1 -2
  10. data/lib/google/appengine/v1/certificate_pb.rb +1 -2
  11. data/lib/google/appengine/v1/deploy_pb.rb +1 -2
  12. data/lib/google/appengine/v1/deployed_files_pb.rb +0 -1
  13. data/lib/google/appengine/v1/domain_mapping_pb.rb +0 -1
  14. data/lib/google/appengine/v1/domain_pb.rb +0 -1
  15. data/lib/google/appengine/v1/firewall_pb.rb +0 -1
  16. data/lib/google/appengine/v1/instance_pb.rb +2 -3
  17. data/lib/google/appengine/v1/location_pb.rb +1 -2
  18. data/lib/google/appengine/v1/network_settings_pb.rb +0 -1
  19. data/lib/google/appengine/v1/operation_pb.rb +1 -3
  20. data/lib/google/appengine/v1/service_pb.rb +1 -2
  21. data/lib/google/appengine/v1/version_pb.rb +2 -4
  22. data/lib/google/cloud/app_engine/v1/applications/client.rb +138 -49
  23. data/lib/google/cloud/app_engine/v1/applications/operations.rb +145 -33
  24. data/lib/google/cloud/app_engine/v1/authorized_certificates/client.rb +150 -56
  25. data/lib/google/cloud/app_engine/v1/authorized_domains/client.rb +58 -40
  26. data/lib/google/cloud/app_engine/v1/domain_mappings/client.rb +172 -56
  27. data/lib/google/cloud/app_engine/v1/domain_mappings/operations.rb +145 -33
  28. data/lib/google/cloud/app_engine/v1/firewall/client.rb +173 -60
  29. data/lib/google/cloud/app_engine/v1/instances/client.rb +142 -52
  30. data/lib/google/cloud/app_engine/v1/instances/operations.rb +145 -33
  31. data/lib/google/cloud/app_engine/v1/services/client.rb +142 -52
  32. data/lib/google/cloud/app_engine/v1/services/operations.rb +145 -33
  33. data/lib/google/cloud/app_engine/v1/version.rb +1 -1
  34. data/lib/google/cloud/app_engine/v1/versions/client.rb +172 -56
  35. data/lib/google/cloud/app_engine/v1/versions/operations.rb +145 -33
  36. data/proto_docs/google/api/resource.rb +10 -71
  37. metadata +5 -5
@@ -39,13 +39,12 @@ module Google
39
39
  # See {::Google::Cloud::AppEngine::V1::DomainMappings::Client::Configuration}
40
40
  # for a description of the configuration fields.
41
41
  #
42
- # ## Example
42
+ # @example
43
43
  #
44
- # To modify the configuration for all DomainMappings clients:
45
- #
46
- # ::Google::Cloud::AppEngine::V1::DomainMappings::Client.configure do |config|
47
- # config.timeout = 10.0
48
- # end
44
+ # # Modify the configuration for all DomainMappings clients
45
+ # ::Google::Cloud::AppEngine::V1::DomainMappings::Client.configure do |config|
46
+ # config.timeout = 10.0
47
+ # end
49
48
  #
50
49
  # @yield [config] Configure the Client client.
51
50
  # @yieldparam config [Client::Configuration]
@@ -92,19 +91,15 @@ module Google
92
91
  ##
93
92
  # Create a new DomainMappings client object.
94
93
  #
95
- # ## Examples
96
- #
97
- # To create a new DomainMappings client with the default
98
- # configuration:
99
- #
100
- # client = ::Google::Cloud::AppEngine::V1::DomainMappings::Client.new
94
+ # @example
101
95
  #
102
- # To create a new DomainMappings client with a custom
103
- # configuration:
96
+ # # Create a client using the default configuration
97
+ # client = ::Google::Cloud::AppEngine::V1::DomainMappings::Client.new
104
98
  #
105
- # client = ::Google::Cloud::AppEngine::V1::DomainMappings::Client.new do |config|
106
- # config.timeout = 10.0
107
- # end
99
+ # # Create a client using a custom configuration
100
+ # client = ::Google::Cloud::AppEngine::V1::DomainMappings::Client.new do |config|
101
+ # config.timeout = 10.0
102
+ # end
108
103
  #
109
104
  # @yield [config] Configure the DomainMappings client.
110
105
  # @yieldparam config [Client::Configuration]
@@ -124,10 +119,9 @@ module Google
124
119
 
125
120
  # Create credentials
126
121
  credentials = @config.credentials
127
- # Use self-signed JWT if the scope and endpoint are unchanged from default,
122
+ # Use self-signed JWT if the endpoint is unchanged from default,
128
123
  # but only if the default endpoint does not have a region prefix.
129
- enable_self_signed_jwt = @config.scope == Client.configure.scope &&
130
- @config.endpoint == Client.configure.endpoint &&
124
+ enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
131
125
  !@config.endpoint.split(".").first.include?("-")
132
126
  credentials ||= Credentials.default scope: @config.scope,
133
127
  enable_self_signed_jwt: enable_self_signed_jwt
@@ -139,6 +133,7 @@ module Google
139
133
 
140
134
  @operations_client = Operations.new do |config|
141
135
  config.credentials = credentials
136
+ config.quota_project = @quota_project_id
142
137
  config.endpoint = @config.endpoint
143
138
  end
144
139
 
@@ -193,6 +188,27 @@ module Google
193
188
  #
194
189
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
195
190
  #
191
+ # @example Basic example
192
+ # require "google/cloud/app_engine/v1"
193
+ #
194
+ # # Create a client object. The client can be reused for multiple calls.
195
+ # client = Google::Cloud::AppEngine::V1::DomainMappings::Client.new
196
+ #
197
+ # # Create a request. To set request fields, pass in keyword arguments.
198
+ # request = Google::Cloud::AppEngine::V1::ListDomainMappingsRequest.new
199
+ #
200
+ # # Call the list_domain_mappings method.
201
+ # result = client.list_domain_mappings request
202
+ #
203
+ # # The returned object is of type Gapic::PagedEnumerable. You can
204
+ # # iterate over all elements by calling #each, and the enumerable
205
+ # # will lazily make API calls to fetch subsequent pages. Other
206
+ # # methods are also available for managing paging directly.
207
+ # result.each do |response|
208
+ # # Each element is of type ::Google::Cloud::AppEngine::V1::DomainMapping.
209
+ # p response
210
+ # end
211
+ #
196
212
  def list_domain_mappings request, options = nil
197
213
  raise ::ArgumentError, "request must be provided" if request.nil?
198
214
 
@@ -210,16 +226,20 @@ module Google
210
226
  gapic_version: ::Google::Cloud::AppEngine::V1::VERSION
211
227
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
212
228
 
213
- header_params = {
214
- "parent" => request.parent
215
- }
229
+ header_params = {}
230
+ if request.parent
231
+ header_params["parent"] = request.parent
232
+ end
233
+
216
234
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
217
235
  metadata[:"x-goog-request-params"] ||= request_params_header
218
236
 
219
237
  options.apply_defaults timeout: @config.rpcs.list_domain_mappings.timeout,
220
238
  metadata: metadata,
221
239
  retry_policy: @config.rpcs.list_domain_mappings.retry_policy
222
- options.apply_defaults metadata: @config.metadata,
240
+
241
+ options.apply_defaults timeout: @config.timeout,
242
+ metadata: @config.metadata,
223
243
  retry_policy: @config.retry_policy
224
244
 
225
245
  @domain_mappings_stub.call_rpc :list_domain_mappings, request, options: options do |response, operation|
@@ -261,6 +281,21 @@ module Google
261
281
  #
262
282
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
263
283
  #
284
+ # @example Basic example
285
+ # require "google/cloud/app_engine/v1"
286
+ #
287
+ # # Create a client object. The client can be reused for multiple calls.
288
+ # client = Google::Cloud::AppEngine::V1::DomainMappings::Client.new
289
+ #
290
+ # # Create a request. To set request fields, pass in keyword arguments.
291
+ # request = Google::Cloud::AppEngine::V1::GetDomainMappingRequest.new
292
+ #
293
+ # # Call the get_domain_mapping method.
294
+ # result = client.get_domain_mapping request
295
+ #
296
+ # # The returned object is of type Google::Cloud::AppEngine::V1::DomainMapping.
297
+ # p result
298
+ #
264
299
  def get_domain_mapping request, options = nil
265
300
  raise ::ArgumentError, "request must be provided" if request.nil?
266
301
 
@@ -278,16 +313,20 @@ module Google
278
313
  gapic_version: ::Google::Cloud::AppEngine::V1::VERSION
279
314
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
280
315
 
281
- header_params = {
282
- "name" => request.name
283
- }
316
+ header_params = {}
317
+ if request.name
318
+ header_params["name"] = request.name
319
+ end
320
+
284
321
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
285
322
  metadata[:"x-goog-request-params"] ||= request_params_header
286
323
 
287
324
  options.apply_defaults timeout: @config.rpcs.get_domain_mapping.timeout,
288
325
  metadata: metadata,
289
326
  retry_policy: @config.rpcs.get_domain_mapping.retry_policy
290
- options.apply_defaults metadata: @config.metadata,
327
+
328
+ options.apply_defaults timeout: @config.timeout,
329
+ metadata: @config.metadata,
291
330
  retry_policy: @config.retry_policy
292
331
 
293
332
  @domain_mappings_stub.call_rpc :get_domain_mapping, request, options: options do |response, operation|
@@ -334,6 +373,28 @@ module Google
334
373
  #
335
374
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
336
375
  #
376
+ # @example Basic example
377
+ # require "google/cloud/app_engine/v1"
378
+ #
379
+ # # Create a client object. The client can be reused for multiple calls.
380
+ # client = Google::Cloud::AppEngine::V1::DomainMappings::Client.new
381
+ #
382
+ # # Create a request. To set request fields, pass in keyword arguments.
383
+ # request = Google::Cloud::AppEngine::V1::CreateDomainMappingRequest.new
384
+ #
385
+ # # Call the create_domain_mapping method.
386
+ # result = client.create_domain_mapping request
387
+ #
388
+ # # The returned object is of type Gapic::Operation. You can use this
389
+ # # object to check the status of an operation, cancel it, or wait
390
+ # # for results. Here is how to block until completion:
391
+ # result.wait_until_done! timeout: 60
392
+ # if result.response?
393
+ # p result.response
394
+ # else
395
+ # puts "Error!"
396
+ # end
397
+ #
337
398
  def create_domain_mapping request, options = nil
338
399
  raise ::ArgumentError, "request must be provided" if request.nil?
339
400
 
@@ -351,16 +412,20 @@ module Google
351
412
  gapic_version: ::Google::Cloud::AppEngine::V1::VERSION
352
413
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
353
414
 
354
- header_params = {
355
- "parent" => request.parent
356
- }
415
+ header_params = {}
416
+ if request.parent
417
+ header_params["parent"] = request.parent
418
+ end
419
+
357
420
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
358
421
  metadata[:"x-goog-request-params"] ||= request_params_header
359
422
 
360
423
  options.apply_defaults timeout: @config.rpcs.create_domain_mapping.timeout,
361
424
  metadata: metadata,
362
425
  retry_policy: @config.rpcs.create_domain_mapping.retry_policy
363
- options.apply_defaults metadata: @config.metadata,
426
+
427
+ options.apply_defaults timeout: @config.timeout,
428
+ metadata: @config.metadata,
364
429
  retry_policy: @config.retry_policy
365
430
 
366
431
  @domain_mappings_stub.call_rpc :create_domain_mapping, request, options: options do |response, operation|
@@ -410,6 +475,28 @@ module Google
410
475
  #
411
476
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
412
477
  #
478
+ # @example Basic example
479
+ # require "google/cloud/app_engine/v1"
480
+ #
481
+ # # Create a client object. The client can be reused for multiple calls.
482
+ # client = Google::Cloud::AppEngine::V1::DomainMappings::Client.new
483
+ #
484
+ # # Create a request. To set request fields, pass in keyword arguments.
485
+ # request = Google::Cloud::AppEngine::V1::UpdateDomainMappingRequest.new
486
+ #
487
+ # # Call the update_domain_mapping method.
488
+ # result = client.update_domain_mapping request
489
+ #
490
+ # # The returned object is of type Gapic::Operation. You can use this
491
+ # # object to check the status of an operation, cancel it, or wait
492
+ # # for results. Here is how to block until completion:
493
+ # result.wait_until_done! timeout: 60
494
+ # if result.response?
495
+ # p result.response
496
+ # else
497
+ # puts "Error!"
498
+ # end
499
+ #
413
500
  def update_domain_mapping request, options = nil
414
501
  raise ::ArgumentError, "request must be provided" if request.nil?
415
502
 
@@ -427,16 +514,20 @@ module Google
427
514
  gapic_version: ::Google::Cloud::AppEngine::V1::VERSION
428
515
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
429
516
 
430
- header_params = {
431
- "name" => request.name
432
- }
517
+ header_params = {}
518
+ if request.name
519
+ header_params["name"] = request.name
520
+ end
521
+
433
522
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
434
523
  metadata[:"x-goog-request-params"] ||= request_params_header
435
524
 
436
525
  options.apply_defaults timeout: @config.rpcs.update_domain_mapping.timeout,
437
526
  metadata: metadata,
438
527
  retry_policy: @config.rpcs.update_domain_mapping.retry_policy
439
- options.apply_defaults metadata: @config.metadata,
528
+
529
+ options.apply_defaults timeout: @config.timeout,
530
+ metadata: @config.metadata,
440
531
  retry_policy: @config.retry_policy
441
532
 
442
533
  @domain_mappings_stub.call_rpc :update_domain_mapping, request, options: options do |response, operation|
@@ -480,6 +571,28 @@ module Google
480
571
  #
481
572
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
482
573
  #
574
+ # @example Basic example
575
+ # require "google/cloud/app_engine/v1"
576
+ #
577
+ # # Create a client object. The client can be reused for multiple calls.
578
+ # client = Google::Cloud::AppEngine::V1::DomainMappings::Client.new
579
+ #
580
+ # # Create a request. To set request fields, pass in keyword arguments.
581
+ # request = Google::Cloud::AppEngine::V1::DeleteDomainMappingRequest.new
582
+ #
583
+ # # Call the delete_domain_mapping method.
584
+ # result = client.delete_domain_mapping request
585
+ #
586
+ # # The returned object is of type Gapic::Operation. You can use this
587
+ # # object to check the status of an operation, cancel it, or wait
588
+ # # for results. Here is how to block until completion:
589
+ # result.wait_until_done! timeout: 60
590
+ # if result.response?
591
+ # p result.response
592
+ # else
593
+ # puts "Error!"
594
+ # end
595
+ #
483
596
  def delete_domain_mapping request, options = nil
484
597
  raise ::ArgumentError, "request must be provided" if request.nil?
485
598
 
@@ -497,16 +610,20 @@ module Google
497
610
  gapic_version: ::Google::Cloud::AppEngine::V1::VERSION
498
611
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
499
612
 
500
- header_params = {
501
- "name" => request.name
502
- }
613
+ header_params = {}
614
+ if request.name
615
+ header_params["name"] = request.name
616
+ end
617
+
503
618
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
504
619
  metadata[:"x-goog-request-params"] ||= request_params_header
505
620
 
506
621
  options.apply_defaults timeout: @config.rpcs.delete_domain_mapping.timeout,
507
622
  metadata: metadata,
508
623
  retry_policy: @config.rpcs.delete_domain_mapping.retry_policy
509
- options.apply_defaults metadata: @config.metadata,
624
+
625
+ options.apply_defaults timeout: @config.timeout,
626
+ metadata: @config.metadata,
510
627
  retry_policy: @config.retry_policy
511
628
 
512
629
  @domain_mappings_stub.call_rpc :delete_domain_mapping, request, options: options do |response, operation|
@@ -531,22 +648,21 @@ module Google
531
648
  # Configuration can be applied globally to all clients, or to a single client
532
649
  # on construction.
533
650
  #
534
- # # Examples
535
- #
536
- # To modify the global config, setting the timeout for list_domain_mappings
537
- # to 20 seconds, and all remaining timeouts to 10 seconds:
538
- #
539
- # ::Google::Cloud::AppEngine::V1::DomainMappings::Client.configure do |config|
540
- # config.timeout = 10.0
541
- # config.rpcs.list_domain_mappings.timeout = 20.0
542
- # end
543
- #
544
- # To apply the above configuration only to a new client:
545
- #
546
- # client = ::Google::Cloud::AppEngine::V1::DomainMappings::Client.new do |config|
547
- # config.timeout = 10.0
548
- # config.rpcs.list_domain_mappings.timeout = 20.0
549
- # end
651
+ # @example
652
+ #
653
+ # # Modify the global config, setting the timeout for
654
+ # # list_domain_mappings to 20 seconds,
655
+ # # and all remaining timeouts to 10 seconds.
656
+ # ::Google::Cloud::AppEngine::V1::DomainMappings::Client.configure do |config|
657
+ # config.timeout = 10.0
658
+ # config.rpcs.list_domain_mappings.timeout = 20.0
659
+ # end
660
+ #
661
+ # # Apply the above configuration only to a new client.
662
+ # client = ::Google::Cloud::AppEngine::V1::DomainMappings::Client.new do |config|
663
+ # config.timeout = 10.0
664
+ # config.rpcs.list_domain_mappings.timeout = 20.0
665
+ # end
550
666
  #
551
667
  # @!attribute [rw] endpoint
552
668
  # The hostname or hostname:port of the service endpoint.
@@ -143,6 +143,27 @@ module Google
143
143
  #
144
144
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
145
145
  #
146
+ # @example Basic example
147
+ # require "google/longrunning"
148
+ #
149
+ # # Create a client object. The client can be reused for multiple calls.
150
+ # client = Google::Longrunning::Operations::Client.new
151
+ #
152
+ # # Create a request. To set request fields, pass in keyword arguments.
153
+ # request = Google::Longrunning::ListOperationsRequest.new
154
+ #
155
+ # # Call the list_operations method.
156
+ # result = client.list_operations request
157
+ #
158
+ # # The returned object is of type Gapic::PagedEnumerable. You can
159
+ # # iterate over all elements by calling #each, and the enumerable
160
+ # # will lazily make API calls to fetch subsequent pages. Other
161
+ # # methods are also available for managing paging directly.
162
+ # result.each do |response|
163
+ # # Each element is of type ::Google::Longrunning::Operation.
164
+ # p response
165
+ # end
166
+ #
146
167
  def list_operations request, options = nil
147
168
  raise ::ArgumentError, "request must be provided" if request.nil?
148
169
 
@@ -160,16 +181,20 @@ module Google
160
181
  gapic_version: ::Google::Cloud::AppEngine::V1::VERSION
161
182
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
162
183
 
163
- header_params = {
164
- "name" => request.name
165
- }
184
+ header_params = {}
185
+ if request.name
186
+ header_params["name"] = request.name
187
+ end
188
+
166
189
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
167
190
  metadata[:"x-goog-request-params"] ||= request_params_header
168
191
 
169
192
  options.apply_defaults timeout: @config.rpcs.list_operations.timeout,
170
193
  metadata: metadata,
171
194
  retry_policy: @config.rpcs.list_operations.retry_policy
172
- options.apply_defaults metadata: @config.metadata,
195
+
196
+ options.apply_defaults timeout: @config.timeout,
197
+ metadata: @config.metadata,
173
198
  retry_policy: @config.retry_policy
174
199
 
175
200
  @operations_stub.call_rpc :list_operations, request, options: options do |response, operation|
@@ -213,6 +238,28 @@ module Google
213
238
  #
214
239
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
215
240
  #
241
+ # @example Basic example
242
+ # require "google/longrunning"
243
+ #
244
+ # # Create a client object. The client can be reused for multiple calls.
245
+ # client = Google::Longrunning::Operations::Client.new
246
+ #
247
+ # # Create a request. To set request fields, pass in keyword arguments.
248
+ # request = Google::Longrunning::GetOperationRequest.new
249
+ #
250
+ # # Call the get_operation method.
251
+ # result = client.get_operation request
252
+ #
253
+ # # The returned object is of type Gapic::Operation. You can use this
254
+ # # object to check the status of an operation, cancel it, or wait
255
+ # # for results. Here is how to block until completion:
256
+ # result.wait_until_done! timeout: 60
257
+ # if result.response?
258
+ # p result.response
259
+ # else
260
+ # puts "Error!"
261
+ # end
262
+ #
216
263
  def get_operation request, options = nil
217
264
  raise ::ArgumentError, "request must be provided" if request.nil?
218
265
 
@@ -230,16 +277,20 @@ module Google
230
277
  gapic_version: ::Google::Cloud::AppEngine::V1::VERSION
231
278
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
232
279
 
233
- header_params = {
234
- "name" => request.name
235
- }
280
+ header_params = {}
281
+ if request.name
282
+ header_params["name"] = request.name
283
+ end
284
+
236
285
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
237
286
  metadata[:"x-goog-request-params"] ||= request_params_header
238
287
 
239
288
  options.apply_defaults timeout: @config.rpcs.get_operation.timeout,
240
289
  metadata: metadata,
241
290
  retry_policy: @config.rpcs.get_operation.retry_policy
242
- options.apply_defaults metadata: @config.metadata,
291
+
292
+ options.apply_defaults timeout: @config.timeout,
293
+ metadata: @config.metadata,
243
294
  retry_policy: @config.retry_policy
244
295
 
245
296
  @operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
@@ -283,6 +334,21 @@ module Google
283
334
  #
284
335
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
285
336
  #
337
+ # @example Basic example
338
+ # require "google/longrunning"
339
+ #
340
+ # # Create a client object. The client can be reused for multiple calls.
341
+ # client = Google::Longrunning::Operations::Client.new
342
+ #
343
+ # # Create a request. To set request fields, pass in keyword arguments.
344
+ # request = Google::Longrunning::DeleteOperationRequest.new
345
+ #
346
+ # # Call the delete_operation method.
347
+ # result = client.delete_operation request
348
+ #
349
+ # # The returned object is of type Google::Protobuf::Empty.
350
+ # p result
351
+ #
286
352
  def delete_operation request, options = nil
287
353
  raise ::ArgumentError, "request must be provided" if request.nil?
288
354
 
@@ -300,16 +366,20 @@ module Google
300
366
  gapic_version: ::Google::Cloud::AppEngine::V1::VERSION
301
367
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
302
368
 
303
- header_params = {
304
- "name" => request.name
305
- }
369
+ header_params = {}
370
+ if request.name
371
+ header_params["name"] = request.name
372
+ end
373
+
306
374
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
307
375
  metadata[:"x-goog-request-params"] ||= request_params_header
308
376
 
309
377
  options.apply_defaults timeout: @config.rpcs.delete_operation.timeout,
310
378
  metadata: metadata,
311
379
  retry_policy: @config.rpcs.delete_operation.retry_policy
312
- options.apply_defaults metadata: @config.metadata,
380
+
381
+ options.apply_defaults timeout: @config.timeout,
382
+ metadata: @config.metadata,
313
383
  retry_policy: @config.retry_policy
314
384
 
315
385
  @operations_stub.call_rpc :delete_operation, request, options: options do |response, operation|
@@ -358,6 +428,21 @@ module Google
358
428
  #
359
429
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
360
430
  #
431
+ # @example Basic example
432
+ # require "google/longrunning"
433
+ #
434
+ # # Create a client object. The client can be reused for multiple calls.
435
+ # client = Google::Longrunning::Operations::Client.new
436
+ #
437
+ # # Create a request. To set request fields, pass in keyword arguments.
438
+ # request = Google::Longrunning::CancelOperationRequest.new
439
+ #
440
+ # # Call the cancel_operation method.
441
+ # result = client.cancel_operation request
442
+ #
443
+ # # The returned object is of type Google::Protobuf::Empty.
444
+ # p result
445
+ #
361
446
  def cancel_operation request, options = nil
362
447
  raise ::ArgumentError, "request must be provided" if request.nil?
363
448
 
@@ -375,16 +460,20 @@ module Google
375
460
  gapic_version: ::Google::Cloud::AppEngine::V1::VERSION
376
461
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
377
462
 
378
- header_params = {
379
- "name" => request.name
380
- }
463
+ header_params = {}
464
+ if request.name
465
+ header_params["name"] = request.name
466
+ end
467
+
381
468
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
382
469
  metadata[:"x-goog-request-params"] ||= request_params_header
383
470
 
384
471
  options.apply_defaults timeout: @config.rpcs.cancel_operation.timeout,
385
472
  metadata: metadata,
386
473
  retry_policy: @config.rpcs.cancel_operation.retry_policy
387
- options.apply_defaults metadata: @config.metadata,
474
+
475
+ options.apply_defaults timeout: @config.timeout,
476
+ metadata: @config.metadata,
388
477
  retry_policy: @config.retry_policy
389
478
 
390
479
  @operations_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
@@ -436,6 +525,28 @@ module Google
436
525
  #
437
526
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
438
527
  #
528
+ # @example Basic example
529
+ # require "google/longrunning"
530
+ #
531
+ # # Create a client object. The client can be reused for multiple calls.
532
+ # client = Google::Longrunning::Operations::Client.new
533
+ #
534
+ # # Create a request. To set request fields, pass in keyword arguments.
535
+ # request = Google::Longrunning::WaitOperationRequest.new
536
+ #
537
+ # # Call the wait_operation method.
538
+ # result = client.wait_operation request
539
+ #
540
+ # # The returned object is of type Gapic::Operation. You can use this
541
+ # # object to check the status of an operation, cancel it, or wait
542
+ # # for results. Here is how to block until completion:
543
+ # result.wait_until_done! timeout: 60
544
+ # if result.response?
545
+ # p result.response
546
+ # else
547
+ # puts "Error!"
548
+ # end
549
+ #
439
550
  def wait_operation request, options = nil
440
551
  raise ::ArgumentError, "request must be provided" if request.nil?
441
552
 
@@ -456,7 +567,9 @@ module Google
456
567
  options.apply_defaults timeout: @config.rpcs.wait_operation.timeout,
457
568
  metadata: metadata,
458
569
  retry_policy: @config.rpcs.wait_operation.retry_policy
459
- options.apply_defaults metadata: @config.metadata,
570
+
571
+ options.apply_defaults timeout: @config.timeout,
572
+ metadata: @config.metadata,
460
573
  retry_policy: @config.retry_policy
461
574
 
462
575
  @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
@@ -481,22 +594,21 @@ module Google
481
594
  # Configuration can be applied globally to all clients, or to a single client
482
595
  # on construction.
483
596
  #
484
- # # Examples
485
- #
486
- # To modify the global config, setting the timeout for list_operations
487
- # to 20 seconds, and all remaining timeouts to 10 seconds:
488
- #
489
- # ::Google::Longrunning::Operations::Client.configure do |config|
490
- # config.timeout = 10.0
491
- # config.rpcs.list_operations.timeout = 20.0
492
- # end
493
- #
494
- # To apply the above configuration only to a new client:
495
- #
496
- # client = ::Google::Longrunning::Operations::Client.new do |config|
497
- # config.timeout = 10.0
498
- # config.rpcs.list_operations.timeout = 20.0
499
- # end
597
+ # @example
598
+ #
599
+ # # Modify the global config, setting the timeout for
600
+ # # list_operations to 20 seconds,
601
+ # # and all remaining timeouts to 10 seconds.
602
+ # ::Google::Longrunning::Operations::Client.configure do |config|
603
+ # config.timeout = 10.0
604
+ # config.rpcs.list_operations.timeout = 20.0
605
+ # end
606
+ #
607
+ # # Apply the above configuration only to a new client.
608
+ # client = ::Google::Longrunning::Operations::Client.new do |config|
609
+ # config.timeout = 10.0
610
+ # config.rpcs.list_operations.timeout = 20.0
611
+ # end
500
612
  #
501
613
  # @!attribute [rw] endpoint
502
614
  # The hostname or hostname:port of the service endpoint.