Google Cloud Game Servers V1 Client - Class GetGameServerClusterRequest (1.2.6)

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.

Parameter
Name Description
var int
Returns
Type Description
$this

static::build

Parameter
Name Description
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.
Returns
Type Description
Google\Cloud\Gaming\V1\GetGameServerClusterRequest