Google Cloud Container V1 Client - Class ClusterUpdate (1.9.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
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.
↳ 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.
↳ desired_node_pool_logging_config Google\Cloud\Container\V1\NodePoolLoggingConfig

The desired node pool logging configuration defaults for the cluster.

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

Generated from protobuf field string desired_node_version = 4;

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

Generated from protobuf field string desired_node_version = 4;

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.

Generated from protobuf field string desired_monitoring_service = 5;

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.

Generated from protobuf field string desired_monitoring_service = 5;

Parameter
Name Description
var string
Returns
Type Description
$this

getDesiredAddonsConfig

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

Generated from protobuf field .google.container.v1.AddonsConfig desired_addons_config = 6;

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

hasDesiredAddonsConfig

clearDesiredAddonsConfig

setDesiredAddonsConfig

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

Generated from protobuf field .google.container.v1.AddonsConfig desired_addons_config = 6;

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.

Generated from protobuf field string desired_node_pool_id = 7;

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.

Generated from protobuf field string desired_node_pool_id = 7;

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.

Generated from protobuf field string desired_image_type = 8;

Returns
Type Description
string

setDesiredImageType

The desired image type for the node pool.

NOTE: Set the "desired_node_pool" field as well.

Generated from protobuf field string desired_image_type = 8;

Parameter
Name Description
var string
Returns
Type Description
$this

getDesiredDatabaseEncryption

Configuration of etcd encryption.

Generated from protobuf field .google.container.v1.DatabaseEncryption desired_database_encryption = 46;

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

hasDesiredDatabaseEncryption

clearDesiredDatabaseEncryption

setDesiredDatabaseEncryption

Configuration of etcd encryption.

Generated from protobuf field .google.container.v1.DatabaseEncryption desired_database_encryption = 46;

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

getDesiredWorkloadIdentityConfig

Configuration for Workload Identity.

Generated from protobuf field .google.container.v1.WorkloadIdentityConfig desired_workload_identity_config = 47;

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

hasDesiredWorkloadIdentityConfig

clearDesiredWorkloadIdentityConfig

setDesiredWorkloadIdentityConfig

Configuration for Workload Identity.

Generated from protobuf field .google.container.v1.WorkloadIdentityConfig desired_workload_identity_config = 47;

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.

Generated from protobuf field .google.container.v1.MeshCertificates desired_mesh_certificates = 67;

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

hasDesiredMeshCertificates

clearDesiredMeshCertificates

setDesiredMeshCertificates

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

Generated from protobuf field .google.container.v1.MeshCertificates desired_mesh_certificates = 67;

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

getDesiredShieldedNodes

Configuration for Shielded Nodes.

Generated from protobuf field .google.container.v1.ShieldedNodes desired_shielded_nodes = 48;

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

hasDesiredShieldedNodes

clearDesiredShieldedNodes

setDesiredShieldedNodes

Configuration for Shielded Nodes.

Generated from protobuf field .google.container.v1.ShieldedNodes desired_shielded_nodes = 48;

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

getDesiredCostManagementConfig

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

Generated from protobuf field .google.container.v1.CostManagementConfig desired_cost_management_config = 49;

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

hasDesiredCostManagementConfig

clearDesiredCostManagementConfig

setDesiredCostManagementConfig

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

Generated from protobuf field .google.container.v1.CostManagementConfig desired_cost_management_config = 49;

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

getDesiredDnsConfig

DNSConfig contains clusterDNS config for this cluster.

Generated from protobuf field .google.container.v1.DNSConfig desired_dns_config = 53;

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

hasDesiredDnsConfig

clearDesiredDnsConfig

setDesiredDnsConfig

DNSConfig contains clusterDNS config for this cluster.

Generated from protobuf field .google.container.v1.DNSConfig desired_dns_config = 53;

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.

Generated from protobuf field .google.container.v1.NodePoolAutoscaling desired_node_pool_autoscaling = 9;

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.

Generated from protobuf field .google.container.v1.NodePoolAutoscaling desired_node_pool_autoscaling = 9;

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.

Generated from protobuf field repeated string desired_locations = 10;

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.

Generated from protobuf field repeated string desired_locations = 10;

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

getDesiredMasterAuthorizedNetworksConfig

The desired configuration options for master authorized networks feature.

Generated from protobuf field .google.container.v1.MasterAuthorizedNetworksConfig desired_master_authorized_networks_config = 12;

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

hasDesiredMasterAuthorizedNetworksConfig

clearDesiredMasterAuthorizedNetworksConfig

setDesiredMasterAuthorizedNetworksConfig

The desired configuration options for master authorized networks feature.

Generated from protobuf field .google.container.v1.MasterAuthorizedNetworksConfig desired_master_authorized_networks_config = 12;

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

getDesiredClusterAutoscaling

Cluster-level autoscaling configuration.

Generated from protobuf field .google.container.v1.ClusterAutoscaling desired_cluster_autoscaling = 15;

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

hasDesiredClusterAutoscaling

clearDesiredClusterAutoscaling

setDesiredClusterAutoscaling

Cluster-level autoscaling configuration.

Generated from protobuf field .google.container.v1.ClusterAutoscaling desired_cluster_autoscaling = 15;

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

getDesiredBinaryAuthorization

The desired configuration options for the Binary Authorization feature.

Generated from protobuf field .google.container.v1.BinaryAuthorization desired_binary_authorization = 16;

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

hasDesiredBinaryAuthorization

clearDesiredBinaryAuthorization

setDesiredBinaryAuthorization

The desired configuration options for the Binary Authorization feature.

Generated from protobuf field .google.container.v1.BinaryAuthorization desired_binary_authorization = 16;

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.

Generated from protobuf field string desired_logging_service = 19;

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.

Generated from protobuf field string desired_logging_service = 19;

Parameter
Name Description
var string
Returns
Type Description
$this

getDesiredResourceUsageExportConfig

The desired configuration for exporting resource usage.

Generated from protobuf field .google.container.v1.ResourceUsageExportConfig desired_resource_usage_export_config = 21;

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

hasDesiredResourceUsageExportConfig

clearDesiredResourceUsageExportConfig

setDesiredResourceUsageExportConfig

The desired configuration for exporting resource usage.

Generated from protobuf field .google.container.v1.ResourceUsageExportConfig desired_resource_usage_export_config = 21;

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

getDesiredVerticalPodAutoscaling

Cluster-level Vertical Pod Autoscaling configuration.

Generated from protobuf field .google.container.v1.VerticalPodAutoscaling desired_vertical_pod_autoscaling = 22;

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

hasDesiredVerticalPodAutoscaling

clearDesiredVerticalPodAutoscaling

setDesiredVerticalPodAutoscaling

Cluster-level Vertical Pod Autoscaling configuration.

Generated from protobuf field .google.container.v1.VerticalPodAutoscaling desired_vertical_pod_autoscaling = 22;

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

getDesiredPrivateClusterConfig

The desired private cluster configuration.

Generated from protobuf field .google.container.v1.PrivateClusterConfig desired_private_cluster_config = 25;

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

hasDesiredPrivateClusterConfig

clearDesiredPrivateClusterConfig

setDesiredPrivateClusterConfig

The desired private cluster configuration.

Generated from protobuf field .google.container.v1.PrivateClusterConfig desired_private_cluster_config = 25;

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

getDesiredIntraNodeVisibilityConfig

The desired config of Intra-node visibility.

Generated from protobuf field .google.container.v1.IntraNodeVisibilityConfig desired_intra_node_visibility_config = 26;

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

hasDesiredIntraNodeVisibilityConfig

clearDesiredIntraNodeVisibilityConfig

setDesiredIntraNodeVisibilityConfig

The desired config of Intra-node visibility.

Generated from protobuf field .google.container.v1.IntraNodeVisibilityConfig desired_intra_node_visibility_config = 26;

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.

Generated from protobuf field .google.container.v1.DefaultSnatStatus desired_default_snat_status = 28;

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

hasDesiredDefaultSnatStatus

clearDesiredDefaultSnatStatus

setDesiredDefaultSnatStatus

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

Generated from protobuf field .google.container.v1.DefaultSnatStatus desired_default_snat_status = 28;

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

getDesiredReleaseChannel

The desired release channel configuration.

Generated from protobuf field .google.container.v1.ReleaseChannel desired_release_channel = 31;

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

hasDesiredReleaseChannel

clearDesiredReleaseChannel

setDesiredReleaseChannel

The desired release channel configuration.

Generated from protobuf field .google.container.v1.ReleaseChannel desired_release_channel = 31;

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

getDesiredL4IlbSubsettingConfig

The desired L4 Internal Load Balancer Subsetting configuration.

Generated from protobuf field .google.container.v1.ILBSubsettingConfig desired_l4ilb_subsetting_config = 39;

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

hasDesiredL4IlbSubsettingConfig

clearDesiredL4IlbSubsettingConfig

setDesiredL4IlbSubsettingConfig

The desired L4 Internal Load Balancer Subsetting configuration.

Generated from protobuf field .google.container.v1.ILBSubsettingConfig desired_l4ilb_subsetting_config = 39;

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

getDesiredDatapathProvider

The desired datapath provider for the cluster.

Generated from protobuf field .google.container.v1.DatapathProvider desired_datapath_provider = 50;

Returns
Type Description
int

setDesiredDatapathProvider

The desired datapath provider for the cluster.

Generated from protobuf field .google.container.v1.DatapathProvider desired_datapath_provider = 50;

Parameter
Name Description
var int
Returns
Type Description
$this

getDesiredPrivateIpv6GoogleAccess

The desired state of IPv6 connectivity to Google Services.

Generated from protobuf field .google.container.v1.PrivateIPv6GoogleAccess desired_private_ipv6_google_access = 51;

Returns
Type Description
int

setDesiredPrivateIpv6GoogleAccess

The desired state of IPv6 connectivity to Google Services.

Generated from protobuf field .google.container.v1.PrivateIPv6GoogleAccess desired_private_ipv6_google_access = 51;

Parameter
Name Description
var int
Returns
Type Description
$this

getDesiredNotificationConfig

The desired notification configuration.

Generated from protobuf field .google.container.v1.NotificationConfig desired_notification_config = 55;

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

hasDesiredNotificationConfig

clearDesiredNotificationConfig

setDesiredNotificationConfig

The desired notification configuration.

Generated from protobuf field .google.container.v1.NotificationConfig desired_notification_config = 55;

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

getDesiredAuthenticatorGroupsConfig

The desired authenticator groups config for the cluster.

Generated from protobuf field .google.container.v1.AuthenticatorGroupsConfig desired_authenticator_groups_config = 63;

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

hasDesiredAuthenticatorGroupsConfig

clearDesiredAuthenticatorGroupsConfig

setDesiredAuthenticatorGroupsConfig

The desired authenticator groups config for the cluster.

Generated from protobuf field .google.container.v1.AuthenticatorGroupsConfig desired_authenticator_groups_config = 63;

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

getDesiredLoggingConfig

The desired logging configuration.

Generated from protobuf field .google.container.v1.LoggingConfig desired_logging_config = 64;

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

hasDesiredLoggingConfig

clearDesiredLoggingConfig

setDesiredLoggingConfig

The desired logging configuration.

Generated from protobuf field .google.container.v1.LoggingConfig desired_logging_config = 64;

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

getDesiredMonitoringConfig

The desired monitoring configuration.

Generated from protobuf field .google.container.v1.MonitoringConfig desired_monitoring_config = 65;

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

hasDesiredMonitoringConfig

clearDesiredMonitoringConfig

setDesiredMonitoringConfig

The desired monitoring configuration.

Generated from protobuf field .google.container.v1.MonitoringConfig desired_monitoring_config = 65;

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

getDesiredIdentityServiceConfig

The desired Identity Service component configuration.

Generated from protobuf field .google.container.v1.IdentityServiceConfig desired_identity_service_config = 66;

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

hasDesiredIdentityServiceConfig

clearDesiredIdentityServiceConfig

setDesiredIdentityServiceConfig

The desired Identity Service component configuration.

Generated from protobuf field .google.container.v1.IdentityServiceConfig desired_identity_service_config = 66;

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.

Generated from protobuf field .google.container.v1.ServiceExternalIPsConfig desired_service_external_ips_config = 60;

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

hasDesiredServiceExternalIpsConfig

clearDesiredServiceExternalIpsConfig

setDesiredServiceExternalIpsConfig

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

Generated from protobuf field .google.container.v1.ServiceExternalIPsConfig desired_service_external_ips_config = 60;

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

getDesiredEnablePrivateEndpoint

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

Generated from protobuf field optional bool desired_enable_private_endpoint = 71;

Returns
Type Description
bool

hasDesiredEnablePrivateEndpoint

clearDesiredEnablePrivateEndpoint

setDesiredEnablePrivateEndpoint

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

Generated from protobuf field optional bool desired_enable_private_endpoint = 71;

Parameter
Name Description
var bool
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

Generated from protobuf field string desired_master_version = 100;

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

Generated from protobuf field string desired_master_version = 100;

Parameter
Name Description
var string
Returns
Type Description
$this

getDesiredGcfsConfig

The desired GCFS config for the cluster

Generated from protobuf field .google.container.v1.GcfsConfig desired_gcfs_config = 109;

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

hasDesiredGcfsConfig

clearDesiredGcfsConfig

setDesiredGcfsConfig

The desired GCFS config for the cluster

Generated from protobuf field .google.container.v1.GcfsConfig desired_gcfs_config = 109;

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.

Generated from protobuf field .google.container.v1.NetworkTags desired_node_pool_auto_config_network_tags = 110;

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.

Generated from protobuf field .google.container.v1.NetworkTags desired_node_pool_auto_config_network_tags = 110;

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

getDesiredGatewayApiConfig

The desired config of Gateway API on this cluster.

Generated from protobuf field .google.container.v1.GatewayAPIConfig desired_gateway_api_config = 114;

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

hasDesiredGatewayApiConfig

clearDesiredGatewayApiConfig

setDesiredGatewayApiConfig

The desired config of Gateway API on this cluster.

Generated from protobuf field .google.container.v1.GatewayAPIConfig desired_gateway_api_config = 114;

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

getDesiredNodePoolLoggingConfig

The desired node pool logging configuration defaults for the cluster.

Generated from protobuf field .google.container.v1.NodePoolLoggingConfig desired_node_pool_logging_config = 116;

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

hasDesiredNodePoolLoggingConfig

clearDesiredNodePoolLoggingConfig

setDesiredNodePoolLoggingConfig

The desired node pool logging configuration defaults for the cluster.

Generated from protobuf field .google.container.v1.NodePoolLoggingConfig desired_node_pool_logging_config = 116;

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