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