blob: f7e49a1b13457d559dc32c580be5c14e486878c4 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="gameservices_v1beta.html">Game Services API</a> . <a href="gameservices_v1beta.projects.html">projects</a> . <a href="gameservices_v1beta.projects.locations.html">locations</a> . <a href="gameservices_v1beta.projects.locations.realms.html">realms</a> . <a href="gameservices_v1beta.projects.locations.realms.gameServerClusters.html">gameServerClusters</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(parent, body=None, gameServerClusterId=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Creates a new game server cluster in a given project and location.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a single game server cluster.</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets details of a single game server cluster.</p>
86<p class="toc_element">
87 <code><a href="#list">list(parent, filter=None, pageToken=None, orderBy=None, pageSize=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Lists game server clusters in a given project and location.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
93 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
94<p class="firstline">Patches a single game server cluster.</p>
95<p class="toc_element">
96 <code><a href="#previewCreate">previewCreate(parent, body=None, gameServerClusterId=None, previewTime=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Previews creation of a new game server cluster in a given project and</p>
98<p class="toc_element">
99 <code><a href="#previewDelete">previewDelete(name, previewTime=None, x__xgafv=None)</a></code></p>
100<p class="firstline">Previews deletion of a single game server cluster.</p>
101<p class="toc_element">
102 <code><a href="#previewUpdate">previewUpdate(name, body=None, previewTime=None, updateMask=None, x__xgafv=None)</a></code></p>
103<p class="firstline">Previews updating a GameServerCluster.</p>
104<h3>Method Details</h3>
105<div class="method">
106 <code class="details" id="create">create(parent, body=None, gameServerClusterId=None, x__xgafv=None)</code>
107 <pre>Creates a new game server cluster in a given project and location.
108
109Args:
110 parent: string, Required. The parent resource name. Uses the form:
111`projects/{project}/locations/{location}/realms/{realm-id}`. (required)
112 body: object, The request body.
113 The object takes the form of:
114
115{ # A game server cluster resource.
116 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the cluster.
117 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
118 &quot;labels&quot;: { # The labels associated with this game server cluster. Each label is a
119 # key-value pair.
120 &quot;a_key&quot;: &quot;A String&quot;,
121 },
122 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time.
123 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
124 &quot;connectionInfo&quot;: { # The game server cluster connection information. # The game server cluster connection information. This information is used to
125 # manage game server clusters.
126 &quot;gkeClusterReference&quot;: { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
127 &quot;cluster&quot;: &quot;A String&quot;, # The full or partial name of a GKE cluster, using one of the following
128 # forms:
129 # * `projects/{project}/locations/{location}/clusters/{cluster}`
130 # * `locations/{location}/clusters/{cluster}`
131 # * `{cluster}`
132 # If project and location are not specified, the project and location of the
133 # GameServerCluster resource are used to generate the full name of the
134 # GKE cluster.
135 },
136 &quot;namespace&quot;: &quot;A String&quot;, # Namespace designated on the game server cluster where the Agones game
137 # server instances will be created. Existence of the namespace will be
138 # validated during creation.
139 },
140 &quot;name&quot;: &quot;A String&quot;, # Required. The resource name of the game server cluster. Uses the form:
141 #
142 # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
143 # For example,
144 #
145 # `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
146}
147
148 gameServerClusterId: string, Required. The ID of the game server cluster resource to be created.
149 x__xgafv: string, V1 error format.
150 Allowed values
151 1 - v1 error format
152 2 - v2 error format
153
154Returns:
155 An object of the form:
156
157 { # This resource represents a long-running operation that is the result of a
158 # network API call.
159 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
160 # If `true`, the operation is completed, and either `error` or `response` is
161 # available.
162 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
163 # method returns no data on success, such as `Delete`, the response is
164 # `google.protobuf.Empty`. If the original method is standard
165 # `Get`/`Create`/`Update`, the response should be the resource. For other
166 # methods, the response should have the type `XxxResponse`, where `Xxx`
167 # is the original method name. For example, if the original method name
168 # is `TakeSnapshot()`, the inferred response type is
169 # `TakeSnapshotResponse`.
170 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
171 },
172 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
173 # originally returns it. If you use the default HTTP mapping, the
174 # `name` should be a resource name ending with `operations/{unique_id}`.
175 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
176 # different programming environments, including REST APIs and RPC APIs. It is
177 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
178 # three pieces of data: error code, error message, and error details.
179 #
180 # You can find out more about this error model and how to work with it in the
181 # [API Design Guide](https://cloud.google.com/apis/design/errors).
182 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
183 # message types for APIs to use.
184 {
185 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
186 },
187 ],
188 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
189 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
190 # user-facing error message should be localized and sent in the
191 # google.rpc.Status.details field, or localized by the client.
192 },
193 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
194 # contains progress information and common metadata such as create time.
195 # Some services might not provide such metadata. Any method that returns a
196 # long-running operation should document the metadata type, if any.
197 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
198 },
199 }</pre>
200</div>
201
202<div class="method">
203 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
204 <pre>Deletes a single game server cluster.
205
206Args:
207 name: string, Required. The name of the game server cluster to delete. Uses the form:
208`projects/{project}/locations/{location}/gameServerClusters/{cluster}`. (required)
209 x__xgafv: string, V1 error format.
210 Allowed values
211 1 - v1 error format
212 2 - v2 error format
213
214Returns:
215 An object of the form:
216
217 { # This resource represents a long-running operation that is the result of a
218 # network API call.
219 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
220 # If `true`, the operation is completed, and either `error` or `response` is
221 # available.
222 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
223 # method returns no data on success, such as `Delete`, the response is
224 # `google.protobuf.Empty`. If the original method is standard
225 # `Get`/`Create`/`Update`, the response should be the resource. For other
226 # methods, the response should have the type `XxxResponse`, where `Xxx`
227 # is the original method name. For example, if the original method name
228 # is `TakeSnapshot()`, the inferred response type is
229 # `TakeSnapshotResponse`.
230 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
231 },
232 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
233 # originally returns it. If you use the default HTTP mapping, the
234 # `name` should be a resource name ending with `operations/{unique_id}`.
235 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
236 # different programming environments, including REST APIs and RPC APIs. It is
237 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
238 # three pieces of data: error code, error message, and error details.
239 #
240 # You can find out more about this error model and how to work with it in the
241 # [API Design Guide](https://cloud.google.com/apis/design/errors).
242 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
243 # message types for APIs to use.
244 {
245 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
246 },
247 ],
248 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
249 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
250 # user-facing error message should be localized and sent in the
251 # google.rpc.Status.details field, or localized by the client.
252 },
253 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
254 # contains progress information and common metadata such as create time.
255 # Some services might not provide such metadata. Any method that returns a
256 # long-running operation should document the metadata type, if any.
257 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
258 },
259 }</pre>
260</div>
261
262<div class="method">
263 <code class="details" id="get">get(name, x__xgafv=None)</code>
264 <pre>Gets details of a single game server cluster.
265
266Args:
267 name: string, Required. The name of the game server cluster to retrieve. Uses the form:
268
269`projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}`. (required)
270 x__xgafv: string, V1 error format.
271 Allowed values
272 1 - v1 error format
273 2 - v2 error format
274
275Returns:
276 An object of the form:
277
278 { # A game server cluster resource.
279 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the cluster.
280 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
281 &quot;labels&quot;: { # The labels associated with this game server cluster. Each label is a
282 # key-value pair.
283 &quot;a_key&quot;: &quot;A String&quot;,
284 },
285 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time.
286 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
287 &quot;connectionInfo&quot;: { # The game server cluster connection information. # The game server cluster connection information. This information is used to
288 # manage game server clusters.
289 &quot;gkeClusterReference&quot;: { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
290 &quot;cluster&quot;: &quot;A String&quot;, # The full or partial name of a GKE cluster, using one of the following
291 # forms:
292 # * `projects/{project}/locations/{location}/clusters/{cluster}`
293 # * `locations/{location}/clusters/{cluster}`
294 # * `{cluster}`
295 # If project and location are not specified, the project and location of the
296 # GameServerCluster resource are used to generate the full name of the
297 # GKE cluster.
298 },
299 &quot;namespace&quot;: &quot;A String&quot;, # Namespace designated on the game server cluster where the Agones game
300 # server instances will be created. Existence of the namespace will be
301 # validated during creation.
302 },
303 &quot;name&quot;: &quot;A String&quot;, # Required. The resource name of the game server cluster. Uses the form:
304 #
305 # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
306 # For example,
307 #
308 # `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
309 }</pre>
310</div>
311
312<div class="method">
313 <code class="details" id="list">list(parent, filter=None, pageToken=None, orderBy=None, pageSize=None, x__xgafv=None)</code>
314 <pre>Lists game server clusters in a given project and location.
315
316Args:
317 parent: string, Required. The parent resource name. Uses the form:
318&quot;projects/{project}/locations/{location}/realms/{realm}&quot;. (required)
319 filter: string, Optional. The filter to apply to list results.
320 pageToken: string, Optional. The next_page_token value returned from a previous List request, if any.
321 orderBy: string, Optional. Specifies the ordering of results following syntax at
322https://cloud.google.com/apis/design/design_patterns#sorting_order.
323 pageSize: integer, Optional. The maximum number of items to return. If unspecified, the server
324will pick an appropriate default. The server may return fewer items than
325requested. A caller should only rely on response&#x27;s
326next_page_token to
327determine if there are more GameServerClusters left to be queried.
328 x__xgafv: string, V1 error format.
329 Allowed values
330 1 - v1 error format
331 2 - v2 error format
332
333Returns:
334 An object of the form:
335
336 { # Response message for GameServerClustersService.ListGameServerClusters.
337 &quot;gameServerClusters&quot;: [ # The list of game server clusters.
338 { # A game server cluster resource.
339 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the cluster.
340 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
341 &quot;labels&quot;: { # The labels associated with this game server cluster. Each label is a
342 # key-value pair.
343 &quot;a_key&quot;: &quot;A String&quot;,
344 },
345 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time.
346 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
347 &quot;connectionInfo&quot;: { # The game server cluster connection information. # The game server cluster connection information. This information is used to
348 # manage game server clusters.
349 &quot;gkeClusterReference&quot;: { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
350 &quot;cluster&quot;: &quot;A String&quot;, # The full or partial name of a GKE cluster, using one of the following
351 # forms:
352 # * `projects/{project}/locations/{location}/clusters/{cluster}`
353 # * `locations/{location}/clusters/{cluster}`
354 # * `{cluster}`
355 # If project and location are not specified, the project and location of the
356 # GameServerCluster resource are used to generate the full name of the
357 # GKE cluster.
358 },
359 &quot;namespace&quot;: &quot;A String&quot;, # Namespace designated on the game server cluster where the Agones game
360 # server instances will be created. Existence of the namespace will be
361 # validated during creation.
362 },
363 &quot;name&quot;: &quot;A String&quot;, # Required. The resource name of the game server cluster. Uses the form:
364 #
365 # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
366 # For example,
367 #
368 # `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
369 },
370 ],
371 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more
372 # results in the list.
373 &quot;unreachable&quot;: [ # List of locations that could not be reached.
374 &quot;A String&quot;,
375 ],
376 }</pre>
377</div>
378
379<div class="method">
380 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
381 <pre>Retrieves the next page of results.
382
383Args:
384 previous_request: The request for the previous page. (required)
385 previous_response: The response from the request for the previous page. (required)
386
387Returns:
388 A request object that you can call &#x27;execute()&#x27; on to request the next
389 page. Returns None if there are no more items in the collection.
390 </pre>
391</div>
392
393<div class="method">
394 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
395 <pre>Patches a single game server cluster.
396
397Args:
398 name: string, Required. The resource name of the game server cluster. Uses the form:
399
400`projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
401For example,
402
403`projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`. (required)
404 body: object, The request body.
405 The object takes the form of:
406
407{ # A game server cluster resource.
408 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the cluster.
409 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
410 &quot;labels&quot;: { # The labels associated with this game server cluster. Each label is a
411 # key-value pair.
412 &quot;a_key&quot;: &quot;A String&quot;,
413 },
414 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time.
415 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
416 &quot;connectionInfo&quot;: { # The game server cluster connection information. # The game server cluster connection information. This information is used to
417 # manage game server clusters.
418 &quot;gkeClusterReference&quot;: { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
419 &quot;cluster&quot;: &quot;A String&quot;, # The full or partial name of a GKE cluster, using one of the following
420 # forms:
421 # * `projects/{project}/locations/{location}/clusters/{cluster}`
422 # * `locations/{location}/clusters/{cluster}`
423 # * `{cluster}`
424 # If project and location are not specified, the project and location of the
425 # GameServerCluster resource are used to generate the full name of the
426 # GKE cluster.
427 },
428 &quot;namespace&quot;: &quot;A String&quot;, # Namespace designated on the game server cluster where the Agones game
429 # server instances will be created. Existence of the namespace will be
430 # validated during creation.
431 },
432 &quot;name&quot;: &quot;A String&quot;, # Required. The resource name of the game server cluster. Uses the form:
433 #
434 # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
435 # For example,
436 #
437 # `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
438}
439
440 updateMask: string, Required. Mask of fields to update. At least one path must be supplied in
441this field. For the `FieldMask` definition, see
442
443https:
444//developers.google.com/protocol-buffers
445// /docs/reference/google.protobuf#fieldmask
446 x__xgafv: string, V1 error format.
447 Allowed values
448 1 - v1 error format
449 2 - v2 error format
450
451Returns:
452 An object of the form:
453
454 { # This resource represents a long-running operation that is the result of a
455 # network API call.
456 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
457 # If `true`, the operation is completed, and either `error` or `response` is
458 # available.
459 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
460 # method returns no data on success, such as `Delete`, the response is
461 # `google.protobuf.Empty`. If the original method is standard
462 # `Get`/`Create`/`Update`, the response should be the resource. For other
463 # methods, the response should have the type `XxxResponse`, where `Xxx`
464 # is the original method name. For example, if the original method name
465 # is `TakeSnapshot()`, the inferred response type is
466 # `TakeSnapshotResponse`.
467 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
468 },
469 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
470 # originally returns it. If you use the default HTTP mapping, the
471 # `name` should be a resource name ending with `operations/{unique_id}`.
472 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
473 # different programming environments, including REST APIs and RPC APIs. It is
474 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
475 # three pieces of data: error code, error message, and error details.
476 #
477 # You can find out more about this error model and how to work with it in the
478 # [API Design Guide](https://cloud.google.com/apis/design/errors).
479 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
480 # message types for APIs to use.
481 {
482 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
483 },
484 ],
485 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
486 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
487 # user-facing error message should be localized and sent in the
488 # google.rpc.Status.details field, or localized by the client.
489 },
490 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
491 # contains progress information and common metadata such as create time.
492 # Some services might not provide such metadata. Any method that returns a
493 # long-running operation should document the metadata type, if any.
494 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
495 },
496 }</pre>
497</div>
498
499<div class="method">
500 <code class="details" id="previewCreate">previewCreate(parent, body=None, gameServerClusterId=None, previewTime=None, x__xgafv=None)</code>
501 <pre>Previews creation of a new game server cluster in a given project and
502location.
503
504Args:
505 parent: string, Required. The parent resource name. Uses the form:
506`projects/{project}/locations/{location}/realms/{realm}`. (required)
507 body: object, The request body.
508 The object takes the form of:
509
510{ # A game server cluster resource.
511 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the cluster.
512 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
513 &quot;labels&quot;: { # The labels associated with this game server cluster. Each label is a
514 # key-value pair.
515 &quot;a_key&quot;: &quot;A String&quot;,
516 },
517 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time.
518 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
519 &quot;connectionInfo&quot;: { # The game server cluster connection information. # The game server cluster connection information. This information is used to
520 # manage game server clusters.
521 &quot;gkeClusterReference&quot;: { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
522 &quot;cluster&quot;: &quot;A String&quot;, # The full or partial name of a GKE cluster, using one of the following
523 # forms:
524 # * `projects/{project}/locations/{location}/clusters/{cluster}`
525 # * `locations/{location}/clusters/{cluster}`
526 # * `{cluster}`
527 # If project and location are not specified, the project and location of the
528 # GameServerCluster resource are used to generate the full name of the
529 # GKE cluster.
530 },
531 &quot;namespace&quot;: &quot;A String&quot;, # Namespace designated on the game server cluster where the Agones game
532 # server instances will be created. Existence of the namespace will be
533 # validated during creation.
534 },
535 &quot;name&quot;: &quot;A String&quot;, # Required. The resource name of the game server cluster. Uses the form:
536 #
537 # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
538 # For example,
539 #
540 # `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
541}
542
543 gameServerClusterId: string, Required. The ID of the game server cluster resource to be created.
544 previewTime: string, Optional. The target timestamp to compute the preview.
545 x__xgafv: string, V1 error format.
546 Allowed values
547 1 - v1 error format
548 2 - v2 error format
549
550Returns:
551 An object of the form:
552
553 { # Response message for
554 # GameServerClustersService.PreviewCreateGameServerCluster.
555 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the game server cluster.
556 &quot;targetState&quot;: { # Encapsulates the Target state. # The target state.
557 &quot;details&quot;: [ # Details about Agones fleets.
558 { # Details about the Agones resources.
559 &quot;gameServerClusterName&quot;: &quot;A String&quot;, # The game server cluster name. Uses the form:
560 #
561 # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
562 &quot;gameServerDeploymentName&quot;: &quot;A String&quot;, # The game server deployment name. Uses the form:
563 #
564 # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
565 &quot;fleetDetails&quot;: [ # Agones fleet details for game server clusters and game server deployments.
566 { # Details of the target Agones fleet.
567 &quot;autoscaler&quot;: { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
568 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones autoscaler.
569 &quot;specSource&quot;: { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec.
570 # Details about the Agones autoscaler spec.
571 &quot;gameServerConfigName&quot;: &quot;A String&quot;, # The game server config resource. Uses the form:
572 #
573 # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
574 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones leet config or Agones scaling config used to derive
575 # the Agones fleet or Agones autoscaler spec.
576 },
577 },
578 &quot;fleet&quot;: { # Target Agones fleet specification. # Reference to target Agones fleet.
579 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones fleet.
580 &quot;specSource&quot;: { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec.
581 # The Agones fleet spec source.
582 &quot;gameServerConfigName&quot;: &quot;A String&quot;, # The game server config resource. Uses the form:
583 #
584 # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
585 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones leet config or Agones scaling config used to derive
586 # the Agones fleet or Agones autoscaler spec.
587 },
588 },
589 },
590 ],
591 },
592 ],
593 },
594 }</pre>
595</div>
596
597<div class="method">
598 <code class="details" id="previewDelete">previewDelete(name, previewTime=None, x__xgafv=None)</code>
599 <pre>Previews deletion of a single game server cluster.
600
601Args:
602 name: string, Required. The name of the game server cluster to delete. Uses the form:
603`projects/{project}/locations/{location}/gameServerClusters/{cluster}`. (required)
604 previewTime: string, Optional. The target timestamp to compute the preview.
605 x__xgafv: string, V1 error format.
606 Allowed values
607 1 - v1 error format
608 2 - v2 error format
609
610Returns:
611 An object of the form:
612
613 { # Response message for
614 # GameServerClustersService.PreviewDeleteGameServerCluster.
615 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the game server cluster.
616 &quot;targetState&quot;: { # Encapsulates the Target state. # The target state.
617 &quot;details&quot;: [ # Details about Agones fleets.
618 { # Details about the Agones resources.
619 &quot;gameServerClusterName&quot;: &quot;A String&quot;, # The game server cluster name. Uses the form:
620 #
621 # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
622 &quot;gameServerDeploymentName&quot;: &quot;A String&quot;, # The game server deployment name. Uses the form:
623 #
624 # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
625 &quot;fleetDetails&quot;: [ # Agones fleet details for game server clusters and game server deployments.
626 { # Details of the target Agones fleet.
627 &quot;autoscaler&quot;: { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
628 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones autoscaler.
629 &quot;specSource&quot;: { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec.
630 # Details about the Agones autoscaler spec.
631 &quot;gameServerConfigName&quot;: &quot;A String&quot;, # The game server config resource. Uses the form:
632 #
633 # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
634 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones leet config or Agones scaling config used to derive
635 # the Agones fleet or Agones autoscaler spec.
636 },
637 },
638 &quot;fleet&quot;: { # Target Agones fleet specification. # Reference to target Agones fleet.
639 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones fleet.
640 &quot;specSource&quot;: { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec.
641 # The Agones fleet spec source.
642 &quot;gameServerConfigName&quot;: &quot;A String&quot;, # The game server config resource. Uses the form:
643 #
644 # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
645 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones leet config or Agones scaling config used to derive
646 # the Agones fleet or Agones autoscaler spec.
647 },
648 },
649 },
650 ],
651 },
652 ],
653 },
654 }</pre>
655</div>
656
657<div class="method">
658 <code class="details" id="previewUpdate">previewUpdate(name, body=None, previewTime=None, updateMask=None, x__xgafv=None)</code>
659 <pre>Previews updating a GameServerCluster.
660
661Args:
662 name: string, Required. The resource name of the game server cluster. Uses the form:
663
664`projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
665For example,
666
667`projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`. (required)
668 body: object, The request body.
669 The object takes the form of:
670
671{ # A game server cluster resource.
672 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the cluster.
673 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
674 &quot;labels&quot;: { # The labels associated with this game server cluster. Each label is a
675 # key-value pair.
676 &quot;a_key&quot;: &quot;A String&quot;,
677 },
678 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time.
679 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
680 &quot;connectionInfo&quot;: { # The game server cluster connection information. # The game server cluster connection information. This information is used to
681 # manage game server clusters.
682 &quot;gkeClusterReference&quot;: { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
683 &quot;cluster&quot;: &quot;A String&quot;, # The full or partial name of a GKE cluster, using one of the following
684 # forms:
685 # * `projects/{project}/locations/{location}/clusters/{cluster}`
686 # * `locations/{location}/clusters/{cluster}`
687 # * `{cluster}`
688 # If project and location are not specified, the project and location of the
689 # GameServerCluster resource are used to generate the full name of the
690 # GKE cluster.
691 },
692 &quot;namespace&quot;: &quot;A String&quot;, # Namespace designated on the game server cluster where the Agones game
693 # server instances will be created. Existence of the namespace will be
694 # validated during creation.
695 },
696 &quot;name&quot;: &quot;A String&quot;, # Required. The resource name of the game server cluster. Uses the form:
697 #
698 # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
699 # For example,
700 #
701 # `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
702}
703
704 previewTime: string, Optional. The target timestamp to compute the preview.
705 updateMask: string, Required. Mask of fields to update. At least one path must be supplied in
706this field. For the `FieldMask` definition, see
707
708https:
709//developers.google.com/protocol-buffers
710// /docs/reference/google.protobuf#fieldmask
711 x__xgafv: string, V1 error format.
712 Allowed values
713 1 - v1 error format
714 2 - v2 error format
715
716Returns:
717 An object of the form:
718
719 { # Response message for GameServerClustersService.PreviewUpdateGameServerCluster
720 &quot;targetState&quot;: { # Encapsulates the Target state. # The target state.
721 &quot;details&quot;: [ # Details about Agones fleets.
722 { # Details about the Agones resources.
723 &quot;gameServerClusterName&quot;: &quot;A String&quot;, # The game server cluster name. Uses the form:
724 #
725 # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
726 &quot;gameServerDeploymentName&quot;: &quot;A String&quot;, # The game server deployment name. Uses the form:
727 #
728 # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
729 &quot;fleetDetails&quot;: [ # Agones fleet details for game server clusters and game server deployments.
730 { # Details of the target Agones fleet.
731 &quot;autoscaler&quot;: { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
732 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones autoscaler.
733 &quot;specSource&quot;: { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec.
734 # Details about the Agones autoscaler spec.
735 &quot;gameServerConfigName&quot;: &quot;A String&quot;, # The game server config resource. Uses the form:
736 #
737 # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
738 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones leet config or Agones scaling config used to derive
739 # the Agones fleet or Agones autoscaler spec.
740 },
741 },
742 &quot;fleet&quot;: { # Target Agones fleet specification. # Reference to target Agones fleet.
743 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones fleet.
744 &quot;specSource&quot;: { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec.
745 # The Agones fleet spec source.
746 &quot;gameServerConfigName&quot;: &quot;A String&quot;, # The game server config resource. Uses the form:
747 #
748 # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
749 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones leet config or Agones scaling config used to derive
750 # the Agones fleet or Agones autoscaler spec.
751 },
752 },
753 },
754 ],
755 },
756 ],
757 },
758 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the game server cluster.
759 }</pre>
760</div>
761
762</body></html>