google-cloud-app_engine-v1 0.3.1 → 0.3.5

Sign up to get free protection for your applications and to get access to all the features.
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::Services::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 Services clients:
45
- #
46
- # ::Google::Cloud::AppEngine::V1::Services::Client.configure do |config|
47
- # config.timeout = 10.0
48
- # end
44
+ # # Modify the configuration for all Services clients
45
+ # ::Google::Cloud::AppEngine::V1::Services::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 Services client object.
94
93
  #
95
- # ## Examples
96
- #
97
- # To create a new Services client with the default
98
- # configuration:
99
- #
100
- # client = ::Google::Cloud::AppEngine::V1::Services::Client.new
94
+ # @example
101
95
  #
102
- # To create a new Services client with a custom
103
- # configuration:
96
+ # # Create a client using the default configuration
97
+ # client = ::Google::Cloud::AppEngine::V1::Services::Client.new
104
98
  #
105
- # client = ::Google::Cloud::AppEngine::V1::Services::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::Services::Client.new do |config|
101
+ # config.timeout = 10.0
102
+ # end
108
103
  #
109
104
  # @yield [config] Configure the Services 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
 
@@ -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::Services::Client.new
196
+ #
197
+ # # Create a request. To set request fields, pass in keyword arguments.
198
+ # request = Google::Cloud::AppEngine::V1::ListServicesRequest.new
199
+ #
200
+ # # Call the list_services method.
201
+ # result = client.list_services 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::Service.
209
+ # p response
210
+ # end
211
+ #
196
212
  def list_services 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_services.timeout,
220
238
  metadata: metadata,
221
239
  retry_policy: @config.rpcs.list_services.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
  @services_stub.call_rpc :list_services, request, options: options do |response, operation|
@@ -260,6 +280,21 @@ module Google
260
280
  #
261
281
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
262
282
  #
283
+ # @example Basic example
284
+ # require "google/cloud/app_engine/v1"
285
+ #
286
+ # # Create a client object. The client can be reused for multiple calls.
287
+ # client = Google::Cloud::AppEngine::V1::Services::Client.new
288
+ #
289
+ # # Create a request. To set request fields, pass in keyword arguments.
290
+ # request = Google::Cloud::AppEngine::V1::GetServiceRequest.new
291
+ #
292
+ # # Call the get_service method.
293
+ # result = client.get_service request
294
+ #
295
+ # # The returned object is of type Google::Cloud::AppEngine::V1::Service.
296
+ # p result
297
+ #
263
298
  def get_service request, options = nil
264
299
  raise ::ArgumentError, "request must be provided" if request.nil?
265
300
 
@@ -277,16 +312,20 @@ module Google
277
312
  gapic_version: ::Google::Cloud::AppEngine::V1::VERSION
278
313
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
279
314
 
280
- header_params = {
281
- "name" => request.name
282
- }
315
+ header_params = {}
316
+ if request.name
317
+ header_params["name"] = request.name
318
+ end
319
+
283
320
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
284
321
  metadata[:"x-goog-request-params"] ||= request_params_header
285
322
 
286
323
  options.apply_defaults timeout: @config.rpcs.get_service.timeout,
287
324
  metadata: metadata,
288
325
  retry_policy: @config.rpcs.get_service.retry_policy
289
- options.apply_defaults metadata: @config.metadata,
326
+
327
+ options.apply_defaults timeout: @config.timeout,
328
+ metadata: @config.metadata,
290
329
  retry_policy: @config.retry_policy
291
330
 
292
331
  @services_stub.call_rpc :get_service, request, options: options do |response, operation|
@@ -344,6 +383,28 @@ module Google
344
383
  #
345
384
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
346
385
  #
386
+ # @example Basic example
387
+ # require "google/cloud/app_engine/v1"
388
+ #
389
+ # # Create a client object. The client can be reused for multiple calls.
390
+ # client = Google::Cloud::AppEngine::V1::Services::Client.new
391
+ #
392
+ # # Create a request. To set request fields, pass in keyword arguments.
393
+ # request = Google::Cloud::AppEngine::V1::UpdateServiceRequest.new
394
+ #
395
+ # # Call the update_service method.
396
+ # result = client.update_service request
397
+ #
398
+ # # The returned object is of type Gapic::Operation. You can use this
399
+ # # object to check the status of an operation, cancel it, or wait
400
+ # # for results. Here is how to block until completion:
401
+ # result.wait_until_done! timeout: 60
402
+ # if result.response?
403
+ # p result.response
404
+ # else
405
+ # puts "Error!"
406
+ # end
407
+ #
347
408
  def update_service request, options = nil
348
409
  raise ::ArgumentError, "request must be provided" if request.nil?
349
410
 
@@ -361,16 +422,20 @@ module Google
361
422
  gapic_version: ::Google::Cloud::AppEngine::V1::VERSION
362
423
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
363
424
 
364
- header_params = {
365
- "name" => request.name
366
- }
425
+ header_params = {}
426
+ if request.name
427
+ header_params["name"] = request.name
428
+ end
429
+
367
430
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
368
431
  metadata[:"x-goog-request-params"] ||= request_params_header
369
432
 
370
433
  options.apply_defaults timeout: @config.rpcs.update_service.timeout,
371
434
  metadata: metadata,
372
435
  retry_policy: @config.rpcs.update_service.retry_policy
373
- options.apply_defaults metadata: @config.metadata,
436
+
437
+ options.apply_defaults timeout: @config.timeout,
438
+ metadata: @config.metadata,
374
439
  retry_policy: @config.retry_policy
375
440
 
376
441
  @services_stub.call_rpc :update_service, request, options: options do |response, operation|
@@ -411,6 +476,28 @@ module Google
411
476
  #
412
477
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
413
478
  #
479
+ # @example Basic example
480
+ # require "google/cloud/app_engine/v1"
481
+ #
482
+ # # Create a client object. The client can be reused for multiple calls.
483
+ # client = Google::Cloud::AppEngine::V1::Services::Client.new
484
+ #
485
+ # # Create a request. To set request fields, pass in keyword arguments.
486
+ # request = Google::Cloud::AppEngine::V1::DeleteServiceRequest.new
487
+ #
488
+ # # Call the delete_service method.
489
+ # result = client.delete_service request
490
+ #
491
+ # # The returned object is of type Gapic::Operation. You can use this
492
+ # # object to check the status of an operation, cancel it, or wait
493
+ # # for results. Here is how to block until completion:
494
+ # result.wait_until_done! timeout: 60
495
+ # if result.response?
496
+ # p result.response
497
+ # else
498
+ # puts "Error!"
499
+ # end
500
+ #
414
501
  def delete_service request, options = nil
415
502
  raise ::ArgumentError, "request must be provided" if request.nil?
416
503
 
@@ -428,16 +515,20 @@ module Google
428
515
  gapic_version: ::Google::Cloud::AppEngine::V1::VERSION
429
516
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
430
517
 
431
- header_params = {
432
- "name" => request.name
433
- }
518
+ header_params = {}
519
+ if request.name
520
+ header_params["name"] = request.name
521
+ end
522
+
434
523
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
435
524
  metadata[:"x-goog-request-params"] ||= request_params_header
436
525
 
437
526
  options.apply_defaults timeout: @config.rpcs.delete_service.timeout,
438
527
  metadata: metadata,
439
528
  retry_policy: @config.rpcs.delete_service.retry_policy
440
- options.apply_defaults metadata: @config.metadata,
529
+
530
+ options.apply_defaults timeout: @config.timeout,
531
+ metadata: @config.metadata,
441
532
  retry_policy: @config.retry_policy
442
533
 
443
534
  @services_stub.call_rpc :delete_service, request, options: options do |response, operation|
@@ -462,22 +553,21 @@ module Google
462
553
  # Configuration can be applied globally to all clients, or to a single client
463
554
  # on construction.
464
555
  #
465
- # # Examples
466
- #
467
- # To modify the global config, setting the timeout for list_services
468
- # to 20 seconds, and all remaining timeouts to 10 seconds:
469
- #
470
- # ::Google::Cloud::AppEngine::V1::Services::Client.configure do |config|
471
- # config.timeout = 10.0
472
- # config.rpcs.list_services.timeout = 20.0
473
- # end
474
- #
475
- # To apply the above configuration only to a new client:
476
- #
477
- # client = ::Google::Cloud::AppEngine::V1::Services::Client.new do |config|
478
- # config.timeout = 10.0
479
- # config.rpcs.list_services.timeout = 20.0
480
- # end
556
+ # @example
557
+ #
558
+ # # Modify the global config, setting the timeout for
559
+ # # list_services to 20 seconds,
560
+ # # and all remaining timeouts to 10 seconds.
561
+ # ::Google::Cloud::AppEngine::V1::Services::Client.configure do |config|
562
+ # config.timeout = 10.0
563
+ # config.rpcs.list_services.timeout = 20.0
564
+ # end
565
+ #
566
+ # # Apply the above configuration only to a new client.
567
+ # client = ::Google::Cloud::AppEngine::V1::Services::Client.new do |config|
568
+ # config.timeout = 10.0
569
+ # config.rpcs.list_services.timeout = 20.0
570
+ # end
481
571
  #
482
572
  # @!attribute [rw] endpoint
483
573
  # 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.
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module AppEngine
23
23
  module V1
24
- VERSION = "0.3.1"
24
+ VERSION = "0.3.5"
25
25
  end
26
26
  end
27
27
  end