google-cloud-gaming-v1 0.3.3 → 0.4.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (32) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +1 -1
  3. data/AUTHENTICATION.md +7 -25
  4. data/lib/google/cloud/gaming/v1/common_pb.rb +2 -2
  5. data/lib/google/cloud/gaming/v1/game_server_clusters_pb.rb +33 -2
  6. data/lib/google/cloud/gaming/v1/game_server_clusters_service/client.rb +217 -43
  7. data/lib/google/cloud/gaming/v1/game_server_clusters_service/operations.rb +115 -12
  8. data/lib/google/cloud/gaming/v1/game_server_clusters_service_pb.rb +2 -2
  9. data/lib/google/cloud/gaming/v1/game_server_clusters_service_services_pb.rb +1 -1
  10. data/lib/google/cloud/gaming/v1/game_server_configs_pb.rb +2 -2
  11. data/lib/google/cloud/gaming/v1/game_server_configs_service/client.rb +105 -20
  12. data/lib/google/cloud/gaming/v1/game_server_configs_service/operations.rb +115 -12
  13. data/lib/google/cloud/gaming/v1/game_server_configs_service_pb.rb +2 -2
  14. data/lib/google/cloud/gaming/v1/game_server_configs_service_services_pb.rb +1 -1
  15. data/lib/google/cloud/gaming/v1/game_server_deployments_pb.rb +2 -2
  16. data/lib/google/cloud/gaming/v1/game_server_deployments_service/client.rb +225 -50
  17. data/lib/google/cloud/gaming/v1/game_server_deployments_service/operations.rb +115 -12
  18. data/lib/google/cloud/gaming/v1/game_server_deployments_service_pb.rb +2 -2
  19. data/lib/google/cloud/gaming/v1/game_server_deployments_service_services_pb.rb +1 -1
  20. data/lib/google/cloud/gaming/v1/realms_pb.rb +2 -2
  21. data/lib/google/cloud/gaming/v1/realms_service/client.rb +154 -30
  22. data/lib/google/cloud/gaming/v1/realms_service/operations.rb +115 -12
  23. data/lib/google/cloud/gaming/v1/realms_service_pb.rb +2 -2
  24. data/lib/google/cloud/gaming/v1/realms_service_services_pb.rb +1 -1
  25. data/lib/google/cloud/gaming/v1/version.rb +1 -1
  26. data/proto_docs/google/api/resource.rb +10 -71
  27. data/proto_docs/google/cloud/gaming/v1/common.rb +4 -5
  28. data/proto_docs/google/cloud/gaming/v1/game_server_clusters.rb +117 -19
  29. data/proto_docs/google/cloud/gaming/v1/game_server_configs.rb +5 -11
  30. data/proto_docs/google/cloud/gaming/v1/game_server_deployments.rb +12 -28
  31. data/proto_docs/google/cloud/gaming/v1/realms.rb +7 -13
  32. metadata +3 -3
@@ -93,7 +93,7 @@ module Google
93
93
  initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
94
94
  }
95
95
 
96
- default_config.rpcs.fetch_deployment_state.timeout = 120.0
96
+ default_config.rpcs.fetch_deployment_state.timeout = 60.0
97
97
  default_config.rpcs.fetch_deployment_state.retry_policy = {
98
98
  initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
99
99
  }
@@ -169,6 +169,7 @@ module Google
169
169
 
170
170
  @operations_client = Operations.new do |config|
171
171
  config.credentials = credentials
172
+ config.quota_project = @quota_project_id
172
173
  config.endpoint = @config.endpoint
173
174
  end
174
175
 
@@ -209,7 +210,7 @@ module Google
209
210
  # the default parameter values, pass an empty Hash as a request object (see above).
210
211
  #
211
212
  # @param parent [::String]
212
- # Required. The parent resource name. Uses the form:
213
+ # Required. The parent resource name, in the following form:
213
214
  # `projects/{project}/locations/{location}`.
214
215
  # @param page_size [::Integer]
215
216
  # Optional. The maximum number of items to return. If unspecified, the server
@@ -234,6 +235,27 @@ module Google
234
235
  #
235
236
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
236
237
  #
238
+ # @example Basic example
239
+ # require "google/cloud/gaming/v1"
240
+ #
241
+ # # Create a client object. The client can be reused for multiple calls.
242
+ # client = Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new
243
+ #
244
+ # # Create a request. To set request fields, pass in keyword arguments.
245
+ # request = Google::Cloud::Gaming::V1::ListGameServerDeploymentsRequest.new
246
+ #
247
+ # # Call the list_game_server_deployments method.
248
+ # result = client.list_game_server_deployments request
249
+ #
250
+ # # The returned object is of type Gapic::PagedEnumerable. You can
251
+ # # iterate over all elements by calling #each, and the enumerable
252
+ # # will lazily make API calls to fetch subsequent pages. Other
253
+ # # methods are also available for managing paging directly.
254
+ # result.each do |response|
255
+ # # Each element is of type ::Google::Cloud::Gaming::V1::GameServerDeployment.
256
+ # p response
257
+ # end
258
+ #
237
259
  def list_game_server_deployments request, options = nil
238
260
  raise ::ArgumentError, "request must be provided" if request.nil?
239
261
 
@@ -251,9 +273,11 @@ module Google
251
273
  gapic_version: ::Google::Cloud::Gaming::V1::VERSION
252
274
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
253
275
 
254
- header_params = {
255
- "parent" => request.parent
256
- }
276
+ header_params = {}
277
+ if request.parent
278
+ header_params["parent"] = request.parent
279
+ end
280
+
257
281
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
258
282
  metadata[:"x-goog-request-params"] ||= request_params_header
259
283
 
@@ -293,8 +317,7 @@ module Google
293
317
  # the default parameter values, pass an empty Hash as a request object (see above).
294
318
  #
295
319
  # @param name [::String]
296
- # Required. The name of the game server delpoyment to retrieve. Uses the form:
297
- #
320
+ # Required. The name of the game server delpoyment to retrieve, in the following form:
298
321
  # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.
299
322
  #
300
323
  # @yield [response, operation] Access the result along with the RPC operation
@@ -305,6 +328,21 @@ module Google
305
328
  #
306
329
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
307
330
  #
331
+ # @example Basic example
332
+ # require "google/cloud/gaming/v1"
333
+ #
334
+ # # Create a client object. The client can be reused for multiple calls.
335
+ # client = Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new
336
+ #
337
+ # # Create a request. To set request fields, pass in keyword arguments.
338
+ # request = Google::Cloud::Gaming::V1::GetGameServerDeploymentRequest.new
339
+ #
340
+ # # Call the get_game_server_deployment method.
341
+ # result = client.get_game_server_deployment request
342
+ #
343
+ # # The returned object is of type Google::Cloud::Gaming::V1::GameServerDeployment.
344
+ # p result
345
+ #
308
346
  def get_game_server_deployment request, options = nil
309
347
  raise ::ArgumentError, "request must be provided" if request.nil?
310
348
 
@@ -322,9 +360,11 @@ module Google
322
360
  gapic_version: ::Google::Cloud::Gaming::V1::VERSION
323
361
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
324
362
 
325
- header_params = {
326
- "name" => request.name
327
- }
363
+ header_params = {}
364
+ if request.name
365
+ header_params["name"] = request.name
366
+ end
367
+
328
368
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
329
369
  metadata[:"x-goog-request-params"] ||= request_params_header
330
370
 
@@ -363,7 +403,7 @@ module Google
363
403
  # the default parameter values, pass an empty Hash as a request object (see above).
364
404
  #
365
405
  # @param parent [::String]
366
- # Required. The parent resource name. Uses the form:
406
+ # Required. The parent resource name, in the following form:
367
407
  # `projects/{project}/locations/{location}`.
368
408
  # @param deployment_id [::String]
369
409
  # Required. The ID of the game server delpoyment resource to be created.
@@ -378,6 +418,28 @@ module Google
378
418
  #
379
419
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
380
420
  #
421
+ # @example Basic example
422
+ # require "google/cloud/gaming/v1"
423
+ #
424
+ # # Create a client object. The client can be reused for multiple calls.
425
+ # client = Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new
426
+ #
427
+ # # Create a request. To set request fields, pass in keyword arguments.
428
+ # request = Google::Cloud::Gaming::V1::CreateGameServerDeploymentRequest.new
429
+ #
430
+ # # Call the create_game_server_deployment method.
431
+ # result = client.create_game_server_deployment request
432
+ #
433
+ # # The returned object is of type Gapic::Operation. You can use this
434
+ # # object to check the status of an operation, cancel it, or wait
435
+ # # for results. Here is how to block until completion:
436
+ # result.wait_until_done! timeout: 60
437
+ # if result.response?
438
+ # p result.response
439
+ # else
440
+ # puts "Error!"
441
+ # end
442
+ #
381
443
  def create_game_server_deployment request, options = nil
382
444
  raise ::ArgumentError, "request must be provided" if request.nil?
383
445
 
@@ -395,9 +457,11 @@ module Google
395
457
  gapic_version: ::Google::Cloud::Gaming::V1::VERSION
396
458
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
397
459
 
398
- header_params = {
399
- "parent" => request.parent
400
- }
460
+ header_params = {}
461
+ if request.parent
462
+ header_params["parent"] = request.parent
463
+ end
464
+
401
465
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
402
466
  metadata[:"x-goog-request-params"] ||= request_params_header
403
467
 
@@ -437,8 +501,7 @@ module Google
437
501
  # the default parameter values, pass an empty Hash as a request object (see above).
438
502
  #
439
503
  # @param name [::String]
440
- # Required. The name of the game server delpoyment to delete. Uses the form:
441
- #
504
+ # Required. The name of the game server delpoyment to delete, in the following form:
442
505
  # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.
443
506
  #
444
507
  # @yield [response, operation] Access the result along with the RPC operation
@@ -449,6 +512,28 @@ module Google
449
512
  #
450
513
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
451
514
  #
515
+ # @example Basic example
516
+ # require "google/cloud/gaming/v1"
517
+ #
518
+ # # Create a client object. The client can be reused for multiple calls.
519
+ # client = Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new
520
+ #
521
+ # # Create a request. To set request fields, pass in keyword arguments.
522
+ # request = Google::Cloud::Gaming::V1::DeleteGameServerDeploymentRequest.new
523
+ #
524
+ # # Call the delete_game_server_deployment method.
525
+ # result = client.delete_game_server_deployment request
526
+ #
527
+ # # The returned object is of type Gapic::Operation. You can use this
528
+ # # object to check the status of an operation, cancel it, or wait
529
+ # # for results. Here is how to block until completion:
530
+ # result.wait_until_done! timeout: 60
531
+ # if result.response?
532
+ # p result.response
533
+ # else
534
+ # puts "Error!"
535
+ # end
536
+ #
452
537
  def delete_game_server_deployment request, options = nil
453
538
  raise ::ArgumentError, "request must be provided" if request.nil?
454
539
 
@@ -466,9 +551,11 @@ module Google
466
551
  gapic_version: ::Google::Cloud::Gaming::V1::VERSION
467
552
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
468
553
 
469
- header_params = {
470
- "name" => request.name
471
- }
554
+ header_params = {}
555
+ if request.name
556
+ header_params["name"] = request.name
557
+ end
558
+
472
559
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
473
560
  metadata[:"x-goog-request-params"] ||= request_params_header
474
561
 
@@ -513,10 +600,7 @@ module Google
513
600
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
514
601
  # Required. Mask of fields to update. At least one path must be supplied in
515
602
  # this field. For the `FieldMask` definition, see
516
- #
517
- # https:
518
- # //developers.google.com/protocol-buffers
519
- # // /docs/reference/google.protobuf#fieldmask
603
+ # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
520
604
  #
521
605
  # @yield [response, operation] Access the result along with the RPC operation
522
606
  # @yieldparam response [::Gapic::Operation]
@@ -526,6 +610,28 @@ module Google
526
610
  #
527
611
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
528
612
  #
613
+ # @example Basic example
614
+ # require "google/cloud/gaming/v1"
615
+ #
616
+ # # Create a client object. The client can be reused for multiple calls.
617
+ # client = Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new
618
+ #
619
+ # # Create a request. To set request fields, pass in keyword arguments.
620
+ # request = Google::Cloud::Gaming::V1::UpdateGameServerDeploymentRequest.new
621
+ #
622
+ # # Call the update_game_server_deployment method.
623
+ # result = client.update_game_server_deployment request
624
+ #
625
+ # # The returned object is of type Gapic::Operation. You can use this
626
+ # # object to check the status of an operation, cancel it, or wait
627
+ # # for results. Here is how to block until completion:
628
+ # result.wait_until_done! timeout: 60
629
+ # if result.response?
630
+ # p result.response
631
+ # else
632
+ # puts "Error!"
633
+ # end
634
+ #
529
635
  def update_game_server_deployment request, options = nil
530
636
  raise ::ArgumentError, "request must be provided" if request.nil?
531
637
 
@@ -543,9 +649,11 @@ module Google
543
649
  gapic_version: ::Google::Cloud::Gaming::V1::VERSION
544
650
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
545
651
 
546
- header_params = {
547
- "game_server_deployment.name" => request.game_server_deployment.name
548
- }
652
+ header_params = {}
653
+ if request.game_server_deployment&.name
654
+ header_params["game_server_deployment.name"] = request.game_server_deployment.name
655
+ end
656
+
549
657
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
550
658
  metadata[:"x-goog-request-params"] ||= request_params_header
551
659
 
@@ -585,8 +693,7 @@ module Google
585
693
  # the default parameter values, pass an empty Hash as a request object (see above).
586
694
  #
587
695
  # @param name [::String]
588
- # Required. The name of the game server delpoyment to retrieve. Uses the form:
589
- #
696
+ # Required. The name of the game server delpoyment to retrieve, in the following form:
590
697
  # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/rollout`.
591
698
  #
592
699
  # @yield [response, operation] Access the result along with the RPC operation
@@ -597,6 +704,21 @@ module Google
597
704
  #
598
705
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
599
706
  #
707
+ # @example Basic example
708
+ # require "google/cloud/gaming/v1"
709
+ #
710
+ # # Create a client object. The client can be reused for multiple calls.
711
+ # client = Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new
712
+ #
713
+ # # Create a request. To set request fields, pass in keyword arguments.
714
+ # request = Google::Cloud::Gaming::V1::GetGameServerDeploymentRolloutRequest.new
715
+ #
716
+ # # Call the get_game_server_deployment_rollout method.
717
+ # result = client.get_game_server_deployment_rollout request
718
+ #
719
+ # # The returned object is of type Google::Cloud::Gaming::V1::GameServerDeploymentRollout.
720
+ # p result
721
+ #
600
722
  def get_game_server_deployment_rollout request, options = nil
601
723
  raise ::ArgumentError, "request must be provided" if request.nil?
602
724
 
@@ -614,9 +736,11 @@ module Google
614
736
  gapic_version: ::Google::Cloud::Gaming::V1::VERSION
615
737
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
616
738
 
617
- header_params = {
618
- "name" => request.name
619
- }
739
+ header_params = {}
740
+ if request.name
741
+ header_params["name"] = request.name
742
+ end
743
+
620
744
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
621
745
  metadata[:"x-goog-request-params"] ||= request_params_header
622
746
 
@@ -665,10 +789,7 @@ module Google
665
789
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
666
790
  # Required. Mask of fields to update. At least one path must be supplied in
667
791
  # this field. For the `FieldMask` definition, see
668
- #
669
- # https:
670
- # //developers.google.com/protocol-buffers
671
- # // /docs/reference/google.protobuf#fieldmask
792
+ # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
672
793
  #
673
794
  # @yield [response, operation] Access the result along with the RPC operation
674
795
  # @yieldparam response [::Gapic::Operation]
@@ -678,6 +799,28 @@ module Google
678
799
  #
679
800
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
680
801
  #
802
+ # @example Basic example
803
+ # require "google/cloud/gaming/v1"
804
+ #
805
+ # # Create a client object. The client can be reused for multiple calls.
806
+ # client = Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new
807
+ #
808
+ # # Create a request. To set request fields, pass in keyword arguments.
809
+ # request = Google::Cloud::Gaming::V1::UpdateGameServerDeploymentRolloutRequest.new
810
+ #
811
+ # # Call the update_game_server_deployment_rollout method.
812
+ # result = client.update_game_server_deployment_rollout request
813
+ #
814
+ # # The returned object is of type Gapic::Operation. You can use this
815
+ # # object to check the status of an operation, cancel it, or wait
816
+ # # for results. Here is how to block until completion:
817
+ # result.wait_until_done! timeout: 60
818
+ # if result.response?
819
+ # p result.response
820
+ # else
821
+ # puts "Error!"
822
+ # end
823
+ #
681
824
  def update_game_server_deployment_rollout request, options = nil
682
825
  raise ::ArgumentError, "request must be provided" if request.nil?
683
826
 
@@ -695,9 +838,11 @@ module Google
695
838
  gapic_version: ::Google::Cloud::Gaming::V1::VERSION
696
839
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
697
840
 
698
- header_params = {
699
- "rollout.name" => request.rollout.name
700
- }
841
+ header_params = {}
842
+ if request.rollout&.name
843
+ header_params["rollout.name"] = request.rollout.name
844
+ end
845
+
701
846
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
702
847
  metadata[:"x-goog-request-params"] ||= request_params_header
703
848
 
@@ -743,10 +888,7 @@ module Google
743
888
  # @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
744
889
  # Optional. Mask of fields to update. At least one path must be supplied in
745
890
  # this field. For the `FieldMask` definition, see
746
- #
747
- # https:
748
- # //developers.google.com/protocol-buffers
749
- # // /docs/reference/google.protobuf#fieldmask
891
+ # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
750
892
  # @param preview_time [::Google::Protobuf::Timestamp, ::Hash]
751
893
  # Optional. The target timestamp to compute the preview. Defaults to the immediately
752
894
  # after the proposed rollout completes.
@@ -759,6 +901,21 @@ module Google
759
901
  #
760
902
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
761
903
  #
904
+ # @example Basic example
905
+ # require "google/cloud/gaming/v1"
906
+ #
907
+ # # Create a client object. The client can be reused for multiple calls.
908
+ # client = Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new
909
+ #
910
+ # # Create a request. To set request fields, pass in keyword arguments.
911
+ # request = Google::Cloud::Gaming::V1::PreviewGameServerDeploymentRolloutRequest.new
912
+ #
913
+ # # Call the preview_game_server_deployment_rollout method.
914
+ # result = client.preview_game_server_deployment_rollout request
915
+ #
916
+ # # The returned object is of type Google::Cloud::Gaming::V1::PreviewGameServerDeploymentRolloutResponse.
917
+ # p result
918
+ #
762
919
  def preview_game_server_deployment_rollout request, options = nil
763
920
  raise ::ArgumentError, "request must be provided" if request.nil?
764
921
 
@@ -776,9 +933,11 @@ module Google
776
933
  gapic_version: ::Google::Cloud::Gaming::V1::VERSION
777
934
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
778
935
 
779
- header_params = {
780
- "rollout.name" => request.rollout.name
781
- }
936
+ header_params = {}
937
+ if request.rollout&.name
938
+ header_params["rollout.name"] = request.rollout.name
939
+ end
940
+
782
941
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
783
942
  metadata[:"x-goog-request-params"] ||= request_params_header
784
943
 
@@ -819,8 +978,7 @@ module Google
819
978
  # the default parameter values, pass an empty Hash as a request object (see above).
820
979
  #
821
980
  # @param name [::String]
822
- # Required. The name of the game server delpoyment. Uses the form:
823
- #
981
+ # Required. The name of the game server delpoyment, in the following form:
824
982
  # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}`.
825
983
  #
826
984
  # @yield [response, operation] Access the result along with the RPC operation
@@ -831,6 +989,21 @@ module Google
831
989
  #
832
990
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
833
991
  #
992
+ # @example Basic example
993
+ # require "google/cloud/gaming/v1"
994
+ #
995
+ # # Create a client object. The client can be reused for multiple calls.
996
+ # client = Google::Cloud::Gaming::V1::GameServerDeploymentsService::Client.new
997
+ #
998
+ # # Create a request. To set request fields, pass in keyword arguments.
999
+ # request = Google::Cloud::Gaming::V1::FetchDeploymentStateRequest.new
1000
+ #
1001
+ # # Call the fetch_deployment_state method.
1002
+ # result = client.fetch_deployment_state request
1003
+ #
1004
+ # # The returned object is of type Google::Cloud::Gaming::V1::FetchDeploymentStateResponse.
1005
+ # p result
1006
+ #
834
1007
  def fetch_deployment_state request, options = nil
835
1008
  raise ::ArgumentError, "request must be provided" if request.nil?
836
1009
 
@@ -848,9 +1021,11 @@ module Google
848
1021
  gapic_version: ::Google::Cloud::Gaming::V1::VERSION
849
1022
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
850
1023
 
851
- header_params = {
852
- "name" => request.name
853
- }
1024
+ header_params = {}
1025
+ if request.name
1026
+ header_params["name"] = request.name
1027
+ end
1028
+
854
1029
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
855
1030
  metadata[:"x-goog-request-params"] ||= request_params_header
856
1031
 
@@ -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,9 +181,11 @@ 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
- "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
 
@@ -215,6 +238,28 @@ module Google
215
238
  #
216
239
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
217
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
+ #
218
263
  def get_operation request, options = nil
219
264
  raise ::ArgumentError, "request must be provided" if request.nil?
220
265
 
@@ -232,9 +277,11 @@ module Google
232
277
  gapic_version: ::Google::Cloud::Gaming::V1::VERSION
233
278
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
234
279
 
235
- header_params = {
236
- "name" => request.name
237
- }
280
+ header_params = {}
281
+ if request.name
282
+ header_params["name"] = request.name
283
+ end
284
+
238
285
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
239
286
  metadata[:"x-goog-request-params"] ||= request_params_header
240
287
 
@@ -287,6 +334,21 @@ module Google
287
334
  #
288
335
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
289
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
+ #
290
352
  def delete_operation request, options = nil
291
353
  raise ::ArgumentError, "request must be provided" if request.nil?
292
354
 
@@ -304,9 +366,11 @@ module Google
304
366
  gapic_version: ::Google::Cloud::Gaming::V1::VERSION
305
367
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
306
368
 
307
- header_params = {
308
- "name" => request.name
309
- }
369
+ header_params = {}
370
+ if request.name
371
+ header_params["name"] = request.name
372
+ end
373
+
310
374
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
311
375
  metadata[:"x-goog-request-params"] ||= request_params_header
312
376
 
@@ -364,6 +428,21 @@ module Google
364
428
  #
365
429
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
366
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
+ #
367
446
  def cancel_operation request, options = nil
368
447
  raise ::ArgumentError, "request must be provided" if request.nil?
369
448
 
@@ -381,9 +460,11 @@ module Google
381
460
  gapic_version: ::Google::Cloud::Gaming::V1::VERSION
382
461
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
383
462
 
384
- header_params = {
385
- "name" => request.name
386
- }
463
+ header_params = {}
464
+ if request.name
465
+ header_params["name"] = request.name
466
+ end
467
+
387
468
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
388
469
  metadata[:"x-goog-request-params"] ||= request_params_header
389
470
 
@@ -444,6 +525,28 @@ module Google
444
525
  #
445
526
  # @raise [::Google::Cloud::Error] if the RPC is aborted.
446
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
+ #
447
550
  def wait_operation request, options = nil
448
551
  raise ::ArgumentError, "request must be provided" if request.nil?
449
552
 
@@ -1,12 +1,12 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/cloud/gaming/v1/game_server_deployments_service.proto
3
3
 
4
- require 'google/protobuf'
5
-
6
4
  require 'google/api/annotations_pb'
7
5
  require 'google/api/client_pb'
8
6
  require 'google/cloud/gaming/v1/game_server_deployments_pb'
9
7
  require 'google/longrunning/operations_pb'
8
+ require 'google/protobuf'
9
+
10
10
  Google::Protobuf::DescriptorPool.generated_pool.build do
11
11
  add_file("google/cloud/gaming/v1/game_server_deployments_service.proto", :syntax => :proto3) do
12
12
  end