Google Cloud Container V1 Client - Class ClusterUpdate (2.2.1)

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

ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided.

Generated from protobuf message google.container.v1.ClusterUpdate

Namespace

Google \ Cloud \ Container \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ desired_node_version string

The Kubernetes version to change the nodes to (typically an upgrade). 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 Kubernetes master version
↳ desired_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.
↳ desired_addons_config Google\Cloud\Container\V1\AddonsConfig

Configurations for the various addons available to run in the cluster.
↳ desired_node_pool_id string

The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family" or "desired_node_pool_autoscaling" is specified and there is more than one node pool on the cluster.
↳ desired_image_type string

The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.
↳ desired_database_encryption Google\Cloud\Container\V1\DatabaseEncryption

Configuration of etcd encryption.
↳ desired_workload_identity_config Google\Cloud\Container\V1\WorkloadIdentityConfig

Configuration for Workload Identity.
↳ desired_mesh_certificates Google\Cloud\Container\V1\MeshCertificates

Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
↳ desired_shielded_nodes Google\Cloud\Container\V1\ShieldedNodes

Configuration for Shielded Nodes.
↳ desired_cost_management_config Google\Cloud\Container\V1\CostManagementConfig

The desired configuration for the fine-grained cost management feature.
↳ desired_dns_config Google\Cloud\Container\V1\DNSConfig

DNSConfig contains clusterDNS config for this cluster.
↳ desired_node_pool_autoscaling Google\Cloud\Container\V1\NodePoolAutoscaling

Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool.
↳ desired_locations array

The desired list of Google Compute Engine zones in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.
↳ desired_master_authorized_networks_config Google\Cloud\Container\V1\MasterAuthorizedNetworksConfig

The desired configuration options for master authorized networks feature. Deprecated: Use desired_control_plane_endpoints_config.ip_endpoints_config.authorized_networks_config instead.
↳ desired_cluster_autoscaling Google\Cloud\Container\V1\ClusterAutoscaling

Cluster-level autoscaling configuration.
↳ desired_binary_authorization Google\Cloud\Container\V1\BinaryAuthorization

The desired configuration options for the Binary Authorization feature.
↳ desired_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.
↳ desired_resource_usage_export_config Google\Cloud\Container\V1\ResourceUsageExportConfig

The desired configuration for exporting resource usage.
↳ desired_vertical_pod_autoscaling Google\Cloud\Container\V1\VerticalPodAutoscaling

Cluster-level Vertical Pod Autoscaling configuration.
↳ desired_private_cluster_config Google\Cloud\Container\V1\PrivateClusterConfig

The desired private cluster configuration. master_global_access_config is the only field that can be changed via this field. See also ClusterUpdate.desired_enable_private_endpoint for modifying other fields within PrivateClusterConfig. Deprecated: Use desired_control_plane_endpoints_config.ip_endpoints_config.global_access instead.
↳ desired_intra_node_visibility_config Google\Cloud\Container\V1\IntraNodeVisibilityConfig

The desired config of Intra-node visibility.
↳ desired_default_snat_status Google\Cloud\Container\V1\DefaultSnatStatus

The desired status of whether to disable default sNAT for this cluster.
↳ desired_release_channel Google\Cloud\Container\V1\ReleaseChannel

The desired release channel configuration.
↳ desired_l4ilb_subsetting_config Google\Cloud\Container\V1\ILBSubsettingConfig

The desired L4 Internal Load Balancer Subsetting configuration.
↳ desired_datapath_provider int

The desired datapath provider for the cluster.
↳ desired_private_ipv6_google_access int

The desired state of IPv6 connectivity to Google Services.
↳ desired_notification_config Google\Cloud\Container\V1\NotificationConfig

The desired notification configuration.
↳ desired_authenticator_groups_config Google\Cloud\Container\V1\AuthenticatorGroupsConfig

The desired authenticator groups config for the cluster.
↳ desired_logging_config Google\Cloud\Container\V1\LoggingConfig

The desired logging configuration.
↳ desired_monitoring_config Google\Cloud\Container\V1\MonitoringConfig

The desired monitoring configuration.
↳ desired_identity_service_config Google\Cloud\Container\V1\IdentityServiceConfig

The desired Identity Service component configuration.
↳ desired_service_external_ips_config Google\Cloud\Container\V1\ServiceExternalIPsConfig

ServiceExternalIPsConfig specifies the config for the use of Services with ExternalIPs field.
↳ desired_enable_private_endpoint bool

Enable/Disable private endpoint for the cluster's master. Deprecated: Use desired_control_plane_endpoints_config.ip_endpoints_config.enable_public_endpoint instead. Note that the value of enable_public_endpoint is reversed: if enable_private_endpoint is false, then enable_public_endpoint will be true.
↳ desired_default_enable_private_nodes bool

Override the default setting of whether future created nodes have private IP addresses only, namely NetworkConfig.default_enable_private_nodes
↳ desired_control_plane_endpoints_config Google\Cloud\Container\V1\ControlPlaneEndpointsConfig

Control plane endpoints configuration.
↳ desired_master_version string

The Kubernetes version to change the master to. 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
↳ desired_gcfs_config Google\Cloud\Container\V1\GcfsConfig

The desired GCFS config for the cluster
↳ desired_node_pool_auto_config_network_tags Google\Cloud\Container\V1\NetworkTags

The desired network tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
↳ desired_gateway_api_config Google\Cloud\Container\V1\GatewayAPIConfig

The desired config of Gateway API on this cluster.
↳ etag string

The current etag of the cluster. If an etag is provided and does not match the current etag of the cluster, update will be blocked and an ABORTED error will be returned.
↳ desired_node_pool_logging_config Google\Cloud\Container\V1\NodePoolLoggingConfig

The desired node pool logging configuration defaults for the cluster.
↳ desired_fleet Google\Cloud\Container\V1\Fleet

The desired fleet configuration for the cluster.
↳ desired_stack_type int

The desired stack type of the cluster. If a stack type is provided and does not match the current stack type of the cluster, update will attempt to change the stack type to the new type.
↳ additional_pod_ranges_config Google\Cloud\Container\V1\AdditionalPodRangesConfig

The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs.
↳ removed_additional_pod_ranges_config Google\Cloud\Container\V1\AdditionalPodRangesConfig

The additional pod ranges that are to be removed from the cluster. The pod ranges specified here must have been specified earlier in the 'additional_pod_ranges_config' argument.
↳ enable_k8s_beta_apis Google\Cloud\Container\V1\K8sBetaAPIConfig

Kubernetes open source beta apis enabled on the cluster. Only beta apis
↳ desired_security_posture_config Google\Cloud\Container\V1\SecurityPostureConfig

Enable/Disable Security Posture API features for the cluster.
↳ desired_network_performance_config Google\Cloud\Container\V1\NetworkConfig\ClusterNetworkPerformanceConfig

The desired network performance config.
↳ desired_enable_fqdn_network_policy bool

Enable/Disable FQDN Network Policy for the cluster.
↳ desired_autopilot_workload_policy_config Google\Cloud\Container\V1\WorkloadPolicyConfig

The desired workload policy configuration for the autopilot cluster.
↳ desired_k8s_beta_apis Google\Cloud\Container\V1\K8sBetaAPIConfig

Desired Beta APIs to be enabled for cluster.
↳ desired_containerd_config Google\Cloud\Container\V1\ContainerdConfig

The desired containerd config for the cluster.
↳ desired_enable_multi_networking bool

Enable/Disable Multi-Networking for the cluster
↳ desired_node_pool_auto_config_resource_manager_tags Google\Cloud\Container\V1\ResourceManagerTags

The desired resource manager tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
↳ desired_in_transit_encryption_config int

Specify the details of in-transit encryption.
↳ desired_enable_cilium_clusterwide_network_policy bool

Enable/Disable Cilium Clusterwide Network Policy for the cluster.
↳ desired_secret_manager_config Google\Cloud\Container\V1\SecretManagerConfig

Enable/Disable Secret Manager Config.
↳ desired_compliance_posture_config Google\Cloud\Container\V1\CompliancePostureConfig

Enable/Disable Compliance Posture features for the cluster.
↳ desired_node_kubelet_config Google\Cloud\Container\V1\NodeKubeletConfig

The desired node kubelet config for the cluster.
↳ desired_node_pool_auto_config_kubelet_config Google\Cloud\Container\V1\NodeKubeletConfig

The desired node kubelet config for all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
↳ user_managed_keys_config Google\Cloud\Container\V1\UserManagedKeysConfig

The Custom keys configuration for the cluster.
↳ desired_rbac_binding_config Google\Cloud\Container\V1\RBACBindingConfig

RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created.
↳ desired_enterprise_config Google\Cloud\Container\V1\DesiredEnterpriseConfig

The desired enterprise configuration for the cluster.
↳ desired_node_pool_auto_config_linux_node_config Google\Cloud\Container\V1\LinuxNodeConfig

The desired Linux node config for all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. Currently only cgroup_mode can be set here.

getDesiredNodeVersion

The Kubernetes version to change the nodes to (typically an upgrade).

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 Kubernetes master version
Returns
Type Description
string

setDesiredNodeVersion

The Kubernetes version to change the nodes to (typically an upgrade).

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 Kubernetes master version
Parameter
Name Description
var string
Returns
Type Description
$this

getDesiredMonitoringService

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
Type Description
string

setDesiredMonitoringService

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
Name Description
var string
Returns
Type Description
$this

getDesiredAddonsConfig

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

Returns
Type Description
Google\Cloud\Container\V1\AddonsConfig|null

hasDesiredAddonsConfig

clearDesiredAddonsConfig

setDesiredAddonsConfig

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

Parameter
Name Description
var Google\Cloud\Container\V1\AddonsConfig
Returns
Type Description
$this

getDesiredNodePoolId

The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family" or "desired_node_pool_autoscaling" is specified and there is more than one node pool on the cluster.

Returns
Type Description
string

setDesiredNodePoolId

The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family" or "desired_node_pool_autoscaling" is specified and there is more than one node pool on the cluster.

Parameter
Name Description
var string
Returns
Type Description
$this

getDesiredImageType

The desired image type for the node pool.

NOTE: Set the "desired_node_pool" field as well.

Returns
Type Description
string

setDesiredImageType

The desired image type for the node pool.

NOTE: Set the "desired_node_pool" field as well.

Parameter
Name Description
var string
Returns
Type Description
$this

getDesiredDatabaseEncryption

Configuration of etcd encryption.

Returns
Type Description
Google\Cloud\Container\V1\DatabaseEncryption|null

hasDesiredDatabaseEncryption

clearDesiredDatabaseEncryption

setDesiredDatabaseEncryption

Configuration of etcd encryption.

Parameter
Name Description
var Google\Cloud\Container\V1\DatabaseEncryption
Returns
Type Description
$this

getDesiredWorkloadIdentityConfig

Configuration for Workload Identity.

Returns
Type Description
Google\Cloud\Container\V1\WorkloadIdentityConfig|null

hasDesiredWorkloadIdentityConfig

clearDesiredWorkloadIdentityConfig

setDesiredWorkloadIdentityConfig

Configuration for Workload Identity.

Parameter
Name Description
var Google\Cloud\Container\V1\WorkloadIdentityConfig
Returns
Type Description
$this

getDesiredMeshCertificates

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

Returns
Type Description
Google\Cloud\Container\V1\MeshCertificates|null

hasDesiredMeshCertificates

clearDesiredMeshCertificates

setDesiredMeshCertificates

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

Parameter
Name Description
var Google\Cloud\Container\V1\MeshCertificates
Returns
Type Description
$this

getDesiredShieldedNodes

Configuration for Shielded Nodes.

Returns
Type Description
Google\Cloud\Container\V1\ShieldedNodes|null

hasDesiredShieldedNodes

clearDesiredShieldedNodes

setDesiredShieldedNodes

Configuration for Shielded Nodes.

Parameter
Name Description
var Google\Cloud\Container\V1\ShieldedNodes
Returns
Type Description
$this

getDesiredCostManagementConfig

The desired configuration for the fine-grained cost management feature.

Returns
Type Description
Google\Cloud\Container\V1\CostManagementConfig|null

hasDesiredCostManagementConfig

clearDesiredCostManagementConfig

setDesiredCostManagementConfig

The desired configuration for the fine-grained cost management feature.

Parameter
Name Description
var Google\Cloud\Container\V1\CostManagementConfig
Returns
Type Description
$this

getDesiredDnsConfig

DNSConfig contains clusterDNS config for this cluster.

Returns
Type Description
Google\Cloud\Container\V1\DNSConfig|null

hasDesiredDnsConfig

clearDesiredDnsConfig

setDesiredDnsConfig

DNSConfig contains clusterDNS config for this cluster.

Parameter
Name Description
var Google\Cloud\Container\V1\DNSConfig
Returns
Type Description
$this

getDesiredNodePoolAutoscaling

Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool.

Returns
Type Description
Google\Cloud\Container\V1\NodePoolAutoscaling|null

hasDesiredNodePoolAutoscaling

clearDesiredNodePoolAutoscaling

setDesiredNodePoolAutoscaling

Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool.

Parameter
Name Description
var Google\Cloud\Container\V1\NodePoolAutoscaling
Returns
Type Description
$this

getDesiredLocations

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

This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setDesiredLocations

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

This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getDesiredMasterAuthorizedNetworksConfig

The desired configuration options for master authorized networks feature.

Deprecated: Use desired_control_plane_endpoints_config.ip_endpoints_config.authorized_networks_config instead.

Returns
Type Description
Google\Cloud\Container\V1\MasterAuthorizedNetworksConfig|null

hasDesiredMasterAuthorizedNetworksConfig

clearDesiredMasterAuthorizedNetworksConfig

setDesiredMasterAuthorizedNetworksConfig

The desired configuration options for master authorized networks feature.

Deprecated: Use desired_control_plane_endpoints_config.ip_endpoints_config.authorized_networks_config instead.

Parameter
Name Description
var Google\Cloud\Container\V1\MasterAuthorizedNetworksConfig
Returns
Type Description
$this

getDesiredClusterAutoscaling

Cluster-level autoscaling configuration.

Returns
Type Description
Google\Cloud\Container\V1\ClusterAutoscaling|null

hasDesiredClusterAutoscaling

clearDesiredClusterAutoscaling

setDesiredClusterAutoscaling

Cluster-level autoscaling configuration.

Parameter
Name Description
var Google\Cloud\Container\V1\ClusterAutoscaling
Returns
Type Description
$this

getDesiredBinaryAuthorization

The desired configuration options for the Binary Authorization feature.

Returns
Type Description
Google\Cloud\Container\V1\BinaryAuthorization|null

hasDesiredBinaryAuthorization

clearDesiredBinaryAuthorization

setDesiredBinaryAuthorization

The desired configuration options for the Binary Authorization feature.

Parameter
Name Description
var Google\Cloud\Container\V1\BinaryAuthorization
Returns
Type Description
$this

getDesiredLoggingService

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
Type Description
string

setDesiredLoggingService

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
Name Description
var string
Returns
Type Description
$this

getDesiredResourceUsageExportConfig

The desired configuration for exporting resource usage.

Returns
Type Description
Google\Cloud\Container\V1\ResourceUsageExportConfig|null

hasDesiredResourceUsageExportConfig

clearDesiredResourceUsageExportConfig

setDesiredResourceUsageExportConfig

The desired configuration for exporting resource usage.

Parameter
Name Description
var Google\Cloud\Container\V1\ResourceUsageExportConfig
Returns
Type Description
$this

getDesiredVerticalPodAutoscaling

Cluster-level Vertical Pod Autoscaling configuration.

Returns
Type Description
Google\Cloud\Container\V1\VerticalPodAutoscaling|null

hasDesiredVerticalPodAutoscaling

clearDesiredVerticalPodAutoscaling

setDesiredVerticalPodAutoscaling

Cluster-level Vertical Pod Autoscaling configuration.

Parameter
Name Description
var Google\Cloud\Container\V1\VerticalPodAutoscaling
Returns
Type Description
$this

getDesiredPrivateClusterConfig

The desired private cluster configuration. master_global_access_config is the only field that can be changed via this field.

See also ClusterUpdate.desired_enable_private_endpoint for modifying other fields within PrivateClusterConfig. Deprecated: Use desired_control_plane_endpoints_config.ip_endpoints_config.global_access instead.

Returns
Type Description
Google\Cloud\Container\V1\PrivateClusterConfig|null

hasDesiredPrivateClusterConfig

clearDesiredPrivateClusterConfig

setDesiredPrivateClusterConfig

The desired private cluster configuration. master_global_access_config is the only field that can be changed via this field.

See also ClusterUpdate.desired_enable_private_endpoint for modifying other fields within PrivateClusterConfig. Deprecated: Use desired_control_plane_endpoints_config.ip_endpoints_config.global_access instead.

Parameter
Name Description
var Google\Cloud\Container\V1\PrivateClusterConfig
Returns
Type Description
$this

getDesiredIntraNodeVisibilityConfig

The desired config of Intra-node visibility.

Returns
Type Description
Google\Cloud\Container\V1\IntraNodeVisibilityConfig|null

hasDesiredIntraNodeVisibilityConfig

clearDesiredIntraNodeVisibilityConfig

setDesiredIntraNodeVisibilityConfig

The desired config of Intra-node visibility.

Parameter
Name Description
var Google\Cloud\Container\V1\IntraNodeVisibilityConfig
Returns
Type Description
$this

getDesiredDefaultSnatStatus

The desired status of whether to disable default sNAT for this cluster.

Returns
Type Description
Google\Cloud\Container\V1\DefaultSnatStatus|null

hasDesiredDefaultSnatStatus

clearDesiredDefaultSnatStatus

setDesiredDefaultSnatStatus

The desired status of whether to disable default sNAT for this cluster.

Parameter
Name Description
var Google\Cloud\Container\V1\DefaultSnatStatus
Returns
Type Description
$this

getDesiredReleaseChannel

The desired release channel configuration.

Returns
Type Description
Google\Cloud\Container\V1\ReleaseChannel|null

hasDesiredReleaseChannel

clearDesiredReleaseChannel

setDesiredReleaseChannel

The desired release channel configuration.

Parameter
Name Description
var Google\Cloud\Container\V1\ReleaseChannel
Returns
Type Description
$this

getDesiredL4IlbSubsettingConfig

The desired L4 Internal Load Balancer Subsetting configuration.

Returns
Type Description
Google\Cloud\Container\V1\ILBSubsettingConfig|null

hasDesiredL4IlbSubsettingConfig

clearDesiredL4IlbSubsettingConfig

setDesiredL4IlbSubsettingConfig

The desired L4 Internal Load Balancer Subsetting configuration.

Parameter
Name Description
var Google\Cloud\Container\V1\ILBSubsettingConfig
Returns
Type Description
$this

getDesiredDatapathProvider

The desired datapath provider for the cluster.

Returns
Type Description
int

setDesiredDatapathProvider

The desired datapath provider for the cluster.

Parameter
Name Description
var int
Returns
Type Description
$this

getDesiredPrivateIpv6GoogleAccess

The desired state of IPv6 connectivity to Google Services.

Returns
Type Description
int

setDesiredPrivateIpv6GoogleAccess

The desired state of IPv6 connectivity to Google Services.

Parameter
Name Description
var int
Returns
Type Description
$this

getDesiredNotificationConfig

The desired notification configuration.

Returns
Type Description
Google\Cloud\Container\V1\NotificationConfig|null

hasDesiredNotificationConfig

clearDesiredNotificationConfig

setDesiredNotificationConfig

The desired notification configuration.

Parameter
Name Description
var Google\Cloud\Container\V1\NotificationConfig
Returns
Type Description
$this

getDesiredAuthenticatorGroupsConfig

The desired authenticator groups config for the cluster.

Returns
Type Description
Google\Cloud\Container\V1\AuthenticatorGroupsConfig|null

hasDesiredAuthenticatorGroupsConfig

clearDesiredAuthenticatorGroupsConfig

setDesiredAuthenticatorGroupsConfig

The desired authenticator groups config for the cluster.

Parameter
Name Description
var Google\Cloud\Container\V1\AuthenticatorGroupsConfig
Returns
Type Description
$this

getDesiredLoggingConfig

The desired logging configuration.

Returns
Type Description
Google\Cloud\Container\V1\LoggingConfig|null

hasDesiredLoggingConfig

clearDesiredLoggingConfig

setDesiredLoggingConfig

The desired logging configuration.

Parameter
Name Description
var Google\Cloud\Container\V1\LoggingConfig
Returns
Type Description
$this

getDesiredMonitoringConfig

The desired monitoring configuration.

Returns
Type Description
Google\Cloud\Container\V1\MonitoringConfig|null

hasDesiredMonitoringConfig

clearDesiredMonitoringConfig

setDesiredMonitoringConfig

The desired monitoring configuration.

Parameter
Name Description
var Google\Cloud\Container\V1\MonitoringConfig
Returns
Type Description
$this

getDesiredIdentityServiceConfig

The desired Identity Service component configuration.

Returns
Type Description
Google\Cloud\Container\V1\IdentityServiceConfig|null

hasDesiredIdentityServiceConfig

clearDesiredIdentityServiceConfig

setDesiredIdentityServiceConfig

The desired Identity Service component configuration.

Parameter
Name Description
var Google\Cloud\Container\V1\IdentityServiceConfig
Returns
Type Description
$this

getDesiredServiceExternalIpsConfig

ServiceExternalIPsConfig specifies the config for the use of Services with ExternalIPs field.

Returns
Type Description
Google\Cloud\Container\V1\ServiceExternalIPsConfig|null

hasDesiredServiceExternalIpsConfig

clearDesiredServiceExternalIpsConfig

setDesiredServiceExternalIpsConfig

ServiceExternalIPsConfig specifies the config for the use of Services with ExternalIPs field.

Parameter
Name Description
var Google\Cloud\Container\V1\ServiceExternalIPsConfig
Returns
Type Description
$this

getDesiredEnablePrivateEndpoint

Enable/Disable private endpoint for the cluster's master.

Deprecated: Use desired_control_plane_endpoints_config.ip_endpoints_config.enable_public_endpoint instead. Note that the value of enable_public_endpoint is reversed: if enable_private_endpoint is false, then enable_public_endpoint will be true.

Returns
Type Description
bool

hasDesiredEnablePrivateEndpoint

clearDesiredEnablePrivateEndpoint

setDesiredEnablePrivateEndpoint

Enable/Disable private endpoint for the cluster's master.

Deprecated: Use desired_control_plane_endpoints_config.ip_endpoints_config.enable_public_endpoint instead. Note that the value of enable_public_endpoint is reversed: if enable_private_endpoint is false, then enable_public_endpoint will be true.

Parameter
Name Description
var bool
Returns
Type Description
$this

getDesiredDefaultEnablePrivateNodes

Override the default setting of whether future created nodes have private IP addresses only, namely NetworkConfig.default_enable_private_nodes

Returns
Type Description
bool

hasDesiredDefaultEnablePrivateNodes

clearDesiredDefaultEnablePrivateNodes

setDesiredDefaultEnablePrivateNodes

Override the default setting of whether future created nodes have private IP addresses only, namely NetworkConfig.default_enable_private_nodes

Parameter
Name Description
var bool
Returns
Type Description
$this

getDesiredControlPlaneEndpointsConfig

Control plane endpoints configuration.

Returns
Type Description
Google\Cloud\Container\V1\ControlPlaneEndpointsConfig|null

hasDesiredControlPlaneEndpointsConfig

clearDesiredControlPlaneEndpointsConfig

setDesiredControlPlaneEndpointsConfig

Control plane endpoints configuration.

Parameter
Name Description
var Google\Cloud\Container\V1\ControlPlaneEndpointsConfig
Returns
Type Description
$this

getDesiredMasterVersion

The Kubernetes version to change the master to.

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
Type Description
string

setDesiredMasterVersion

The Kubernetes version to change the master to.

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
Name Description
var string
Returns
Type Description
$this

getDesiredGcfsConfig

The desired GCFS config for the cluster

Returns
Type Description
Google\Cloud\Container\V1\GcfsConfig|null

hasDesiredGcfsConfig

clearDesiredGcfsConfig

setDesiredGcfsConfig

The desired GCFS config for the cluster

Parameter
Name Description
var Google\Cloud\Container\V1\GcfsConfig
Returns
Type Description
$this

getDesiredNodePoolAutoConfigNetworkTags

The desired network tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

Returns
Type Description
Google\Cloud\Container\V1\NetworkTags|null

hasDesiredNodePoolAutoConfigNetworkTags

clearDesiredNodePoolAutoConfigNetworkTags

setDesiredNodePoolAutoConfigNetworkTags

The desired network tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

Parameter
Name Description
var Google\Cloud\Container\V1\NetworkTags
Returns
Type Description
$this

getDesiredGatewayApiConfig

The desired config of Gateway API on this cluster.

Returns
Type Description
Google\Cloud\Container\V1\GatewayAPIConfig|null

hasDesiredGatewayApiConfig

clearDesiredGatewayApiConfig

setDesiredGatewayApiConfig

The desired config of Gateway API on this cluster.

Parameter
Name Description
var Google\Cloud\Container\V1\GatewayAPIConfig
Returns
Type Description
$this

getEtag

The current etag of the cluster.

If an etag is provided and does not match the current etag of the cluster, update will be blocked and an ABORTED error will be returned.

Returns
Type Description
string

setEtag

The current etag of the cluster.

If an etag is provided and does not match the current etag of the cluster, update will be blocked and an ABORTED error will be returned.

Parameter
Name Description
var string
Returns
Type Description
$this

getDesiredNodePoolLoggingConfig

The desired node pool logging configuration defaults for the cluster.

Returns
Type Description
Google\Cloud\Container\V1\NodePoolLoggingConfig|null

hasDesiredNodePoolLoggingConfig

clearDesiredNodePoolLoggingConfig

setDesiredNodePoolLoggingConfig

The desired node pool logging configuration defaults for the cluster.

Parameter
Name Description
var Google\Cloud\Container\V1\NodePoolLoggingConfig
Returns
Type Description
$this

getDesiredFleet

The desired fleet configuration for the cluster.

Returns
Type Description
Google\Cloud\Container\V1\Fleet|null

hasDesiredFleet

clearDesiredFleet

setDesiredFleet

The desired fleet configuration for the cluster.

Parameter
Name Description
var Google\Cloud\Container\V1\Fleet
Returns
Type Description
$this

getDesiredStackType

The desired stack type of the cluster.

If a stack type is provided and does not match the current stack type of the cluster, update will attempt to change the stack type to the new type.

Returns
Type Description
int

setDesiredStackType

The desired stack type of the cluster.

If a stack type is provided and does not match the current stack type of the cluster, update will attempt to change the stack type to the new type.

Parameter
Name Description
var int
Returns
Type Description
$this

getAdditionalPodRangesConfig

The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs.

Returns
Type Description
Google\Cloud\Container\V1\AdditionalPodRangesConfig|null

hasAdditionalPodRangesConfig

clearAdditionalPodRangesConfig

setAdditionalPodRangesConfig

The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs.

Parameter
Name Description
var Google\Cloud\Container\V1\AdditionalPodRangesConfig
Returns
Type Description
$this

getRemovedAdditionalPodRangesConfig

The additional pod ranges that are to be removed from the cluster.

The pod ranges specified here must have been specified earlier in the 'additional_pod_ranges_config' argument.

Returns
Type Description
Google\Cloud\Container\V1\AdditionalPodRangesConfig|null

hasRemovedAdditionalPodRangesConfig

clearRemovedAdditionalPodRangesConfig

setRemovedAdditionalPodRangesConfig

The additional pod ranges that are to be removed from the cluster.

The pod ranges specified here must have been specified earlier in the 'additional_pod_ranges_config' argument.

Parameter
Name Description
var Google\Cloud\Container\V1\AdditionalPodRangesConfig
Returns
Type Description
$this

getEnableK8SBetaApis

Kubernetes open source beta apis enabled on the cluster. Only beta apis

Returns
Type Description
Google\Cloud\Container\V1\K8sBetaAPIConfig|null

hasEnableK8SBetaApis

clearEnableK8SBetaApis

setEnableK8SBetaApis

Kubernetes open source beta apis enabled on the cluster. Only beta apis

Parameter
Name Description
var Google\Cloud\Container\V1\K8sBetaAPIConfig
Returns
Type Description
$this

getDesiredSecurityPostureConfig

Enable/Disable Security Posture API features for the cluster.

Returns
Type Description
Google\Cloud\Container\V1\SecurityPostureConfig|null

hasDesiredSecurityPostureConfig

clearDesiredSecurityPostureConfig

setDesiredSecurityPostureConfig

Enable/Disable Security Posture API features for the cluster.

Parameter
Name Description
var Google\Cloud\Container\V1\SecurityPostureConfig
Returns
Type Description
$this

getDesiredNetworkPerformanceConfig

The desired network performance config.

Returns
Type Description
Google\Cloud\Container\V1\NetworkConfig\ClusterNetworkPerformanceConfig|null

hasDesiredNetworkPerformanceConfig

clearDesiredNetworkPerformanceConfig

setDesiredNetworkPerformanceConfig

The desired network performance config.

Parameter
Name Description
var Google\Cloud\Container\V1\NetworkConfig\ClusterNetworkPerformanceConfig
Returns
Type Description
$this

getDesiredEnableFqdnNetworkPolicy

Enable/Disable FQDN Network Policy for the cluster.

Returns
Type Description
bool

hasDesiredEnableFqdnNetworkPolicy

clearDesiredEnableFqdnNetworkPolicy

setDesiredEnableFqdnNetworkPolicy

Enable/Disable FQDN Network Policy for the cluster.

Parameter
Name Description
var bool
Returns
Type Description
$this

getDesiredAutopilotWorkloadPolicyConfig

The desired workload policy configuration for the autopilot cluster.

Returns
Type Description
Google\Cloud\Container\V1\WorkloadPolicyConfig|null

hasDesiredAutopilotWorkloadPolicyConfig

clearDesiredAutopilotWorkloadPolicyConfig

setDesiredAutopilotWorkloadPolicyConfig

The desired workload policy configuration for the autopilot cluster.

Parameter
Name Description
var Google\Cloud\Container\V1\WorkloadPolicyConfig
Returns
Type Description
$this

getDesiredK8SBetaApis

Desired Beta APIs to be enabled for cluster.

Returns
Type Description
Google\Cloud\Container\V1\K8sBetaAPIConfig|null

hasDesiredK8SBetaApis

clearDesiredK8SBetaApis

setDesiredK8SBetaApis

Desired Beta APIs to be enabled for cluster.

Parameter
Name Description
var Google\Cloud\Container\V1\K8sBetaAPIConfig
Returns
Type Description
$this

getDesiredContainerdConfig

The desired containerd config for the cluster.

Returns
Type Description
Google\Cloud\Container\V1\ContainerdConfig|null

hasDesiredContainerdConfig

clearDesiredContainerdConfig

setDesiredContainerdConfig

The desired containerd config for the cluster.

Parameter
Name Description
var Google\Cloud\Container\V1\ContainerdConfig
Returns
Type Description
$this

getDesiredEnableMultiNetworking

Enable/Disable Multi-Networking for the cluster

Returns
Type Description
bool

hasDesiredEnableMultiNetworking

clearDesiredEnableMultiNetworking

setDesiredEnableMultiNetworking

Enable/Disable Multi-Networking for the cluster

Parameter
Name Description
var bool
Returns
Type Description
$this

getDesiredNodePoolAutoConfigResourceManagerTags

The desired resource manager tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

Returns
Type Description
Google\Cloud\Container\V1\ResourceManagerTags|null

hasDesiredNodePoolAutoConfigResourceManagerTags

clearDesiredNodePoolAutoConfigResourceManagerTags

setDesiredNodePoolAutoConfigResourceManagerTags

The desired resource manager tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

Parameter
Name Description
var Google\Cloud\Container\V1\ResourceManagerTags
Returns
Type Description
$this

getDesiredInTransitEncryptionConfig

Specify the details of in-transit encryption.

Returns
Type Description
int

hasDesiredInTransitEncryptionConfig

clearDesiredInTransitEncryptionConfig

setDesiredInTransitEncryptionConfig

Specify the details of in-transit encryption.

Parameter
Name Description
var int
Returns
Type Description
$this

getDesiredEnableCiliumClusterwideNetworkPolicy

Enable/Disable Cilium Clusterwide Network Policy for the cluster.

Returns
Type Description
bool

hasDesiredEnableCiliumClusterwideNetworkPolicy

clearDesiredEnableCiliumClusterwideNetworkPolicy

setDesiredEnableCiliumClusterwideNetworkPolicy

Enable/Disable Cilium Clusterwide Network Policy for the cluster.

Parameter
Name Description
var bool
Returns
Type Description
$this

getDesiredSecretManagerConfig

Enable/Disable Secret Manager Config.

Returns
Type Description
Google\Cloud\Container\V1\SecretManagerConfig|null

hasDesiredSecretManagerConfig

clearDesiredSecretManagerConfig

setDesiredSecretManagerConfig

Enable/Disable Secret Manager Config.

Parameter
Name Description
var Google\Cloud\Container\V1\SecretManagerConfig
Returns
Type Description
$this

getDesiredCompliancePostureConfig

Enable/Disable Compliance Posture features for the cluster.

Returns
Type Description
Google\Cloud\Container\V1\CompliancePostureConfig|null

hasDesiredCompliancePostureConfig

clearDesiredCompliancePostureConfig

setDesiredCompliancePostureConfig

Enable/Disable Compliance Posture features for the cluster.

Parameter
Name Description
var Google\Cloud\Container\V1\CompliancePostureConfig
Returns
Type Description
$this

getDesiredNodeKubeletConfig

The desired node kubelet config for the cluster.

Returns
Type Description
Google\Cloud\Container\V1\NodeKubeletConfig|null

hasDesiredNodeKubeletConfig

clearDesiredNodeKubeletConfig

setDesiredNodeKubeletConfig

The desired node kubelet config for the cluster.

Parameter
Name Description
var Google\Cloud\Container\V1\NodeKubeletConfig
Returns
Type Description
$this

getDesiredNodePoolAutoConfigKubeletConfig

The desired node kubelet config for all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

Returns
Type Description
Google\Cloud\Container\V1\NodeKubeletConfig|null

hasDesiredNodePoolAutoConfigKubeletConfig

clearDesiredNodePoolAutoConfigKubeletConfig

setDesiredNodePoolAutoConfigKubeletConfig

The desired node kubelet config for all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

Parameter
Name Description
var Google\Cloud\Container\V1\NodeKubeletConfig
Returns
Type Description
$this

getUserManagedKeysConfig

The Custom keys configuration for the cluster.

Returns
Type Description
Google\Cloud\Container\V1\UserManagedKeysConfig|null

hasUserManagedKeysConfig

clearUserManagedKeysConfig

setUserManagedKeysConfig

The Custom keys configuration for the cluster.

Parameter
Name Description
var Google\Cloud\Container\V1\UserManagedKeysConfig
Returns
Type Description
$this

getDesiredRbacBindingConfig

RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created.

Returns
Type Description
Google\Cloud\Container\V1\RBACBindingConfig|null

hasDesiredRbacBindingConfig

clearDesiredRbacBindingConfig

setDesiredRbacBindingConfig

RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created.

Parameter
Name Description
var Google\Cloud\Container\V1\RBACBindingConfig
Returns
Type Description
$this

getDesiredEnterpriseConfig

The desired enterprise configuration for the cluster.

Returns
Type Description
Google\Cloud\Container\V1\DesiredEnterpriseConfig|null

hasDesiredEnterpriseConfig

clearDesiredEnterpriseConfig

setDesiredEnterpriseConfig

The desired enterprise configuration for the cluster.

Parameter
Name Description
var Google\Cloud\Container\V1\DesiredEnterpriseConfig
Returns
Type Description
$this

getDesiredNodePoolAutoConfigLinuxNodeConfig

The desired Linux node config for all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

Currently only cgroup_mode can be set here.

Returns
Type Description
Google\Cloud\Container\V1\LinuxNodeConfig|null

hasDesiredNodePoolAutoConfigLinuxNodeConfig

clearDesiredNodePoolAutoConfigLinuxNodeConfig

setDesiredNodePoolAutoConfigLinuxNodeConfig

The desired Linux node config for all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

Currently only cgroup_mode can be set here.

Parameter
Name Description
var Google\Cloud\Container\V1\LinuxNodeConfig
Returns
Type Description
$this