blob: f4e115426d87d86801a1587c855af565d32fc531 [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">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070087 <code><a href="#list">list(parent, pageToken=None, pageSize=None, orderBy=None, filter=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070088<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">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070096 <code><a href="#previewCreate">previewCreate(parent, body=None, previewTime=None, gameServerClusterId=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070097<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">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700102 <code><a href="#previewUpdate">previewUpdate(name, body=None, updateMask=None, previewTime=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700103<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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700116 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time.
117 &quot;labels&quot;: { # The labels associated with this game server cluster. Each label is a
118 # key-value pair.
119 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700120 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700121 &quot;connectionInfo&quot;: { # The game server cluster connection information. # The game server cluster connection information. This information is used to
122 # manage game server clusters.
123 &quot;namespace&quot;: &quot;A String&quot;, # Namespace designated on the game server cluster where the Agones game
124 # server instances will be created. Existence of the namespace will be
125 # validated during creation.
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 },
137 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
138 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the cluster.
139 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
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 }
Bu Sun Kim65020912020-05-20 12:08:20 -0700147
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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700162 &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.
163 # different programming environments, including REST APIs and RPC APIs. It is
164 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
165 # three pieces of data: error code, error message, and error details.
166 #
167 # You can find out more about this error model and how to work with it in the
168 # [API Design Guide](https://cloud.google.com/apis/design/errors).
169 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
170 # message types for APIs to use.
171 {
172 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
173 },
174 ],
175 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
176 # user-facing error message should be localized and sent in the
177 # google.rpc.Status.details field, or localized by the client.
178 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
179 },
180 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
181 # originally returns it. If you use the default HTTP mapping, the
182 # `name` should be a resource name ending with `operations/{unique_id}`.
183 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
184 # contains progress information and common metadata such as create time.
185 # Some services might not provide such metadata. Any method that returns a
186 # long-running operation should document the metadata type, if any.
187 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
188 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700189 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
190 # method returns no data on success, such as `Delete`, the response is
191 # `google.protobuf.Empty`. If the original method is standard
192 # `Get`/`Create`/`Update`, the response should be the resource. For other
193 # methods, the response should have the type `XxxResponse`, where `Xxx`
194 # is the original method name. For example, if the original method name
195 # is `TakeSnapshot()`, the inferred response type is
196 # `TakeSnapshotResponse`.
197 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
198 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700199 }</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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700222 &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.
223 # different programming environments, including REST APIs and RPC APIs. It is
224 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
225 # three pieces of data: error code, error message, and error details.
226 #
227 # You can find out more about this error model and how to work with it in the
228 # [API Design Guide](https://cloud.google.com/apis/design/errors).
229 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
230 # message types for APIs to use.
231 {
232 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
233 },
234 ],
235 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
236 # user-facing error message should be localized and sent in the
237 # google.rpc.Status.details field, or localized by the client.
238 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
239 },
240 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
241 # originally returns it. If you use the default HTTP mapping, the
242 # `name` should be a resource name ending with `operations/{unique_id}`.
243 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
244 # contains progress information and common metadata such as create time.
245 # Some services might not provide such metadata. Any method that returns a
246 # long-running operation should document the metadata type, if any.
247 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
248 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700249 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
250 # method returns no data on success, such as `Delete`, the response is
251 # `google.protobuf.Empty`. If the original method is standard
252 # `Get`/`Create`/`Update`, the response should be the resource. For other
253 # methods, the response should have the type `XxxResponse`, where `Xxx`
254 # is the original method name. For example, if the original method name
255 # is `TakeSnapshot()`, the inferred response type is
256 # `TakeSnapshotResponse`.
257 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
258 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700259 }</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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700279 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time.
280 &quot;labels&quot;: { # The labels associated with this game server cluster. Each label is a
281 # key-value pair.
282 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700283 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700284 &quot;connectionInfo&quot;: { # The game server cluster connection information. # The game server cluster connection information. This information is used to
285 # manage game server clusters.
286 &quot;namespace&quot;: &quot;A String&quot;, # Namespace designated on the game server cluster where the Agones game
287 # server instances will be created. Existence of the namespace will be
288 # validated during creation.
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 },
300 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
301 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the cluster.
302 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
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>
Bu Sun Kim65020912020-05-20 12:08:20 -0700310</div>
311
312<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700313 <code class="details" id="list">list(parent, pageToken=None, pageSize=None, orderBy=None, filter=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700314 <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)
Bu Sun Kim65020912020-05-20 12:08:20 -0700319 pageToken: string, Optional. The next_page_token value returned from a previous List request, if any.
Bu Sun Kim65020912020-05-20 12:08:20 -0700320 pageSize: integer, Optional. The maximum number of items to return. If unspecified, the server
321will pick an appropriate default. The server may return fewer items than
322requested. A caller should only rely on response&#x27;s
323next_page_token to
324determine if there are more GameServerClusters left to be queried.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700325 orderBy: string, Optional. Specifies the ordering of results following syntax at
326https://cloud.google.com/apis/design/design_patterns#sorting_order.
327 filter: string, Optional. The filter to apply to list results.
Bu Sun Kim65020912020-05-20 12:08:20 -0700328 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700339 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time.
340 &quot;labels&quot;: { # The labels associated with this game server cluster. Each label is a
341 # key-value pair.
342 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700343 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700344 &quot;connectionInfo&quot;: { # The game server cluster connection information. # The game server cluster connection information. This information is used to
345 # manage game server clusters.
346 &quot;namespace&quot;: &quot;A String&quot;, # Namespace designated on the game server cluster where the Agones game
347 # server instances will be created. Existence of the namespace will be
348 # validated during creation.
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 },
360 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
361 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the cluster.
362 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
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`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700369 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700370 ],
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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700373 &quot;unreachable&quot;: [ # List of locations that could not be reached.
374 &quot;A String&quot;,
375 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700376 }</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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700408 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time.
409 &quot;labels&quot;: { # The labels associated with this game server cluster. Each label is a
410 # key-value pair.
411 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700412 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700413 &quot;connectionInfo&quot;: { # The game server cluster connection information. # The game server cluster connection information. This information is used to
414 # manage game server clusters.
415 &quot;namespace&quot;: &quot;A String&quot;, # Namespace designated on the game server cluster where the Agones game
416 # server instances will be created. Existence of the namespace will be
417 # validated during creation.
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 },
429 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
430 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the cluster.
431 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
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 }
Bu Sun Kim65020912020-05-20 12:08:20 -0700439
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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700459 &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.
460 # different programming environments, including REST APIs and RPC APIs. It is
461 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
462 # three pieces of data: error code, error message, and error details.
463 #
464 # You can find out more about this error model and how to work with it in the
465 # [API Design Guide](https://cloud.google.com/apis/design/errors).
466 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
467 # message types for APIs to use.
468 {
469 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
470 },
471 ],
472 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
473 # user-facing error message should be localized and sent in the
474 # google.rpc.Status.details field, or localized by the client.
475 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
476 },
477 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
478 # originally returns it. If you use the default HTTP mapping, the
479 # `name` should be a resource name ending with `operations/{unique_id}`.
480 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
481 # contains progress information and common metadata such as create time.
482 # Some services might not provide such metadata. Any method that returns a
483 # long-running operation should document the metadata type, if any.
484 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
485 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700486 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
487 # method returns no data on success, such as `Delete`, the response is
488 # `google.protobuf.Empty`. If the original method is standard
489 # `Get`/`Create`/`Update`, the response should be the resource. For other
490 # methods, the response should have the type `XxxResponse`, where `Xxx`
491 # is the original method name. For example, if the original method name
492 # is `TakeSnapshot()`, the inferred response type is
493 # `TakeSnapshotResponse`.
494 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
495 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700496 }</pre>
497</div>
498
499<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700500 <code class="details" id="previewCreate">previewCreate(parent, body=None, previewTime=None, gameServerClusterId=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700501 <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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700511 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time.
512 &quot;labels&quot;: { # The labels associated with this game server cluster. Each label is a
513 # key-value pair.
514 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700515 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700516 &quot;connectionInfo&quot;: { # The game server cluster connection information. # The game server cluster connection information. This information is used to
517 # manage game server clusters.
518 &quot;namespace&quot;: &quot;A String&quot;, # Namespace designated on the game server cluster where the Agones game
519 # server instances will be created. Existence of the namespace will be
520 # validated during creation.
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 },
532 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
533 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the cluster.
534 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
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 }
Bu Sun Kim65020912020-05-20 12:08:20 -0700542
Bu Sun Kim65020912020-05-20 12:08:20 -0700543 previewTime: string, Optional. The target timestamp to compute the preview.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700544 gameServerClusterId: string, Required. The ID of the game server cluster resource to be created.
Bu Sun Kim65020912020-05-20 12:08:20 -0700545 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700555 &quot;targetState&quot;: { # Encapsulates the Target state. # The target state.
556 &quot;details&quot;: [ # Details about Agones fleets.
557 { # Details about the Agones resources.
Bu Sun Kim65020912020-05-20 12:08:20 -0700558 &quot;fleetDetails&quot;: [ # Agones fleet details for game server clusters and game server deployments.
559 { # Details of the target Agones fleet.
Bu Sun Kim65020912020-05-20 12:08:20 -0700560 &quot;fleet&quot;: { # Target Agones fleet specification. # Reference to target Agones fleet.
561 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones fleet.
562 &quot;specSource&quot;: { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec.
563 # The Agones fleet spec source.
564 &quot;gameServerConfigName&quot;: &quot;A String&quot;, # The game server config resource. Uses the form:
565 #
566 # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700567 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones leet config or Agones scaling config used to derive
568 # the Agones fleet or Agones autoscaler spec.
569 },
570 },
571 &quot;autoscaler&quot;: { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
572 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones autoscaler.
573 &quot;specSource&quot;: { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec.
574 # Details about the Agones autoscaler spec.
575 &quot;gameServerConfigName&quot;: &quot;A String&quot;, # The game server config resource. Uses the form:
576 #
577 # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
578 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones leet config or Agones scaling config used to derive
579 # the Agones fleet or Agones autoscaler spec.
Bu Sun Kim65020912020-05-20 12:08:20 -0700580 },
581 },
582 },
583 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700584 &quot;gameServerClusterName&quot;: &quot;A String&quot;, # The game server cluster name. Uses the form:
585 #
586 # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700587 &quot;gameServerDeploymentName&quot;: &quot;A String&quot;, # The game server deployment name. Uses the form:
588 #
589 # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700590 },
591 ],
592 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700593 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the game server cluster.
Bu Sun Kim65020912020-05-20 12:08:20 -0700594 }</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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700615 &quot;targetState&quot;: { # Encapsulates the Target state. # The target state.
616 &quot;details&quot;: [ # Details about Agones fleets.
617 { # Details about the Agones resources.
Bu Sun Kim65020912020-05-20 12:08:20 -0700618 &quot;fleetDetails&quot;: [ # Agones fleet details for game server clusters and game server deployments.
619 { # Details of the target Agones fleet.
Bu Sun Kim65020912020-05-20 12:08:20 -0700620 &quot;fleet&quot;: { # Target Agones fleet specification. # Reference to target Agones fleet.
621 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones fleet.
622 &quot;specSource&quot;: { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec.
623 # The Agones fleet spec source.
624 &quot;gameServerConfigName&quot;: &quot;A String&quot;, # The game server config resource. Uses the form:
625 #
626 # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700627 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones leet config or Agones scaling config used to derive
628 # the Agones fleet or Agones autoscaler spec.
629 },
630 },
631 &quot;autoscaler&quot;: { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
632 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones autoscaler.
633 &quot;specSource&quot;: { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec.
634 # Details about the Agones autoscaler spec.
635 &quot;gameServerConfigName&quot;: &quot;A String&quot;, # The game server config resource. Uses the form:
636 #
637 # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
638 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones leet config or Agones scaling config used to derive
639 # the Agones fleet or Agones autoscaler spec.
Bu Sun Kim65020912020-05-20 12:08:20 -0700640 },
641 },
642 },
643 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700644 &quot;gameServerClusterName&quot;: &quot;A String&quot;, # The game server cluster name. Uses the form:
645 #
646 # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700647 &quot;gameServerDeploymentName&quot;: &quot;A String&quot;, # The game server deployment name. Uses the form:
648 #
649 # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700650 },
651 ],
652 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700653 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the game server cluster.
Bu Sun Kim65020912020-05-20 12:08:20 -0700654 }</pre>
655</div>
656
657<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700658 <code class="details" id="previewUpdate">previewUpdate(name, body=None, updateMask=None, previewTime=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700659 <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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700672 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time.
673 &quot;labels&quot;: { # The labels associated with this game server cluster. Each label is a
674 # key-value pair.
675 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim65020912020-05-20 12:08:20 -0700676 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700677 &quot;connectionInfo&quot;: { # The game server cluster connection information. # The game server cluster connection information. This information is used to
678 # manage game server clusters.
679 &quot;namespace&quot;: &quot;A String&quot;, # Namespace designated on the game server cluster where the Agones game
680 # server instances will be created. Existence of the namespace will be
681 # validated during creation.
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 },
693 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
694 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the cluster.
695 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
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 }
Bu Sun Kim65020912020-05-20 12:08:20 -0700703
Bu Sun Kim65020912020-05-20 12:08:20 -0700704 updateMask: string, Required. Mask of fields to update. At least one path must be supplied in
705this field. For the `FieldMask` definition, see
706
707https:
708//developers.google.com/protocol-buffers
709// /docs/reference/google.protobuf#fieldmask
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700710 previewTime: string, Optional. The target timestamp to compute the preview.
Bu Sun Kim65020912020-05-20 12:08:20 -0700711 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700723 &quot;fleetDetails&quot;: [ # Agones fleet details for game server clusters and game server deployments.
724 { # Details of the target Agones fleet.
Bu Sun Kim65020912020-05-20 12:08:20 -0700725 &quot;fleet&quot;: { # Target Agones fleet specification. # Reference to target Agones fleet.
726 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones fleet.
727 &quot;specSource&quot;: { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec.
728 # The Agones fleet spec source.
729 &quot;gameServerConfigName&quot;: &quot;A String&quot;, # The game server config resource. Uses the form:
730 #
731 # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700732 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones leet config or Agones scaling config used to derive
733 # the Agones fleet or Agones autoscaler spec.
734 },
735 },
736 &quot;autoscaler&quot;: { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
737 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones autoscaler.
738 &quot;specSource&quot;: { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec.
739 # Details about the Agones autoscaler spec.
740 &quot;gameServerConfigName&quot;: &quot;A String&quot;, # The game server config resource. Uses the form:
741 #
742 # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
743 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones leet config or Agones scaling config used to derive
744 # the Agones fleet or Agones autoscaler spec.
Bu Sun Kim65020912020-05-20 12:08:20 -0700745 },
746 },
747 },
748 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700749 &quot;gameServerClusterName&quot;: &quot;A String&quot;, # The game server cluster name. Uses the form:
750 #
751 # `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700752 &quot;gameServerDeploymentName&quot;: &quot;A String&quot;, # The game server deployment name. Uses the form:
753 #
754 # `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700755 },
756 ],
757 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700758 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the game server cluster.
Bu Sun Kim65020912020-05-20 12:08:20 -0700759 }</pre>
760</div>
761
762</body></html>