Google Cloud Container V1 Client - Class ClusterUpdate (1.13.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

Methods

__construct

Constructor.

Parameters
NameDescription
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.

↳ 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.

↳ 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.

↳ 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.

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

getDesiredAddonsConfig

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

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

hasDesiredAddonsConfig

clearDesiredAddonsConfig

setDesiredAddonsConfig

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

Parameter
NameDescription
var Google\Cloud\Container\V1\AddonsConfig
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getDesiredImageType

The desired image type for the node pool.

NOTE: Set the "desired_node_pool" field as well.

Returns
TypeDescription
string

setDesiredImageType

The desired image type for the node pool.

NOTE: Set the "desired_node_pool" field as well.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getDesiredDatabaseEncryption

Configuration of etcd encryption.

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

hasDesiredDatabaseEncryption

clearDesiredDatabaseEncryption

setDesiredDatabaseEncryption

Configuration of etcd encryption.

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

getDesiredWorkloadIdentityConfig

Configuration for Workload Identity.

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

hasDesiredWorkloadIdentityConfig

clearDesiredWorkloadIdentityConfig

setDesiredWorkloadIdentityConfig

Configuration for Workload Identity.

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

getDesiredMeshCertificates

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

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

hasDesiredMeshCertificates

clearDesiredMeshCertificates

setDesiredMeshCertificates

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

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

getDesiredShieldedNodes

Configuration for Shielded Nodes.

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

hasDesiredShieldedNodes

clearDesiredShieldedNodes

setDesiredShieldedNodes

Configuration for Shielded Nodes.

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

getDesiredCostManagementConfig

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

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

hasDesiredCostManagementConfig

clearDesiredCostManagementConfig

setDesiredCostManagementConfig

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

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

getDesiredDnsConfig

DNSConfig contains clusterDNS config for this cluster.

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

hasDesiredDnsConfig

clearDesiredDnsConfig

setDesiredDnsConfig

DNSConfig contains clusterDNS config for this cluster.

Parameter
NameDescription
var Google\Cloud\Container\V1\DNSConfig
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Cloud\Container\V1\NodePoolAutoscaling
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string[]
Returns
TypeDescription
$this

getDesiredMasterAuthorizedNetworksConfig

The desired configuration options for master authorized networks feature.

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

hasDesiredMasterAuthorizedNetworksConfig

clearDesiredMasterAuthorizedNetworksConfig

setDesiredMasterAuthorizedNetworksConfig

The desired configuration options for master authorized networks feature.

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

getDesiredClusterAutoscaling

Cluster-level autoscaling configuration.

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

hasDesiredClusterAutoscaling

clearDesiredClusterAutoscaling

setDesiredClusterAutoscaling

Cluster-level autoscaling configuration.

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

getDesiredBinaryAuthorization

The desired configuration options for the Binary Authorization feature.

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

hasDesiredBinaryAuthorization

clearDesiredBinaryAuthorization

setDesiredBinaryAuthorization

The desired configuration options for the Binary Authorization feature.

Parameter
NameDescription
var Google\Cloud\Container\V1\BinaryAuthorization
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getDesiredResourceUsageExportConfig

The desired configuration for exporting resource usage.

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

hasDesiredResourceUsageExportConfig

clearDesiredResourceUsageExportConfig

setDesiredResourceUsageExportConfig

The desired configuration for exporting resource usage.

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

getDesiredVerticalPodAutoscaling

Cluster-level Vertical Pod Autoscaling configuration.

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

hasDesiredVerticalPodAutoscaling

clearDesiredVerticalPodAutoscaling

setDesiredVerticalPodAutoscaling

Cluster-level Vertical Pod Autoscaling configuration.

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

getDesiredPrivateClusterConfig

The desired private cluster configuration.

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

hasDesiredPrivateClusterConfig

clearDesiredPrivateClusterConfig

setDesiredPrivateClusterConfig

The desired private cluster configuration.

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

getDesiredIntraNodeVisibilityConfig

The desired config of Intra-node visibility.

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

hasDesiredIntraNodeVisibilityConfig

clearDesiredIntraNodeVisibilityConfig

setDesiredIntraNodeVisibilityConfig

The desired config of Intra-node visibility.

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

getDesiredDefaultSnatStatus

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

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

hasDesiredDefaultSnatStatus

clearDesiredDefaultSnatStatus

setDesiredDefaultSnatStatus

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

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

getDesiredReleaseChannel

The desired release channel configuration.

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

hasDesiredReleaseChannel

clearDesiredReleaseChannel

setDesiredReleaseChannel

The desired release channel configuration.

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

getDesiredL4IlbSubsettingConfig

The desired L4 Internal Load Balancer Subsetting configuration.

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

hasDesiredL4IlbSubsettingConfig

clearDesiredL4IlbSubsettingConfig

setDesiredL4IlbSubsettingConfig

The desired L4 Internal Load Balancer Subsetting configuration.

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

getDesiredDatapathProvider

The desired datapath provider for the cluster.

Returns
TypeDescription
int

setDesiredDatapathProvider

The desired datapath provider for the cluster.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getDesiredPrivateIpv6GoogleAccess

The desired state of IPv6 connectivity to Google Services.

Returns
TypeDescription
int

setDesiredPrivateIpv6GoogleAccess

The desired state of IPv6 connectivity to Google Services.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getDesiredNotificationConfig

The desired notification configuration.

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

hasDesiredNotificationConfig

clearDesiredNotificationConfig

setDesiredNotificationConfig

The desired notification configuration.

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

getDesiredAuthenticatorGroupsConfig

The desired authenticator groups config for the cluster.

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

hasDesiredAuthenticatorGroupsConfig

clearDesiredAuthenticatorGroupsConfig

setDesiredAuthenticatorGroupsConfig

The desired authenticator groups config for the cluster.

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

getDesiredLoggingConfig

The desired logging configuration.

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

hasDesiredLoggingConfig

clearDesiredLoggingConfig

setDesiredLoggingConfig

The desired logging configuration.

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

getDesiredMonitoringConfig

The desired monitoring configuration.

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

hasDesiredMonitoringConfig

clearDesiredMonitoringConfig

setDesiredMonitoringConfig

The desired monitoring configuration.

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

getDesiredIdentityServiceConfig

The desired Identity Service component configuration.

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

hasDesiredIdentityServiceConfig

clearDesiredIdentityServiceConfig

setDesiredIdentityServiceConfig

The desired Identity Service component configuration.

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

getDesiredServiceExternalIpsConfig

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

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

hasDesiredServiceExternalIpsConfig

clearDesiredServiceExternalIpsConfig

setDesiredServiceExternalIpsConfig

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

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

getDesiredEnablePrivateEndpoint

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

Returns
TypeDescription
bool

hasDesiredEnablePrivateEndpoint

clearDesiredEnablePrivateEndpoint

setDesiredEnablePrivateEndpoint

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

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

getDesiredGcfsConfig

The desired GCFS config for the cluster

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

hasDesiredGcfsConfig

clearDesiredGcfsConfig

setDesiredGcfsConfig

The desired GCFS config for the cluster

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

getDesiredNodePoolAutoConfigNetworkTags

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

Returns
TypeDescription
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
NameDescription
var Google\Cloud\Container\V1\NetworkTags
Returns
TypeDescription
$this

getDesiredGatewayApiConfig

The desired config of Gateway API on this cluster.

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

hasDesiredGatewayApiConfig

clearDesiredGatewayApiConfig

setDesiredGatewayApiConfig

The desired config of Gateway API on this cluster.

Parameter
NameDescription
var Google\Cloud\Container\V1\GatewayAPIConfig
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

getDesiredNodePoolLoggingConfig

The desired node pool logging configuration defaults for the cluster.

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

hasDesiredNodePoolLoggingConfig

clearDesiredNodePoolLoggingConfig

setDesiredNodePoolLoggingConfig

The desired node pool logging configuration defaults for the cluster.

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

getDesiredFleet

The desired fleet configuration for the cluster.

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

hasDesiredFleet

clearDesiredFleet

setDesiredFleet

The desired fleet configuration for the cluster.

Parameter
NameDescription
var Google\Cloud\Container\V1\Fleet
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Cloud\Container\V1\AdditionalPodRangesConfig
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var Google\Cloud\Container\V1\AdditionalPodRangesConfig
Returns
TypeDescription
$this