google-cloud-app_engine-v1 0.3.1 → 0.3.5

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 +15 -33
  4. data/README.md +1 -1
  5. data/lib/google/appengine/v1/app_yaml_pb.rb +2 -2
  6. data/lib/google/appengine/v1/appengine_pb.rb +2 -2
  7. data/lib/google/appengine/v1/application_pb.rb +2 -2
  8. data/lib/google/appengine/v1/audit_data_pb.rb +2 -2
  9. data/lib/google/appengine/v1/certificate_pb.rb +2 -2
  10. data/lib/google/appengine/v1/deploy_pb.rb +2 -2
  11. data/lib/google/appengine/v1/deployed_files_pb.rb +1 -1
  12. data/lib/google/appengine/v1/domain_mapping_pb.rb +1 -1
  13. data/lib/google/appengine/v1/domain_pb.rb +1 -1
  14. data/lib/google/appengine/v1/firewall_pb.rb +1 -1
  15. data/lib/google/appengine/v1/instance_pb.rb +2 -2
  16. data/lib/google/appengine/v1/location_pb.rb +2 -2
  17. data/lib/google/appengine/v1/network_settings_pb.rb +1 -1
  18. data/lib/google/appengine/v1/operation_pb.rb +2 -2
  19. data/lib/google/appengine/v1/service_pb.rb +2 -2
  20. data/lib/google/appengine/v1/version_pb.rb +2 -2
  21. data/lib/google/cloud/app_engine/v1/applications/client.rb +139 -50
  22. data/lib/google/cloud/app_engine/v1/applications/operations.rb +149 -37
  23. data/lib/google/cloud/app_engine/v1/authorized_certificates/client.rb +151 -57
  24. data/lib/google/cloud/app_engine/v1/authorized_domains/client.rb +59 -41
  25. data/lib/google/cloud/app_engine/v1/domain_mappings/client.rb +173 -57
  26. data/lib/google/cloud/app_engine/v1/domain_mappings/operations.rb +149 -37
  27. data/lib/google/cloud/app_engine/v1/firewall/client.rb +174 -61
  28. data/lib/google/cloud/app_engine/v1/instances/client.rb +143 -53
  29. data/lib/google/cloud/app_engine/v1/instances/operations.rb +149 -37
  30. data/lib/google/cloud/app_engine/v1/services/client.rb +143 -53
  31. data/lib/google/cloud/app_engine/v1/services/operations.rb +149 -37
  32. data/lib/google/cloud/app_engine/v1/version.rb +1 -1
  33. data/lib/google/cloud/app_engine/v1/versions/client.rb +173 -57
  34. data/lib/google/cloud/app_engine/v1/versions/operations.rb +149 -37
  35. data/proto_docs/google/api/field_behavior.rb +7 -1
  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::Instances::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 Instances clients:
45
- #
46
- # ::Google::Cloud::AppEngine::V1::Instances::Client.configure do |config|
47
- # config.timeout = 10.0
48
- # end
44
+ # # Modify the configuration for all Instances clients
45
+ # ::Google::Cloud::AppEngine::V1::Instances::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 Instances client object.
94
93
  #
95
- # ## Examples
96
- #
97
- # To create a new Instances client with the default
98
- # configuration:
99
- #
100
- # client = ::Google::Cloud::AppEngine::V1::Instances::Client.new
94
+ # @example
101
95
  #
102
- # To create a new Instances client with a custom
103
- # configuration:
96
+ # # Create a client using the default configuration
97
+ # client = ::Google::Cloud::AppEngine::V1::Instances::Client.new
104
98
  #
105
- # client = ::Google::Cloud::AppEngine::V1::Instances::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::Instances::Client.new do |config|
101
+ # config.timeout = 10.0
102
+ # end
108
103
  #
109
104
  # @yield [config] Configure the Instances client.
110
105
  # @yieldparam config [Client::Configuration]
@@ -124,14 +119,13 @@ 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
134
- if credentials.is_a?(String) || credentials.is_a?(Hash)
128
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
135
129
  credentials = Credentials.new credentials, scope: @config.scope
136
130
  end
137
131
  @quota_project_id = @config.quota_project
@@ -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
 
@@ -197,6 +192,27 @@ module Google
197
192
  #
198
193
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
199
194
  #
195
+ # @example Basic example
196
+ # require "google/cloud/app_engine/v1"
197
+ #
198
+ # # Create a client object. The client can be reused for multiple calls.
199
+ # client = Google::Cloud::AppEngine::V1::Instances::Client.new
200
+ #
201
+ # # Create a request. To set request fields, pass in keyword arguments.
202
+ # request = Google::Cloud::AppEngine::V1::ListInstancesRequest.new
203
+ #
204
+ # # Call the list_instances method.
205
+ # result = client.list_instances request
206
+ #
207
+ # # The returned object is of type Gapic::PagedEnumerable. You can
208
+ # # iterate over all elements by calling #each, and the enumerable
209
+ # # will lazily make API calls to fetch subsequent pages. Other
210
+ # # methods are also available for managing paging directly.
211
+ # result.each do |response|
212
+ # # Each element is of type ::Google::Cloud::AppEngine::V1::Instance.
213
+ # p response
214
+ # end
215
+ #
200
216
  def list_instances request, options = nil
201
217
  raise ::ArgumentError, "request must be provided" if request.nil?
202
218
 
@@ -214,16 +230,20 @@ module Google
214
230
  gapic_version: ::Google::Cloud::AppEngine::V1::VERSION
215
231
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
216
232
 
217
- header_params = {
218
- "parent" => request.parent
219
- }
233
+ header_params = {}
234
+ if request.parent
235
+ header_params["parent"] = request.parent
236
+ end
237
+
220
238
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
221
239
  metadata[:"x-goog-request-params"] ||= request_params_header
222
240
 
223
241
  options.apply_defaults timeout: @config.rpcs.list_instances.timeout,
224
242
  metadata: metadata,
225
243
  retry_policy: @config.rpcs.list_instances.retry_policy
226
- options.apply_defaults metadata: @config.metadata,
244
+
245
+ options.apply_defaults timeout: @config.timeout,
246
+ metadata: @config.metadata,
227
247
  retry_policy: @config.retry_policy
228
248
 
229
249
  @instances_stub.call_rpc :list_instances, request, options: options do |response, operation|
@@ -265,6 +285,21 @@ module Google
265
285
  #
266
286
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
267
287
  #
288
+ # @example Basic example
289
+ # require "google/cloud/app_engine/v1"
290
+ #
291
+ # # Create a client object. The client can be reused for multiple calls.
292
+ # client = Google::Cloud::AppEngine::V1::Instances::Client.new
293
+ #
294
+ # # Create a request. To set request fields, pass in keyword arguments.
295
+ # request = Google::Cloud::AppEngine::V1::GetInstanceRequest.new
296
+ #
297
+ # # Call the get_instance method.
298
+ # result = client.get_instance request
299
+ #
300
+ # # The returned object is of type Google::Cloud::AppEngine::V1::Instance.
301
+ # p result
302
+ #
268
303
  def get_instance request, options = nil
269
304
  raise ::ArgumentError, "request must be provided" if request.nil?
270
305
 
@@ -282,16 +317,20 @@ module Google
282
317
  gapic_version: ::Google::Cloud::AppEngine::V1::VERSION
283
318
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
284
319
 
285
- header_params = {
286
- "name" => request.name
287
- }
320
+ header_params = {}
321
+ if request.name
322
+ header_params["name"] = request.name
323
+ end
324
+
288
325
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
289
326
  metadata[:"x-goog-request-params"] ||= request_params_header
290
327
 
291
328
  options.apply_defaults timeout: @config.rpcs.get_instance.timeout,
292
329
  metadata: metadata,
293
330
  retry_policy: @config.rpcs.get_instance.retry_policy
294
- options.apply_defaults metadata: @config.metadata,
331
+
332
+ options.apply_defaults timeout: @config.timeout,
333
+ metadata: @config.metadata,
295
334
  retry_policy: @config.retry_policy
296
335
 
297
336
  @instances_stub.call_rpc :get_instance, request, options: options do |response, operation|
@@ -343,6 +382,28 @@ module Google
343
382
  #
344
383
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
345
384
  #
385
+ # @example Basic example
386
+ # require "google/cloud/app_engine/v1"
387
+ #
388
+ # # Create a client object. The client can be reused for multiple calls.
389
+ # client = Google::Cloud::AppEngine::V1::Instances::Client.new
390
+ #
391
+ # # Create a request. To set request fields, pass in keyword arguments.
392
+ # request = Google::Cloud::AppEngine::V1::DeleteInstanceRequest.new
393
+ #
394
+ # # Call the delete_instance method.
395
+ # result = client.delete_instance request
396
+ #
397
+ # # The returned object is of type Gapic::Operation. You can use this
398
+ # # object to check the status of an operation, cancel it, or wait
399
+ # # for results. Here is how to block until completion:
400
+ # result.wait_until_done! timeout: 60
401
+ # if result.response?
402
+ # p result.response
403
+ # else
404
+ # puts "Error!"
405
+ # end
406
+ #
346
407
  def delete_instance request, options = nil
347
408
  raise ::ArgumentError, "request must be provided" if request.nil?
348
409
 
@@ -360,16 +421,20 @@ module Google
360
421
  gapic_version: ::Google::Cloud::AppEngine::V1::VERSION
361
422
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
362
423
 
363
- header_params = {
364
- "name" => request.name
365
- }
424
+ header_params = {}
425
+ if request.name
426
+ header_params["name"] = request.name
427
+ end
428
+
366
429
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
367
430
  metadata[:"x-goog-request-params"] ||= request_params_header
368
431
 
369
432
  options.apply_defaults timeout: @config.rpcs.delete_instance.timeout,
370
433
  metadata: metadata,
371
434
  retry_policy: @config.rpcs.delete_instance.retry_policy
372
- options.apply_defaults metadata: @config.metadata,
435
+
436
+ options.apply_defaults timeout: @config.timeout,
437
+ metadata: @config.metadata,
373
438
  retry_policy: @config.retry_policy
374
439
 
375
440
  @instances_stub.call_rpc :delete_instance, request, options: options do |response, operation|
@@ -426,6 +491,28 @@ module Google
426
491
  #
427
492
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
428
493
  #
494
+ # @example Basic example
495
+ # require "google/cloud/app_engine/v1"
496
+ #
497
+ # # Create a client object. The client can be reused for multiple calls.
498
+ # client = Google::Cloud::AppEngine::V1::Instances::Client.new
499
+ #
500
+ # # Create a request. To set request fields, pass in keyword arguments.
501
+ # request = Google::Cloud::AppEngine::V1::DebugInstanceRequest.new
502
+ #
503
+ # # Call the debug_instance method.
504
+ # result = client.debug_instance request
505
+ #
506
+ # # The returned object is of type Gapic::Operation. You can use this
507
+ # # object to check the status of an operation, cancel it, or wait
508
+ # # for results. Here is how to block until completion:
509
+ # result.wait_until_done! timeout: 60
510
+ # if result.response?
511
+ # p result.response
512
+ # else
513
+ # puts "Error!"
514
+ # end
515
+ #
429
516
  def debug_instance request, options = nil
430
517
  raise ::ArgumentError, "request must be provided" if request.nil?
431
518
 
@@ -443,16 +530,20 @@ module Google
443
530
  gapic_version: ::Google::Cloud::AppEngine::V1::VERSION
444
531
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
445
532
 
446
- header_params = {
447
- "name" => request.name
448
- }
533
+ header_params = {}
534
+ if request.name
535
+ header_params["name"] = request.name
536
+ end
537
+
449
538
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
450
539
  metadata[:"x-goog-request-params"] ||= request_params_header
451
540
 
452
541
  options.apply_defaults timeout: @config.rpcs.debug_instance.timeout,
453
542
  metadata: metadata,
454
543
  retry_policy: @config.rpcs.debug_instance.retry_policy
455
- options.apply_defaults metadata: @config.metadata,
544
+
545
+ options.apply_defaults timeout: @config.timeout,
546
+ metadata: @config.metadata,
456
547
  retry_policy: @config.retry_policy
457
548
 
458
549
  @instances_stub.call_rpc :debug_instance, request, options: options do |response, operation|
@@ -477,22 +568,21 @@ module Google
477
568
  # Configuration can be applied globally to all clients, or to a single client
478
569
  # on construction.
479
570
  #
480
- # # Examples
481
- #
482
- # To modify the global config, setting the timeout for list_instances
483
- # to 20 seconds, and all remaining timeouts to 10 seconds:
484
- #
485
- # ::Google::Cloud::AppEngine::V1::Instances::Client.configure do |config|
486
- # config.timeout = 10.0
487
- # config.rpcs.list_instances.timeout = 20.0
488
- # end
489
- #
490
- # To apply the above configuration only to a new client:
491
- #
492
- # client = ::Google::Cloud::AppEngine::V1::Instances::Client.new do |config|
493
- # config.timeout = 10.0
494
- # config.rpcs.list_instances.timeout = 20.0
495
- # end
571
+ # @example
572
+ #
573
+ # # Modify the global config, setting the timeout for
574
+ # # list_instances to 20 seconds,
575
+ # # and all remaining timeouts to 10 seconds.
576
+ # ::Google::Cloud::AppEngine::V1::Instances::Client.configure do |config|
577
+ # config.timeout = 10.0
578
+ # config.rpcs.list_instances.timeout = 20.0
579
+ # end
580
+ #
581
+ # # Apply the above configuration only to a new client.
582
+ # client = ::Google::Cloud::AppEngine::V1::Instances::Client.new do |config|
583
+ # config.timeout = 10.0
584
+ # config.rpcs.list_instances.timeout = 20.0
585
+ # end
496
586
  #
497
587
  # @!attribute [rw] endpoint
498
588
  # The hostname or hostname:port of the service endpoint.
@@ -82,7 +82,7 @@ module Google
82
82
  # Create credentials
83
83
  credentials = @config.credentials
84
84
  credentials ||= Credentials.default scope: @config.scope
85
- if credentials.is_a?(String) || credentials.is_a?(Hash)
85
+ if credentials.is_a?(::String) || credentials.is_a?(::Hash)
86
86
  credentials = Credentials.new credentials, scope: @config.scope
87
87
  end
88
88
  @quota_project_id = @config.quota_project
@@ -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|
@@ -396,9 +485,9 @@ module Google
396
485
  end
397
486
 
398
487
  ##
399
- # Waits for the specified long-running operation until it is done or reaches
400
- # at most a specified timeout, returning the latest state. If the operation
401
- # is already done, the latest state is immediately returned. If the timeout
488
+ # Waits until the specified long-running operation is done or reaches at most
489
+ # a specified timeout, returning the latest state. If the operation is
490
+ # already done, the latest state is immediately returned. If the timeout
402
491
  # specified is greater than the default HTTP/RPC timeout, the HTTP/RPC
403
492
  # timeout is used. If the server does not support this method, it returns
404
493
  # `google.rpc.Code.UNIMPLEMENTED`.
@@ -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.