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 \ V1Methods
__construct
Constructor.
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}
.
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}
.
var
string
$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.
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.
var
int
$this
static::build
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}
. Please see Google\Cloud\Gaming\V1\GameServerClustersServiceClient::gameServerClusterName()
for help formatting this field.
