blob: f13ebf87e556724a695e3faf8be2ab4bb13f5091 [file] [log] [blame]
Bu Sun Kimd059ad82020-07-22 17:02:09 -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_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>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070081 <code><a href="#create">create(parent, body=None, gameServerClusterId=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Creates a new game server cluster in a given project and location.</p>
83<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Deletes a single game server cluster.</p>
86<p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88<p class="firstline">Gets details of a single game server cluster.</p>
89<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070090 <code><a href="#list">list(parent, pageToken=None, pageSize=None, filter=None, orderBy=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -070091<p class="firstline">Lists game server clusters in a given project and location.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Patches a single game server cluster.</p>
98<p class="toc_element">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -070099 <code><a href="#previewCreate">previewCreate(parent, body=None, gameServerClusterId=None, previewTime=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700100<p class="firstline">Previews creation of a new game server cluster in a given project and location.</p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700101<p class="toc_element">
102 <code><a href="#previewDelete">previewDelete(name, previewTime=None, x__xgafv=None)</a></code></p>
103<p class="firstline">Previews deletion of a single game server cluster.</p>
104<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700105 <code><a href="#previewUpdate">previewUpdate(name, body=None, updateMask=None, previewTime=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700106<p class="firstline">Previews updating a GameServerCluster.</p>
107<h3>Method Details</h3>
108<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700109 <code class="details" id="close">close()</code>
110 <pre>Close httplib2 connections.</pre>
111</div>
112
113<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700114 <code class="details" id="create">create(parent, body=None, gameServerClusterId=None, x__xgafv=None)</code>
115 <pre>Creates a new game server cluster in a given project and location.
116
117Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700118 parent: string, Required. The parent resource name, in the following form: `projects/{project}/locations/{location}/realms/{realm-id}`. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700119 body: object, The request body.
120 The object takes the form of:
121
122{ # A game server cluster resource.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700123 &quot;labels&quot;: { # The labels associated with this game server cluster. Each label is a key-value pair.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700124 &quot;a_key&quot;: &quot;A String&quot;,
125 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700126 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the cluster.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700127 &quot;connectionInfo&quot;: { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700128 &quot;namespace&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700129 &quot;gkeClusterReference&quot;: { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700130 &quot;cluster&quot;: &quot;A String&quot;, # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700131 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700132 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700133 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
134 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time.
135 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
136 &quot;name&quot;: &quot;A String&quot;, # Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700137}
138
139 gameServerClusterId: string, Required. The ID of the game server cluster resource to be created.
140 x__xgafv: string, V1 error format.
141 Allowed values
142 1 - v1 error format
143 2 - v2 error format
144
145Returns:
146 An object of the form:
147
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700148 { # This resource represents a long-running operation that is the result of a network API call.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700149 &quot;done&quot;: 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700150 &quot;response&quot;: { # 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`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700151 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
152 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700153 &quot;name&quot;: &quot;A String&quot;, # 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}`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700154 &quot;error&quot;: { # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700155 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700156 &quot;message&quot;: &quot;A String&quot;, # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700157 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700158 {
159 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
160 },
161 ],
162 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700163 &quot;metadata&quot;: { # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700164 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
165 },
166 }</pre>
167</div>
168
169<div class="method">
170 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
171 <pre>Deletes a single game server cluster.
172
173Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700174 name: string, Required. The name of the game server cluster to delete, in the following form: `projects/{project}/locations/{location}/gameServerClusters/{cluster}`. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700175 x__xgafv: string, V1 error format.
176 Allowed values
177 1 - v1 error format
178 2 - v2 error format
179
180Returns:
181 An object of the form:
182
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700183 { # This resource represents a long-running operation that is the result of a network API call.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700184 &quot;done&quot;: 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700185 &quot;response&quot;: { # 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`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700186 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
187 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700188 &quot;name&quot;: &quot;A String&quot;, # 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}`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700189 &quot;error&quot;: { # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700190 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700191 &quot;message&quot;: &quot;A String&quot;, # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700192 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700193 {
194 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
195 },
196 ],
197 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700198 &quot;metadata&quot;: { # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700199 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
200 },
201 }</pre>
202</div>
203
204<div class="method">
205 <code class="details" id="get">get(name, x__xgafv=None)</code>
206 <pre>Gets details of a single game server cluster.
207
208Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700209 name: string, Required. The name of the game server cluster to retrieve, in the following form: `projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}`. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700210 x__xgafv: string, V1 error format.
211 Allowed values
212 1 - v1 error format
213 2 - v2 error format
214
215Returns:
216 An object of the form:
217
218 { # A game server cluster resource.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700219 &quot;labels&quot;: { # The labels associated with this game server cluster. Each label is a key-value pair.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700220 &quot;a_key&quot;: &quot;A String&quot;,
221 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700222 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the cluster.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700223 &quot;connectionInfo&quot;: { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700224 &quot;namespace&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700225 &quot;gkeClusterReference&quot;: { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700226 &quot;cluster&quot;: &quot;A String&quot;, # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700227 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700228 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700229 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
230 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time.
231 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
232 &quot;name&quot;: &quot;A String&quot;, # Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700233 }</pre>
234</div>
235
236<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700237 <code class="details" id="list">list(parent, pageToken=None, pageSize=None, filter=None, orderBy=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700238 <pre>Lists game server clusters in a given project and location.
239
240Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700241 parent: string, Required. The parent resource name, in the following form: &quot;projects/{project}/locations/{location}/realms/{realm}&quot;. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700242 pageToken: string, Optional. The next_page_token value returned from a previous List request, if any.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700243 pageSize: integer, Optional. The maximum number of items to return. If unspecified, the server will pick an appropriate default. The server may return fewer items than requested. A caller should only rely on response&#x27;s next_page_token to determine if there are more GameServerClusters left to be queried.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700244 filter: string, Optional. The filter to apply to list results.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700245 orderBy: string, Optional. Specifies the ordering of results following syntax at https://cloud.google.com/apis/design/design_patterns#sorting_order.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700246 x__xgafv: string, V1 error format.
247 Allowed values
248 1 - v1 error format
249 2 - v2 error format
250
251Returns:
252 An object of the form:
253
254 { # Response message for GameServerClustersService.ListGameServerClusters.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700255 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more results in the list.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700256 &quot;gameServerClusters&quot;: [ # The list of game server clusters.
257 { # A game server cluster resource.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700258 &quot;labels&quot;: { # The labels associated with this game server cluster. Each label is a key-value pair.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700259 &quot;a_key&quot;: &quot;A String&quot;,
260 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700261 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the cluster.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700262 &quot;connectionInfo&quot;: { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700263 &quot;namespace&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700264 &quot;gkeClusterReference&quot;: { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700265 &quot;cluster&quot;: &quot;A String&quot;, # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700266 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700267 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700268 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
269 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time.
270 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
271 &quot;name&quot;: &quot;A String&quot;, # Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700272 },
273 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700274 &quot;unreachable&quot;: [ # List of locations that could not be reached.
275 &quot;A String&quot;,
276 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700277 }</pre>
278</div>
279
280<div class="method">
281 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
282 <pre>Retrieves the next page of results.
283
284Args:
285 previous_request: The request for the previous page. (required)
286 previous_response: The response from the request for the previous page. (required)
287
288Returns:
289 A request object that you can call &#x27;execute()&#x27; on to request the next
290 page. Returns None if there are no more items in the collection.
291 </pre>
292</div>
293
294<div class="method">
295 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
296 <pre>Patches a single game server cluster.
297
298Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700299 name: string, Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700300 body: object, The request body.
301 The object takes the form of:
302
303{ # A game server cluster resource.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700304 &quot;labels&quot;: { # The labels associated with this game server cluster. Each label is a key-value pair.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700305 &quot;a_key&quot;: &quot;A String&quot;,
306 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700307 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the cluster.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700308 &quot;connectionInfo&quot;: { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700309 &quot;namespace&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700310 &quot;gkeClusterReference&quot;: { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700311 &quot;cluster&quot;: &quot;A String&quot;, # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700312 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700313 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700314 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
315 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time.
316 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
317 &quot;name&quot;: &quot;A String&quot;, # Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700318}
319
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700320 updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. For the `FieldMask` definition, see https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700321 x__xgafv: string, V1 error format.
322 Allowed values
323 1 - v1 error format
324 2 - v2 error format
325
326Returns:
327 An object of the form:
328
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700329 { # This resource represents a long-running operation that is the result of a network API call.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700330 &quot;done&quot;: 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700331 &quot;response&quot;: { # 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`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700332 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
333 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700334 &quot;name&quot;: &quot;A String&quot;, # 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}`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700335 &quot;error&quot;: { # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700336 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700337 &quot;message&quot;: &quot;A String&quot;, # 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700338 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700339 {
340 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
341 },
342 ],
343 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700344 &quot;metadata&quot;: { # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700345 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
346 },
347 }</pre>
348</div>
349
350<div class="method">
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700351 <code class="details" id="previewCreate">previewCreate(parent, body=None, gameServerClusterId=None, previewTime=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700352 <pre>Previews creation of a new game server cluster in a given project and location.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700353
354Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700355 parent: string, Required. The parent resource name, in the following form: `projects/{project}/locations/{location}/realms/{realm}`. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700356 body: object, The request body.
357 The object takes the form of:
358
359{ # A game server cluster resource.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700360 &quot;labels&quot;: { # The labels associated with this game server cluster. Each label is a key-value pair.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700361 &quot;a_key&quot;: &quot;A String&quot;,
362 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700363 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the cluster.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700364 &quot;connectionInfo&quot;: { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700365 &quot;namespace&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700366 &quot;gkeClusterReference&quot;: { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700367 &quot;cluster&quot;: &quot;A String&quot;, # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700368 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700369 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700370 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
371 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time.
372 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
373 &quot;name&quot;: &quot;A String&quot;, # Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700374}
375
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700376 gameServerClusterId: string, Required. The ID of the game server cluster resource to be created.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700377 previewTime: string, Optional. The target timestamp to compute the preview.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700378 x__xgafv: string, V1 error format.
379 Allowed values
380 1 - v1 error format
381 2 - v2 error format
382
383Returns:
384 An object of the form:
385
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700386 { # Response message for GameServerClustersService.PreviewCreateGameServerCluster.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700387 &quot;targetState&quot;: { # Encapsulates the Target state. # The target state.
388 &quot;details&quot;: [ # Details about Agones fleets.
389 { # Details about the Agones resources.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700390 &quot;gameServerClusterName&quot;: &quot;A String&quot;, # The game server cluster name. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700391 &quot;gameServerDeploymentName&quot;: &quot;A String&quot;, # The game server deployment name. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700392 &quot;fleetDetails&quot;: [ # Agones fleet details for game server clusters and game server deployments.
393 { # Details of the target Agones fleet.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700394 &quot;autoscaler&quot;: { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
395 &quot;specSource&quot;: { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. Details about the Agones autoscaler spec.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700396 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700397 &quot;gameServerConfigName&quot;: &quot;A String&quot;, # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700398 },
399 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones autoscaler.
400 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700401 &quot;fleet&quot;: { # Target Agones fleet specification. # Reference to target Agones fleet.
402 &quot;specSource&quot;: { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. The Agones fleet spec source.
403 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
404 &quot;gameServerConfigName&quot;: &quot;A String&quot;, # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
405 },
406 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones fleet.
407 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700408 },
409 ],
410 },
411 ],
412 },
413 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the game server cluster.
414 }</pre>
415</div>
416
417<div class="method">
418 <code class="details" id="previewDelete">previewDelete(name, previewTime=None, x__xgafv=None)</code>
419 <pre>Previews deletion of a single game server cluster.
420
421Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700422 name: string, Required. The name of the game server cluster to delete, in the following form: `projects/{project}/locations/{location}/gameServerClusters/{cluster}`. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700423 previewTime: string, Optional. The target timestamp to compute the preview.
424 x__xgafv: string, V1 error format.
425 Allowed values
426 1 - v1 error format
427 2 - v2 error format
428
429Returns:
430 An object of the form:
431
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700432 { # Response message for GameServerClustersService.PreviewDeleteGameServerCluster.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700433 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the game server cluster.
434 &quot;targetState&quot;: { # Encapsulates the Target state. # The target state.
435 &quot;details&quot;: [ # Details about Agones fleets.
436 { # Details about the Agones resources.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700437 &quot;gameServerClusterName&quot;: &quot;A String&quot;, # The game server cluster name. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700438 &quot;gameServerDeploymentName&quot;: &quot;A String&quot;, # The game server deployment name. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700439 &quot;fleetDetails&quot;: [ # Agones fleet details for game server clusters and game server deployments.
440 { # Details of the target Agones fleet.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700441 &quot;autoscaler&quot;: { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
442 &quot;specSource&quot;: { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. Details about the Agones autoscaler spec.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700443 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700444 &quot;gameServerConfigName&quot;: &quot;A String&quot;, # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700445 },
446 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones autoscaler.
447 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700448 &quot;fleet&quot;: { # Target Agones fleet specification. # Reference to target Agones fleet.
449 &quot;specSource&quot;: { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. The Agones fleet spec source.
450 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
451 &quot;gameServerConfigName&quot;: &quot;A String&quot;, # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
452 },
453 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones fleet.
454 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700455 },
456 ],
457 },
458 ],
459 },
460 }</pre>
461</div>
462
463<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700464 <code class="details" id="previewUpdate">previewUpdate(name, body=None, updateMask=None, previewTime=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700465 <pre>Previews updating a GameServerCluster.
466
467Args:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700468 name: string, Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`. (required)
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700469 body: object, The request body.
470 The object takes the form of:
471
472{ # A game server cluster resource.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700473 &quot;labels&quot;: { # The labels associated with this game server cluster. Each label is a key-value pair.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700474 &quot;a_key&quot;: &quot;A String&quot;,
475 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700476 &quot;description&quot;: &quot;A String&quot;, # Human readable description of the cluster.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700477 &quot;connectionInfo&quot;: { # The game server cluster connection information. # The game server cluster connection information. This information is used to manage game server clusters.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700478 &quot;namespace&quot;: &quot;A String&quot;, # 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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700479 &quot;gkeClusterReference&quot;: { # A reference to a GKE cluster. # Reference to the GKE cluster where the game servers are installed.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700480 &quot;cluster&quot;: &quot;A String&quot;, # The full or partial name of a GKE cluster, using one of the following forms: * `projects/{project}/locations/{location}/clusters/{cluster}` * `locations/{location}/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.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700481 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700482 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700483 &quot;updateTime&quot;: &quot;A String&quot;, # Output only. The last-modified time.
484 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The creation time.
485 &quot;etag&quot;: &quot;A String&quot;, # ETag of the resource.
486 &quot;name&quot;: &quot;A String&quot;, # Required. The resource name of the game server cluster, in the following form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`. For example, `projects/my-project/locations/{location}/realms/zanzibar/gameServerClusters/my-onprem-cluster`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700487}
488
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700489 updateMask: string, Required. Mask of fields to update. At least one path must be supplied in this field. For the `FieldMask` definition, see https: //developers.google.com/protocol-buffers // /docs/reference/google.protobuf#fieldmask
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700490 previewTime: string, Optional. The target timestamp to compute the preview.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700491 x__xgafv: string, V1 error format.
492 Allowed values
493 1 - v1 error format
494 2 - v2 error format
495
496Returns:
497 An object of the form:
498
499 { # Response message for GameServerClustersService.PreviewUpdateGameServerCluster
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700500 &quot;targetState&quot;: { # Encapsulates the Target state. # The target state.
501 &quot;details&quot;: [ # Details about Agones fleets.
502 { # Details about the Agones resources.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700503 &quot;gameServerClusterName&quot;: &quot;A String&quot;, # The game server cluster name. Uses the form: `projects/{project}/locations/{location}/realms/{realm}/gameServerClusters/{cluster}`.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700504 &quot;gameServerDeploymentName&quot;: &quot;A String&quot;, # The game server deployment name. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}`.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700505 &quot;fleetDetails&quot;: [ # Agones fleet details for game server clusters and game server deployments.
506 { # Details of the target Agones fleet.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700507 &quot;autoscaler&quot;: { # Target Agones autoscaler policy reference. # Reference to target Agones fleet autoscaling policy.
508 &quot;specSource&quot;: { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. Details about the Agones autoscaler spec.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700509 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700510 &quot;gameServerConfigName&quot;: &quot;A String&quot;, # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700511 },
512 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones autoscaler.
513 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700514 &quot;fleet&quot;: { # Target Agones fleet specification. # Reference to target Agones fleet.
515 &quot;specSource&quot;: { # Encapsulates Agones fleet spec and Agones autoscaler spec sources. # Encapsulates the source of the Agones fleet spec. The Agones fleet spec source.
516 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones leet config or Agones scaling config used to derive the Agones fleet or Agones autoscaler spec.
517 &quot;gameServerConfigName&quot;: &quot;A String&quot;, # The game server config resource. Uses the form: `projects/{project}/locations/{location}/gameServerDeployments/{deployment_id}/configs/{config_id}`.
518 },
519 &quot;name&quot;: &quot;A String&quot;, # The name of the Agones fleet.
520 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700521 },
522 ],
523 },
524 ],
525 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700526 &quot;etag&quot;: &quot;A String&quot;, # The ETag of the game server cluster.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700527 }</pre>
528</div>
529
530</body></html>