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
Methods
__construct
Constructor.
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
↳ 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
↳ network_policy
↳ ip_allocation_policy
↳ master_authorized_networks_config
Google\Cloud\Container\V1\MasterAuthorizedNetworksConfig
The configuration options for master authorized networks feature.
↳ maintenance_policy
↳ binary_authorization
↳ autoscaling
↳ network_config
↳ 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
↳ database_encryption
↳ vertical_pod_autoscaling
Google\Cloud\Container\V1\VerticalPodAutoscaling
Cluster-level Vertical Pod Autoscaling configuration.
↳ shielded_nodes
↳ release_channel
↳ 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
↳ 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
↳ 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
↳ 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
↳ location
↳ 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
↳ 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
↳ monitoring_config
↳ 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
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.
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.
var
string
$this
getDescription
An optional description of this cluster.
string
setDescription
An optional description of this cluster.
var
string
$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.
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.
var
int
$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.
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.
$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.
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.
$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/kuberneteswill be used for GKE 1.14+ orlogging.googleapis.comfor earlier versions.
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/kuberneteswill be used for GKE 1.14+ orlogging.googleapis.comfor earlier versions.
var
string
$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/kuberneteswill be used for GKE 1.14+ ormonitoring.googleapis.comfor earlier versions.
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/kuberneteswill be used for GKE 1.14+ ormonitoring.googleapis.comfor earlier versions.
var
string
$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.
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.
var
string
$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
.
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
.
var
string
$this
getAddonsConfig
Configurations for the various addons available to run in the cluster.
hasAddonsConfig
clearAddonsConfig
setAddonsConfig
Configurations for the various addons available to run in the cluster.
$this
getSubnetwork
The name of the Google Compute Engine subnetwork to which the cluster is connected.
string
setSubnetwork
The name of the Google Compute Engine subnetwork to which the cluster is connected.
var
string
$this
getNodePools
The node pools associated with this cluster.
This field should not be set if "node_config" or "initial_node_count" are specified.
setNodePools
The node pools associated with this cluster.
This field should not be set if "node_config" or "initial_node_count" are specified.
$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.
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.
var
string[]
$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.
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.
var
bool
$this
getResourceLabels
The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
setResourceLabels
The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
$this
getLabelFingerprint
The fingerprint of the set of labels for this cluster.
string
setLabelFingerprint
The fingerprint of the set of labels for this cluster.
var
string
$this
getLegacyAbac
Configuration for the legacy ABAC authorization mode.
hasLegacyAbac
clearLegacyAbac
setLegacyAbac
Configuration for the legacy ABAC authorization mode.
$this
getNetworkPolicy
Configuration options for the NetworkPolicy feature.
hasNetworkPolicy
clearNetworkPolicy
setNetworkPolicy
Configuration options for the NetworkPolicy feature.
$this
getIpAllocationPolicy
Configuration for cluster IP allocation.
hasIpAllocationPolicy
clearIpAllocationPolicy
setIpAllocationPolicy
Configuration for cluster IP allocation.
$this
getMasterAuthorizedNetworksConfig
The configuration options for master authorized networks feature.
hasMasterAuthorizedNetworksConfig
clearMasterAuthorizedNetworksConfig
setMasterAuthorizedNetworksConfig
The configuration options for master authorized networks feature.
$this
getMaintenancePolicy
Configure the maintenance policy for this cluster.
hasMaintenancePolicy
clearMaintenancePolicy
setMaintenancePolicy
Configure the maintenance policy for this cluster.
$this
getBinaryAuthorization
Configuration for Binary Authorization.
hasBinaryAuthorization
clearBinaryAuthorization
setBinaryAuthorization
Configuration for Binary Authorization.
$this
getAutoscaling
Cluster-level autoscaling configuration.
hasAutoscaling
clearAutoscaling
setAutoscaling
Cluster-level autoscaling configuration.
$this
getNetworkConfig
Configuration for cluster networking.
hasNetworkConfig
clearNetworkConfig
setNetworkConfig
Configuration for cluster networking.
$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.
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.
$this
getResourceUsageExportConfig
Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.
hasResourceUsageExportConfig
clearResourceUsageExportConfig
setResourceUsageExportConfig
Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.
$this
getAuthenticatorGroupsConfig
Configuration controlling RBAC group membership information.
hasAuthenticatorGroupsConfig
clearAuthenticatorGroupsConfig
setAuthenticatorGroupsConfig
Configuration controlling RBAC group membership information.
$this
getPrivateClusterConfig
Configuration for private cluster.
hasPrivateClusterConfig
clearPrivateClusterConfig
setPrivateClusterConfig
Configuration for private cluster.
$this
getDatabaseEncryption
Configuration of etcd encryption.
hasDatabaseEncryption
clearDatabaseEncryption
setDatabaseEncryption
Configuration of etcd encryption.
$this
getVerticalPodAutoscaling
Cluster-level Vertical Pod Autoscaling configuration.
hasVerticalPodAutoscaling
clearVerticalPodAutoscaling
setVerticalPodAutoscaling
Cluster-level Vertical Pod Autoscaling configuration.
$this
getShieldedNodes
Shielded Nodes configuration.
hasShieldedNodes
clearShieldedNodes
setShieldedNodes
Shielded Nodes configuration.
$this
getReleaseChannel
Release channel configuration.
hasReleaseChannel
clearReleaseChannel
setReleaseChannel
Release channel configuration.
$this
getWorkloadIdentityConfig
Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.
hasWorkloadIdentityConfig
clearWorkloadIdentityConfig
setWorkloadIdentityConfig
Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.
$this
getMeshCertificates
Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
hasMeshCertificates
clearMeshCertificates
setMeshCertificates
Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
$this
getCostManagementConfig
Configuration for the fine-grained cost management feature.
hasCostManagementConfig
clearCostManagementConfig
setCostManagementConfig
Configuration for the fine-grained cost management feature.
$this
getNotificationConfig
Notification configuration of the cluster.
hasNotificationConfig
clearNotificationConfig
setNotificationConfig
Notification configuration of the cluster.
$this
getConfidentialNodes
Configuration of Confidential Nodes.
All the nodes in the cluster will be Confidential VM once enabled.
hasConfidentialNodes
clearConfidentialNodes
setConfidentialNodes
Configuration of Confidential Nodes.
All the nodes in the cluster will be Confidential VM once enabled.
$this
getIdentityServiceConfig
Configuration for Identity Service component.
hasIdentityServiceConfig
clearIdentityServiceConfig
setIdentityServiceConfig
Configuration for Identity Service component.
$this
getSelfLink
[Output only] Server-defined URL for the resource.
string
setSelfLink
[Output only] Server-defined URL for the resource.
var
string
$this
getZone
[Output only] The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.
string
setZone
[Output only] The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.
var
string
$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.
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.
var
string
$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
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
var
string
$this
getCurrentMasterVersion
[Output only] The current software version of the master endpoint.
string
setCurrentMasterVersion
[Output only] The current software version of the master endpoint.
var
string
$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.
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.
var
string
$this
getCreateTime
[Output only] The time the cluster was created, in RFC3339 text format.
string
setCreateTime
[Output only] The time the cluster was created, in RFC3339 text format.
var
string
$this
getStatus
[Output only] The current status of this cluster.
int
setStatus
[Output only] The current status of this cluster.
var
int
$this
getStatusMessage
[Output only] Deprecated. Use conditions instead.
Additional information about the current status of this cluster, if available.
string
setStatusMessage
[Output only] Deprecated. Use conditions instead.
Additional information about the current status of this cluster, if available.
var
string
$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.
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.
var
int
$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.
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.
var
string
$this
getInstanceGroupUrls
Deprecated. Use node_pools.instance_group_urls.
setInstanceGroupUrls
Deprecated. Use node_pools.instance_group_urls.
var
string[]
$this
getCurrentNodeCount
[Output only] The number of nodes currently in the cluster. Deprecated.
Call Kubernetes API directly to retrieve node information.
int
setCurrentNodeCount
[Output only] The number of nodes currently in the cluster. Deprecated.
Call Kubernetes API directly to retrieve node information.
var
int
$this
getExpireTime
[Output only] The time the cluster will be automatically deleted in RFC3339 text format.
string
setExpireTime
[Output only] The time the cluster will be automatically deleted in RFC3339 text format.
var
string
$this
getLocation
string
setLocation
var
string
$this
getEnableTpu
Enable the ability to use Cloud TPUs in this cluster.
bool
setEnableTpu
Enable the ability to use Cloud TPUs in this cluster.
var
bool
$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
).
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
).
var
string
$this
getConditions
Which conditions caused the current cluster state.
setConditions
Which conditions caused the current cluster state.
$this
getAutopilot
Autopilot configuration for the cluster.
hasAutopilot
clearAutopilot
setAutopilot
Autopilot configuration for the cluster.
$this
getId
Output only. Unique id for the cluster.
string
setId
Output only. Unique id for the cluster.
var
string
$this
getNodePoolDefaults
Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.
hasNodePoolDefaults
clearNodePoolDefaults
setNodePoolDefaults
Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.
$this
getLoggingConfig
Logging configuration for the cluster.
hasLoggingConfig
clearLoggingConfig
setLoggingConfig
Logging configuration for the cluster.
$this
getMonitoringConfig
Monitoring configuration for the cluster.
hasMonitoringConfig
clearMonitoringConfig
setMonitoringConfig
Monitoring configuration for the cluster.
$this
getNodePoolAutoConfig
Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
hasNodePoolAutoConfig
clearNodePoolAutoConfig
setNodePoolAutoConfig
Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
$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.
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.
var
string
$this
getFleet
Fleet information for the cluster.
hasFleet
clearFleet
setFleet
Fleet information for the cluster.
$this
