google-cloud-gaming-v1 0.3.1 → 0.4.1
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/cloud/gaming/v1/common_pb.rb +2 -2
- data/lib/google/cloud/gaming/v1/game_server_clusters_pb.rb +33 -2
- data/lib/google/cloud/gaming/v1/game_server_clusters_service/client.rb +275 -108
- data/lib/google/cloud/gaming/v1/game_server_clusters_service/operations.rb +149 -37
- data/lib/google/cloud/gaming/v1/game_server_clusters_service_pb.rb +2 -2
- data/lib/google/cloud/gaming/v1/game_server_configs_pb.rb +2 -2
- data/lib/google/cloud/gaming/v1/game_server_configs_service/client.rb +148 -69
- data/lib/google/cloud/gaming/v1/game_server_configs_service/operations.rb +149 -37
- data/lib/google/cloud/gaming/v1/game_server_configs_service_pb.rb +2 -2
- data/lib/google/cloud/gaming/v1/game_server_deployments_pb.rb +2 -2
- data/lib/google/cloud/gaming/v1/game_server_deployments_service/client.rb +286 -116
- data/lib/google/cloud/gaming/v1/game_server_deployments_service/operations.rb +149 -37
- data/lib/google/cloud/gaming/v1/game_server_deployments_service_pb.rb +2 -2
- data/lib/google/cloud/gaming/v1/realms_pb.rb +2 -2
- data/lib/google/cloud/gaming/v1/realms_service/client.rb +204 -85
- data/lib/google/cloud/gaming/v1/realms_service/operations.rb +149 -37
- data/lib/google/cloud/gaming/v1/realms_service_pb.rb +2 -2
- data/lib/google/cloud/gaming/v1/version.rb +1 -1
- data/proto_docs/google/api/field_behavior.rb +7 -1
- data/proto_docs/google/cloud/gaming/v1/common.rb +0 -3
- data/proto_docs/google/cloud/gaming/v1/game_server_clusters.rb +117 -19
- data/proto_docs/google/cloud/gaming/v1/game_server_configs.rb +5 -11
- data/proto_docs/google/cloud/gaming/v1/game_server_deployments.rb +12 -28
- data/proto_docs/google/cloud/gaming/v1/realms.rb +7 -13
- metadata +4 -4
@@ -41,13 +41,12 @@ module Google
|
|
41
41
|
# See {::Google::Cloud::Gaming::V1::GameServerConfigsService::Client::Configuration}
|
42
42
|
# for a description of the configuration fields.
|
43
43
|
#
|
44
|
-
#
|
44
|
+
# @example
|
45
45
|
#
|
46
|
-
#
|
47
|
-
#
|
48
|
-
#
|
49
|
-
#
|
50
|
-
# end
|
46
|
+
# # Modify the configuration for all GameServerConfigsService clients
|
47
|
+
# ::Google::Cloud::Gaming::V1::GameServerConfigsService::Client.configure do |config|
|
48
|
+
# config.timeout = 10.0
|
49
|
+
# end
|
51
50
|
#
|
52
51
|
# @yield [config] Configure the Client client.
|
53
52
|
# @yieldparam config [Client::Configuration]
|
@@ -67,18 +66,12 @@ module Google
|
|
67
66
|
|
68
67
|
default_config.rpcs.list_game_server_configs.timeout = 60.0
|
69
68
|
default_config.rpcs.list_game_server_configs.retry_policy = {
|
70
|
-
initial_delay: 1.0,
|
71
|
-
max_delay: 10.0,
|
72
|
-
multiplier: 1.3,
|
73
|
-
retry_codes: [14]
|
69
|
+
initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
|
74
70
|
}
|
75
71
|
|
76
72
|
default_config.rpcs.get_game_server_config.timeout = 60.0
|
77
73
|
default_config.rpcs.get_game_server_config.retry_policy = {
|
78
|
-
initial_delay: 1.0,
|
79
|
-
max_delay: 10.0,
|
80
|
-
multiplier: 1.3,
|
81
|
-
retry_codes: [14]
|
74
|
+
initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
|
82
75
|
}
|
83
76
|
|
84
77
|
default_config.rpcs.create_game_server_config.timeout = 60.0
|
@@ -114,19 +107,15 @@ module Google
|
|
114
107
|
##
|
115
108
|
# Create a new GameServerConfigsService client object.
|
116
109
|
#
|
117
|
-
#
|
118
|
-
#
|
119
|
-
# To create a new GameServerConfigsService client with the default
|
120
|
-
# configuration:
|
121
|
-
#
|
122
|
-
# client = ::Google::Cloud::Gaming::V1::GameServerConfigsService::Client.new
|
110
|
+
# @example
|
123
111
|
#
|
124
|
-
#
|
125
|
-
#
|
112
|
+
# # Create a client using the default configuration
|
113
|
+
# client = ::Google::Cloud::Gaming::V1::GameServerConfigsService::Client.new
|
126
114
|
#
|
127
|
-
#
|
128
|
-
#
|
129
|
-
#
|
115
|
+
# # Create a client using a custom configuration
|
116
|
+
# client = ::Google::Cloud::Gaming::V1::GameServerConfigsService::Client.new do |config|
|
117
|
+
# config.timeout = 10.0
|
118
|
+
# end
|
130
119
|
#
|
131
120
|
# @yield [config] Configure the GameServerConfigsService client.
|
132
121
|
# @yieldparam config [Client::Configuration]
|
@@ -146,14 +135,13 @@ module Google
|
|
146
135
|
|
147
136
|
# Create credentials
|
148
137
|
credentials = @config.credentials
|
149
|
-
# Use self-signed JWT if the
|
138
|
+
# Use self-signed JWT if the endpoint is unchanged from default,
|
150
139
|
# but only if the default endpoint does not have a region prefix.
|
151
|
-
enable_self_signed_jwt = @config.
|
152
|
-
@config.endpoint == Client.configure.endpoint &&
|
140
|
+
enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
|
153
141
|
!@config.endpoint.split(".").first.include?("-")
|
154
142
|
credentials ||= Credentials.default scope: @config.scope,
|
155
143
|
enable_self_signed_jwt: enable_self_signed_jwt
|
156
|
-
if credentials.is_a?(String) || credentials.is_a?(Hash)
|
144
|
+
if credentials.is_a?(::String) || credentials.is_a?(::Hash)
|
157
145
|
credentials = Credentials.new credentials, scope: @config.scope
|
158
146
|
end
|
159
147
|
@quota_project_id = @config.quota_project
|
@@ -202,8 +190,7 @@ module Google
|
|
202
190
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
203
191
|
#
|
204
192
|
# @param parent [::String]
|
205
|
-
# Required. The parent resource name
|
206
|
-
#
|
193
|
+
# Required. The parent resource name, in the following form:
|
207
194
|
# `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/*`.
|
208
195
|
# @param page_size [::Integer]
|
209
196
|
# Optional. The maximum number of items to return. If unspecified, server
|
@@ -227,6 +214,27 @@ module Google
|
|
227
214
|
#
|
228
215
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
229
216
|
#
|
217
|
+
# @example Basic example
|
218
|
+
# require "google/cloud/gaming/v1"
|
219
|
+
#
|
220
|
+
# # Create a client object. The client can be reused for multiple calls.
|
221
|
+
# client = Google::Cloud::Gaming::V1::GameServerConfigsService::Client.new
|
222
|
+
#
|
223
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
224
|
+
# request = Google::Cloud::Gaming::V1::ListGameServerConfigsRequest.new
|
225
|
+
#
|
226
|
+
# # Call the list_game_server_configs method.
|
227
|
+
# result = client.list_game_server_configs request
|
228
|
+
#
|
229
|
+
# # The returned object is of type Gapic::PagedEnumerable. You can
|
230
|
+
# # iterate over all elements by calling #each, and the enumerable
|
231
|
+
# # will lazily make API calls to fetch subsequent pages. Other
|
232
|
+
# # methods are also available for managing paging directly.
|
233
|
+
# result.each do |response|
|
234
|
+
# # Each element is of type ::Google::Cloud::Gaming::V1::GameServerConfig.
|
235
|
+
# p response
|
236
|
+
# end
|
237
|
+
#
|
230
238
|
def list_game_server_configs request, options = nil
|
231
239
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
232
240
|
|
@@ -244,16 +252,20 @@ module Google
|
|
244
252
|
gapic_version: ::Google::Cloud::Gaming::V1::VERSION
|
245
253
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
246
254
|
|
247
|
-
header_params = {
|
248
|
-
|
249
|
-
|
255
|
+
header_params = {}
|
256
|
+
if request.parent
|
257
|
+
header_params["parent"] = request.parent
|
258
|
+
end
|
259
|
+
|
250
260
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
251
261
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
252
262
|
|
253
263
|
options.apply_defaults timeout: @config.rpcs.list_game_server_configs.timeout,
|
254
264
|
metadata: metadata,
|
255
265
|
retry_policy: @config.rpcs.list_game_server_configs.retry_policy
|
256
|
-
|
266
|
+
|
267
|
+
options.apply_defaults timeout: @config.timeout,
|
268
|
+
metadata: @config.metadata,
|
257
269
|
retry_policy: @config.retry_policy
|
258
270
|
|
259
271
|
@game_server_configs_service_stub.call_rpc :list_game_server_configs, request, options: options do |response, operation|
|
@@ -284,8 +296,7 @@ module Google
|
|
284
296
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
285
297
|
#
|
286
298
|
# @param name [::String]
|
287
|
-
# Required. The name of the game server config to retrieve
|
288
|
-
#
|
299
|
+
# Required. The name of the game server config to retrieve, in the following form:
|
289
300
|
# `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`.
|
290
301
|
#
|
291
302
|
# @yield [response, operation] Access the result along with the RPC operation
|
@@ -296,6 +307,21 @@ module Google
|
|
296
307
|
#
|
297
308
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
298
309
|
#
|
310
|
+
# @example Basic example
|
311
|
+
# require "google/cloud/gaming/v1"
|
312
|
+
#
|
313
|
+
# # Create a client object. The client can be reused for multiple calls.
|
314
|
+
# client = Google::Cloud::Gaming::V1::GameServerConfigsService::Client.new
|
315
|
+
#
|
316
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
317
|
+
# request = Google::Cloud::Gaming::V1::GetGameServerConfigRequest.new
|
318
|
+
#
|
319
|
+
# # Call the get_game_server_config method.
|
320
|
+
# result = client.get_game_server_config request
|
321
|
+
#
|
322
|
+
# # The returned object is of type Google::Cloud::Gaming::V1::GameServerConfig.
|
323
|
+
# p result
|
324
|
+
#
|
299
325
|
def get_game_server_config request, options = nil
|
300
326
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
301
327
|
|
@@ -313,16 +339,20 @@ module Google
|
|
313
339
|
gapic_version: ::Google::Cloud::Gaming::V1::VERSION
|
314
340
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
315
341
|
|
316
|
-
header_params = {
|
317
|
-
|
318
|
-
|
342
|
+
header_params = {}
|
343
|
+
if request.name
|
344
|
+
header_params["name"] = request.name
|
345
|
+
end
|
346
|
+
|
319
347
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
320
348
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
321
349
|
|
322
350
|
options.apply_defaults timeout: @config.rpcs.get_game_server_config.timeout,
|
323
351
|
metadata: metadata,
|
324
352
|
retry_policy: @config.rpcs.get_game_server_config.retry_policy
|
325
|
-
|
353
|
+
|
354
|
+
options.apply_defaults timeout: @config.timeout,
|
355
|
+
metadata: @config.metadata,
|
326
356
|
retry_policy: @config.retry_policy
|
327
357
|
|
328
358
|
@game_server_configs_service_stub.call_rpc :get_game_server_config, request, options: options do |response, operation|
|
@@ -354,8 +384,7 @@ module Google
|
|
354
384
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
355
385
|
#
|
356
386
|
# @param parent [::String]
|
357
|
-
# Required. The parent resource name
|
358
|
-
#
|
387
|
+
# Required. The parent resource name, in the following form:
|
359
388
|
# `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/`.
|
360
389
|
# @param config_id [::String]
|
361
390
|
# Required. The ID of the game server config resource to be created.
|
@@ -370,6 +399,28 @@ module Google
|
|
370
399
|
#
|
371
400
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
372
401
|
#
|
402
|
+
# @example Basic example
|
403
|
+
# require "google/cloud/gaming/v1"
|
404
|
+
#
|
405
|
+
# # Create a client object. The client can be reused for multiple calls.
|
406
|
+
# client = Google::Cloud::Gaming::V1::GameServerConfigsService::Client.new
|
407
|
+
#
|
408
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
409
|
+
# request = Google::Cloud::Gaming::V1::CreateGameServerConfigRequest.new
|
410
|
+
#
|
411
|
+
# # Call the create_game_server_config method.
|
412
|
+
# result = client.create_game_server_config request
|
413
|
+
#
|
414
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
415
|
+
# # object to check the status of an operation, cancel it, or wait
|
416
|
+
# # for results. Here is how to block until completion:
|
417
|
+
# result.wait_until_done! timeout: 60
|
418
|
+
# if result.response?
|
419
|
+
# p result.response
|
420
|
+
# else
|
421
|
+
# puts "Error!"
|
422
|
+
# end
|
423
|
+
#
|
373
424
|
def create_game_server_config request, options = nil
|
374
425
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
375
426
|
|
@@ -387,16 +438,20 @@ module Google
|
|
387
438
|
gapic_version: ::Google::Cloud::Gaming::V1::VERSION
|
388
439
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
389
440
|
|
390
|
-
header_params = {
|
391
|
-
|
392
|
-
|
441
|
+
header_params = {}
|
442
|
+
if request.parent
|
443
|
+
header_params["parent"] = request.parent
|
444
|
+
end
|
445
|
+
|
393
446
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
394
447
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
395
448
|
|
396
449
|
options.apply_defaults timeout: @config.rpcs.create_game_server_config.timeout,
|
397
450
|
metadata: metadata,
|
398
451
|
retry_policy: @config.rpcs.create_game_server_config.retry_policy
|
399
|
-
|
452
|
+
|
453
|
+
options.apply_defaults timeout: @config.timeout,
|
454
|
+
metadata: @config.metadata,
|
400
455
|
retry_policy: @config.retry_policy
|
401
456
|
|
402
457
|
@game_server_configs_service_stub.call_rpc :create_game_server_config, request, options: options do |response, operation|
|
@@ -428,8 +483,7 @@ module Google
|
|
428
483
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
429
484
|
#
|
430
485
|
# @param name [::String]
|
431
|
-
# Required. The name of the game server config to delete
|
432
|
-
#
|
486
|
+
# Required. The name of the game server config to delete, in the following form:
|
433
487
|
# `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`.
|
434
488
|
#
|
435
489
|
# @yield [response, operation] Access the result along with the RPC operation
|
@@ -440,6 +494,28 @@ module Google
|
|
440
494
|
#
|
441
495
|
# @raise [::Google::Cloud::Error] if the RPC is aborted.
|
442
496
|
#
|
497
|
+
# @example Basic example
|
498
|
+
# require "google/cloud/gaming/v1"
|
499
|
+
#
|
500
|
+
# # Create a client object. The client can be reused for multiple calls.
|
501
|
+
# client = Google::Cloud::Gaming::V1::GameServerConfigsService::Client.new
|
502
|
+
#
|
503
|
+
# # Create a request. To set request fields, pass in keyword arguments.
|
504
|
+
# request = Google::Cloud::Gaming::V1::DeleteGameServerConfigRequest.new
|
505
|
+
#
|
506
|
+
# # Call the delete_game_server_config method.
|
507
|
+
# result = client.delete_game_server_config request
|
508
|
+
#
|
509
|
+
# # The returned object is of type Gapic::Operation. You can use this
|
510
|
+
# # object to check the status of an operation, cancel it, or wait
|
511
|
+
# # for results. Here is how to block until completion:
|
512
|
+
# result.wait_until_done! timeout: 60
|
513
|
+
# if result.response?
|
514
|
+
# p result.response
|
515
|
+
# else
|
516
|
+
# puts "Error!"
|
517
|
+
# end
|
518
|
+
#
|
443
519
|
def delete_game_server_config request, options = nil
|
444
520
|
raise ::ArgumentError, "request must be provided" if request.nil?
|
445
521
|
|
@@ -457,16 +533,20 @@ module Google
|
|
457
533
|
gapic_version: ::Google::Cloud::Gaming::V1::VERSION
|
458
534
|
metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
|
459
535
|
|
460
|
-
header_params = {
|
461
|
-
|
462
|
-
|
536
|
+
header_params = {}
|
537
|
+
if request.name
|
538
|
+
header_params["name"] = request.name
|
539
|
+
end
|
540
|
+
|
463
541
|
request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
|
464
542
|
metadata[:"x-goog-request-params"] ||= request_params_header
|
465
543
|
|
466
544
|
options.apply_defaults timeout: @config.rpcs.delete_game_server_config.timeout,
|
467
545
|
metadata: metadata,
|
468
546
|
retry_policy: @config.rpcs.delete_game_server_config.retry_policy
|
469
|
-
|
547
|
+
|
548
|
+
options.apply_defaults timeout: @config.timeout,
|
549
|
+
metadata: @config.metadata,
|
470
550
|
retry_policy: @config.retry_policy
|
471
551
|
|
472
552
|
@game_server_configs_service_stub.call_rpc :delete_game_server_config, request, options: options do |response, operation|
|
@@ -491,22 +571,21 @@ module Google
|
|
491
571
|
# Configuration can be applied globally to all clients, or to a single client
|
492
572
|
# on construction.
|
493
573
|
#
|
494
|
-
#
|
495
|
-
#
|
496
|
-
#
|
497
|
-
# to 20 seconds,
|
498
|
-
#
|
499
|
-
#
|
500
|
-
#
|
501
|
-
#
|
502
|
-
#
|
503
|
-
#
|
504
|
-
#
|
505
|
-
#
|
506
|
-
#
|
507
|
-
#
|
508
|
-
#
|
509
|
-
# end
|
574
|
+
# @example
|
575
|
+
#
|
576
|
+
# # Modify the global config, setting the timeout for
|
577
|
+
# # list_game_server_configs to 20 seconds,
|
578
|
+
# # and all remaining timeouts to 10 seconds.
|
579
|
+
# ::Google::Cloud::Gaming::V1::GameServerConfigsService::Client.configure do |config|
|
580
|
+
# config.timeout = 10.0
|
581
|
+
# config.rpcs.list_game_server_configs.timeout = 20.0
|
582
|
+
# end
|
583
|
+
#
|
584
|
+
# # Apply the above configuration only to a new client.
|
585
|
+
# client = ::Google::Cloud::Gaming::V1::GameServerConfigsService::Client.new do |config|
|
586
|
+
# config.timeout = 10.0
|
587
|
+
# config.rpcs.list_game_server_configs.timeout = 20.0
|
588
|
+
# end
|
510
589
|
#
|
511
590
|
# @!attribute [rw] endpoint
|
512
591
|
# 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::Gaming::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::Gaming::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::Gaming::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::Gaming::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.
|