Reference documentation and code samples for the Google Cloud Game Servers V1 Client class GetGameServerClusterRequest.
Request message for GameServerClustersService.GetGameServerCluster.
Generated from protobuf message google.cloud.gaming.v1.GetGameServerClusterRequest
Namespace
Google \ Cloud \ Gaming \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ 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}.
↳ view
int
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.
getName
Required. The name of the game server cluster to retrieve, in the following form:
projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}.
Returns
Type
Description
string
setName
Required. The name of the game server cluster to retrieve, in the following form:
projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getView
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.
Returns
Type
Description
int
setView
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Game Servers V1 Client - Class GetGameServerClusterRequest (1.2.6)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.6 (latest)](/php/docs/reference/cloud-game-servers/latest/V1.GetGameServerClusterRequest)\n- [1.2.5](/php/docs/reference/cloud-game-servers/1.2.5/V1.GetGameServerClusterRequest)\n- [1.1.1](/php/docs/reference/cloud-game-servers/1.1.1/V1.GetGameServerClusterRequest)\n- [1.0.5](/php/docs/reference/cloud-game-servers/1.0.5/V1.GetGameServerClusterRequest) \nReference documentation and code samples for the Google Cloud Game Servers V1 Client class GetGameServerClusterRequest.\n\nRequest message for GameServerClustersService.GetGameServerCluster.\n\nGenerated from protobuf message `google.cloud.gaming.v1.GetGameServerClusterRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Gaming \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nRequired. The name of the game server cluster to retrieve, in the following form:\n`projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}`.\n\n### setName\n\nRequired. The name of the game server cluster to retrieve, in the following form:\n`projects/{project}/locations/{location}/realms/{realm-id}/gameServerClusters/{cluster}`.\n\n### getView\n\nOptional. View for the returned GameServerCluster objects. When `FULL` is\nspecified, the `cluster_state` field is also returned in the\nGameServerCluster object, which includes the state of the referenced\nKubernetes cluster such as versions and provider info. The default/unset\nvalue is GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED, same as BASIC, which does\nnot return the `cluster_state` field.\n\n### setView\n\nOptional. View for the returned GameServerCluster objects. When `FULL` is\nspecified, the `cluster_state` field is also returned in the\nGameServerCluster object, which includes the state of the referenced\nKubernetes cluster such as versions and provider info. The default/unset\nvalue is GAME_SERVER_CLUSTER_VIEW_UNSPECIFIED, same as BASIC, which does\nnot return the `cluster_state` field.\n\n### static::build"]]
