Google Cloud Game Servers V1 Client - Class KubernetesClusterState (1.0.5)

Reference documentation and code samples for the Google Cloud Game Servers V1 Client class KubernetesClusterState.

The state of the Kubernetes cluster.

Generated from protobuf message google.cloud.gaming.v1.KubernetesClusterState

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
string

setAgonesVersionInstalled

Output only. The version of Agones currently installed in the registered Kubernetes cluster.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getInstallationState

Output only. The state for the installed versions of Agones/Kubernetes.

Returns
TypeDescription
int

setInstallationState

Output only. The state for the installed versions of Agones/Kubernetes.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getVersionInstalledErrorMessage

Output only. The detailed error message for the installed versions of Agones/Kubernetes.

Returns
TypeDescription
string

setVersionInstalledErrorMessage

Output only. The detailed error message for the installed versions of Agones/Kubernetes.

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getAgonesVersionTargeted

Output only. The version of Agones that is targeted to be installed in the cluster.

Returns
TypeDescription
string

setAgonesVersionTargeted

Output only. The version of Agones that is targeted to be installed in the cluster.

Parameter
NameDescription
var string
Returns
TypeDescription
$this