Method: projects.locations.realms.gameServerClusters.previewCreate

Previews creation of a new game server cluster in a given project and location.

HTTP request

POST https://gameservices.googleapis.com/v1beta/{parent=projects/*/locations/*/realms/*}/gameServerClusters:previewCreate

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent resource name, in the following form: projects/{project}/locations/{location}/realms/{realm}.

Query parameters

Parameters
gameServerClusterId

string

Required. The ID of the game server cluster resource to be created.

previewTime

string (Timestamp format)

Optional. The target timestamp to compute the preview.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

view
(deprecated)

enum (GameServerClusterView)

Optional. This field is deprecated, preview will always return KubernetesClusterState.

Request body

The request body contains an instance of GameServerCluster.

Response body

If successful, the response body contains data with the following structure:

Response message for GameServerClustersService.PreviewCreateGameServerCluster.

JSON representation
{
  "etag": string,
  "targetState": {
    object (TargetState)
  },
  "clusterState": {
    object (KubernetesClusterState)
  }
}
Fields
etag

string

The ETag of the game server cluster.

targetState

object (TargetState)

The target state.

clusterState

object (KubernetesClusterState)

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.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.