Class ClusterUpdate.Builder (2.11.0)

public static final class ClusterUpdate.Builder extends GeneratedMessageV3.Builder<ClusterUpdate.Builder> implements ClusterUpdateOrBuilder

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.

Protobuf type google.container.v1beta1.ClusterUpdate

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllDesiredLocations(Iterable<String> values)

public ClusterUpdate.Builder addAllDesiredLocations(Iterable<String> values)

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.

repeated string desired_locations = 10;

Parameter
NameDescription
valuesIterable<String>

The desiredLocations to add.

Returns
TypeDescription
ClusterUpdate.Builder

This builder for chaining.

addDesiredLocations(String value)

public ClusterUpdate.Builder addDesiredLocations(String value)

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.

repeated string desired_locations = 10;

Parameter
NameDescription
valueString

The desiredLocations to add.

Returns
TypeDescription
ClusterUpdate.Builder

This builder for chaining.

addDesiredLocationsBytes(ByteString value)

public ClusterUpdate.Builder addDesiredLocationsBytes(ByteString value)

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.

repeated string desired_locations = 10;

Parameter
NameDescription
valueByteString

The bytes of the desiredLocations to add.

Returns
TypeDescription
ClusterUpdate.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ClusterUpdate.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ClusterUpdate.Builder
Overrides

build()

public ClusterUpdate build()
Returns
TypeDescription
ClusterUpdate

buildPartial()

public ClusterUpdate buildPartial()
Returns
TypeDescription
ClusterUpdate

clear()

public ClusterUpdate.Builder clear()
Returns
TypeDescription
ClusterUpdate.Builder
Overrides

clearDesiredAddonsConfig()

public ClusterUpdate.Builder clearDesiredAddonsConfig()

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

.google.container.v1beta1.AddonsConfig desired_addons_config = 6;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredAuthenticatorGroupsConfig()

public ClusterUpdate.Builder clearDesiredAuthenticatorGroupsConfig()

AuthenticatorGroupsConfig specifies the config for the cluster security groups settings.

.google.container.v1beta1.AuthenticatorGroupsConfig desired_authenticator_groups_config = 63;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredBinaryAuthorization()

public ClusterUpdate.Builder clearDesiredBinaryAuthorization()

The desired configuration options for the Binary Authorization feature.

.google.container.v1beta1.BinaryAuthorization desired_binary_authorization = 16;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredClusterAutoscaling()

public ClusterUpdate.Builder clearDesiredClusterAutoscaling()

Cluster-level autoscaling configuration.

.google.container.v1beta1.ClusterAutoscaling desired_cluster_autoscaling = 15;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredClusterTelemetry()

public ClusterUpdate.Builder clearDesiredClusterTelemetry()

The desired telemetry integration for the cluster.

.google.container.v1beta1.ClusterTelemetry desired_cluster_telemetry = 30;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredCostManagementConfig()

public ClusterUpdate.Builder clearDesiredCostManagementConfig()

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

.google.container.v1beta1.CostManagementConfig desired_cost_management_config = 49;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredDatabaseEncryption()

public ClusterUpdate.Builder clearDesiredDatabaseEncryption()

Configuration of etcd encryption.

.google.container.v1beta1.DatabaseEncryption desired_database_encryption = 46;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredDatapathProvider()

public ClusterUpdate.Builder clearDesiredDatapathProvider()

The desired datapath provider for the cluster.

.google.container.v1beta1.DatapathProvider desired_datapath_provider = 50;

Returns
TypeDescription
ClusterUpdate.Builder

This builder for chaining.

clearDesiredDefaultSnatStatus()

public ClusterUpdate.Builder clearDesiredDefaultSnatStatus()

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

.google.container.v1beta1.DefaultSnatStatus desired_default_snat_status = 28;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredDnsConfig()

public ClusterUpdate.Builder clearDesiredDnsConfig()

DNSConfig contains clusterDNS config for this cluster.

.google.container.v1beta1.DNSConfig desired_dns_config = 53;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredEnablePrivateEndpoint()

public ClusterUpdate.Builder clearDesiredEnablePrivateEndpoint()

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

optional bool desired_enable_private_endpoint = 71;

Returns
TypeDescription
ClusterUpdate.Builder

This builder for chaining.

clearDesiredGatewayApiConfig()

public ClusterUpdate.Builder clearDesiredGatewayApiConfig()

The desired config of Gateway API on this cluster.

.google.container.v1beta1.GatewayAPIConfig desired_gateway_api_config = 114;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredGcfsConfig()

public ClusterUpdate.Builder clearDesiredGcfsConfig()

The desired GCFS config for the cluster.

.google.container.v1beta1.GcfsConfig desired_gcfs_config = 109;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredIdentityServiceConfig()

public ClusterUpdate.Builder clearDesiredIdentityServiceConfig()

The desired Identity Service component configuration.

.google.container.v1beta1.IdentityServiceConfig desired_identity_service_config = 66;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredImageType()

public ClusterUpdate.Builder clearDesiredImageType()

The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.

string desired_image_type = 8;

Returns
TypeDescription
ClusterUpdate.Builder

This builder for chaining.

clearDesiredIntraNodeVisibilityConfig()

public ClusterUpdate.Builder clearDesiredIntraNodeVisibilityConfig()

The desired config of Intra-node visibility.

.google.container.v1beta1.IntraNodeVisibilityConfig desired_intra_node_visibility_config = 26;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredL4IlbSubsettingConfig()

public ClusterUpdate.Builder clearDesiredL4IlbSubsettingConfig()

The desired L4 Internal Load Balancer Subsetting configuration.

.google.container.v1beta1.ILBSubsettingConfig desired_l4ilb_subsetting_config = 39;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredLocations()

public ClusterUpdate.Builder clearDesiredLocations()

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.

repeated string desired_locations = 10;

Returns
TypeDescription
ClusterUpdate.Builder

This builder for chaining.

clearDesiredLoggingConfig()

public ClusterUpdate.Builder clearDesiredLoggingConfig()

The desired logging configuration.

.google.container.v1beta1.LoggingConfig desired_logging_config = 64;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredLoggingService()

public ClusterUpdate.Builder clearDesiredLoggingService()

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.

string desired_logging_service = 19;

Returns
TypeDescription
ClusterUpdate.Builder

This builder for chaining.

clearDesiredMaster()

public ClusterUpdate.Builder clearDesiredMaster()

Configuration for master components.

.google.container.v1beta1.Master desired_master = 52;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredMasterAuthorizedNetworksConfig()

public ClusterUpdate.Builder clearDesiredMasterAuthorizedNetworksConfig()

The desired configuration options for master authorized networks feature.

.google.container.v1beta1.MasterAuthorizedNetworksConfig desired_master_authorized_networks_config = 12;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredMasterVersion()

public ClusterUpdate.Builder clearDesiredMasterVersion()

The Kubernetes version to change the master to. The only valid value is the latest supported version. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:

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

string desired_master_version = 100;

Returns
TypeDescription
ClusterUpdate.Builder

This builder for chaining.

clearDesiredMeshCertificates()

public ClusterUpdate.Builder clearDesiredMeshCertificates()

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

.google.container.v1beta1.MeshCertificates desired_mesh_certificates = 67;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredMonitoringConfig()

public ClusterUpdate.Builder clearDesiredMonitoringConfig()

The desired monitoring configuration.

.google.container.v1beta1.MonitoringConfig desired_monitoring_config = 65;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredMonitoringService()

public ClusterUpdate.Builder clearDesiredMonitoringService()

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.

string desired_monitoring_service = 5;

Returns
TypeDescription
ClusterUpdate.Builder

This builder for chaining.

clearDesiredNodePoolAutoConfigNetworkTags()

public ClusterUpdate.Builder clearDesiredNodePoolAutoConfigNetworkTags()

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

.google.container.v1beta1.NetworkTags desired_node_pool_auto_config_network_tags = 110;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredNodePoolAutoscaling()

public ClusterUpdate.Builder clearDesiredNodePoolAutoscaling()

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.

.google.container.v1beta1.NodePoolAutoscaling desired_node_pool_autoscaling = 9;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredNodePoolId()

public ClusterUpdate.Builder clearDesiredNodePoolId()

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

string desired_node_pool_id = 7;

Returns
TypeDescription
ClusterUpdate.Builder

This builder for chaining.

clearDesiredNodePoolLoggingConfig()

public ClusterUpdate.Builder clearDesiredNodePoolLoggingConfig()

The desired node pool logging configuration defaults for the cluster.

.google.container.v1beta1.NodePoolLoggingConfig desired_node_pool_logging_config = 116;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredNodeVersion()

public ClusterUpdate.Builder clearDesiredNodeVersion()

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

string desired_node_version = 4;

Returns
TypeDescription
ClusterUpdate.Builder

This builder for chaining.

clearDesiredNotificationConfig()

public ClusterUpdate.Builder clearDesiredNotificationConfig()

The desired notification configuration.

.google.container.v1beta1.NotificationConfig desired_notification_config = 55;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredPodSecurityPolicyConfig()

public ClusterUpdate.Builder clearDesiredPodSecurityPolicyConfig()

The desired configuration options for the PodSecurityPolicy feature.

.google.container.v1beta1.PodSecurityPolicyConfig desired_pod_security_policy_config = 14;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredPrivateClusterConfig()

public ClusterUpdate.Builder clearDesiredPrivateClusterConfig()

The desired private cluster configuration.

.google.container.v1beta1.PrivateClusterConfig desired_private_cluster_config = 25;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredPrivateIpv6GoogleAccess()

public ClusterUpdate.Builder clearDesiredPrivateIpv6GoogleAccess()

The desired state of IPv6 connectivity to Google Services.

.google.container.v1beta1.PrivateIPv6GoogleAccess desired_private_ipv6_google_access = 51;

Returns
TypeDescription
ClusterUpdate.Builder

This builder for chaining.

clearDesiredProtectConfig()

public ClusterUpdate.Builder clearDesiredProtectConfig()

Enable/Disable Protect API features for the cluster.

optional .google.container.v1beta1.ProtectConfig desired_protect_config = 112;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredReleaseChannel()

public ClusterUpdate.Builder clearDesiredReleaseChannel()

The desired release channel configuration.

.google.container.v1beta1.ReleaseChannel desired_release_channel = 31;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredResourceUsageExportConfig()

public ClusterUpdate.Builder clearDesiredResourceUsageExportConfig()

The desired configuration for exporting resource usage.

.google.container.v1beta1.ResourceUsageExportConfig desired_resource_usage_export_config = 21;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredServiceExternalIpsConfig()

public ClusterUpdate.Builder clearDesiredServiceExternalIpsConfig()

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

.google.container.v1beta1.ServiceExternalIPsConfig desired_service_external_ips_config = 60;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredShieldedNodes()

public ClusterUpdate.Builder clearDesiredShieldedNodes()

Configuration for Shielded Nodes.

.google.container.v1beta1.ShieldedNodes desired_shielded_nodes = 48;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredStackType()

public ClusterUpdate.Builder clearDesiredStackType()

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.

.google.container.v1beta1.StackType desired_stack_type = 119;

Returns
TypeDescription
ClusterUpdate.Builder

This builder for chaining.

clearDesiredTpuConfig()

public ClusterUpdate.Builder clearDesiredTpuConfig()

The desired Cloud TPU configuration.

.google.container.v1beta1.TpuConfig desired_tpu_config = 38;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredVerticalPodAutoscaling()

public ClusterUpdate.Builder clearDesiredVerticalPodAutoscaling()

Cluster-level Vertical Pod Autoscaling configuration.

.google.container.v1beta1.VerticalPodAutoscaling desired_vertical_pod_autoscaling = 22;

Returns
TypeDescription
ClusterUpdate.Builder

clearDesiredWorkloadAltsConfig()

public ClusterUpdate.Builder clearDesiredWorkloadAltsConfig()

Configuration for direct-path (via ALTS) with workload identity.

.google.container.v1beta1.WorkloadALTSConfig desired_workload_alts_config = 62;

Returns
TypeDescription
ClusterUpdate.Builder