1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="gameservices_v1.html">Game Services API</a> . <a href="gameservices_v1.projects.html">projects</a> . <a href="gameservices_v1.projects.locations.html">locations</a> . <a href="gameservices_v1.projects.locations.realms.html">realms</a> . <a href="gameservices_v1.projects.locations.realms.gameServerClusters.html">gameServerClusters</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, gameServerClusterId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new game server cluster in a given project and location.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a single game server cluster.</p>
<p class="toc_element">
<code><a href="#get">get(name, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single game server cluster.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists game server clusters in a given project and location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Patches a single game server cluster.</p>
<p class="toc_element">
<code><a href="#previewCreate">previewCreate(parent, body=None, gameServerClusterId=None, previewTime=None, view=None, x__xgafv=None)</a></code></p>
<p class="firstline">Previews creation of a new game server cluster in a given project and location.</p>
<p class="toc_element">
<code><a href="#previewDelete">previewDelete(name, previewTime=None, x__xgafv=None)</a></code></p>
<p class="firstline">Previews deletion of a single game server cluster.</p>
<p class="toc_element">
<code><a href="#previewUpdate">previewUpdate(name, body=None, previewTime=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Previews updating a GameServerCluster.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, gameServerClusterId=None, x__xgafv=None)</code>
<pre>Creates a new game server cluster in a given project and location.
Args:
parent: string, Required. The parent resource name, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}`. (required)
body: object, The request body.
The object takes the form of:
{ # A game server cluster resource.
"clusterState": { # The state of the Kubernetes cluster. # Output only. The state of the Kubernetes cluster in preview. This will be available if view is set to FULL in the relevant list/get/preview request.
"agonesVersionInstalled": "A String", # Output only. The version of Agones currently installed in the registered Kubernetes cluster.
"agonesVersionTargeted": "A String", # Output only. The version of Agones that is targeted to be installed in the cluster.
"installationState": "A String", # Output only. The state for the installed versions of Agones/Kubernetes.
"kubernetesVersionInstalled": "A String", # Output only. The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service).
"provider": "A String", # Output only. The cloud provider type reported by the first node's `providerID` in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty.
"versionInstalledErrorMessage": "A String", # Output only. The detailed error message for the installed versions of Agones/Kubernetes.
},
"connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.
"gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
"cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{locationId}/clusters/{cluster}` * `locations/{locationId}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster.
},
"namespace": "A String", # Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.
},
"createTime": "A String", # Output only. The creation time.
"description": "A String", # Human readable description of the cluster.
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels associated with this game server cluster. Each label is a key-value pair.
"a_key": "A String",
},
"name": "A String", # Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}/gameServerClusters/{gameServerClusterId}`. For example, `projects/my-project/locations/global/realms/zanzibar/gameServerClusters/my-gke-cluster`.
"updateTime": "A String", # Output only. The last-modified time.
}
gameServerClusterId: string, Required. The ID of the game server cluster resource to create.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a single game server cluster.
Args:
name: string, Required. The name of the game server cluster to delete, in the following form: `projects/{project}/locations/{locationId}/gameServerClusters/{gameServerClusterId}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, view=None, x__xgafv=None)</code>
<pre>Gets details of a single game server cluster.
Args:
name: string, Required. The name of the game server cluster to retrieve, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}/gameServerClusters/{gameServerClusterId}`. (required)
view: string, Optional. View for the returned GameServerCluster objects. When `FULL` is specified, the `cluster_state` field is also returned in the GameServerCluster object, which includes the state of the referenced Kubernetes cluster such as versions and provider info. The default/unset value is `GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED`, the same as `BASIC`, which does not return the `cluster_state` field.
Allowed values
GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED - If the value is not set, Google Cloud Game Servers defaults to the `BASIC` view.
BASIC - Includes basic information of a GameServerCluster resource and omits `cluster_state`. This is the default value (for methods ListGameServerClusters, GetGameServerCluster, and PreviewCreateGameServerCluster).
FULL - Include basic information of a GameServerCluster resource as well as `cluster_state`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A game server cluster resource.
"clusterState": { # The state of the Kubernetes cluster. # Output only. The state of the Kubernetes cluster in preview. This will be available if view is set to FULL in the relevant list/get/preview request.
"agonesVersionInstalled": "A String", # Output only. The version of Agones currently installed in the registered Kubernetes cluster.
"agonesVersionTargeted": "A String", # Output only. The version of Agones that is targeted to be installed in the cluster.
"installationState": "A String", # Output only. The state for the installed versions of Agones/Kubernetes.
"kubernetesVersionInstalled": "A String", # Output only. The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service).
"provider": "A String", # Output only. The cloud provider type reported by the first node's `providerID` in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty.
"versionInstalledErrorMessage": "A String", # Output only. The detailed error message for the installed versions of Agones/Kubernetes.
},
"connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.
"gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
"cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{locationId}/clusters/{cluster}` * `locations/{locationId}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster.
},
"namespace": "A String", # Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.
},
"createTime": "A String", # Output only. The creation time.
"description": "A String", # Human readable description of the cluster.
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels associated with this game server cluster. Each label is a key-value pair.
"a_key": "A String",
},
"name": "A String", # Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}/gameServerClusters/{gameServerClusterId}`. For example, `projects/my-project/locations/global/realms/zanzibar/gameServerClusters/my-gke-cluster`.
"updateTime": "A String", # Output only. The last-modified time.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)</code>
<pre>Lists game server clusters in a given project and location.
Args:
parent: string, Required. The parent resource name, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}`. (required)
filter: string, Optional. The filter to apply to list results (see [Filtering](https://google.aip.dev/160)).
orderBy: string, Optional. Specifies the ordering of results following [Cloud API syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order).
pageSize: integer, Optional. The maximum number of items to return. If unspecified, the server picks an appropriate default. The server may return fewer items than requested. A caller should only rely on response's next_page_token to determine if there are more GameServerClusters left to be queried.
pageToken: string, Optional. The next_page_token value returned from a previous list request, if any.
view: string, Optional. View for the returned GameServerCluster objects. When `FULL` is specified, the `cluster_state` field is also returned in the GameServerCluster object, which includes the state of the referenced Kubernetes cluster such as versions and provider info. The default/unset value is `GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED`, the same as `BASIC`, which does not return the `cluster_state` field.
Allowed values
GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED - If the value is not set, Google Cloud Game Servers defaults to the `BASIC` view.
BASIC - Includes basic information of a GameServerCluster resource and omits `cluster_state`. This is the default value (for methods ListGameServerClusters, GetGameServerCluster, and PreviewCreateGameServerCluster).
FULL - Include basic information of a GameServerCluster resource as well as `cluster_state`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for GameServerClustersService.ListGameServerClusters.
"gameServerClusters": [ # The list of game server clusters.
{ # A game server cluster resource.
"clusterState": { # The state of the Kubernetes cluster. # Output only. The state of the Kubernetes cluster in preview. This will be available if view is set to FULL in the relevant list/get/preview request.
"agonesVersionInstalled": "A String", # Output only. The version of Agones currently installed in the registered Kubernetes cluster.
"agonesVersionTargeted": "A String", # Output only. The version of Agones that is targeted to be installed in the cluster.
"installationState": "A String", # Output only. The state for the installed versions of Agones/Kubernetes.
"kubernetesVersionInstalled": "A String", # Output only. The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service).
"provider": "A String", # Output only. The cloud provider type reported by the first node's `providerID` in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty.
"versionInstalledErrorMessage": "A String", # Output only. The detailed error message for the installed versions of Agones/Kubernetes.
},
"connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.
"gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
"cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{locationId}/clusters/{cluster}` * `locations/{locationId}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster.
},
"namespace": "A String", # Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.
},
"createTime": "A String", # Output only. The creation time.
"description": "A String", # Human readable description of the cluster.
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels associated with this game server cluster. Each label is a key-value pair.
"a_key": "A String",
},
"name": "A String", # Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}/gameServerClusters/{gameServerClusterId}`. For example, `projects/my-project/locations/global/realms/zanzibar/gameServerClusters/my-gke-cluster`.
"updateTime": "A String", # Output only. The last-modified time.
},
],
"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
"unreachable": [ # List of locations that could not be reached.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Patches a single game server cluster.
Args:
name: string, Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}/gameServerClusters/{gameServerClusterId}`. For example, `projects/my-project/locations/global/realms/zanzibar/gameServerClusters/my-gke-cluster`. (required)
body: object, The request body.
The object takes the form of:
{ # A game server cluster resource.
"clusterState": { # The state of the Kubernetes cluster. # Output only. The state of the Kubernetes cluster in preview. This will be available if view is set to FULL in the relevant list/get/preview request.
"agonesVersionInstalled": "A String", # Output only. The version of Agones currently installed in the registered Kubernetes cluster.
"agonesVersionTargeted": "A String", # Output only. The version of Agones that is targeted to be installed in the cluster.
"installationState": "A String", # Output only. The state for the installed versions of Agones/Kubernetes.
"kubernetesVersionInstalled": "A String", # Output only. The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service).
"provider": "A String", # Output only. The cloud provider type reported by the first node's `providerID` in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty.
"versionInstalledErrorMessage": "A String", # Output only. The detailed error message for the installed versions of Agones/Kubernetes.
},
"connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.
"gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
"cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{locationId}/clusters/{cluster}` * `locations/{locationId}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster.
},
"namespace": "A String", # Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.
},
"createTime": "A String", # Output only. The creation time.
"description": "A String", # Human readable description of the cluster.
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels associated with this game server cluster. Each label is a key-value pair.
"a_key": "A String",
},
"name": "A String", # Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}/gameServerClusters/{gameServerClusterId}`. For example, `projects/my-project/locations/global/realms/zanzibar/gameServerClusters/my-gke-cluster`.
"updateTime": "A String", # Output only. The last-modified time.
}
updateMask: string, Required. The update mask to apply to the resource. At least one path must be supplied in this field. For more information, see the [`FieldMask` definition](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="previewCreate">previewCreate(parent, body=None, gameServerClusterId=None, previewTime=None, view=None, x__xgafv=None)</code>
<pre>Previews creation of a new game server cluster in a given project and location.
Args:
parent: string, Required. The parent resource name, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}`. (required)
body: object, The request body.
The object takes the form of:
{ # A game server cluster resource.
"clusterState": { # The state of the Kubernetes cluster. # Output only. The state of the Kubernetes cluster in preview. This will be available if view is set to FULL in the relevant list/get/preview request.
"agonesVersionInstalled": "A String", # Output only. The version of Agones currently installed in the registered Kubernetes cluster.
"agonesVersionTargeted": "A String", # Output only. The version of Agones that is targeted to be installed in the cluster.
"installationState": "A String", # Output only. The state for the installed versions of Agones/Kubernetes.
"kubernetesVersionInstalled": "A String", # Output only. The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service).
"provider": "A String", # Output only. The cloud provider type reported by the first node's `providerID` in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty.
"versionInstalledErrorMessage": "A String", # Output only. The detailed error message for the installed versions of Agones/Kubernetes.
},
"connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.
"gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
"cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{locationId}/clusters/{cluster}` * `locations/{locationId}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster.
},
"namespace": "A String", # Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.
},
"createTime": "A String", # Output only. The creation time.
"description": "A String", # Human readable description of the cluster.
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels associated with this game server cluster. Each label is a key-value pair.
"a_key": "A String",
},
"name": "A String", # Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}/gameServerClusters/{gameServerClusterId}`. For example, `projects/my-project/locations/global/realms/zanzibar/gameServerClusters/my-gke-cluster`.
"updateTime": "A String", # Output only. The last-modified time.
}
gameServerClusterId: string, Required. The ID of the game server cluster resource to create.
previewTime: string, Optional. The target timestamp to compute the preview.
view: string, Optional. This field is deprecated. Preview will always return KubernetesClusterState.
Allowed values
GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED - If the value is not set, Google Cloud Game Servers defaults to the `BASIC` view.
BASIC - Includes basic information of a GameServerCluster resource and omits `cluster_state`. This is the default value (for methods ListGameServerClusters, GetGameServerCluster, and PreviewCreateGameServerCluster).
FULL - Include basic information of a GameServerCluster resource as well as `cluster_state`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for GameServerClustersService.PreviewCreateGameServerCluster.
"clusterState": { # The state of the Kubernetes cluster. # Output only. The state of the Kubernetes cluster in preview. This will be available if view is set to FULL in the relevant list/get/preview request.
"agonesVersionInstalled": "A String", # Output only. The version of Agones currently installed in the registered Kubernetes cluster.
"agonesVersionTargeted": "A String", # Output only. The version of Agones that is targeted to be installed in the cluster.
"installationState": "A String", # Output only. The state for the installed versions of Agones/Kubernetes.
"kubernetesVersionInstalled": "A String", # Output only. The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service).
"provider": "A String", # Output only. The cloud provider type reported by the first node's `providerID` in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty.
"versionInstalledErrorMessage": "A String", # Output only. The detailed error message for the installed versions of Agones/Kubernetes.
},
"etag": "A String", # The ETag of the game server cluster.
"targetState": { # Encapsulates the Target state. # The target state.
"details": [ # Details about Agones fleets.
{ # Details about the Agones resources.
"fleetDetails": [ # Agones fleet details for game server clusters and game server deployments.
{ # Details of the target Agones fleet.
"autoscaler": { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
"name": "A String", # The name of the Agones autoscaler.
"specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. Details about the Agones autoscaler spec.
"gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}/configs/{configId}`.
"name": "A String", # The name of the Agones fleet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
},
},
"fleet": { # Target Agones fleet specification. # Reference to target Agones fleet.
"name": "A String", # The name of the Agones fleet.
"specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. The Agones fleet spec source.
"gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}/configs/{configId}`.
"name": "A String", # The name of the Agones fleet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
},
},
},
],
"gameServerClusterName": "A String", # The game server cluster name. Uses the form: `projects/{project}/locations/{locationId}/realms/{realmId}/gameServerClusters/{gameServerClusterId}`.
"gameServerDeploymentName": "A String", # The game server deployment name. Uses the form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}`.
},
],
},
}</pre>
</div>
<div class="method">
<code class="details" id="previewDelete">previewDelete(name, previewTime=None, x__xgafv=None)</code>
<pre>Previews deletion of a single game server cluster.
Args:
name: string, Required. The name of the game server cluster to delete, in the following form: `projects/{project}/locations/{locationId}/gameServerClusters/{gameServerClusterId}`. (required)
previewTime: string, Optional. The target timestamp to compute the preview.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for GameServerClustersService.PreviewDeleteGameServerCluster.
"etag": "A String", # The ETag of the game server cluster.
"targetState": { # Encapsulates the Target state. # The target state.
"details": [ # Details about Agones fleets.
{ # Details about the Agones resources.
"fleetDetails": [ # Agones fleet details for game server clusters and game server deployments.
{ # Details of the target Agones fleet.
"autoscaler": { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
"name": "A String", # The name of the Agones autoscaler.
"specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. Details about the Agones autoscaler spec.
"gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}/configs/{configId}`.
"name": "A String", # The name of the Agones fleet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
},
},
"fleet": { # Target Agones fleet specification. # Reference to target Agones fleet.
"name": "A String", # The name of the Agones fleet.
"specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. The Agones fleet spec source.
"gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}/configs/{configId}`.
"name": "A String", # The name of the Agones fleet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
},
},
},
],
"gameServerClusterName": "A String", # The game server cluster name. Uses the form: `projects/{project}/locations/{locationId}/realms/{realmId}/gameServerClusters/{gameServerClusterId}`.
"gameServerDeploymentName": "A String", # The game server deployment name. Uses the form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}`.
},
],
},
}</pre>
</div>
<div class="method">
<code class="details" id="previewUpdate">previewUpdate(name, body=None, previewTime=None, updateMask=None, x__xgafv=None)</code>
<pre>Previews updating a GameServerCluster.
Args:
name: string, Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}/gameServerClusters/{gameServerClusterId}`. For example, `projects/my-project/locations/global/realms/zanzibar/gameServerClusters/my-gke-cluster`. (required)
body: object, The request body.
The object takes the form of:
{ # A game server cluster resource.
"clusterState": { # The state of the Kubernetes cluster. # Output only. The state of the Kubernetes cluster in preview. This will be available if view is set to FULL in the relevant list/get/preview request.
"agonesVersionInstalled": "A String", # Output only. The version of Agones currently installed in the registered Kubernetes cluster.
"agonesVersionTargeted": "A String", # Output only. The version of Agones that is targeted to be installed in the cluster.
"installationState": "A String", # Output only. The state for the installed versions of Agones/Kubernetes.
"kubernetesVersionInstalled": "A String", # Output only. The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service).
"provider": "A String", # Output only. The cloud provider type reported by the first node's `providerID` in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty.
"versionInstalledErrorMessage": "A String", # Output only. The detailed error message for the installed versions of Agones/Kubernetes.
},
"connectionInfo": { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.
"gkeClusterReference": { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
"cluster": "A String", # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{locationId}/clusters/{cluster}` * `locations/{locationId}/clusters/{cluster}` * `{cluster}` If project and location are not specified, the project and location of the GameServerCluster resource are used to generate the full name of the GKE cluster.
},
"namespace": "A String", # Namespace designated on the game server cluster where the Agones game server instances will be created. Existence of the namespace will be validated during creation.
},
"createTime": "A String", # Output only. The creation time.
"description": "A String", # Human readable description of the cluster.
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"labels": { # The labels associated with this game server cluster. Each label is a key-value pair.
"a_key": "A String",
},
"name": "A String", # Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{locationId}/realms/{realmId}/gameServerClusters/{gameServerClusterId}`. For example, `projects/my-project/locations/global/realms/zanzibar/gameServerClusters/my-gke-cluster`.
"updateTime": "A String", # Output only. The last-modified time.
}
previewTime: string, Optional. The target timestamp to compute the preview.
updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. For more information, see the [`FieldMask` definition](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for GameServerClustersService.PreviewUpdateGameServerCluster
"etag": "A String", # The ETag of the game server cluster.
"targetState": { # Encapsulates the Target state. # The target state.
"details": [ # Details about Agones fleets.
{ # Details about the Agones resources.
"fleetDetails": [ # Agones fleet details for game server clusters and game server deployments.
{ # Details of the target Agones fleet.
"autoscaler": { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
"name": "A String", # The name of the Agones autoscaler.
"specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. Details about the Agones autoscaler spec.
"gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}/configs/{configId}`.
"name": "A String", # The name of the Agones fleet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
},
},
"fleet": { # Target Agones fleet specification. # Reference to target Agones fleet.
"name": "A String", # The name of the Agones fleet.
"specSource": { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. The Agones fleet spec source.
"gameServerConfigName": "A String", # The game server config resource. Uses the form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}/configs/{configId}`.
"name": "A String", # The name of the Agones fleet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
},
},
},
],
"gameServerClusterName": "A String", # The game server cluster name. Uses the form: `projects/{project}/locations/{locationId}/realms/{realmId}/gameServerClusters/{gameServerClusterId}`.
"gameServerDeploymentName": "A String", # The game server deployment name. Uses the form: `projects/{project}/locations/{locationId}/gameServerDeployments/{deploymentId}`.
},
],
},
}</pre>
</div>
</body></html>
|
