Google Cloud Container V1 Client - Class Cluster (1.17.1)

Reference documentation and code samples for the Google Cloud Container V1 Client class Cluster.

A Google Kubernetes Engine cluster.

Generated from protobuf message google.container.v1.Cluster

Namespace

Google \ Cloud \ Container \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: * Lowercase letters, numbers, and hyphens only. * Must start with a letter. * Must end with a number or a letter.

↳ description string

An optional description of this cluster.

↳ initial_node_count int

The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.

↳ node_config Google\Cloud\Container\V1\NodeConfig

Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see node_pool.config) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.

↳ master_auth Google\Cloud\Container\V1\MasterAuth

The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, username will be set to "admin", a random password will be generated, and a client certificate will be issued.

↳ logging_service string

The logging service the cluster should use to write logs. Currently available options: * logging.googleapis.com/kubernetes - The Cloud Logging service with a Kubernetes-native resource model * logging.googleapis.com - The legacy Cloud Logging service (no longer available as of GKE 1.15). * none - no logs will be exported from the cluster. If left as an empty string,logging.googleapis.com/kubernetes will be used for GKE 1.14+ or logging.googleapis.com for earlier versions.

↳ monitoring_service string

The monitoring service the cluster should use to write metrics. Currently available options: * "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model * monitoring.googleapis.com - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). * none - No metrics will be exported from the cluster. If left as an empty string,monitoring.googleapis.com/kubernetes will be used for GKE 1.14+ or monitoring.googleapis.com for earlier versions.

↳ network string

The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.

↳ cluster_ipv4_cidr string

The IP address range of the container pods in this cluster, in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8.

↳ addons_config Google\Cloud\Container\V1\AddonsConfig

Configurations for the various addons available to run in the cluster.

↳ subnetwork string

The name of the Google Compute Engine subnetwork to which the cluster is connected.

↳ node_pools array<Google\Cloud\Container\V1\NodePool>

The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

↳ locations array

The list of Google Compute Engine zones in which the cluster's nodes should be located. This field provides a default value if NodePool.Locations are not specified during node pool creation. Warning: changing cluster locations will update the NodePool.Locations of all node pools and will result in nodes being added and/or removed.

↳ enable_kubernetes_alpha bool

Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.

↳ resource_labels array|Google\Protobuf\Internal\MapField

The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

↳ label_fingerprint string

The fingerprint of the set of labels for this cluster.

↳ legacy_abac Google\Cloud\Container\V1\LegacyAbac

Configuration for the legacy ABAC authorization mode.

↳ network_policy Google\Cloud\Container\V1\NetworkPolicy

Configuration options for the NetworkPolicy feature.

↳ ip_allocation_policy Google\Cloud\Container\V1\IPAllocationPolicy

Configuration for cluster IP allocation.

↳ master_authorized_networks_config Google\Cloud\Container\V1\MasterAuthorizedNetworksConfig

The configuration options for master authorized networks feature.

↳ maintenance_policy Google\Cloud\Container\V1\MaintenancePolicy

Configure the maintenance policy for this cluster.

↳ binary_authorization Google\Cloud\Container\V1\BinaryAuthorization

Configuration for Binary Authorization.

↳ autoscaling Google\Cloud\Container\V1\ClusterAutoscaling

Cluster-level autoscaling configuration.

↳ network_config Google\Cloud\Container\V1\NetworkConfig

Configuration for cluster networking.

↳ default_max_pods_constraint Google\Cloud\Container\V1\MaxPodsConstraint

The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.

↳ resource_usage_export_config Google\Cloud\Container\V1\ResourceUsageExportConfig

Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.

↳ authenticator_groups_config Google\Cloud\Container\V1\AuthenticatorGroupsConfig

Configuration controlling RBAC group membership information.

↳ private_cluster_config Google\Cloud\Container\V1\PrivateClusterConfig

Configuration for private cluster.

↳ database_encryption Google\Cloud\Container\V1\DatabaseEncryption

Configuration of etcd encryption.

↳ vertical_pod_autoscaling Google\Cloud\Container\V1\VerticalPodAutoscaling

Cluster-level Vertical Pod Autoscaling configuration.

↳ shielded_nodes Google\Cloud\Container\V1\ShieldedNodes

Shielded Nodes configuration.

↳ release_channel Google\Cloud\Container\V1\ReleaseChannel

Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version.

↳ workload_identity_config Google\Cloud\Container\V1\WorkloadIdentityConfig

Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.

↳ mesh_certificates Google\Cloud\Container\V1\MeshCertificates

Configuration for issuance of mTLS keys and certificates to Kubernetes pods.

↳ cost_management_config Google\Cloud\Container\V1\CostManagementConfig

Configuration for the fine-grained cost management feature.

↳ notification_config Google\Cloud\Container\V1\NotificationConfig

Notification configuration of the cluster.

↳ confidential_nodes Google\Cloud\Container\V1\ConfidentialNodes

Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled.

↳ identity_service_config Google\Cloud\Container\V1\IdentityServiceConfig

Configuration for Identity Service component.

↳ self_link string

[Output only] Server-defined URL for the resource.

↳ zone string

[Output only] The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.

↳ endpoint string

[Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at https://username:password@endpoint/. See the masterAuth property of this resource for username and password information.

↳ initial_cluster_version string

The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version

↳ current_master_version string

[Output only] The current software version of the master endpoint.

↳ current_node_version string

[Output only] Deprecated, use NodePools.version instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.

↳ create_time string

[Output only] The time the cluster was created, in RFC3339 text format.

↳ status int

[Output only] The current status of this cluster.

↳ status_message string

[Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.

↳ node_ipv4_cidr_size int

[Output only] The size of the address space on each node for hosting containers. This is provisioned from within the container_ipv4_cidr range. This field will only be set when cluster is in route-based network mode.

↳ services_ipv4_cidr string

[Output only] The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the container CIDR.

↳ instance_group_urls array

Deprecated. Use node_pools.instance_group_urls.

↳ current_node_count int

[Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.

↳ expire_time string

[Output only] The time the cluster will be automatically deleted in RFC3339 text format.

↳ location string

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.

↳ enable_tpu bool

Enable the ability to use Cloud TPUs in this cluster.

↳ tpu_ipv4_cidr_block string

[Output only] The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. 1.2.3.4/29).

↳ conditions array<Google\Cloud\Container\V1\StatusCondition>

Which conditions caused the current cluster state.

↳ autopilot Google\Cloud\Container\V1\Autopilot

Autopilot configuration for the cluster.

↳ id string

Output only. Unique id for the cluster.

↳ node_pool_defaults Google\Cloud\Container\V1\NodePoolDefaults

Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.

↳ logging_config Google\Cloud\Container\V1\LoggingConfig

Logging configuration for the cluster.

↳ monitoring_config Google\Cloud\Container\V1\MonitoringConfig

Monitoring configuration for the cluster.

↳ node_pool_auto_config Google\Cloud\Container\V1\NodePoolAutoConfig

Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

↳ etag string

This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.

↳ fleet Google\Cloud\Container\V1\Fleet

Fleet information for the cluster.

↳ security_posture_config Google\Cloud\Container\V1\SecurityPostureConfig

Enable/Disable Security Posture API features for the cluster.

↳ enable_k8s_beta_apis Google\Cloud\Container\V1\K8sBetaAPIConfig

Beta APIs Config

getName

The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions:

  • Lowercase letters, numbers, and hyphens only.

  • Must start with a letter.

  • Must end with a number or a letter.
Returns
TypeDescription
string

setName

The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions:

  • Lowercase letters, numbers, and hyphens only.

  • Must start with a letter.

  • Must end with a number or a letter.
Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDescription

An optional description of this cluster.

Returns
TypeDescription
string

setDescription

An optional description of this cluster.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getInitialNodeCount

The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.

For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.

Returns
TypeDescription
int

setInitialNodeCount

The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.

For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getNodeConfig

Parameters used in creating the cluster's nodes.

For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see node_pool.config) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.

Returns
TypeDescription
Google\Cloud\Container\V1\NodeConfig|null

hasNodeConfig

clearNodeConfig

setNodeConfig

Parameters used in creating the cluster's nodes.

For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see node_pool.config) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.

Parameter
NameDescription
var Google\Cloud\Container\V1\NodeConfig
Returns
TypeDescription
$this

getMasterAuth

The authentication information for accessing the master endpoint.

If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, username will be set to "admin", a random password will be generated, and a client certificate will be issued.

Returns
TypeDescription
Google\Cloud\Container\V1\MasterAuth|null

hasMasterAuth

clearMasterAuth

setMasterAuth

The authentication information for accessing the master endpoint.

If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, username will be set to "admin", a random password will be generated, and a client certificate will be issued.

Parameter
NameDescription
var Google\Cloud\Container\V1\MasterAuth
Returns
TypeDescription
$this

getLoggingService

The logging service the cluster should use to write logs.

Currently available options:

  • logging.googleapis.com/kubernetes - The Cloud Logging service with a Kubernetes-native resource model
  • logging.googleapis.com - The legacy Cloud Logging service (no longer available as of GKE 1.15).
  • none - no logs will be exported from the cluster. If left as an empty string,logging.googleapis.com/kubernetes will be used for GKE 1.14+ or logging.googleapis.com for earlier versions.
Returns
TypeDescription
string

setLoggingService

The logging service the cluster should use to write logs.

Currently available options:

  • logging.googleapis.com/kubernetes - The Cloud Logging service with a Kubernetes-native resource model
  • logging.googleapis.com - The legacy Cloud Logging service (no longer available as of GKE 1.15).
  • none - no logs will be exported from the cluster. If left as an empty string,logging.googleapis.com/kubernetes will be used for GKE 1.14+ or logging.googleapis.com for earlier versions.
Parameter
NameDescription
var string
Returns
TypeDescription
$this

getMonitoringService

The monitoring service the cluster should use to write metrics.

Currently available options:

  • "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model
  • monitoring.googleapis.com - The legacy Cloud Monitoring service (no longer available as of GKE 1.15).
  • none - No metrics will be exported from the cluster. If left as an empty string,monitoring.googleapis.com/kubernetes will be used for GKE 1.14+ or monitoring.googleapis.com for earlier versions.
Returns
TypeDescription
string

setMonitoringService

The monitoring service the cluster should use to write metrics.

Currently available options:

  • "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model
  • monitoring.googleapis.com - The legacy Cloud Monitoring service (no longer available as of GKE 1.15).
  • none - No metrics will be exported from the cluster. If left as an empty string,monitoring.googleapis.com/kubernetes will be used for GKE 1.14+ or monitoring.googleapis.com for earlier versions.
Parameter
NameDescription
var string
Returns
TypeDescription
$this

getNetwork

The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.

Returns
TypeDescription
string

setNetwork

The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getClusterIpv4Cidr

The IP address range of the container pods in this cluster, in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8.

Returns
TypeDescription
string

setClusterIpv4Cidr

The IP address range of the container pods in this cluster, in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAddonsConfig

Configurations for the various addons available to run in the cluster.

Returns
TypeDescription
Google\Cloud\Container\V1\AddonsConfig|null

hasAddonsConfig

clearAddonsConfig

setAddonsConfig

Configurations for the various addons available to run in the cluster.

Parameter
NameDescription
var Google\Cloud\Container\V1\AddonsConfig
Returns
TypeDescription
$this

getSubnetwork

The name of the Google Compute Engine subnetwork to which the cluster is connected.

Returns
TypeDescription
string

setSubnetwork

The name of the Google Compute Engine subnetwork to which the cluster is connected.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getNodePools

The node pools associated with this cluster.

This field should not be set if "node_config" or "initial_node_count" are specified.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setNodePools

The node pools associated with this cluster.

This field should not be set if "node_config" or "initial_node_count" are specified.

Parameter
NameDescription
var array<Google\Cloud\Container\V1\NodePool>
Returns
TypeDescription
$this

getLocations

The list of Google Compute Engine zones in which the cluster's nodes should be located.

This field provides a default value if NodePool.Locations are not specified during node pool creation. Warning: changing cluster locations will update the NodePool.Locations of all node pools and will result in nodes being added and/or removed.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setLocations

The list of Google Compute Engine zones in which the cluster's nodes should be located.

This field provides a default value if NodePool.Locations are not specified during node pool creation. Warning: changing cluster locations will update the NodePool.Locations of all node pools and will result in nodes being added and/or removed.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getEnableKubernetesAlpha

Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes.

The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.

Returns
TypeDescription
bool

setEnableKubernetesAlpha

Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes.

The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getResourceLabels

The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setResourceLabels

The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getLabelFingerprint

The fingerprint of the set of labels for this cluster.

Returns
TypeDescription
string

setLabelFingerprint

The fingerprint of the set of labels for this cluster.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLegacyAbac

Configuration for the legacy ABAC authorization mode.

Returns
TypeDescription
Google\Cloud\Container\V1\LegacyAbac|null

hasLegacyAbac

clearLegacyAbac

setLegacyAbac

Configuration for the legacy ABAC authorization mode.

Parameter
NameDescription
var Google\Cloud\Container\V1\LegacyAbac
Returns
TypeDescription
$this

getNetworkPolicy

Configuration options for the NetworkPolicy feature.

Returns
TypeDescription
Google\Cloud\Container\V1\NetworkPolicy|null

hasNetworkPolicy

clearNetworkPolicy

setNetworkPolicy

Configuration options for the NetworkPolicy feature.

Parameter
NameDescription
var Google\Cloud\Container\V1\NetworkPolicy
Returns
TypeDescription
$this

getIpAllocationPolicy

Configuration for cluster IP allocation.

Returns
TypeDescription
Google\Cloud\Container\V1\IPAllocationPolicy|null

hasIpAllocationPolicy

clearIpAllocationPolicy

setIpAllocationPolicy

Configuration for cluster IP allocation.

Parameter
NameDescription
var Google\Cloud\Container\V1\IPAllocationPolicy
Returns
TypeDescription
$this

getMasterAuthorizedNetworksConfig

The configuration options for master authorized networks feature.

Returns
TypeDescription
Google\Cloud\Container\V1\MasterAuthorizedNetworksConfig|null

hasMasterAuthorizedNetworksConfig

clearMasterAuthorizedNetworksConfig

setMasterAuthorizedNetworksConfig

The configuration options for master authorized networks feature.

Parameter
NameDescription
var Google\Cloud\Container\V1\MasterAuthorizedNetworksConfig
Returns
TypeDescription
$this

getMaintenancePolicy

Configure the maintenance policy for this cluster.

Returns
TypeDescription
Google\Cloud\Container\V1\MaintenancePolicy|null

hasMaintenancePolicy

clearMaintenancePolicy

setMaintenancePolicy

Configure the maintenance policy for this cluster.

Parameter
NameDescription
var Google\Cloud\Container\V1\MaintenancePolicy
Returns
TypeDescription
$this

getBinaryAuthorization

Configuration for Binary Authorization.

Returns
TypeDescription
Google\Cloud\Container\V1\BinaryAuthorization|null

hasBinaryAuthorization

clearBinaryAuthorization

setBinaryAuthorization

Configuration for Binary Authorization.

Parameter
NameDescription
var Google\Cloud\Container\V1\BinaryAuthorization
Returns
TypeDescription
$this

getAutoscaling

Cluster-level autoscaling configuration.

Returns
TypeDescription
Google\Cloud\Container\V1\ClusterAutoscaling|null

hasAutoscaling

clearAutoscaling

setAutoscaling

Cluster-level autoscaling configuration.

Parameter
NameDescription
var Google\Cloud\Container\V1\ClusterAutoscaling
Returns
TypeDescription
$this

getNetworkConfig

Configuration for cluster networking.

Returns
TypeDescription
Google\Cloud\Container\V1\NetworkConfig|null

hasNetworkConfig

clearNetworkConfig

setNetworkConfig

Configuration for cluster networking.

Parameter
NameDescription
var Google\Cloud\Container\V1\NetworkConfig
Returns
TypeDescription
$this

getDefaultMaxPodsConstraint

The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.

Returns
TypeDescription
Google\Cloud\Container\V1\MaxPodsConstraint|null

hasDefaultMaxPodsConstraint

clearDefaultMaxPodsConstraint

setDefaultMaxPodsConstraint

The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.

Parameter
NameDescription
var Google\Cloud\Container\V1\MaxPodsConstraint
Returns
TypeDescription
$this

getResourceUsageExportConfig

Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.

Returns
TypeDescription
Google\Cloud\Container\V1\ResourceUsageExportConfig|null

hasResourceUsageExportConfig

clearResourceUsageExportConfig

setResourceUsageExportConfig

Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.

Parameter
NameDescription
var Google\Cloud\Container\V1\ResourceUsageExportConfig
Returns
TypeDescription
$this

getAuthenticatorGroupsConfig

Configuration controlling RBAC group membership information.

Returns
TypeDescription
Google\Cloud\Container\V1\AuthenticatorGroupsConfig|null

hasAuthenticatorGroupsConfig

clearAuthenticatorGroupsConfig

setAuthenticatorGroupsConfig

Configuration controlling RBAC group membership information.

Parameter
NameDescription
var Google\Cloud\Container\V1\AuthenticatorGroupsConfig
Returns
TypeDescription
$this

getPrivateClusterConfig

Configuration for private cluster.

Returns
TypeDescription
Google\Cloud\Container\V1\PrivateClusterConfig|null

hasPrivateClusterConfig

clearPrivateClusterConfig

setPrivateClusterConfig

Configuration for private cluster.

Parameter
NameDescription
var Google\Cloud\Container\V1\PrivateClusterConfig
Returns
TypeDescription
$this

getDatabaseEncryption

Configuration of etcd encryption.

Returns
TypeDescription
Google\Cloud\Container\V1\DatabaseEncryption|null

hasDatabaseEncryption

clearDatabaseEncryption

setDatabaseEncryption

Configuration of etcd encryption.

Parameter
NameDescription
var Google\Cloud\Container\V1\DatabaseEncryption
Returns
TypeDescription
$this

getVerticalPodAutoscaling

Cluster-level Vertical Pod Autoscaling configuration.

Returns
TypeDescription
Google\Cloud\Container\V1\VerticalPodAutoscaling|null

hasVerticalPodAutoscaling

clearVerticalPodAutoscaling

setVerticalPodAutoscaling

Cluster-level Vertical Pod Autoscaling configuration.

Parameter
NameDescription
var Google\Cloud\Container\V1\VerticalPodAutoscaling
Returns
TypeDescription
$this

getShieldedNodes

Shielded Nodes configuration.

Returns
TypeDescription
Google\Cloud\Container\V1\ShieldedNodes|null

hasShieldedNodes

clearShieldedNodes

setShieldedNodes

Shielded Nodes configuration.

Parameter
NameDescription
var Google\Cloud\Container\V1\ShieldedNodes
Returns
TypeDescription
$this

getReleaseChannel

Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version.

Returns
TypeDescription
Google\Cloud\Container\V1\ReleaseChannel|null

hasReleaseChannel

clearReleaseChannel

setReleaseChannel

Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version.

Parameter
NameDescription
var Google\Cloud\Container\V1\ReleaseChannel
Returns
TypeDescription
$this

getWorkloadIdentityConfig

Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.

Returns
TypeDescription
Google\Cloud\Container\V1\WorkloadIdentityConfig|null

hasWorkloadIdentityConfig

clearWorkloadIdentityConfig

setWorkloadIdentityConfig

Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.

Parameter
NameDescription
var Google\Cloud\Container\V1\WorkloadIdentityConfig
Returns
TypeDescription
$this

getMeshCertificates

Configuration for issuance of mTLS keys and certificates to Kubernetes pods.

Returns
TypeDescription
Google\Cloud\Container\V1\MeshCertificates|null

hasMeshCertificates

clearMeshCertificates

setMeshCertificates

Configuration for issuance of mTLS keys and certificates to Kubernetes pods.

Parameter
NameDescription
var Google\Cloud\Container\V1\MeshCertificates
Returns
TypeDescription
$this

getCostManagementConfig

Configuration for the fine-grained cost management feature.

Returns
TypeDescription
Google\Cloud\Container\V1\CostManagementConfig|null

hasCostManagementConfig

clearCostManagementConfig

setCostManagementConfig

Configuration for the fine-grained cost management feature.

Parameter
NameDescription
var Google\Cloud\Container\V1\CostManagementConfig
Returns
TypeDescription
$this

getNotificationConfig

Notification configuration of the cluster.

Returns
TypeDescription
Google\Cloud\Container\V1\NotificationConfig|null

hasNotificationConfig

clearNotificationConfig

setNotificationConfig

Notification configuration of the cluster.

Parameter
NameDescription
var Google\Cloud\Container\V1\NotificationConfig
Returns
TypeDescription
$this

getConfidentialNodes

Configuration of Confidential Nodes.

All the nodes in the cluster will be Confidential VM once enabled.

Returns
TypeDescription
Google\Cloud\Container\V1\ConfidentialNodes|null

hasConfidentialNodes

clearConfidentialNodes

setConfidentialNodes

Configuration of Confidential Nodes.

All the nodes in the cluster will be Confidential VM once enabled.

Parameter
NameDescription
var Google\Cloud\Container\V1\ConfidentialNodes
Returns
TypeDescription
$this

getIdentityServiceConfig

Configuration for Identity Service component.

Returns
TypeDescription
Google\Cloud\Container\V1\IdentityServiceConfig|null

hasIdentityServiceConfig

clearIdentityServiceConfig

setIdentityServiceConfig

Configuration for Identity Service component.

Parameter
NameDescription
var Google\Cloud\Container\V1\IdentityServiceConfig
Returns
TypeDescription
$this

[Output only] Server-defined URL for the resource.

Returns
TypeDescription
string

[Output only] Server-defined URL for the resource.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getZone

[Output only] The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.

Returns
TypeDescription
string

setZone

[Output only] The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEndpoint

[Output only] The IP address of this cluster's master endpoint.

The endpoint can be accessed from the internet at https://username:password@endpoint/. See the masterAuth property of this resource for username and password information.

Returns
TypeDescription
string

setEndpoint

[Output only] The IP address of this cluster's master endpoint.

The endpoint can be accessed from the internet at https://username:password@endpoint/. See the masterAuth property of this resource for username and password information.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getInitialClusterVersion

The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion.

Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:

  • "latest": picks the highest valid Kubernetes version
  • "1.X": picks the highest valid patch+gke.N patch in the 1.X version
  • "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
  • "1.X.Y-gke.N": picks an explicit Kubernetes version
  • "","-": picks the default Kubernetes version
Returns
TypeDescription
string

setInitialClusterVersion

The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion.

Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:

  • "latest": picks the highest valid Kubernetes version
  • "1.X": picks the highest valid patch+gke.N patch in the 1.X version
  • "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version
  • "1.X.Y-gke.N": picks an explicit Kubernetes version
  • "","-": picks the default Kubernetes version
Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCurrentMasterVersion

[Output only] The current software version of the master endpoint.

Returns
TypeDescription
string

setCurrentMasterVersion

[Output only] The current software version of the master endpoint.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCurrentNodeVersion

[Output only] Deprecated, use NodePools.version instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.

Returns
TypeDescription
string

setCurrentNodeVersion

[Output only] Deprecated, use NodePools.version instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getCreateTime

[Output only] The time the cluster was created, in RFC3339 text format.

Returns
TypeDescription
string

setCreateTime

[Output only] The time the cluster was created, in RFC3339 text format.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getStatus

[Output only] The current status of this cluster.

Returns
TypeDescription
int

setStatus

[Output only] The current status of this cluster.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getStatusMessage

[Output only] Deprecated. Use conditions instead.

Additional information about the current status of this cluster, if available.

Returns
TypeDescription
string

setStatusMessage

[Output only] Deprecated. Use conditions instead.

Additional information about the current status of this cluster, if available.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getNodeIpv4CidrSize

[Output only] The size of the address space on each node for hosting containers. This is provisioned from within the container_ipv4_cidr range. This field will only be set when cluster is in route-based network mode.

Returns
TypeDescription
int

setNodeIpv4CidrSize

[Output only] The size of the address space on each node for hosting containers. This is provisioned from within the container_ipv4_cidr range. This field will only be set when cluster is in route-based network mode.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getServicesIpv4Cidr

[Output only] The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the container CIDR.

Returns
TypeDescription
string

setServicesIpv4Cidr

[Output only] The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the container CIDR.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getInstanceGroupUrls

Deprecated. Use node_pools.instance_group_urls.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setInstanceGroupUrls

Deprecated. Use node_pools.instance_group_urls.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getCurrentNodeCount

[Output only] The number of nodes currently in the cluster. Deprecated.

Call Kubernetes API directly to retrieve node information.

Returns
TypeDescription
int

setCurrentNodeCount

[Output only] The number of nodes currently in the cluster. Deprecated.

Call Kubernetes API directly to retrieve node information.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getExpireTime

[Output only] The time the cluster will be automatically deleted in RFC3339 text format.

Returns
TypeDescription
string

setExpireTime

[Output only] The time the cluster will be automatically deleted in RFC3339 text format.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLocation

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.

Returns
TypeDescription
string

setLocation

[Output only] The name of the Google Compute Engine zone or region in which the cluster resides.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getEnableTpu

Enable the ability to use Cloud TPUs in this cluster.

Returns
TypeDescription
bool

setEnableTpu

Enable the ability to use Cloud TPUs in this cluster.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getTpuIpv4CidrBlock

[Output only] The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. 1.2.3.4/29).

Returns
TypeDescription
string

setTpuIpv4CidrBlock

[Output only] The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. 1.2.3.4/29).

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getConditions

Which conditions caused the current cluster state.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setConditions

Which conditions caused the current cluster state.

Parameter
NameDescription
var array<Google\Cloud\Container\V1\StatusCondition>
Returns
TypeDescription
$this

getAutopilot

Autopilot configuration for the cluster.

Returns
TypeDescription
Google\Cloud\Container\V1\Autopilot|null

hasAutopilot

clearAutopilot

setAutopilot

Autopilot configuration for the cluster.

Parameter
NameDescription
var Google\Cloud\Container\V1\Autopilot
Returns
TypeDescription
$this

getId

Output only. Unique id for the cluster.

Returns
TypeDescription
string

setId

Output only. Unique id for the cluster.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getNodePoolDefaults

Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.

Returns
TypeDescription
Google\Cloud\Container\V1\NodePoolDefaults|null

hasNodePoolDefaults

clearNodePoolDefaults

setNodePoolDefaults

Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.

Parameter
NameDescription
var Google\Cloud\Container\V1\NodePoolDefaults
Returns
TypeDescription
$this

getLoggingConfig

Logging configuration for the cluster.

Returns
TypeDescription
Google\Cloud\Container\V1\LoggingConfig|null

hasLoggingConfig

clearLoggingConfig

setLoggingConfig

Logging configuration for the cluster.

Parameter
NameDescription
var Google\Cloud\Container\V1\LoggingConfig
Returns
TypeDescription
$this

getMonitoringConfig

Monitoring configuration for the cluster.

Returns
TypeDescription
Google\Cloud\Container\V1\MonitoringConfig|null

hasMonitoringConfig

clearMonitoringConfig

setMonitoringConfig

Monitoring configuration for the cluster.

Parameter
NameDescription
var Google\Cloud\Container\V1\MonitoringConfig
Returns
TypeDescription
$this

getNodePoolAutoConfig

Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

Returns
TypeDescription
Google\Cloud\Container\V1\NodePoolAutoConfig|null

hasNodePoolAutoConfig

clearNodePoolAutoConfig

setNodePoolAutoConfig

Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

Parameter
NameDescription
var Google\Cloud\Container\V1\NodePoolAutoConfig
Returns
TypeDescription
$this

getEtag

This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.

Returns
TypeDescription
string

setEtag

This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFleet

Fleet information for the cluster.

Returns
TypeDescription
Google\Cloud\Container\V1\Fleet|null

hasFleet

clearFleet

setFleet

Fleet information for the cluster.

Parameter
NameDescription
var Google\Cloud\Container\V1\Fleet
Returns
TypeDescription
$this

getSecurityPostureConfig

Enable/Disable Security Posture API features for the cluster.

Returns
TypeDescription
Google\Cloud\Container\V1\SecurityPostureConfig|null

hasSecurityPostureConfig

clearSecurityPostureConfig

setSecurityPostureConfig

Enable/Disable Security Posture API features for the cluster.

Parameter
NameDescription
var Google\Cloud\Container\V1\SecurityPostureConfig
Returns
TypeDescription
$this

getEnableK8SBetaApis

Beta APIs Config

Returns
TypeDescription
Google\Cloud\Container\V1\K8sBetaAPIConfig|null

hasEnableK8SBetaApis

clearEnableK8SBetaApis

setEnableK8SBetaApis

Beta APIs Config

Parameter
NameDescription
var Google\Cloud\Container\V1\K8sBetaAPIConfig
Returns
TypeDescription
$this