Reference documentation and code samples for the Google Cloud Game Servers V1 Client class KubernetesClusterState.
The state of the Kubernetes cluster.
Generated from protobuf messagegoogle.cloud.gaming.v1.KubernetesClusterState
Namespace
Google \ Cloud \ Gaming \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ agones_version_installed
string
Output only. The version of Agones currently installed in the registered Kubernetes cluster.
↳ kubernetes_version_installed
string
Output only. The version of Kubernetes that is currently used in the registered Kubernetes cluster (as detected by the Cloud Game Servers service).
↳ installation_state
int
Output only. The state for the installed versions of Agones/Kubernetes.
↳ version_installed_error_message
string
Output only. The detailed error message for the installed versions of Agones/Kubernetes.
↳ provider
string
Output only. The cloud provider type reported by the first node's providerID in the list of nodes on the Kubernetes endpoint. On Kubernetes platforms that support zero-node clusters (like GKE-on-GCP), the provider type will be empty.
↳ agones_version_targeted
string
Output only. The version of Agones that is targeted to be installed in the cluster.
getAgonesVersionInstalled
Output only. The version of Agones currently installed in the registered Kubernetes
cluster.
Returns
Type
Description
string
setAgonesVersionInstalled
Output only. The version of Agones currently installed in the registered Kubernetes
cluster.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getKubernetesVersionInstalled
Output only. The version of Kubernetes that is currently used in the registered
Kubernetes cluster (as detected by the Cloud Game Servers service).
Returns
Type
Description
string
setKubernetesVersionInstalled
Output only. The version of Kubernetes that is currently used in the registered
Kubernetes cluster (as detected by the Cloud Game Servers service).
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getInstallationState
Output only. The state for the installed versions of Agones/Kubernetes.
Returns
Type
Description
int
setInstallationState
Output only. The state for the installed versions of Agones/Kubernetes.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getVersionInstalledErrorMessage
Output only. The detailed error message for the installed versions of Agones/Kubernetes.
Returns
Type
Description
string
setVersionInstalledErrorMessage
Output only. The detailed error message for the installed versions of Agones/Kubernetes.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getProvider
Output only. The cloud provider type reported by the first node's providerID in the list
of nodes on the Kubernetes endpoint. On Kubernetes platforms that support
zero-node clusters (like GKE-on-GCP), the provider type will be empty.
Returns
Type
Description
string
setProvider
Output only. The cloud provider type reported by the first node's providerID in the list
of nodes on the Kubernetes endpoint. On Kubernetes platforms that support
zero-node clusters (like GKE-on-GCP), the provider type will be empty.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getAgonesVersionTargeted
Output only. The version of Agones that is targeted to be installed in the cluster.
Returns
Type
Description
string
setAgonesVersionTargeted
Output only. The version of Agones that is targeted to be installed in the cluster.
[[["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 KubernetesClusterState (1.2.6)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.6 (latest)](/php/docs/reference/cloud-game-servers/latest/V1.KubernetesClusterState)\n- [1.2.5](/php/docs/reference/cloud-game-servers/1.2.5/V1.KubernetesClusterState)\n- [1.1.1](/php/docs/reference/cloud-game-servers/1.1.1/V1.KubernetesClusterState)\n- [1.0.5](/php/docs/reference/cloud-game-servers/1.0.5/V1.KubernetesClusterState) \nReference documentation and code samples for the Google Cloud Game Servers V1 Client class KubernetesClusterState.\n\nThe state of the Kubernetes cluster.\n\nGenerated from protobuf message `google.cloud.gaming.v1.KubernetesClusterState`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Gaming \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getAgonesVersionInstalled\n\nOutput only. The version of Agones currently installed in the registered Kubernetes\ncluster.\n\n### setAgonesVersionInstalled\n\nOutput only. The version of Agones currently installed in the registered Kubernetes\ncluster.\n\n### getKubernetesVersionInstalled\n\nOutput only. The version of Kubernetes that is currently used in the registered\nKubernetes cluster (as detected by the Cloud Game Servers service).\n\n### setKubernetesVersionInstalled\n\nOutput only. The version of Kubernetes that is currently used in the registered\nKubernetes cluster (as detected by the Cloud Game Servers service).\n\n### getInstallationState\n\nOutput only. The state for the installed versions of Agones/Kubernetes.\n\n### setInstallationState\n\nOutput only. The state for the installed versions of Agones/Kubernetes.\n\n### getVersionInstalledErrorMessage\n\nOutput only. The detailed error message for the installed versions of Agones/Kubernetes.\n\n### setVersionInstalledErrorMessage\n\nOutput only. The detailed error message for the installed versions of Agones/Kubernetes.\n\n### getProvider\n\nOutput only. The cloud provider type reported by the first node's providerID in the list\nof nodes on the Kubernetes endpoint. On Kubernetes platforms that support\nzero-node clusters (like GKE-on-GCP), the provider type will be empty.\n\n### setProvider\n\nOutput only. The cloud provider type reported by the first node's providerID in the list\nof nodes on the Kubernetes endpoint. On Kubernetes platforms that support\nzero-node clusters (like GKE-on-GCP), the provider type will be empty.\n\n### getAgonesVersionTargeted\n\nOutput only. The version of Agones that is targeted to be installed in the cluster.\n\n### setAgonesVersionTargeted\n\nOutput only. The version of Agones that is targeted to be installed in the cluster."]]
