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::Versions::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 Versions clients:
45
- #
46
- # ::Google::Cloud::AppEngine::V1::Versions::Client.configure do |config|
47
- # config.timeout = 10.0
48
- # end
44
+ # # Modify the configuration for all Versions clients
45
+ # ::Google::Cloud::AppEngine::V1::Versions::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 Versions client object.
94
93
  #
95
- # ## Examples
96
- #
97
- # To create a new Versions client with the default
98
- # configuration:
99
- #
100
- # client = ::Google::Cloud::AppEngine::V1::Versions::Client.new
94
+ # @example
101
95
  #
102
- # To create a new Versions client with a custom
103
- # configuration:
96
+ # # Create a client using the default configuration
97
+ # client = ::Google::Cloud::AppEngine::V1::Versions::Client.new
104
98
  #
105
- # client = ::Google::Cloud::AppEngine::V1::Versions::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::Versions::Client.new do |config|
101
+ # config.timeout = 10.0
102
+ # end
108
103
  #
109
104
  # @yield [config] Configure the Versions 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
 
@@ -196,6 +191,27 @@ module Google
196
191
  #
197
192
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
198
193
  #
194
+ # @example Basic example
195
+ # require "google/cloud/app_engine/v1"
196
+ #
197
+ # # Create a client object. The client can be reused for multiple calls.
198
+ # client = Google::Cloud::AppEngine::V1::Versions::Client.new
199
+ #
200
+ # # Create a request. To set request fields, pass in keyword arguments.
201
+ # request = Google::Cloud::AppEngine::V1::ListVersionsRequest.new
202
+ #
203
+ # # Call the list_versions method.
204
+ # result = client.list_versions request
205
+ #
206
+ # # The returned object is of type Gapic::PagedEnumerable. You can
207
+ # # iterate over all elements by calling #each, and the enumerable
208
+ # # will lazily make API calls to fetch subsequent pages. Other
209
+ # # methods are also available for managing paging directly.
210
+ # result.each do |response|
211
+ # # Each element is of type ::Google::Cloud::AppEngine::V1::Version.
212
+ # p response
213
+ # end
214
+ #
199
215
  def list_versions request, options = nil
200
216
  raise ::ArgumentError, "request must be provided" if request.nil?
201
217
 
@@ -213,16 +229,20 @@ module Google
213
229
  gapic_version: ::Google::Cloud::AppEngine::V1::VERSION
214
230
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
215
231
 
216
- header_params = {
217
- "parent" => request.parent
218
- }
232
+ header_params = {}
233
+ if request.parent
234
+ header_params["parent"] = request.parent
235
+ end
236
+
219
237
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
220
238
  metadata[:"x-goog-request-params"] ||= request_params_header
221
239
 
222
240
  options.apply_defaults timeout: @config.rpcs.list_versions.timeout,
223
241
  metadata: metadata,
224
242
  retry_policy: @config.rpcs.list_versions.retry_policy
225
- options.apply_defaults metadata: @config.metadata,
243
+
244
+ options.apply_defaults timeout: @config.timeout,
245
+ metadata: @config.metadata,
226
246
  retry_policy: @config.retry_policy
227
247
 
228
248
  @versions_stub.call_rpc :list_versions, request, options: options do |response, operation|
@@ -268,6 +288,21 @@ module Google
268
288
  #
269
289
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
270
290
  #
291
+ # @example Basic example
292
+ # require "google/cloud/app_engine/v1"
293
+ #
294
+ # # Create a client object. The client can be reused for multiple calls.
295
+ # client = Google::Cloud::AppEngine::V1::Versions::Client.new
296
+ #
297
+ # # Create a request. To set request fields, pass in keyword arguments.
298
+ # request = Google::Cloud::AppEngine::V1::GetVersionRequest.new
299
+ #
300
+ # # Call the get_version method.
301
+ # result = client.get_version request
302
+ #
303
+ # # The returned object is of type Google::Cloud::AppEngine::V1::Version.
304
+ # p result
305
+ #
271
306
  def get_version request, options = nil
272
307
  raise ::ArgumentError, "request must be provided" if request.nil?
273
308
 
@@ -285,16 +320,20 @@ module Google
285
320
  gapic_version: ::Google::Cloud::AppEngine::V1::VERSION
286
321
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
287
322
 
288
- header_params = {
289
- "name" => request.name
290
- }
323
+ header_params = {}
324
+ if request.name
325
+ header_params["name"] = request.name
326
+ end
327
+
291
328
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
292
329
  metadata[:"x-goog-request-params"] ||= request_params_header
293
330
 
294
331
  options.apply_defaults timeout: @config.rpcs.get_version.timeout,
295
332
  metadata: metadata,
296
333
  retry_policy: @config.rpcs.get_version.retry_policy
297
- options.apply_defaults metadata: @config.metadata,
334
+
335
+ options.apply_defaults timeout: @config.timeout,
336
+ metadata: @config.metadata,
298
337
  retry_policy: @config.retry_policy
299
338
 
300
339
  @versions_stub.call_rpc :get_version, request, options: options do |response, operation|
@@ -337,6 +376,28 @@ module Google
337
376
  #
338
377
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
339
378
  #
379
+ # @example Basic example
380
+ # require "google/cloud/app_engine/v1"
381
+ #
382
+ # # Create a client object. The client can be reused for multiple calls.
383
+ # client = Google::Cloud::AppEngine::V1::Versions::Client.new
384
+ #
385
+ # # Create a request. To set request fields, pass in keyword arguments.
386
+ # request = Google::Cloud::AppEngine::V1::CreateVersionRequest.new
387
+ #
388
+ # # Call the create_version method.
389
+ # result = client.create_version request
390
+ #
391
+ # # The returned object is of type Gapic::Operation. You can use this
392
+ # # object to check the status of an operation, cancel it, or wait
393
+ # # for results. Here is how to block until completion:
394
+ # result.wait_until_done! timeout: 60
395
+ # if result.response?
396
+ # p result.response
397
+ # else
398
+ # puts "Error!"
399
+ # end
400
+ #
340
401
  def create_version request, options = nil
341
402
  raise ::ArgumentError, "request must be provided" if request.nil?
342
403
 
@@ -354,16 +415,20 @@ module Google
354
415
  gapic_version: ::Google::Cloud::AppEngine::V1::VERSION
355
416
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
356
417
 
357
- header_params = {
358
- "parent" => request.parent
359
- }
418
+ header_params = {}
419
+ if request.parent
420
+ header_params["parent"] = request.parent
421
+ end
422
+
360
423
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
361
424
  metadata[:"x-goog-request-params"] ||= request_params_header
362
425
 
363
426
  options.apply_defaults timeout: @config.rpcs.create_version.timeout,
364
427
  metadata: metadata,
365
428
  retry_policy: @config.rpcs.create_version.retry_policy
366
- options.apply_defaults metadata: @config.metadata,
429
+
430
+ options.apply_defaults timeout: @config.timeout,
431
+ metadata: @config.metadata,
367
432
  retry_policy: @config.retry_policy
368
433
 
369
434
  @versions_stub.call_rpc :create_version, request, options: options do |response, operation|
@@ -445,6 +510,28 @@ module Google
445
510
  #
446
511
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
447
512
  #
513
+ # @example Basic example
514
+ # require "google/cloud/app_engine/v1"
515
+ #
516
+ # # Create a client object. The client can be reused for multiple calls.
517
+ # client = Google::Cloud::AppEngine::V1::Versions::Client.new
518
+ #
519
+ # # Create a request. To set request fields, pass in keyword arguments.
520
+ # request = Google::Cloud::AppEngine::V1::UpdateVersionRequest.new
521
+ #
522
+ # # Call the update_version method.
523
+ # result = client.update_version request
524
+ #
525
+ # # The returned object is of type Gapic::Operation. You can use this
526
+ # # object to check the status of an operation, cancel it, or wait
527
+ # # for results. Here is how to block until completion:
528
+ # result.wait_until_done! timeout: 60
529
+ # if result.response?
530
+ # p result.response
531
+ # else
532
+ # puts "Error!"
533
+ # end
534
+ #
448
535
  def update_version request, options = nil
449
536
  raise ::ArgumentError, "request must be provided" if request.nil?
450
537
 
@@ -462,16 +549,20 @@ module Google
462
549
  gapic_version: ::Google::Cloud::AppEngine::V1::VERSION
463
550
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
464
551
 
465
- header_params = {
466
- "name" => request.name
467
- }
552
+ header_params = {}
553
+ if request.name
554
+ header_params["name"] = request.name
555
+ end
556
+
468
557
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
469
558
  metadata[:"x-goog-request-params"] ||= request_params_header
470
559
 
471
560
  options.apply_defaults timeout: @config.rpcs.update_version.timeout,
472
561
  metadata: metadata,
473
562
  retry_policy: @config.rpcs.update_version.retry_policy
474
- options.apply_defaults metadata: @config.metadata,
563
+
564
+ options.apply_defaults timeout: @config.timeout,
565
+ metadata: @config.metadata,
475
566
  retry_policy: @config.retry_policy
476
567
 
477
568
  @versions_stub.call_rpc :update_version, request, options: options do |response, operation|
@@ -513,6 +604,28 @@ module Google
513
604
  #
514
605
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
515
606
  #
607
+ # @example Basic example
608
+ # require "google/cloud/app_engine/v1"
609
+ #
610
+ # # Create a client object. The client can be reused for multiple calls.
611
+ # client = Google::Cloud::AppEngine::V1::Versions::Client.new
612
+ #
613
+ # # Create a request. To set request fields, pass in keyword arguments.
614
+ # request = Google::Cloud::AppEngine::V1::DeleteVersionRequest.new
615
+ #
616
+ # # Call the delete_version method.
617
+ # result = client.delete_version request
618
+ #
619
+ # # The returned object is of type Gapic::Operation. You can use this
620
+ # # object to check the status of an operation, cancel it, or wait
621
+ # # for results. Here is how to block until completion:
622
+ # result.wait_until_done! timeout: 60
623
+ # if result.response?
624
+ # p result.response
625
+ # else
626
+ # puts "Error!"
627
+ # end
628
+ #
516
629
  def delete_version request, options = nil
517
630
  raise ::ArgumentError, "request must be provided" if request.nil?
518
631
 
@@ -530,16 +643,20 @@ module Google
530
643
  gapic_version: ::Google::Cloud::AppEngine::V1::VERSION
531
644
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
532
645
 
533
- header_params = {
534
- "name" => request.name
535
- }
646
+ header_params = {}
647
+ if request.name
648
+ header_params["name"] = request.name
649
+ end
650
+
536
651
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
537
652
  metadata[:"x-goog-request-params"] ||= request_params_header
538
653
 
539
654
  options.apply_defaults timeout: @config.rpcs.delete_version.timeout,
540
655
  metadata: metadata,
541
656
  retry_policy: @config.rpcs.delete_version.retry_policy
542
- options.apply_defaults metadata: @config.metadata,
657
+
658
+ options.apply_defaults timeout: @config.timeout,
659
+ metadata: @config.metadata,
543
660
  retry_policy: @config.retry_policy
544
661
 
545
662
  @versions_stub.call_rpc :delete_version, request, options: options do |response, operation|
@@ -564,22 +681,21 @@ module Google
564
681
  # Configuration can be applied globally to all clients, or to a single client
565
682
  # on construction.
566
683
  #
567
- # # Examples
568
- #
569
- # To modify the global config, setting the timeout for list_versions
570
- # to 20 seconds, and all remaining timeouts to 10 seconds:
571
- #
572
- # ::Google::Cloud::AppEngine::V1::Versions::Client.configure do |config|
573
- # config.timeout = 10.0
574
- # config.rpcs.list_versions.timeout = 20.0
575
- # end
576
- #
577
- # To apply the above configuration only to a new client:
578
- #
579
- # client = ::Google::Cloud::AppEngine::V1::Versions::Client.new do |config|
580
- # config.timeout = 10.0
581
- # config.rpcs.list_versions.timeout = 20.0
582
- # end
684
+ # @example
685
+ #
686
+ # # Modify the global config, setting the timeout for
687
+ # # list_versions to 20 seconds,
688
+ # # and all remaining timeouts to 10 seconds.
689
+ # ::Google::Cloud::AppEngine::V1::Versions::Client.configure do |config|
690
+ # config.timeout = 10.0
691
+ # config.rpcs.list_versions.timeout = 20.0
692
+ # end
693
+ #
694
+ # # Apply the above configuration only to a new client.
695
+ # client = ::Google::Cloud::AppEngine::V1::Versions::Client.new do |config|
696
+ # config.timeout = 10.0
697
+ # config.rpcs.list_versions.timeout = 20.0
698
+ # end
583
699
  #
584
700
  # @!attribute [rw] endpoint
585
701
  # 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.