1. class
  2. Google
  3. \
  4. Service
  5. \
  6. GameServices
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsRealmsGameServerClusters

ProjectsLocationsRealmsGameServerClusters

class ProjectsLocationsRealmsGameServerClusters extends Resource (View source)

The "gameServerClusters" collection of methods.

Typical usage is:

 $gameservicesService = new Google\Service\GameServices(...);
 $gameServerClusters = $gameservicesService->gameServerClusters;

Methods

Operation
create(string $parent, GameServerCluster $postBody, array $optParams = [])

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

Operation
delete(string $name, array $optParams = [])

Deletes a single game server cluster. (gameServerClusters.delete)

GameServerCluster
get(string $name, array $optParams = [])

Gets details of a single game server cluster. (gameServerClusters.get)

ListGameServerClustersResponse
listProjectsLocationsRealmsGameServerClusters(string $parent, array $optParams = [])

Lists game server clusters in a given project and location.

Operation
patch(string $name, GameServerCluster $postBody, array $optParams = [])

Patches a single game server cluster. (gameServerClusters.patch)

PreviewCreateGameServerClusterResponse
previewCreate(string $parent, GameServerCluster $postBody, array $optParams = [])

Previews creation of a new game server cluster in a given project and location. (gameServerClusters.previewCreate)

PreviewDeleteGameServerClusterResponse
previewDelete(string $name, array $optParams = [])

Previews deletion of a single game server cluster.

PreviewUpdateGameServerClusterResponse
previewUpdate(string $name, GameServerCluster $postBody, array $optParams = [])

Previews updating a GameServerCluster. (gameServerClusters.previewUpdate)

Details

at line 50
Operation create(string $parent, GameServerCluster $postBody, array $optParams = [])

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

(gameServerClusters.create)

Parameters

string $parent

Required. The parent resource name, in the following form: projects/{project}/locations/{locationId}/realms/{realmId}.
GameServerCluster $postBody
array $optParams

Optional parameters.

Return Value

Operation

at line 65
Operation delete(string $name, array $optParams = [])

Deletes a single game server cluster. (gameServerClusters.delete)

Parameters

string $name

Required. The name of the game server cluster to delete, in the following form: projects/{project}/locations/{locationId}/gameServerC lusters/{gameServerClusterId}.
array $optParams

Optional parameters.

Return Value

Operation

at line 87
GameServerCluster get(string $name, array $optParams = [])

Gets details of a single game server cluster. (gameServerClusters.get)

Parameters

string $name

Required. The name of the game server cluster to retrieve, in the following form: projects/{project}/locations/{locationId}/r ealms/{realmId}/gameServerClusters/{gameServerClusterId}.
array $optParams

Optional parameters.

Return Value

GameServerCluster

at line 121
ListGameServerClustersResponse listProjectsLocationsRealmsGameServerClusters(string $parent, array $optParams = [])

Lists game server clusters in a given project and location.

(gameServerClusters.listProjectsLocationsRealmsGameServerClusters)

Parameters

string $parent

Required. The parent resource name, in the following form: projects/{project}/locations/{locationId}/realms/{realmId}.
array $optParams

Optional parameters.

Return Value

ListGameServerClustersResponse

at line 143
Operation patch(string $name, GameServerCluster $postBody, array $optParams = [])

Patches a single game server cluster. (gameServerClusters.patch)

Parameters

string $name

Required. The resource name of the game server cluster, in the following form: projects/{project}/locations/{locationId}/realms/{rea lmId}/gameServerClusters/{gameServerClusterId}. For example, projects/my- project/locations/global/realms/zanzibar/gameServerClusters/my-gke-cluster.
GameServerCluster $postBody
array $optParams

Optional parameters.

Return Value

Operation

at line 166
PreviewCreateGameServerClusterResponse previewCreate(string $parent, GameServerCluster $postBody, array $optParams = [])

Previews creation of a new game server cluster in a given project and location. (gameServerClusters.previewCreate)

Parameters

string $parent

Required. The parent resource name, in the following form: projects/{project}/locations/{locationId}/realms/{realmId}.
GameServerCluster $postBody
array $optParams

Optional parameters.

Return Value

PreviewCreateGameServerClusterResponse

at line 185
PreviewDeleteGameServerClusterResponse previewDelete(string $name, array $optParams = [])

Previews deletion of a single game server cluster.

(gameServerClusters.previewDelete)

Parameters

string $name

Required. The name of the game server cluster to delete, in the following form: projects/{project}/locations/{locationId}/gameServerC lusters/{gameServerClusterId}.
array $optParams

Optional parameters.

Return Value

PreviewDeleteGameServerClusterResponse

at line 209
PreviewUpdateGameServerClusterResponse previewUpdate(string $name, GameServerCluster $postBody, array $optParams = [])

Previews updating a GameServerCluster. (gameServerClusters.previewUpdate)

Parameters

string $name

Required. The resource name of the game server cluster, in the following form: projects/{project}/locations/{locationId}/realms/{rea lmId}/gameServerClusters/{gameServerClusterId}. For example, projects/my- project/locations/global/realms/zanzibar/gameServerClusters/my-gke-cluster.
GameServerCluster $postBody
array $optParams

Optional parameters.

Return Value

PreviewUpdateGameServerClusterResponse