REST Resource: projects.locations.realms.gameServerClusters

Resource: GameServerCluster

A game server cluster resource.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "connectionInfo": {
    object (GameServerClusterConnectionInfo)
  },
  "etag": string,
  "description": string
}
Fields
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.

createTime

string (Timestamp format)

Output only. The creation time.

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".

updateTime

string (Timestamp format)

Output only. The last-modified time.

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".

labels

map (key: string, value: string)

The labels associated with this game server cluster. Each label is a key-value pair.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

connectionInfo

object (GameServerClusterConnectionInfo)

The game server cluster connection information. This information is used to manage game server clusters.

etag

string

ETag of the resource.

description

string

Human readable description of the cluster.

GameServerClusterConnectionInfo

The game server cluster connection information.

JSON representation
{
  "namespace": string,
  "gkeClusterReference": {
    object (GkeClusterReference)
  }
}
Fields
namespace

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.

gkeClusterReference

object (GkeClusterReference)

Reference to the GKE cluster where the game servers are installed.

GkeClusterReference

A reference to a GKE cluster.

JSON representation
{
  "cluster": string
}
Fields
cluster

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.

Methods

create

Creates a new game server cluster in a given project and location.

delete

Deletes a single game server cluster.

get

Gets details of a single game server cluster.

list

Lists game server clusters in a given project and location.

patch

Patches a single game server cluster.

previewCreate

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

previewDelete

Previews deletion of a single game server cluster.

previewUpdate

Previews updating a GameServerCluster.