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.
Files changed (28) hide show
  1. checksums.yaml +4 -4
  2. data/AUTHENTICATION.md +8 -8
  3. data/README.md +1 -1
  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 +275 -108
  7. data/lib/google/cloud/gaming/v1/game_server_clusters_service/operations.rb +149 -37
  8. data/lib/google/cloud/gaming/v1/game_server_clusters_service_pb.rb +2 -2
  9. data/lib/google/cloud/gaming/v1/game_server_configs_pb.rb +2 -2
  10. data/lib/google/cloud/gaming/v1/game_server_configs_service/client.rb +148 -69
  11. data/lib/google/cloud/gaming/v1/game_server_configs_service/operations.rb +149 -37
  12. data/lib/google/cloud/gaming/v1/game_server_configs_service_pb.rb +2 -2
  13. data/lib/google/cloud/gaming/v1/game_server_deployments_pb.rb +2 -2
  14. data/lib/google/cloud/gaming/v1/game_server_deployments_service/client.rb +286 -116
  15. data/lib/google/cloud/gaming/v1/game_server_deployments_service/operations.rb +149 -37
  16. data/lib/google/cloud/gaming/v1/game_server_deployments_service_pb.rb +2 -2
  17. data/lib/google/cloud/gaming/v1/realms_pb.rb +2 -2
  18. data/lib/google/cloud/gaming/v1/realms_service/client.rb +204 -85
  19. data/lib/google/cloud/gaming/v1/realms_service/operations.rb +149 -37
  20. data/lib/google/cloud/gaming/v1/realms_service_pb.rb +2 -2
  21. data/lib/google/cloud/gaming/v1/version.rb +1 -1
  22. data/proto_docs/google/api/field_behavior.rb +7 -1
  23. data/proto_docs/google/cloud/gaming/v1/common.rb +0 -3
  24. data/proto_docs/google/cloud/gaming/v1/game_server_clusters.rb +117 -19
  25. data/proto_docs/google/cloud/gaming/v1/game_server_configs.rb +5 -11
  26. data/proto_docs/google/cloud/gaming/v1/game_server_deployments.rb +12 -28
  27. data/proto_docs/google/cloud/gaming/v1/realms.rb +7 -13
  28. metadata +4 -4
@@ -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
- "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::Gaming::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::Gaming::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::Gaming::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.
@@ -1,12 +1,12 @@
1
1
  # Generated by the protocol buffer compiler. DO NOT EDIT!
2
2
  # source: google/cloud/gaming/v1/realms_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/realms_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/realms_service.proto", :syntax => :proto3) do
12
12
  end
@@ -21,7 +21,7 @@ module Google
21
21
  module Cloud
22
22
  module Gaming
23
23
  module V1
24
- VERSION = "0.3.1"
24
+ VERSION = "0.4.1"
25
25
  end
26
26
  end
27
27
  end
@@ -57,9 +57,15 @@ module Google
57
57
 
58
58
  # Denotes that a (repeated) field is an unordered list.
59
59
  # This indicates that the service may provide the elements of the list
60
- # in any arbitrary order, rather than the order the user originally
60
+ # in any arbitrary order, rather than the order the user originally
61
61
  # provided. Additionally, the list's order may or may not be stable.
62
62
  UNORDERED_LIST = 6
63
+
64
+ # Denotes that this field returns a non-empty default value if not set.
65
+ # This indicates that if the user provides the empty value in a request,
66
+ # a non-empty value will be returned. The user will not be aware of what
67
+ # non-empty value to expect.
68
+ NON_EMPTY_DEFAULT = 7
63
69
  end
64
70
  end
65
71
  end
@@ -152,7 +152,6 @@ module Google
152
152
  # @!attribute [rw] game_server_config_name
153
153
  # @return [::String]
154
154
  # The game server config resource. Uses the form:
155
- #
156
155
  # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
157
156
  # @!attribute [rw] name
158
157
  # @return [::String]
@@ -167,12 +166,10 @@ module Google
167
166
  # @!attribute [rw] game_server_cluster_name
168
167
  # @return [::String]
169
168
  # The game server cluster name. Uses the form:
170
- #
171
169
  # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
172
170
  # @!attribute [rw] game_server_deployment_name
173
171
  # @return [::String]
174
172
  # The game server deployment name. Uses the form:
175
- #
176
173
  # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
177
174
  # @!attribute [rw] fleet_details
178
175
  # @return [::Array<::Google::Cloud::Gaming::V1::TargetDetails::TargetFleetDetails>]
@@ -24,11 +24,11 @@ module Google
24
24
  # Request message for GameServerClustersService.ListGameServerClusters.
25
25
  # @!attribute [rw] parent
26
26
  # @return [::String]
27
- # Required. The parent resource name. Uses the form:
27
+ # Required. The parent resource name, in the following form:
28
28
  # "projects/\\{project}/locations/\\{location}/realms/\\{realm}".
29
29
  # @!attribute [rw] page_size
30
30
  # @return [::Integer]
31
- # Optional. The maximum number of items to return. If unspecified, the server
31
+ # Optional. The maximum number of items to return. If unspecified, the server
32
32
  # will pick an appropriate default. The server may return fewer items than
33
33
  # requested. A caller should only rely on response's
34
34
  # {::Google::Cloud::Gaming::V1::ListGameServerClustersResponse#next_page_token next_page_token} to
@@ -43,6 +43,14 @@ module Google
43
43
  # @return [::String]
44
44
  # Optional. Specifies the ordering of results following syntax at
45
45
  # https://cloud.google.com/apis/design/design_patterns#sorting_order.
46
+ # @!attribute [rw] view
47
+ # @return [::Google::Cloud::Gaming::V1::GameServerClusterView]
48
+ # Optional. View for the returned GameServerCluster objects. When `FULL` is
49
+ # specified, the `cluster_state` field is also returned in the
50
+ # GameServerCluster object, which includes the state of the referenced
51
+ # Kubernetes cluster such as versions and provider info. The default/unset
52
+ # value is GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED, same as BASIC, which does
53
+ # not return the `cluster_state` field.
46
54
  class ListGameServerClustersRequest
47
55
  include ::Google::Protobuf::MessageExts
48
56
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -67,9 +75,16 @@ module Google
67
75
  # Request message for GameServerClustersService.GetGameServerCluster.
68
76
  # @!attribute [rw] name
69
77
  # @return [::String]
70
- # Required. The name of the game server cluster to retrieve. Uses the form:
71
- #
78
+ # Required. The name of the game server cluster to retrieve, in the following form:
72
79
  # `projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}`.
80
+ # @!attribute [rw] view
81
+ # @return [::Google::Cloud::Gaming::V1::GameServerClusterView]
82
+ # Optional. View for the returned GameServerCluster objects. When `FULL` is
83
+ # specified, the `cluster_state` field is also returned in the
84
+ # GameServerCluster object, which includes the state of the referenced
85
+ # Kubernetes cluster such as versions and provider info. The default/unset
86
+ # value is GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED, same as BASIC, which does
87
+ # not return the `cluster_state` field.
73
88
  class GetGameServerClusterRequest
74
89
  include ::Google::Protobuf::MessageExts
75
90
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -78,7 +93,7 @@ module Google
78
93
  # Request message for GameServerClustersService.CreateGameServerCluster.
79
94
  # @!attribute [rw] parent
80
95
  # @return [::String]
81
- # Required. The parent resource name. Uses the form:
96
+ # Required. The parent resource name, in the following form:
82
97
  # `projects/{project}/locations/{location}/realms/{realm-id}`.
83
98
  # @!attribute [rw] game_server_cluster_id
84
99
  # @return [::String]
@@ -94,7 +109,7 @@ module Google
94
109
  # Request message for GameServerClustersService.PreviewCreateGameServerCluster.
95
110
  # @!attribute [rw] parent
96
111
  # @return [::String]
97
- # Required. The parent resource name. Uses the form:
112
+ # Required. The parent resource name, in the following form:
98
113
  # `projects/{project}/locations/{location}/realms/{realm}`.
99
114
  # @!attribute [rw] game_server_cluster_id
100
115
  # @return [::String]
@@ -105,6 +120,10 @@ module Google
105
120
  # @!attribute [rw] preview_time
106
121
  # @return [::Google::Protobuf::Timestamp]
107
122
  # Optional. The target timestamp to compute the preview.
123
+ # @!attribute [rw] view
124
+ # @return [::Google::Cloud::Gaming::V1::GameServerClusterView]
125
+ # Optional. This field is deprecated, preview will always return
126
+ # KubernetesClusterState.
108
127
  class PreviewCreateGameServerClusterRequest
109
128
  include ::Google::Protobuf::MessageExts
110
129
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -118,6 +137,10 @@ module Google
118
137
  # @!attribute [rw] target_state
119
138
  # @return [::Google::Cloud::Gaming::V1::TargetState]
120
139
  # The target state.
140
+ # @!attribute [r] cluster_state
141
+ # @return [::Google::Cloud::Gaming::V1::KubernetesClusterState]
142
+ # Output only. The state of the Kubernetes cluster in preview, this will be available if
143
+ # 'view' is set to `FULL` in the relevant List/Get/Preview request.
121
144
  class PreviewCreateGameServerClusterResponse
122
145
  include ::Google::Protobuf::MessageExts
123
146
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -126,7 +149,7 @@ module Google
126
149
  # Request message for GameServerClustersService.DeleteGameServerCluster.
127
150
  # @!attribute [rw] name
128
151
  # @return [::String]
129
- # Required. The name of the game server cluster to delete. Uses the form:
152
+ # Required. The name of the game server cluster to delete, in the following form:
130
153
  # `projects/{project}/locations/{location}/gameServerClusters/{cluster}`.
131
154
  class DeleteGameServerClusterRequest
132
155
  include ::Google::Protobuf::MessageExts
@@ -136,7 +159,7 @@ module Google
136
159
  # Request message for GameServerClustersService.PreviewDeleteGameServerCluster.
137
160
  # @!attribute [rw] name
138
161
  # @return [::String]
139
- # Required. The name of the game server cluster to delete. Uses the form:
162
+ # Required. The name of the game server cluster to delete, in the following form:
140
163
  # `projects/{project}/locations/{location}/gameServerClusters/{cluster}`.
141
164
  # @!attribute [rw] preview_time
142
165
  # @return [::Google::Protobuf::Timestamp]
@@ -168,10 +191,7 @@ module Google
168
191
  # @return [::Google::Protobuf::FieldMask]
169
192
  # Required. Mask of fields to update. At least one path must be supplied in
170
193
  # this field. For the `FieldMask` definition, see
171
- #
172
- # https:
173
- # //developers.google.com/protocol-buffers
174
- # // /docs/reference/google.protobuf#fieldmask
194
+ # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
175
195
  class UpdateGameServerClusterRequest
176
196
  include ::Google::Protobuf::MessageExts
177
197
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -186,10 +206,7 @@ module Google
186
206
  # @return [::Google::Protobuf::FieldMask]
187
207
  # Required. Mask of fields to update. At least one path must be supplied in
188
208
  # this field. For the `FieldMask` definition, see
189
- #
190
- # https:
191
- # //developers.google.com/protocol-buffers
192
- # // /docs/reference/google.protobuf#fieldmask
209
+ # https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
193
210
  # @!attribute [rw] preview_time
194
211
  # @return [::Google::Protobuf::Timestamp]
195
212
  # Optional. The target timestamp to compute the preview.
@@ -243,11 +260,9 @@ module Google
243
260
  # A game server cluster resource.
244
261
  # @!attribute [rw] name
245
262
  # @return [::String]
246
- # Required. The resource name of the game server cluster. Uses the form:
247
- #
263
+ # Required. The resource name of the game server cluster, in the following form:
248
264
  # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
249
265
  # For example,
250
- #
251
266
  # `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
252
267
  # @!attribute [r] create_time
253
268
  # @return [::Google::Protobuf::Timestamp]
@@ -269,6 +284,10 @@ module Google
269
284
  # @!attribute [rw] description
270
285
  # @return [::String]
271
286
  # Human readable description of the cluster.
287
+ # @!attribute [r] cluster_state
288
+ # @return [::Google::Cloud::Gaming::V1::KubernetesClusterState]
289
+ # Output only. The state of the Kubernetes cluster, this will be available if
290
+ # 'view' is set to `FULL` in the relevant List/Get/Preview request.
272
291
  class GameServerCluster
273
292
  include ::Google::Protobuf::MessageExts
274
293
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -282,6 +301,85 @@ module Google
282
301
  extend ::Google::Protobuf::MessageExts::ClassMethods
283
302
  end
284
303
  end
304
+
305
+ # The state of the Kubernetes cluster.
306
+ # @!attribute [r] agones_version_installed
307
+ # @return [::String]
308
+ # Output only. The version of Agones currently installed in the registered Kubernetes
309
+ # cluster.
310
+ # @!attribute [r] kubernetes_version_installed
311
+ # @return [::String]
312
+ # Output only. The version of Kubernetes that is currently used in the registered
313
+ # Kubernetes cluster (as detected by the Cloud Game Servers service).
314
+ # @!attribute [r] installation_state
315
+ # @return [::Google::Cloud::Gaming::V1::KubernetesClusterState::InstallationState]
316
+ # Output only. The state for the installed versions of Agones/Kubernetes.
317
+ # @!attribute [r] version_installed_error_message
318
+ # @return [::String]
319
+ # Output only. The detailed error message for the installed versions of Agones/Kubernetes.
320
+ # @!attribute [r] provider
321
+ # @return [::String]
322
+ # Output only. The cloud provider type reported by the first node's providerID in the list
323
+ # of nodes on the Kubernetes endpoint. On Kubernetes platforms that support
324
+ # zero-node clusters (like GKE-on-GCP), the provider type will be empty.
325
+ # @!attribute [r] agones_version_targeted
326
+ # @return [::String]
327
+ # Output only. The version of Agones that is targeted to be installed in the cluster.
328
+ class KubernetesClusterState
329
+ include ::Google::Protobuf::MessageExts
330
+ extend ::Google::Protobuf::MessageExts::ClassMethods
331
+
332
+ # The state of the installed versions of Agones/Kubernetes. See also
333
+ # https://cloud.google.com/game-servers/docs/versions-and-upgrades.
334
+ module InstallationState
335
+ # The default value. This value is used if the state is omitted.
336
+ INSTALLATION_STATE_UNSPECIFIED = 0
337
+
338
+ # The combination of Agones and Kubernetes versions is supported by Google
339
+ # Cloud Game Servers.
340
+ AGONES_KUBERNETES_VERSION_SUPPORTED = 1
341
+
342
+ # The installed version of Agones is not supported by Google Cloud Game
343
+ # Servers.
344
+ AGONES_VERSION_UNSUPPORTED = 2
345
+
346
+ # The installed version of Agones is supported by Google Cloud Game
347
+ # Servers, but the installed version of Kubernetes is not recommended or
348
+ # supported by the version of Agones.
349
+ AGONES_KUBERNETES_VERSION_UNSUPPORTED = 3
350
+
351
+ # The installed version of Agones is not recognized because the Agones
352
+ # controller's image name does not have a version string reported as
353
+ # \\{major}.\\{minor}(.\\{patch}).
354
+ AGONES_VERSION_UNRECOGNIZED = 4
355
+
356
+ # The server version of Kubernetes cluster is not recognized because the
357
+ # API server didn't return parsable version info on path/version.
358
+ KUBERNETES_VERSION_UNRECOGNIZED = 5
359
+
360
+ # Failed to read or verify the version of Agones or Kubernetes. See
361
+ # version_installed_error_message for details.
362
+ VERSION_VERIFICATION_FAILED = 6
363
+
364
+ # Agones is not installed.
365
+ AGONES_NOT_INSTALLED = 7
366
+ end
367
+ end
368
+
369
+ # A view for GameServerCluster objects.
370
+ module GameServerClusterView
371
+ # The default / unset value.
372
+ # The API will default to the BASIC view.
373
+ GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED = 0
374
+
375
+ # Include basic information of a GameServerCluster resource and omit
376
+ # `cluster_state`. This is the default value (for ListGameServerClusters,
377
+ # GetGameServerCluster and PreviewCreateGameServerCluster).
378
+ BASIC = 1
379
+
380
+ # Include everything.
381
+ FULL = 2
382
+ end
285
383
  end
286
384
  end
287
385
  end
@@ -24,8 +24,7 @@ module Google
24
24
  # Request message for GameServerConfigsService.ListGameServerConfigs.
25
25
  # @!attribute [rw] parent
26
26
  # @return [::String]
27
- # Required. The parent resource name. Uses the form:
28
- #
27
+ # Required. The parent resource name, in the following form:
29
28
  # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/*`.
30
29
  # @!attribute [rw] page_size
31
30
  # @return [::Integer]
@@ -68,8 +67,7 @@ module Google
68
67
  # Request message for GameServerConfigsService.GetGameServerConfig.
69
68
  # @!attribute [rw] name
70
69
  # @return [::String]
71
- # Required. The name of the game server config to retrieve. Uses the form:
72
- #
70
+ # Required. The name of the game server config to retrieve, in the following form:
73
71
  # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`.
74
72
  class GetGameServerConfigRequest
75
73
  include ::Google::Protobuf::MessageExts
@@ -79,8 +77,7 @@ module Google
79
77
  # Request message for GameServerConfigsService.CreateGameServerConfig.
80
78
  # @!attribute [rw] parent
81
79
  # @return [::String]
82
- # Required. The parent resource name. Uses the form:
83
- #
80
+ # Required. The parent resource name, in the following form:
84
81
  # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/`.
85
82
  # @!attribute [rw] config_id
86
83
  # @return [::String]
@@ -96,8 +93,7 @@ module Google
96
93
  # Request message for GameServerConfigsService.DeleteGameServerConfig.
97
94
  # @!attribute [rw] name
98
95
  # @return [::String]
99
- # Required. The name of the game server config to delete. Uses the form:
100
- #
96
+ # Required. The name of the game server config to delete, in the following form:
101
97
  # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`.
102
98
  class DeleteGameServerConfigRequest
103
99
  include ::Google::Protobuf::MessageExts
@@ -141,11 +137,9 @@ module Google
141
137
  # A game server config resource.
142
138
  # @!attribute [rw] name
143
139
  # @return [::String]
144
- # The resource name of the game server config. Uses the form:
145
- #
140
+ # The resource name of the game server config, in the following form:
146
141
  # `projects/{project}/locations/{location}/gameServerDeployments/{deployment}/configs/{config}`.
147
142
  # For example,
148
- #
149
143
  # `projects/my-project/locations/global/gameServerDeployments/my-game/configs/my-config`.
150
144
  # @!attribute [r] create_time
151
145
  # @return [::Google::Protobuf::Timestamp]