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