Class Cluster.Builder (2.52.0) 

public static final class Cluster.Builder extends GeneratedMessageV3.Builder<Cluster.Builder> implements ClusterOrBuilder

A Google Kubernetes Engine cluster.

Protobuf type google.container.v1.Cluster

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Cluster.Builder

Implements

ClusterOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllConditions(Iterable<? extends StatusCondition> values)

public Cluster.Builder addAllConditions(Iterable<? extends StatusCondition> values)

Which conditions caused the current cluster state.

repeated .google.container.v1.StatusCondition conditions = 118;

Parameter
Name Description
values Iterable<? extends com.google.container.v1.StatusCondition>
Returns
Type Description
Cluster.Builder

addAllInstanceGroupUrls(Iterable<String> values) (deprecated)

public Cluster.Builder addAllInstanceGroupUrls(Iterable<String> values)

Deprecated. google.container.v1.Cluster.instance_group_urls is deprecated. See google/container/v1/cluster_service.proto;l=2024

Output only. Deprecated. Use node_pools.instance_group_urls.

repeated string instance_group_urls = 111 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
values Iterable<String>

The instanceGroupUrls to add.
Returns
Type Description
Cluster.Builder

This builder for chaining.

addAllLocations(Iterable<String> values)

public Cluster.Builder addAllLocations(Iterable<String> values)

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

This field provides a default value if NodePool.Locations are not specified during node pool creation.

Warning: changing cluster locations will update the NodePool.Locations of all node pools and will result in nodes being added and/or removed.

repeated string locations = 13;

Parameter
Name Description
values Iterable<String>

The locations to add.
Returns
Type Description
Cluster.Builder

This builder for chaining.

addAllNodePools(Iterable<? extends NodePool> values)

public Cluster.Builder addAllNodePools(Iterable<? extends NodePool> values)

The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

repeated .google.container.v1.NodePool node_pools = 12;

Parameter
Name Description
values Iterable<? extends com.google.container.v1.NodePool>
Returns
Type Description
Cluster.Builder

addConditions(StatusCondition value)

public Cluster.Builder addConditions(StatusCondition value)

Which conditions caused the current cluster state.

repeated .google.container.v1.StatusCondition conditions = 118;

Parameter
Name Description
value StatusCondition
Returns
Type Description
Cluster.Builder

addConditions(StatusCondition.Builder builderForValue)

public Cluster.Builder addConditions(StatusCondition.Builder builderForValue)

Which conditions caused the current cluster state.

repeated .google.container.v1.StatusCondition conditions = 118;

Parameter
Name Description
builderForValue StatusCondition.Builder
Returns
Type Description
Cluster.Builder

addConditions(int index, StatusCondition value)

public Cluster.Builder addConditions(int index, StatusCondition value)

Which conditions caused the current cluster state.

repeated .google.container.v1.StatusCondition conditions = 118;

Parameters
Name Description
index int
value StatusCondition
Returns
Type Description
Cluster.Builder

addConditions(int index, StatusCondition.Builder builderForValue)

public Cluster.Builder addConditions(int index, StatusCondition.Builder builderForValue)

Which conditions caused the current cluster state.

repeated .google.container.v1.StatusCondition conditions = 118;

Parameters
Name Description
index int
builderForValue StatusCondition.Builder
Returns
Type Description
Cluster.Builder

addConditionsBuilder()

public StatusCondition.Builder addConditionsBuilder()

Which conditions caused the current cluster state.

repeated .google.container.v1.StatusCondition conditions = 118;

Returns
Type Description
StatusCondition.Builder

addConditionsBuilder(int index)

public StatusCondition.Builder addConditionsBuilder(int index)

Which conditions caused the current cluster state.

repeated .google.container.v1.StatusCondition conditions = 118;

Parameter
Name Description
index int
Returns
Type Description
StatusCondition.Builder

addInstanceGroupUrls(String value) (deprecated)

public Cluster.Builder addInstanceGroupUrls(String value)

Deprecated. google.container.v1.Cluster.instance_group_urls is deprecated. See google/container/v1/cluster_service.proto;l=2024

Output only. Deprecated. Use node_pools.instance_group_urls.

repeated string instance_group_urls = 111 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The instanceGroupUrls to add.
Returns
Type Description
Cluster.Builder

This builder for chaining.

addInstanceGroupUrlsBytes(ByteString value) (deprecated)

public Cluster.Builder addInstanceGroupUrlsBytes(ByteString value)

Deprecated. google.container.v1.Cluster.instance_group_urls is deprecated. See google/container/v1/cluster_service.proto;l=2024

Output only. Deprecated. Use node_pools.instance_group_urls.

repeated string instance_group_urls = 111 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes of the instanceGroupUrls to add.
Returns
Type Description
Cluster.Builder

This builder for chaining.

addLocations(String value)

public Cluster.Builder addLocations(String value)

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

This field provides a default value if NodePool.Locations are not specified during node pool creation.

Warning: changing cluster locations will update the NodePool.Locations of all node pools and will result in nodes being added and/or removed.

repeated string locations = 13;

Parameter
Name Description
value String

The locations to add.
Returns
Type Description
Cluster.Builder

This builder for chaining.

addLocationsBytes(ByteString value)

public Cluster.Builder addLocationsBytes(ByteString value)

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

This field provides a default value if NodePool.Locations are not specified during node pool creation.

Warning: changing cluster locations will update the NodePool.Locations of all node pools and will result in nodes being added and/or removed.

repeated string locations = 13;

Parameter
Name Description
value ByteString

The bytes of the locations to add.
Returns
Type Description
Cluster.Builder

This builder for chaining.

addNodePools(NodePool value)

public Cluster.Builder addNodePools(NodePool value)

The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

repeated .google.container.v1.NodePool node_pools = 12;

Parameter
Name Description
value NodePool
Returns
Type Description
Cluster.Builder

addNodePools(NodePool.Builder builderForValue)

public Cluster.Builder addNodePools(NodePool.Builder builderForValue)

The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

repeated .google.container.v1.NodePool node_pools = 12;

Parameter
Name Description
builderForValue NodePool.Builder
Returns
Type Description
Cluster.Builder

addNodePools(int index, NodePool value)

public Cluster.Builder addNodePools(int index, NodePool value)

The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

repeated .google.container.v1.NodePool node_pools = 12;

Parameters
Name Description
index int
value NodePool
Returns
Type Description
Cluster.Builder

addNodePools(int index, NodePool.Builder builderForValue)

public Cluster.Builder addNodePools(int index, NodePool.Builder builderForValue)

The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

repeated .google.container.v1.NodePool node_pools = 12;

Parameters
Name Description
index int
builderForValue NodePool.Builder
Returns
Type Description
Cluster.Builder

addNodePoolsBuilder()

public NodePool.Builder addNodePoolsBuilder()

The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

repeated .google.container.v1.NodePool node_pools = 12;

Returns
Type Description
NodePool.Builder

addNodePoolsBuilder(int index)

public NodePool.Builder addNodePoolsBuilder(int index)

The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

repeated .google.container.v1.NodePool node_pools = 12;

Parameter
Name Description
index int
Returns
Type Description
NodePool.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Cluster.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Cluster.Builder
Overrides

build()

public Cluster build()
Returns
Type Description
Cluster

buildPartial()

public Cluster buildPartial()
Returns
Type Description
Cluster

clear()

public Cluster.Builder clear()
Returns
Type Description
Cluster.Builder
Overrides

clearAddonsConfig()

public Cluster.Builder clearAddonsConfig()

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

.google.container.v1.AddonsConfig addons_config = 10;

Returns
Type Description
Cluster.Builder

clearAuthenticatorGroupsConfig()

public Cluster.Builder clearAuthenticatorGroupsConfig()

Configuration controlling RBAC group membership information.

.google.container.v1.AuthenticatorGroupsConfig authenticator_groups_config = 34;

Returns
Type Description
Cluster.Builder

clearAutopilot()

public Cluster.Builder clearAutopilot()

Autopilot configuration for the cluster.

.google.container.v1.Autopilot autopilot = 128;

Returns
Type Description
Cluster.Builder

clearAutoscaling()

public Cluster.Builder clearAutoscaling()

Cluster-level autoscaling configuration.

.google.container.v1.ClusterAutoscaling autoscaling = 26;

Returns
Type Description
Cluster.Builder

clearBinaryAuthorization()

public Cluster.Builder clearBinaryAuthorization()

Configuration for Binary Authorization.

.google.container.v1.BinaryAuthorization binary_authorization = 24;

Returns
Type Description
Cluster.Builder

clearClusterIpv4Cidr()

public Cluster.Builder clearClusterIpv4Cidr()

The IP address range of the container pods in this cluster, in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8.

string cluster_ipv4_cidr = 9;

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearConditions()

public Cluster.Builder clearConditions()

Which conditions caused the current cluster state.

repeated .google.container.v1.StatusCondition conditions = 118;

Returns
Type Description
Cluster.Builder

clearConfidentialNodes()

public Cluster.Builder clearConfidentialNodes()

Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled.

.google.container.v1.ConfidentialNodes confidential_nodes = 50;

Returns
Type Description
Cluster.Builder

clearCostManagementConfig()

public Cluster.Builder clearCostManagementConfig()

Configuration for the fine-grained cost management feature.

.google.container.v1.CostManagementConfig cost_management_config = 45;

Returns
Type Description
Cluster.Builder

clearCreateTime()

public Cluster.Builder clearCreateTime()

Output only. The time the cluster was created, in RFC3339 text format.

string create_time = 106 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearCurrentMasterVersion()

public Cluster.Builder clearCurrentMasterVersion()

Output only. The current software version of the master endpoint.

string current_master_version = 104 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearCurrentNodeCount() (deprecated)

public Cluster.Builder clearCurrentNodeCount()

Deprecated. google.container.v1.Cluster.current_node_count is deprecated. See google/container/v1/cluster_service.proto;l=2029

Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.

int32 current_node_count = 112 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearCurrentNodeVersion() (deprecated)

public Cluster.Builder clearCurrentNodeVersion()

Deprecated. google.container.v1.Cluster.current_node_version is deprecated. See google/container/v1/cluster_service.proto;l=1994

Output only. Deprecated, use NodePools.version instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.

string current_node_version = 105 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearDatabaseEncryption()

public Cluster.Builder clearDatabaseEncryption()

Configuration of etcd encryption.

.google.container.v1.DatabaseEncryption database_encryption = 38;

Returns
Type Description
Cluster.Builder

clearDefaultMaxPodsConstraint()

public Cluster.Builder clearDefaultMaxPodsConstraint()

The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.

.google.container.v1.MaxPodsConstraint default_max_pods_constraint = 30;

Returns
Type Description
Cluster.Builder

clearDescription()

public Cluster.Builder clearDescription()

An optional description of this cluster.

string description = 2;

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearEnableK8SBetaApis()

public Cluster.Builder clearEnableK8SBetaApis()

Beta APIs Config

.google.container.v1.K8sBetaAPIConfig enable_k8s_beta_apis = 143;

Returns
Type Description
Cluster.Builder

clearEnableKubernetesAlpha()

public Cluster.Builder clearEnableKubernetesAlpha()

Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.

bool enable_kubernetes_alpha = 14;

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearEnableTpu()

public Cluster.Builder clearEnableTpu()

Enable the ability to use Cloud TPUs in this cluster.

bool enable_tpu = 115;

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearEndpoint()

public Cluster.Builder clearEndpoint()

Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at https://username:password@endpoint/.

See the masterAuth property of this resource for username and password information.

string endpoint = 102 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearEnterpriseConfig()

public Cluster.Builder clearEnterpriseConfig()

GKE Enterprise Configuration.

.google.container.v1.EnterpriseConfig enterprise_config = 149;

Returns
Type Description
Cluster.Builder

clearEtag()

public Cluster.Builder clearEtag()

This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.

string etag = 139;

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearExpireTime()

public Cluster.Builder clearExpireTime()

Output only. The time the cluster will be automatically deleted in RFC3339 text format.

string expire_time = 113 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Cluster.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Cluster.Builder
Overrides

clearFleet()

public Cluster.Builder clearFleet()

Fleet information for the cluster.

.google.container.v1.Fleet fleet = 140;

Returns
Type Description
Cluster.Builder

clearId()

public Cluster.Builder clearId()

Output only. Unique id for the cluster.

string id = 129 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearIdentityServiceConfig()

public Cluster.Builder clearIdentityServiceConfig()

Configuration for Identity Service component.

.google.container.v1.IdentityServiceConfig identity_service_config = 54;

Returns
Type Description
Cluster.Builder

clearInitialClusterVersion()

public Cluster.Builder clearInitialClusterVersion()

The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion.

Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:

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

string initial_cluster_version = 103;

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearInitialNodeCount() (deprecated)

public Cluster.Builder clearInitialNodeCount()

Deprecated. google.container.v1.Cluster.initial_node_count is deprecated. See google/container/v1/cluster_service.proto;l=1775

The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time.

This field is deprecated, use node_pool.initial_node_count instead.

int32 initial_node_count = 3 [deprecated = true];

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearInstanceGroupUrls() (deprecated)

public Cluster.Builder clearInstanceGroupUrls()

Deprecated. google.container.v1.Cluster.instance_group_urls is deprecated. See google/container/v1/cluster_service.proto;l=2024

Output only. Deprecated. Use node_pools.instance_group_urls.

repeated string instance_group_urls = 111 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearIpAllocationPolicy()

public Cluster.Builder clearIpAllocationPolicy()

Configuration for cluster IP allocation.

.google.container.v1.IPAllocationPolicy ip_allocation_policy = 20;

Returns
Type Description
Cluster.Builder

clearLabelFingerprint()

public Cluster.Builder clearLabelFingerprint()

The fingerprint of the set of labels for this cluster.

string label_fingerprint = 16;

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearLegacyAbac()

public Cluster.Builder clearLegacyAbac()

Configuration for the legacy ABAC authorization mode.

.google.container.v1.LegacyAbac legacy_abac = 18;

Returns
Type Description
Cluster.Builder

clearLocation()

public Cluster.Builder clearLocation()

Output only. The name of the Google Compute Engine zone or region in which the cluster resides.

string location = 114 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearLocations()

public Cluster.Builder clearLocations()

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

This field provides a default value if NodePool.Locations are not specified during node pool creation.

Warning: changing cluster locations will update the NodePool.Locations of all node pools and will result in nodes being added and/or removed.

repeated string locations = 13;

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearLoggingConfig()

public Cluster.Builder clearLoggingConfig()

Logging configuration for the cluster.

.google.container.v1.LoggingConfig logging_config = 132;

Returns
Type Description
Cluster.Builder

clearLoggingService()

public Cluster.Builder clearLoggingService()

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 logging_service = 6;

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearMaintenancePolicy()

public Cluster.Builder clearMaintenancePolicy()

Configure the maintenance policy for this cluster.

.google.container.v1.MaintenancePolicy maintenance_policy = 23;

Returns
Type Description
Cluster.Builder

clearMasterAuth()

public Cluster.Builder clearMasterAuth()

The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, username will be set to "admin", a random password will be generated, and a client certificate will be issued.

.google.container.v1.MasterAuth master_auth = 5;

Returns
Type Description
Cluster.Builder

clearMasterAuthorizedNetworksConfig()

public Cluster.Builder clearMasterAuthorizedNetworksConfig()

The configuration options for master authorized networks feature.

.google.container.v1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 22;

Returns
Type Description
Cluster.Builder

clearMeshCertificates()

public Cluster.Builder clearMeshCertificates()

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

.google.container.v1.MeshCertificates mesh_certificates = 67;

Returns
Type Description
Cluster.Builder

clearMonitoringConfig()

public Cluster.Builder clearMonitoringConfig()

Monitoring configuration for the cluster.

.google.container.v1.MonitoringConfig monitoring_config = 133;

Returns
Type Description
Cluster.Builder

clearMonitoringService()

public Cluster.Builder clearMonitoringService()

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 monitoring_service = 7;

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearName()

public Cluster.Builder clearName()

The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions:

  • Lowercase letters, numbers, and hyphens only.
  • Must start with a letter.
  • Must end with a number or a letter.

string name = 1;

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearNetwork()

public Cluster.Builder clearNetwork()

The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.

string network = 8;

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearNetworkConfig()

public Cluster.Builder clearNetworkConfig()

Configuration for cluster networking.

.google.container.v1.NetworkConfig network_config = 27;

Returns
Type Description
Cluster.Builder

clearNetworkPolicy()

public Cluster.Builder clearNetworkPolicy()

Configuration options for the NetworkPolicy feature.

.google.container.v1.NetworkPolicy network_policy = 19;

Returns
Type Description
Cluster.Builder

clearNodeConfig() (deprecated)

public Cluster.Builder clearNodeConfig()

Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see node_pool.config)

If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.

.google.container.v1.NodeConfig node_config = 4 [deprecated = true];

Returns
Type Description
Cluster.Builder

clearNodeIpv4CidrSize()

public Cluster.Builder clearNodeIpv4CidrSize()

Output only. The size of the address space on each node for hosting containers. This is provisioned from within the container_ipv4_cidr range. This field will only be set when cluster is in route-based network mode.

int32 node_ipv4_cidr_size = 109 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearNodePoolAutoConfig()

public Cluster.Builder clearNodePoolAutoConfig()

Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

.google.container.v1.NodePoolAutoConfig node_pool_auto_config = 136;

Returns
Type Description
Cluster.Builder

clearNodePoolDefaults()

public Cluster.Builder clearNodePoolDefaults()

Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.

optional .google.container.v1.NodePoolDefaults node_pool_defaults = 131;

Returns
Type Description
Cluster.Builder

clearNodePools()

public Cluster.Builder clearNodePools()

The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

repeated .google.container.v1.NodePool node_pools = 12;

Returns
Type Description
Cluster.Builder

clearNotificationConfig()

public Cluster.Builder clearNotificationConfig()

Notification configuration of the cluster.

.google.container.v1.NotificationConfig notification_config = 49;

Returns
Type Description
Cluster.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Cluster.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Cluster.Builder
Overrides

clearPrivateClusterConfig()

public Cluster.Builder clearPrivateClusterConfig()

Configuration for private cluster.

.google.container.v1.PrivateClusterConfig private_cluster_config = 37;

Returns
Type Description
Cluster.Builder

clearReleaseChannel()

public Cluster.Builder clearReleaseChannel()

Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version.

.google.container.v1.ReleaseChannel release_channel = 41;

Returns
Type Description
Cluster.Builder

clearResourceLabels()

public Cluster.Builder clearResourceLabels()
Returns
Type Description
Cluster.Builder

clearResourceUsageExportConfig()

public Cluster.Builder clearResourceUsageExportConfig()

Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.

.google.container.v1.ResourceUsageExportConfig resource_usage_export_config = 33;

Returns
Type Description
Cluster.Builder

clearSatisfiesPzi()

public Cluster.Builder clearSatisfiesPzi()

Output only. Reserved for future use.

optional bool satisfies_pzi = 153 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearSatisfiesPzs()

public Cluster.Builder clearSatisfiesPzs()

Output only. Reserved for future use.

optional bool satisfies_pzs = 152 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearSecurityPostureConfig()

public Cluster.Builder clearSecurityPostureConfig()

Enable/Disable Security Posture API features for the cluster.

.google.container.v1.SecurityPostureConfig security_posture_config = 145;

Returns
Type Description
Cluster.Builder

clearSelfLink()

public Cluster.Builder clearSelfLink()

Output only. Server-defined URL for the resource.

string self_link = 100 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearServicesIpv4Cidr()

public Cluster.Builder clearServicesIpv4Cidr()

Output only. The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the container CIDR.

string services_ipv4_cidr = 110 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearShieldedNodes()

public Cluster.Builder clearShieldedNodes()

Shielded Nodes configuration.

.google.container.v1.ShieldedNodes shielded_nodes = 40;

Returns
Type Description
Cluster.Builder

clearStatus()

public Cluster.Builder clearStatus()

Output only. The current status of this cluster.

.google.container.v1.Cluster.Status status = 107 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearStatusMessage() (deprecated)

public Cluster.Builder clearStatusMessage()

Deprecated. google.container.v1.Cluster.status_message is deprecated. See google/container/v1/cluster_service.proto;l=2007

Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.

string status_message = 108 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearSubnetwork()

public Cluster.Builder clearSubnetwork()

The name of the Google Compute Engine subnetwork to which the cluster is connected.

string subnetwork = 11;

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearTpuIpv4CidrBlock()

public Cluster.Builder clearTpuIpv4CidrBlock()

Output only. The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. 1.2.3.4/29).

string tpu_ipv4_cidr_block = 116 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

This builder for chaining.

clearVerticalPodAutoscaling()

public Cluster.Builder clearVerticalPodAutoscaling()

Cluster-level Vertical Pod Autoscaling configuration.

.google.container.v1.VerticalPodAutoscaling vertical_pod_autoscaling = 39;

Returns
Type Description
Cluster.Builder

clearWorkloadIdentityConfig()

public Cluster.Builder clearWorkloadIdentityConfig()

Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.

.google.container.v1.WorkloadIdentityConfig workload_identity_config = 43;

Returns
Type Description
Cluster.Builder

clearZone() (deprecated)

public Cluster.Builder clearZone()

Deprecated. google.container.v1.Cluster.zone is deprecated. See google/container/v1/cluster_service.proto;l=1959

Output only. The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.

string zone = 101 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Builder

This builder for chaining.

clone()

public Cluster.Builder clone()
Returns
Type Description
Cluster.Builder
Overrides

containsResourceLabels(String key)

public boolean containsResourceLabels(String key)

The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

map<string, string> resource_labels = 15;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAddonsConfig()

public AddonsConfig getAddonsConfig()

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

.google.container.v1.AddonsConfig addons_config = 10;

Returns
Type Description
AddonsConfig

The addonsConfig.

getAddonsConfigBuilder()

public AddonsConfig.Builder getAddonsConfigBuilder()

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

.google.container.v1.AddonsConfig addons_config = 10;

Returns
Type Description
AddonsConfig.Builder

getAddonsConfigOrBuilder()

public AddonsConfigOrBuilder getAddonsConfigOrBuilder()

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

.google.container.v1.AddonsConfig addons_config = 10;

Returns
Type Description
AddonsConfigOrBuilder

getAuthenticatorGroupsConfig()

public AuthenticatorGroupsConfig getAuthenticatorGroupsConfig()

Configuration controlling RBAC group membership information.

.google.container.v1.AuthenticatorGroupsConfig authenticator_groups_config = 34;

Returns
Type Description
AuthenticatorGroupsConfig

The authenticatorGroupsConfig.

getAuthenticatorGroupsConfigBuilder()

public AuthenticatorGroupsConfig.Builder getAuthenticatorGroupsConfigBuilder()

Configuration controlling RBAC group membership information.

.google.container.v1.AuthenticatorGroupsConfig authenticator_groups_config = 34;

Returns
Type Description
AuthenticatorGroupsConfig.Builder

getAuthenticatorGroupsConfigOrBuilder()

public AuthenticatorGroupsConfigOrBuilder getAuthenticatorGroupsConfigOrBuilder()

Configuration controlling RBAC group membership information.

.google.container.v1.AuthenticatorGroupsConfig authenticator_groups_config = 34;

Returns
Type Description
AuthenticatorGroupsConfigOrBuilder

getAutopilot()

public Autopilot getAutopilot()

Autopilot configuration for the cluster.

.google.container.v1.Autopilot autopilot = 128;

Returns
Type Description
Autopilot

The autopilot.

getAutopilotBuilder()

public Autopilot.Builder getAutopilotBuilder()

Autopilot configuration for the cluster.

.google.container.v1.Autopilot autopilot = 128;

Returns
Type Description
Autopilot.Builder

getAutopilotOrBuilder()

public AutopilotOrBuilder getAutopilotOrBuilder()

Autopilot configuration for the cluster.

.google.container.v1.Autopilot autopilot = 128;

Returns
Type Description
AutopilotOrBuilder

getAutoscaling()

public ClusterAutoscaling getAutoscaling()

Cluster-level autoscaling configuration.

.google.container.v1.ClusterAutoscaling autoscaling = 26;

Returns
Type Description
ClusterAutoscaling

The autoscaling.

getAutoscalingBuilder()

public ClusterAutoscaling.Builder getAutoscalingBuilder()

Cluster-level autoscaling configuration.

.google.container.v1.ClusterAutoscaling autoscaling = 26;

Returns
Type Description
ClusterAutoscaling.Builder

getAutoscalingOrBuilder()

public ClusterAutoscalingOrBuilder getAutoscalingOrBuilder()

Cluster-level autoscaling configuration.

.google.container.v1.ClusterAutoscaling autoscaling = 26;

Returns
Type Description
ClusterAutoscalingOrBuilder

getBinaryAuthorization()

public BinaryAuthorization getBinaryAuthorization()

Configuration for Binary Authorization.

.google.container.v1.BinaryAuthorization binary_authorization = 24;

Returns
Type Description
BinaryAuthorization

The binaryAuthorization.

getBinaryAuthorizationBuilder()

public BinaryAuthorization.Builder getBinaryAuthorizationBuilder()

Configuration for Binary Authorization.

.google.container.v1.BinaryAuthorization binary_authorization = 24;

Returns
Type Description
BinaryAuthorization.Builder

getBinaryAuthorizationOrBuilder()

public BinaryAuthorizationOrBuilder getBinaryAuthorizationOrBuilder()

Configuration for Binary Authorization.

.google.container.v1.BinaryAuthorization binary_authorization = 24;

Returns
Type Description
BinaryAuthorizationOrBuilder

getClusterIpv4Cidr()

public String getClusterIpv4Cidr()

The IP address range of the container pods in this cluster, in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8.

string cluster_ipv4_cidr = 9;

Returns
Type Description
String

The clusterIpv4Cidr.

getClusterIpv4CidrBytes()

public ByteString getClusterIpv4CidrBytes()

The IP address range of the container pods in this cluster, in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8.

string cluster_ipv4_cidr = 9;

Returns
Type Description
ByteString

The bytes for clusterIpv4Cidr.

getConditions(int index)

public StatusCondition getConditions(int index)

Which conditions caused the current cluster state.

repeated .google.container.v1.StatusCondition conditions = 118;

Parameter
Name Description
index int
Returns
Type Description
StatusCondition

getConditionsBuilder(int index)

public StatusCondition.Builder getConditionsBuilder(int index)

Which conditions caused the current cluster state.

repeated .google.container.v1.StatusCondition conditions = 118;

Parameter
Name Description
index int
Returns
Type Description
StatusCondition.Builder

getConditionsBuilderList()

public List<StatusCondition.Builder> getConditionsBuilderList()

Which conditions caused the current cluster state.

repeated .google.container.v1.StatusCondition conditions = 118;

Returns
Type Description
List<Builder>

getConditionsCount()

public int getConditionsCount()

Which conditions caused the current cluster state.

repeated .google.container.v1.StatusCondition conditions = 118;

Returns
Type Description
int

getConditionsList()

public List<StatusCondition> getConditionsList()

Which conditions caused the current cluster state.

repeated .google.container.v1.StatusCondition conditions = 118;

Returns
Type Description
List<StatusCondition>

getConditionsOrBuilder(int index)

public StatusConditionOrBuilder getConditionsOrBuilder(int index)

Which conditions caused the current cluster state.

repeated .google.container.v1.StatusCondition conditions = 118;

Parameter
Name Description
index int
Returns
Type Description
StatusConditionOrBuilder

getConditionsOrBuilderList()

public List<? extends StatusConditionOrBuilder> getConditionsOrBuilderList()

Which conditions caused the current cluster state.

repeated .google.container.v1.StatusCondition conditions = 118;

Returns
Type Description
List<? extends com.google.container.v1.StatusConditionOrBuilder>

getConfidentialNodes()

public ConfidentialNodes getConfidentialNodes()

Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled.

.google.container.v1.ConfidentialNodes confidential_nodes = 50;

Returns
Type Description
ConfidentialNodes

The confidentialNodes.

getConfidentialNodesBuilder()

public ConfidentialNodes.Builder getConfidentialNodesBuilder()

Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled.

.google.container.v1.ConfidentialNodes confidential_nodes = 50;

Returns
Type Description
ConfidentialNodes.Builder

getConfidentialNodesOrBuilder()

public ConfidentialNodesOrBuilder getConfidentialNodesOrBuilder()

Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled.

.google.container.v1.ConfidentialNodes confidential_nodes = 50;

Returns
Type Description
ConfidentialNodesOrBuilder

getCostManagementConfig()

public CostManagementConfig getCostManagementConfig()

Configuration for the fine-grained cost management feature.

.google.container.v1.CostManagementConfig cost_management_config = 45;

Returns
Type Description
CostManagementConfig

The costManagementConfig.

getCostManagementConfigBuilder()

public CostManagementConfig.Builder getCostManagementConfigBuilder()

Configuration for the fine-grained cost management feature.

.google.container.v1.CostManagementConfig cost_management_config = 45;

Returns
Type Description
CostManagementConfig.Builder

getCostManagementConfigOrBuilder()

public CostManagementConfigOrBuilder getCostManagementConfigOrBuilder()

Configuration for the fine-grained cost management feature.

.google.container.v1.CostManagementConfig cost_management_config = 45;

Returns
Type Description
CostManagementConfigOrBuilder

getCreateTime()

public String getCreateTime()

Output only. The time the cluster was created, in RFC3339 text format.

string create_time = 106 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The createTime.

getCreateTimeBytes()

public ByteString getCreateTimeBytes()

Output only. The time the cluster was created, in RFC3339 text format.

string create_time = 106 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for createTime.

getCurrentMasterVersion()

public String getCurrentMasterVersion()

Output only. The current software version of the master endpoint.

string current_master_version = 104 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The currentMasterVersion.

getCurrentMasterVersionBytes()

public ByteString getCurrentMasterVersionBytes()

Output only. The current software version of the master endpoint.

string current_master_version = 104 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for currentMasterVersion.

getCurrentNodeCount() (deprecated)

public int getCurrentNodeCount()

Deprecated. google.container.v1.Cluster.current_node_count is deprecated. See google/container/v1/cluster_service.proto;l=2029

Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.

int32 current_node_count = 112 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The currentNodeCount.

getCurrentNodeVersion() (deprecated)

public String getCurrentNodeVersion()

Deprecated. google.container.v1.Cluster.current_node_version is deprecated. See google/container/v1/cluster_service.proto;l=1994

Output only. Deprecated, use NodePools.version instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.

string current_node_version = 105 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The currentNodeVersion.

getCurrentNodeVersionBytes() (deprecated)

public ByteString getCurrentNodeVersionBytes()

Deprecated. google.container.v1.Cluster.current_node_version is deprecated. See google/container/v1/cluster_service.proto;l=1994

Output only. Deprecated, use NodePools.version instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.

string current_node_version = 105 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for currentNodeVersion.

getDatabaseEncryption()

public DatabaseEncryption getDatabaseEncryption()

Configuration of etcd encryption.

.google.container.v1.DatabaseEncryption database_encryption = 38;

Returns
Type Description
DatabaseEncryption

The databaseEncryption.

getDatabaseEncryptionBuilder()

public DatabaseEncryption.Builder getDatabaseEncryptionBuilder()

Configuration of etcd encryption.

.google.container.v1.DatabaseEncryption database_encryption = 38;

Returns
Type Description
DatabaseEncryption.Builder

getDatabaseEncryptionOrBuilder()

public DatabaseEncryptionOrBuilder getDatabaseEncryptionOrBuilder()

Configuration of etcd encryption.

.google.container.v1.DatabaseEncryption database_encryption = 38;

Returns
Type Description
DatabaseEncryptionOrBuilder

getDefaultInstanceForType()

public Cluster getDefaultInstanceForType()
Returns
Type Description
Cluster

getDefaultMaxPodsConstraint()

public MaxPodsConstraint getDefaultMaxPodsConstraint()

The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.

.google.container.v1.MaxPodsConstraint default_max_pods_constraint = 30;

Returns
Type Description
MaxPodsConstraint

The defaultMaxPodsConstraint.

getDefaultMaxPodsConstraintBuilder()

public MaxPodsConstraint.Builder getDefaultMaxPodsConstraintBuilder()

The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.

.google.container.v1.MaxPodsConstraint default_max_pods_constraint = 30;

Returns
Type Description
MaxPodsConstraint.Builder

getDefaultMaxPodsConstraintOrBuilder()

public MaxPodsConstraintOrBuilder getDefaultMaxPodsConstraintOrBuilder()

The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.

.google.container.v1.MaxPodsConstraint default_max_pods_constraint = 30;

Returns
Type Description
MaxPodsConstraintOrBuilder

getDescription()

public String getDescription()

An optional description of this cluster.

string description = 2;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of this cluster.

string description = 2;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEnableK8SBetaApis()

public K8sBetaAPIConfig getEnableK8SBetaApis()

Beta APIs Config

.google.container.v1.K8sBetaAPIConfig enable_k8s_beta_apis = 143;

Returns
Type Description
K8sBetaAPIConfig

The enableK8sBetaApis.

getEnableK8SBetaApisBuilder()

public K8sBetaAPIConfig.Builder getEnableK8SBetaApisBuilder()

Beta APIs Config

.google.container.v1.K8sBetaAPIConfig enable_k8s_beta_apis = 143;

Returns
Type Description
K8sBetaAPIConfig.Builder

getEnableK8SBetaApisOrBuilder()

public K8sBetaAPIConfigOrBuilder getEnableK8SBetaApisOrBuilder()

Beta APIs Config

.google.container.v1.K8sBetaAPIConfig enable_k8s_beta_apis = 143;

Returns
Type Description
K8sBetaAPIConfigOrBuilder

getEnableKubernetesAlpha()

public boolean getEnableKubernetesAlpha()

Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.

bool enable_kubernetes_alpha = 14;

Returns
Type Description
boolean

The enableKubernetesAlpha.

getEnableTpu()

public boolean getEnableTpu()

Enable the ability to use Cloud TPUs in this cluster.

bool enable_tpu = 115;

Returns
Type Description
boolean

The enableTpu.

getEndpoint()

public String getEndpoint()

Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at https://username:password@endpoint/.

See the masterAuth property of this resource for username and password information.

string endpoint = 102 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The endpoint.

getEndpointBytes()

public ByteString getEndpointBytes()

Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at https://username:password@endpoint/.

See the masterAuth property of this resource for username and password information.

string endpoint = 102 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for endpoint.

getEnterpriseConfig()

public EnterpriseConfig getEnterpriseConfig()

GKE Enterprise Configuration.

.google.container.v1.EnterpriseConfig enterprise_config = 149;

Returns
Type Description
EnterpriseConfig

The enterpriseConfig.

getEnterpriseConfigBuilder()

public EnterpriseConfig.Builder getEnterpriseConfigBuilder()

GKE Enterprise Configuration.

.google.container.v1.EnterpriseConfig enterprise_config = 149;

Returns
Type Description
EnterpriseConfig.Builder

getEnterpriseConfigOrBuilder()

public EnterpriseConfigOrBuilder getEnterpriseConfigOrBuilder()

GKE Enterprise Configuration.

.google.container.v1.EnterpriseConfig enterprise_config = 149;

Returns
Type Description
EnterpriseConfigOrBuilder

getEtag()

public String getEtag()

This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.

string etag = 139;

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.

string etag = 139;

Returns
Type Description
ByteString

The bytes for etag.

getExpireTime()

public String getExpireTime()

Output only. The time the cluster will be automatically deleted in RFC3339 text format.

string expire_time = 113 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The expireTime.

getExpireTimeBytes()

public ByteString getExpireTimeBytes()

Output only. The time the cluster will be automatically deleted in RFC3339 text format.

string expire_time = 113 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for expireTime.

getFleet()

public Fleet getFleet()

Fleet information for the cluster.

.google.container.v1.Fleet fleet = 140;

Returns
Type Description
Fleet

The fleet.

getFleetBuilder()

public Fleet.Builder getFleetBuilder()

Fleet information for the cluster.

.google.container.v1.Fleet fleet = 140;

Returns
Type Description
Fleet.Builder

getFleetOrBuilder()

public FleetOrBuilder getFleetOrBuilder()

Fleet information for the cluster.

.google.container.v1.Fleet fleet = 140;

Returns
Type Description
FleetOrBuilder

getId()

public String getId()

Output only. Unique id for the cluster.

string id = 129 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

Output only. Unique id for the cluster.

string id = 129 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for id.

getIdentityServiceConfig()

public IdentityServiceConfig getIdentityServiceConfig()

Configuration for Identity Service component.

.google.container.v1.IdentityServiceConfig identity_service_config = 54;

Returns
Type Description
IdentityServiceConfig

The identityServiceConfig.

getIdentityServiceConfigBuilder()

public IdentityServiceConfig.Builder getIdentityServiceConfigBuilder()

Configuration for Identity Service component.

.google.container.v1.IdentityServiceConfig identity_service_config = 54;

Returns
Type Description
IdentityServiceConfig.Builder

getIdentityServiceConfigOrBuilder()

public IdentityServiceConfigOrBuilder getIdentityServiceConfigOrBuilder()

Configuration for Identity Service component.

.google.container.v1.IdentityServiceConfig identity_service_config = 54;

Returns
Type Description
IdentityServiceConfigOrBuilder

getInitialClusterVersion()

public String getInitialClusterVersion()

The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion.

Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:

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

string initial_cluster_version = 103;

Returns
Type Description
String

The initialClusterVersion.

getInitialClusterVersionBytes()

public ByteString getInitialClusterVersionBytes()

The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion.

Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:

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

string initial_cluster_version = 103;

Returns
Type Description
ByteString

The bytes for initialClusterVersion.

getInitialNodeCount() (deprecated)

public int getInitialNodeCount()

Deprecated. google.container.v1.Cluster.initial_node_count is deprecated. See google/container/v1/cluster_service.proto;l=1775

The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time.

This field is deprecated, use node_pool.initial_node_count instead.

int32 initial_node_count = 3 [deprecated = true];

Returns
Type Description
int

The initialNodeCount.

getInstanceGroupUrls(int index) (deprecated)

public String getInstanceGroupUrls(int index)

Deprecated. google.container.v1.Cluster.instance_group_urls is deprecated. See google/container/v1/cluster_service.proto;l=2024

Output only. Deprecated. Use node_pools.instance_group_urls.

repeated string instance_group_urls = 111 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The instanceGroupUrls at the given index.

getInstanceGroupUrlsBytes(int index) (deprecated)

public ByteString getInstanceGroupUrlsBytes(int index)

Deprecated. google.container.v1.Cluster.instance_group_urls is deprecated. See google/container/v1/cluster_service.proto;l=2024

Output only. Deprecated. Use node_pools.instance_group_urls.

repeated string instance_group_urls = 111 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the instanceGroupUrls at the given index.

getInstanceGroupUrlsCount() (deprecated)

public int getInstanceGroupUrlsCount()

Deprecated. google.container.v1.Cluster.instance_group_urls is deprecated. See google/container/v1/cluster_service.proto;l=2024

Output only. Deprecated. Use node_pools.instance_group_urls.

repeated string instance_group_urls = 111 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of instanceGroupUrls.

getInstanceGroupUrlsList() (deprecated)

public ProtocolStringList getInstanceGroupUrlsList()

Deprecated. google.container.v1.Cluster.instance_group_urls is deprecated. See google/container/v1/cluster_service.proto;l=2024

Output only. Deprecated. Use node_pools.instance_group_urls.

repeated string instance_group_urls = 111 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ProtocolStringList

A list containing the instanceGroupUrls.

getIpAllocationPolicy()

public IPAllocationPolicy getIpAllocationPolicy()

Configuration for cluster IP allocation.

.google.container.v1.IPAllocationPolicy ip_allocation_policy = 20;

Returns
Type Description
IPAllocationPolicy

The ipAllocationPolicy.

getIpAllocationPolicyBuilder()

public IPAllocationPolicy.Builder getIpAllocationPolicyBuilder()

Configuration for cluster IP allocation.

.google.container.v1.IPAllocationPolicy ip_allocation_policy = 20;

Returns
Type Description
IPAllocationPolicy.Builder

getIpAllocationPolicyOrBuilder()

public IPAllocationPolicyOrBuilder getIpAllocationPolicyOrBuilder()

Configuration for cluster IP allocation.

.google.container.v1.IPAllocationPolicy ip_allocation_policy = 20;

Returns
Type Description
IPAllocationPolicyOrBuilder

getLabelFingerprint()

public String getLabelFingerprint()

The fingerprint of the set of labels for this cluster.

string label_fingerprint = 16;

Returns
Type Description
String

The labelFingerprint.

getLabelFingerprintBytes()

public ByteString getLabelFingerprintBytes()

The fingerprint of the set of labels for this cluster.

string label_fingerprint = 16;

Returns
Type Description
ByteString

The bytes for labelFingerprint.

getLegacyAbac()

public LegacyAbac getLegacyAbac()

Configuration for the legacy ABAC authorization mode.

.google.container.v1.LegacyAbac legacy_abac = 18;

Returns
Type Description
LegacyAbac

The legacyAbac.

getLegacyAbacBuilder()

public LegacyAbac.Builder getLegacyAbacBuilder()

Configuration for the legacy ABAC authorization mode.

.google.container.v1.LegacyAbac legacy_abac = 18;

Returns
Type Description
LegacyAbac.Builder

getLegacyAbacOrBuilder()

public LegacyAbacOrBuilder getLegacyAbacOrBuilder()

Configuration for the legacy ABAC authorization mode.

.google.container.v1.LegacyAbac legacy_abac = 18;

Returns
Type Description
LegacyAbacOrBuilder

getLocation()

public String getLocation()

Output only. The name of the Google Compute Engine zone or region in which the cluster resides.

string location = 114 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The location.

getLocationBytes()

public ByteString getLocationBytes()

Output only. The name of the Google Compute Engine zone or region in which the cluster resides.

string location = 114 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for location.

getLocations(int index)

public String getLocations(int index)

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

This field provides a default value if NodePool.Locations are not specified during node pool creation.

Warning: changing cluster locations will update the NodePool.Locations of all node pools and will result in nodes being added and/or removed.

repeated string locations = 13;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The locations at the given index.

getLocationsBytes(int index)

public ByteString getLocationsBytes(int index)

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

This field provides a default value if NodePool.Locations are not specified during node pool creation.

Warning: changing cluster locations will update the NodePool.Locations of all node pools and will result in nodes being added and/or removed.

repeated string locations = 13;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the locations at the given index.

getLocationsCount()

public int getLocationsCount()

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

This field provides a default value if NodePool.Locations are not specified during node pool creation.

Warning: changing cluster locations will update the NodePool.Locations of all node pools and will result in nodes being added and/or removed.

repeated string locations = 13;

Returns
Type Description
int

The count of locations.

getLocationsList()

public ProtocolStringList getLocationsList()

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

This field provides a default value if NodePool.Locations are not specified during node pool creation.

Warning: changing cluster locations will update the NodePool.Locations of all node pools and will result in nodes being added and/or removed.

repeated string locations = 13;

Returns
Type Description
ProtocolStringList

A list containing the locations.

getLoggingConfig()

public LoggingConfig getLoggingConfig()

Logging configuration for the cluster.

.google.container.v1.LoggingConfig logging_config = 132;

Returns
Type Description
LoggingConfig

The loggingConfig.

getLoggingConfigBuilder()

public LoggingConfig.Builder getLoggingConfigBuilder()

Logging configuration for the cluster.

.google.container.v1.LoggingConfig logging_config = 132;

Returns
Type Description
LoggingConfig.Builder

getLoggingConfigOrBuilder()

public LoggingConfigOrBuilder getLoggingConfigOrBuilder()

Logging configuration for the cluster.

.google.container.v1.LoggingConfig logging_config = 132;

Returns
Type Description
LoggingConfigOrBuilder

getLoggingService()

public String getLoggingService()

The logging service the cluster should use to write logs. Currently available options:

  • logging.googleapis.com/kubernetes - The Cloud Logging service with a Kubernetes-native resource model
  • logging.googleapis.com - The legacy Cloud Logging service (no longer available as of GKE 1.15).

  • none - no logs will be exported from the cluster.

    If left as an empty string,logging.googleapis.com/kubernetes will be used for GKE 1.14+ or logging.googleapis.com for earlier versions.

string logging_service = 6;

Returns
Type Description
String

The loggingService.

getLoggingServiceBytes()

public ByteString getLoggingServiceBytes()

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 logging_service = 6;

Returns
Type Description
ByteString

The bytes for loggingService.

getMaintenancePolicy()

public MaintenancePolicy getMaintenancePolicy()

Configure the maintenance policy for this cluster.

.google.container.v1.MaintenancePolicy maintenance_policy = 23;

Returns
Type Description
MaintenancePolicy

The maintenancePolicy.

getMaintenancePolicyBuilder()

public MaintenancePolicy.Builder getMaintenancePolicyBuilder()

Configure the maintenance policy for this cluster.

.google.container.v1.MaintenancePolicy maintenance_policy = 23;

Returns
Type Description
MaintenancePolicy.Builder

getMaintenancePolicyOrBuilder()

public MaintenancePolicyOrBuilder getMaintenancePolicyOrBuilder()

Configure the maintenance policy for this cluster.

.google.container.v1.MaintenancePolicy maintenance_policy = 23;

Returns
Type Description
MaintenancePolicyOrBuilder

getMasterAuth()

public MasterAuth getMasterAuth()

The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, username will be set to "admin", a random password will be generated, and a client certificate will be issued.

.google.container.v1.MasterAuth master_auth = 5;

Returns
Type Description
MasterAuth

The masterAuth.

getMasterAuthBuilder()

public MasterAuth.Builder getMasterAuthBuilder()

The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, username will be set to "admin", a random password will be generated, and a client certificate will be issued.

.google.container.v1.MasterAuth master_auth = 5;

Returns
Type Description
MasterAuth.Builder

getMasterAuthOrBuilder()

public MasterAuthOrBuilder getMasterAuthOrBuilder()

The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, username will be set to "admin", a random password will be generated, and a client certificate will be issued.

.google.container.v1.MasterAuth master_auth = 5;

Returns
Type Description
MasterAuthOrBuilder

getMasterAuthorizedNetworksConfig()

public MasterAuthorizedNetworksConfig getMasterAuthorizedNetworksConfig()

The configuration options for master authorized networks feature.

.google.container.v1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 22;

Returns
Type Description
MasterAuthorizedNetworksConfig

The masterAuthorizedNetworksConfig.

getMasterAuthorizedNetworksConfigBuilder()

public MasterAuthorizedNetworksConfig.Builder getMasterAuthorizedNetworksConfigBuilder()

The configuration options for master authorized networks feature.

.google.container.v1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 22;

Returns
Type Description
MasterAuthorizedNetworksConfig.Builder

getMasterAuthorizedNetworksConfigOrBuilder()

public MasterAuthorizedNetworksConfigOrBuilder getMasterAuthorizedNetworksConfigOrBuilder()

The configuration options for master authorized networks feature.

.google.container.v1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 22;

Returns
Type Description
MasterAuthorizedNetworksConfigOrBuilder

getMeshCertificates()

public MeshCertificates getMeshCertificates()

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

.google.container.v1.MeshCertificates mesh_certificates = 67;

Returns
Type Description
MeshCertificates

The meshCertificates.

getMeshCertificatesBuilder()

public MeshCertificates.Builder getMeshCertificatesBuilder()

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

.google.container.v1.MeshCertificates mesh_certificates = 67;

Returns
Type Description
MeshCertificates.Builder

getMeshCertificatesOrBuilder()

public MeshCertificatesOrBuilder getMeshCertificatesOrBuilder()

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

.google.container.v1.MeshCertificates mesh_certificates = 67;

Returns
Type Description
MeshCertificatesOrBuilder

getMonitoringConfig()

public MonitoringConfig getMonitoringConfig()

Monitoring configuration for the cluster.

.google.container.v1.MonitoringConfig monitoring_config = 133;

Returns
Type Description
MonitoringConfig

The monitoringConfig.

getMonitoringConfigBuilder()

public MonitoringConfig.Builder getMonitoringConfigBuilder()

Monitoring configuration for the cluster.

.google.container.v1.MonitoringConfig monitoring_config = 133;

Returns
Type Description
MonitoringConfig.Builder

getMonitoringConfigOrBuilder()

public MonitoringConfigOrBuilder getMonitoringConfigOrBuilder()

Monitoring configuration for the cluster.

.google.container.v1.MonitoringConfig monitoring_config = 133;

Returns
Type Description
MonitoringConfigOrBuilder

getMonitoringService()

public String getMonitoringService()

The monitoring service the cluster should use to write metrics. Currently available options:

  • "monitoring.googleapis.com/kubernetes" - The Cloud Monitoring service with a Kubernetes-native resource model
  • monitoring.googleapis.com - The legacy Cloud Monitoring service (no longer available as of GKE 1.15).

  • none - No metrics will be exported from the cluster.

    If left as an empty string,monitoring.googleapis.com/kubernetes will be used for GKE 1.14+ or monitoring.googleapis.com for earlier versions.

string monitoring_service = 7;

Returns
Type Description
String

The monitoringService.

getMonitoringServiceBytes()

public ByteString getMonitoringServiceBytes()

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 monitoring_service = 7;

Returns
Type Description
ByteString

The bytes for monitoringService.

getMutableResourceLabels() (deprecated)

public Map<String,String> getMutableResourceLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions:

  • Lowercase letters, numbers, and hyphens only.
  • Must start with a letter.
  • Must end with a number or a letter.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions:

  • Lowercase letters, numbers, and hyphens only.
  • Must start with a letter.
  • Must end with a number or a letter.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getNetwork()

public String getNetwork()

The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.

string network = 8;

Returns
Type Description
String

The network.

getNetworkBytes()

public ByteString getNetworkBytes()

The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.

string network = 8;

Returns
Type Description
ByteString

The bytes for network.

getNetworkConfig()

public NetworkConfig getNetworkConfig()

Configuration for cluster networking.

.google.container.v1.NetworkConfig network_config = 27;

Returns
Type Description
NetworkConfig

The networkConfig.

getNetworkConfigBuilder()

public NetworkConfig.Builder getNetworkConfigBuilder()

Configuration for cluster networking.

.google.container.v1.NetworkConfig network_config = 27;

Returns
Type Description
NetworkConfig.Builder

getNetworkConfigOrBuilder()

public NetworkConfigOrBuilder getNetworkConfigOrBuilder()

Configuration for cluster networking.

.google.container.v1.NetworkConfig network_config = 27;

Returns
Type Description
NetworkConfigOrBuilder

getNetworkPolicy()

public NetworkPolicy getNetworkPolicy()

Configuration options for the NetworkPolicy feature.

.google.container.v1.NetworkPolicy network_policy = 19;

Returns
Type Description
NetworkPolicy

The networkPolicy.

getNetworkPolicyBuilder()

public NetworkPolicy.Builder getNetworkPolicyBuilder()

Configuration options for the NetworkPolicy feature.

.google.container.v1.NetworkPolicy network_policy = 19;

Returns
Type Description
NetworkPolicy.Builder

getNetworkPolicyOrBuilder()

public NetworkPolicyOrBuilder getNetworkPolicyOrBuilder()

Configuration options for the NetworkPolicy feature.

.google.container.v1.NetworkPolicy network_policy = 19;

Returns
Type Description
NetworkPolicyOrBuilder

getNodeConfig() (deprecated)

public NodeConfig getNodeConfig()

Deprecated. google.container.v1.Cluster.node_config is deprecated. See google/container/v1/cluster_service.proto;l=1788

Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see node_pool.config)

If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.

.google.container.v1.NodeConfig node_config = 4 [deprecated = true];

Returns
Type Description
NodeConfig

The nodeConfig.

getNodeConfigBuilder() (deprecated)

public NodeConfig.Builder getNodeConfigBuilder()

Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see node_pool.config)

If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.

.google.container.v1.NodeConfig node_config = 4 [deprecated = true];

Returns
Type Description
NodeConfig.Builder

getNodeConfigOrBuilder() (deprecated)

public NodeConfigOrBuilder getNodeConfigOrBuilder()

Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see node_pool.config)

If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.

.google.container.v1.NodeConfig node_config = 4 [deprecated = true];

Returns
Type Description
NodeConfigOrBuilder

getNodeIpv4CidrSize()

public int getNodeIpv4CidrSize()

Output only. The size of the address space on each node for hosting containers. This is provisioned from within the container_ipv4_cidr range. This field will only be set when cluster is in route-based network mode.

int32 node_ipv4_cidr_size = 109 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The nodeIpv4CidrSize.

getNodePoolAutoConfig()

public NodePoolAutoConfig getNodePoolAutoConfig()

Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

.google.container.v1.NodePoolAutoConfig node_pool_auto_config = 136;

Returns
Type Description
NodePoolAutoConfig

The nodePoolAutoConfig.

getNodePoolAutoConfigBuilder()

public NodePoolAutoConfig.Builder getNodePoolAutoConfigBuilder()

Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

.google.container.v1.NodePoolAutoConfig node_pool_auto_config = 136;

Returns
Type Description
NodePoolAutoConfig.Builder

getNodePoolAutoConfigOrBuilder()

public NodePoolAutoConfigOrBuilder getNodePoolAutoConfigOrBuilder()

Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

.google.container.v1.NodePoolAutoConfig node_pool_auto_config = 136;

Returns
Type Description
NodePoolAutoConfigOrBuilder

getNodePoolDefaults()

public NodePoolDefaults getNodePoolDefaults()

Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.

optional .google.container.v1.NodePoolDefaults node_pool_defaults = 131;

Returns
Type Description
NodePoolDefaults

The nodePoolDefaults.

getNodePoolDefaultsBuilder()

public NodePoolDefaults.Builder getNodePoolDefaultsBuilder()

Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.

optional .google.container.v1.NodePoolDefaults node_pool_defaults = 131;

Returns
Type Description
NodePoolDefaults.Builder

getNodePoolDefaultsOrBuilder()

public NodePoolDefaultsOrBuilder getNodePoolDefaultsOrBuilder()

Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.

optional .google.container.v1.NodePoolDefaults node_pool_defaults = 131;

Returns
Type Description
NodePoolDefaultsOrBuilder

getNodePools(int index)

public NodePool getNodePools(int index)

The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

repeated .google.container.v1.NodePool node_pools = 12;

Parameter
Name Description
index int
Returns
Type Description
NodePool

getNodePoolsBuilder(int index)

public NodePool.Builder getNodePoolsBuilder(int index)

The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

repeated .google.container.v1.NodePool node_pools = 12;

Parameter
Name Description
index int
Returns
Type Description
NodePool.Builder

getNodePoolsBuilderList()

public List<NodePool.Builder> getNodePoolsBuilderList()

The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

repeated .google.container.v1.NodePool node_pools = 12;

Returns
Type Description
List<Builder>

getNodePoolsCount()

public int getNodePoolsCount()

The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

repeated .google.container.v1.NodePool node_pools = 12;

Returns
Type Description
int

getNodePoolsList()

public List<NodePool> getNodePoolsList()

The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

repeated .google.container.v1.NodePool node_pools = 12;

Returns
Type Description
List<NodePool>

getNodePoolsOrBuilder(int index)

public NodePoolOrBuilder getNodePoolsOrBuilder(int index)

The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

repeated .google.container.v1.NodePool node_pools = 12;

Parameter
Name Description
index int
Returns
Type Description
NodePoolOrBuilder

getNodePoolsOrBuilderList()

public List<? extends NodePoolOrBuilder> getNodePoolsOrBuilderList()

The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

repeated .google.container.v1.NodePool node_pools = 12;

Returns
Type Description
List<? extends com.google.container.v1.NodePoolOrBuilder>

getNotificationConfig()

public NotificationConfig getNotificationConfig()

Notification configuration of the cluster.

.google.container.v1.NotificationConfig notification_config = 49;

Returns
Type Description
NotificationConfig

The notificationConfig.

getNotificationConfigBuilder()

public NotificationConfig.Builder getNotificationConfigBuilder()

Notification configuration of the cluster.

.google.container.v1.NotificationConfig notification_config = 49;

Returns
Type Description
NotificationConfig.Builder

getNotificationConfigOrBuilder()

public NotificationConfigOrBuilder getNotificationConfigOrBuilder()

Notification configuration of the cluster.

.google.container.v1.NotificationConfig notification_config = 49;

Returns
Type Description
NotificationConfigOrBuilder

getPrivateClusterConfig()

public PrivateClusterConfig getPrivateClusterConfig()

Configuration for private cluster.

.google.container.v1.PrivateClusterConfig private_cluster_config = 37;

Returns
Type Description
PrivateClusterConfig

The privateClusterConfig.

getPrivateClusterConfigBuilder()

public PrivateClusterConfig.Builder getPrivateClusterConfigBuilder()

Configuration for private cluster.

.google.container.v1.PrivateClusterConfig private_cluster_config = 37;

Returns
Type Description
PrivateClusterConfig.Builder

getPrivateClusterConfigOrBuilder()

public PrivateClusterConfigOrBuilder getPrivateClusterConfigOrBuilder()

Configuration for private cluster.

.google.container.v1.PrivateClusterConfig private_cluster_config = 37;

Returns
Type Description
PrivateClusterConfigOrBuilder

getReleaseChannel()

public ReleaseChannel getReleaseChannel()

Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version.

.google.container.v1.ReleaseChannel release_channel = 41;

Returns
Type Description
ReleaseChannel

The releaseChannel.

getReleaseChannelBuilder()

public ReleaseChannel.Builder getReleaseChannelBuilder()

Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version.

.google.container.v1.ReleaseChannel release_channel = 41;

Returns
Type Description
ReleaseChannel.Builder

getReleaseChannelOrBuilder()

public ReleaseChannelOrBuilder getReleaseChannelOrBuilder()

Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version.

.google.container.v1.ReleaseChannel release_channel = 41;

Returns
Type Description
ReleaseChannelOrBuilder

getResourceLabels() (deprecated)

public Map<String,String> getResourceLabels()

Use #getResourceLabelsMap() instead.

Returns
Type Description
Map<String,String>

getResourceLabelsCount()

public int getResourceLabelsCount()

The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

map<string, string> resource_labels = 15;

Returns
Type Description
int

getResourceLabelsMap()

public Map<String,String> getResourceLabelsMap()

The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

map<string, string> resource_labels = 15;

Returns
Type Description
Map<String,String>

getResourceLabelsOrDefault(String key, String defaultValue)

public String getResourceLabelsOrDefault(String key, String defaultValue)

The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

map<string, string> resource_labels = 15;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getResourceLabelsOrThrow(String key)

public String getResourceLabelsOrThrow(String key)

The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

map<string, string> resource_labels = 15;

Parameter
Name Description
key String
Returns
Type Description
String

getResourceUsageExportConfig()

public ResourceUsageExportConfig getResourceUsageExportConfig()

Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.

.google.container.v1.ResourceUsageExportConfig resource_usage_export_config = 33;

Returns
Type Description
ResourceUsageExportConfig

The resourceUsageExportConfig.

getResourceUsageExportConfigBuilder()

public ResourceUsageExportConfig.Builder getResourceUsageExportConfigBuilder()

Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.

.google.container.v1.ResourceUsageExportConfig resource_usage_export_config = 33;

Returns
Type Description
ResourceUsageExportConfig.Builder

getResourceUsageExportConfigOrBuilder()

public ResourceUsageExportConfigOrBuilder getResourceUsageExportConfigOrBuilder()

Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.

.google.container.v1.ResourceUsageExportConfig resource_usage_export_config = 33;

Returns
Type Description
ResourceUsageExportConfigOrBuilder

getSatisfiesPzi()

public boolean getSatisfiesPzi()

Output only. Reserved for future use.

optional bool satisfies_pzi = 153 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzi.

getSatisfiesPzs()

public boolean getSatisfiesPzs()

Output only. Reserved for future use.

optional bool satisfies_pzs = 152 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The satisfiesPzs.

getSecurityPostureConfig()

public SecurityPostureConfig getSecurityPostureConfig()

Enable/Disable Security Posture API features for the cluster.

.google.container.v1.SecurityPostureConfig security_posture_config = 145;

Returns
Type Description
SecurityPostureConfig

The securityPostureConfig.

getSecurityPostureConfigBuilder()

public SecurityPostureConfig.Builder getSecurityPostureConfigBuilder()

Enable/Disable Security Posture API features for the cluster.

.google.container.v1.SecurityPostureConfig security_posture_config = 145;

Returns
Type Description
SecurityPostureConfig.Builder

getSecurityPostureConfigOrBuilder()

public SecurityPostureConfigOrBuilder getSecurityPostureConfigOrBuilder()

Enable/Disable Security Posture API features for the cluster.

.google.container.v1.SecurityPostureConfig security_posture_config = 145;

Returns
Type Description
SecurityPostureConfigOrBuilder

getSelfLink()

public String getSelfLink()

Output only. Server-defined URL for the resource.

string self_link = 100 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

Output only. Server-defined URL for the resource.

string self_link = 100 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for selfLink.

getServicesIpv4Cidr()

public String getServicesIpv4Cidr()

Output only. The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the container CIDR.

string services_ipv4_cidr = 110 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The servicesIpv4Cidr.

getServicesIpv4CidrBytes()

public ByteString getServicesIpv4CidrBytes()

Output only. The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the container CIDR.

string services_ipv4_cidr = 110 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for servicesIpv4Cidr.

getShieldedNodes()

public ShieldedNodes getShieldedNodes()

Shielded Nodes configuration.

.google.container.v1.ShieldedNodes shielded_nodes = 40;

Returns
Type Description
ShieldedNodes

The shieldedNodes.

getShieldedNodesBuilder()

public ShieldedNodes.Builder getShieldedNodesBuilder()

Shielded Nodes configuration.

.google.container.v1.ShieldedNodes shielded_nodes = 40;

Returns
Type Description
ShieldedNodes.Builder

getShieldedNodesOrBuilder()

public ShieldedNodesOrBuilder getShieldedNodesOrBuilder()

Shielded Nodes configuration.

.google.container.v1.ShieldedNodes shielded_nodes = 40;

Returns
Type Description
ShieldedNodesOrBuilder

getStatus()

public Cluster.Status getStatus()

Output only. The current status of this cluster.

.google.container.v1.Cluster.Status status = 107 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Cluster.Status

The status.

getStatusMessage() (deprecated)

public String getStatusMessage()

Deprecated. google.container.v1.Cluster.status_message is deprecated. See google/container/v1/cluster_service.proto;l=2007

Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.

string status_message = 108 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The statusMessage.

getStatusMessageBytes() (deprecated)

public ByteString getStatusMessageBytes()

Deprecated. google.container.v1.Cluster.status_message is deprecated. See google/container/v1/cluster_service.proto;l=2007

Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.

string status_message = 108 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for statusMessage.

getStatusValue()

public int getStatusValue()

Output only. The current status of this cluster.

.google.container.v1.Cluster.Status status = 107 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for status.

getSubnetwork()

public String getSubnetwork()

The name of the Google Compute Engine subnetwork to which the cluster is connected.

string subnetwork = 11;

Returns
Type Description
String

The subnetwork.

getSubnetworkBytes()

public ByteString getSubnetworkBytes()

The name of the Google Compute Engine subnetwork to which the cluster is connected.

string subnetwork = 11;

Returns
Type Description
ByteString

The bytes for subnetwork.

getTpuIpv4CidrBlock()

public String getTpuIpv4CidrBlock()

Output only. The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. 1.2.3.4/29).

string tpu_ipv4_cidr_block = 116 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The tpuIpv4CidrBlock.

getTpuIpv4CidrBlockBytes()

public ByteString getTpuIpv4CidrBlockBytes()

Output only. The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. 1.2.3.4/29).

string tpu_ipv4_cidr_block = 116 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for tpuIpv4CidrBlock.

getVerticalPodAutoscaling()

public VerticalPodAutoscaling getVerticalPodAutoscaling()

Cluster-level Vertical Pod Autoscaling configuration.

.google.container.v1.VerticalPodAutoscaling vertical_pod_autoscaling = 39;

Returns
Type Description
VerticalPodAutoscaling

The verticalPodAutoscaling.

getVerticalPodAutoscalingBuilder()

public VerticalPodAutoscaling.Builder getVerticalPodAutoscalingBuilder()

Cluster-level Vertical Pod Autoscaling configuration.

.google.container.v1.VerticalPodAutoscaling vertical_pod_autoscaling = 39;

Returns
Type Description
VerticalPodAutoscaling.Builder

getVerticalPodAutoscalingOrBuilder()

public VerticalPodAutoscalingOrBuilder getVerticalPodAutoscalingOrBuilder()

Cluster-level Vertical Pod Autoscaling configuration.

.google.container.v1.VerticalPodAutoscaling vertical_pod_autoscaling = 39;

Returns
Type Description
VerticalPodAutoscalingOrBuilder

getWorkloadIdentityConfig()

public WorkloadIdentityConfig getWorkloadIdentityConfig()

Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.

.google.container.v1.WorkloadIdentityConfig workload_identity_config = 43;

Returns
Type Description
WorkloadIdentityConfig

The workloadIdentityConfig.

getWorkloadIdentityConfigBuilder()

public WorkloadIdentityConfig.Builder getWorkloadIdentityConfigBuilder()

Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.

.google.container.v1.WorkloadIdentityConfig workload_identity_config = 43;

Returns
Type Description
WorkloadIdentityConfig.Builder

getWorkloadIdentityConfigOrBuilder()

public WorkloadIdentityConfigOrBuilder getWorkloadIdentityConfigOrBuilder()

Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.

.google.container.v1.WorkloadIdentityConfig workload_identity_config = 43;

Returns
Type Description
WorkloadIdentityConfigOrBuilder

getZone() (deprecated)

public String getZone()

Deprecated. google.container.v1.Cluster.zone is deprecated. See google/container/v1/cluster_service.proto;l=1959

Output only. The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.

string zone = 101 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The zone.

getZoneBytes() (deprecated)

public ByteString getZoneBytes()

Deprecated. google.container.v1.Cluster.zone is deprecated. See google/container/v1/cluster_service.proto;l=1959

Output only. The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.

string zone = 101 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for zone.

hasAddonsConfig()

public boolean hasAddonsConfig()

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

.google.container.v1.AddonsConfig addons_config = 10;

Returns
Type Description
boolean

Whether the addonsConfig field is set.

hasAuthenticatorGroupsConfig()

public boolean hasAuthenticatorGroupsConfig()

Configuration controlling RBAC group membership information.

.google.container.v1.AuthenticatorGroupsConfig authenticator_groups_config = 34;

Returns
Type Description
boolean

Whether the authenticatorGroupsConfig field is set.

hasAutopilot()

public boolean hasAutopilot()

Autopilot configuration for the cluster.

.google.container.v1.Autopilot autopilot = 128;

Returns
Type Description
boolean

Whether the autopilot field is set.

hasAutoscaling()

public boolean hasAutoscaling()

Cluster-level autoscaling configuration.

.google.container.v1.ClusterAutoscaling autoscaling = 26;

Returns
Type Description
boolean

Whether the autoscaling field is set.

hasBinaryAuthorization()

public boolean hasBinaryAuthorization()

Configuration for Binary Authorization.

.google.container.v1.BinaryAuthorization binary_authorization = 24;

Returns
Type Description
boolean

Whether the binaryAuthorization field is set.

hasConfidentialNodes()

public boolean hasConfidentialNodes()

Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled.

.google.container.v1.ConfidentialNodes confidential_nodes = 50;

Returns
Type Description
boolean

Whether the confidentialNodes field is set.

hasCostManagementConfig()

public boolean hasCostManagementConfig()

Configuration for the fine-grained cost management feature.

.google.container.v1.CostManagementConfig cost_management_config = 45;

Returns
Type Description
boolean

Whether the costManagementConfig field is set.

hasDatabaseEncryption()

public boolean hasDatabaseEncryption()

Configuration of etcd encryption.

.google.container.v1.DatabaseEncryption database_encryption = 38;

Returns
Type Description
boolean

Whether the databaseEncryption field is set.

hasDefaultMaxPodsConstraint()

public boolean hasDefaultMaxPodsConstraint()

The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.

.google.container.v1.MaxPodsConstraint default_max_pods_constraint = 30;

Returns
Type Description
boolean

Whether the defaultMaxPodsConstraint field is set.

hasEnableK8SBetaApis()

public boolean hasEnableK8SBetaApis()

Beta APIs Config

.google.container.v1.K8sBetaAPIConfig enable_k8s_beta_apis = 143;

Returns
Type Description
boolean

Whether the enableK8sBetaApis field is set.

hasEnterpriseConfig()

public boolean hasEnterpriseConfig()

GKE Enterprise Configuration.

.google.container.v1.EnterpriseConfig enterprise_config = 149;

Returns
Type Description
boolean

Whether the enterpriseConfig field is set.

hasFleet()

public boolean hasFleet()

Fleet information for the cluster.

.google.container.v1.Fleet fleet = 140;

Returns
Type Description
boolean

Whether the fleet field is set.

hasIdentityServiceConfig()

public boolean hasIdentityServiceConfig()

Configuration for Identity Service component.

.google.container.v1.IdentityServiceConfig identity_service_config = 54;

Returns
Type Description
boolean

Whether the identityServiceConfig field is set.

hasIpAllocationPolicy()

public boolean hasIpAllocationPolicy()

Configuration for cluster IP allocation.

.google.container.v1.IPAllocationPolicy ip_allocation_policy = 20;

Returns
Type Description
boolean

Whether the ipAllocationPolicy field is set.

hasLegacyAbac()

public boolean hasLegacyAbac()

Configuration for the legacy ABAC authorization mode.

.google.container.v1.LegacyAbac legacy_abac = 18;

Returns
Type Description
boolean

Whether the legacyAbac field is set.

hasLoggingConfig()

public boolean hasLoggingConfig()

Logging configuration for the cluster.

.google.container.v1.LoggingConfig logging_config = 132;

Returns
Type Description
boolean

Whether the loggingConfig field is set.

hasMaintenancePolicy()

public boolean hasMaintenancePolicy()

Configure the maintenance policy for this cluster.

.google.container.v1.MaintenancePolicy maintenance_policy = 23;

Returns
Type Description
boolean

Whether the maintenancePolicy field is set.

hasMasterAuth()

public boolean hasMasterAuth()

The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, username will be set to "admin", a random password will be generated, and a client certificate will be issued.

.google.container.v1.MasterAuth master_auth = 5;

Returns
Type Description
boolean

Whether the masterAuth field is set.

hasMasterAuthorizedNetworksConfig()

public boolean hasMasterAuthorizedNetworksConfig()

The configuration options for master authorized networks feature.

.google.container.v1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 22;

Returns
Type Description
boolean

Whether the masterAuthorizedNetworksConfig field is set.

hasMeshCertificates()

public boolean hasMeshCertificates()

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

.google.container.v1.MeshCertificates mesh_certificates = 67;

Returns
Type Description
boolean

Whether the meshCertificates field is set.

hasMonitoringConfig()

public boolean hasMonitoringConfig()

Monitoring configuration for the cluster.

.google.container.v1.MonitoringConfig monitoring_config = 133;

Returns
Type Description
boolean

Whether the monitoringConfig field is set.

hasNetworkConfig()

public boolean hasNetworkConfig()

Configuration for cluster networking.

.google.container.v1.NetworkConfig network_config = 27;

Returns
Type Description
boolean

Whether the networkConfig field is set.

hasNetworkPolicy()

public boolean hasNetworkPolicy()

Configuration options for the NetworkPolicy feature.

.google.container.v1.NetworkPolicy network_policy = 19;

Returns
Type Description
boolean

Whether the networkPolicy field is set.

hasNodeConfig() (deprecated)

public boolean hasNodeConfig()

Deprecated. google.container.v1.Cluster.node_config is deprecated. See google/container/v1/cluster_service.proto;l=1788

Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see node_pool.config)

If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.

.google.container.v1.NodeConfig node_config = 4 [deprecated = true];

Returns
Type Description
boolean

Whether the nodeConfig field is set.

hasNodePoolAutoConfig()

public boolean hasNodePoolAutoConfig()

Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

.google.container.v1.NodePoolAutoConfig node_pool_auto_config = 136;

Returns
Type Description
boolean

Whether the nodePoolAutoConfig field is set.

hasNodePoolDefaults()

public boolean hasNodePoolDefaults()

Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.

optional .google.container.v1.NodePoolDefaults node_pool_defaults = 131;

Returns
Type Description
boolean

Whether the nodePoolDefaults field is set.

hasNotificationConfig()

public boolean hasNotificationConfig()

Notification configuration of the cluster.

.google.container.v1.NotificationConfig notification_config = 49;

Returns
Type Description
boolean

Whether the notificationConfig field is set.

hasPrivateClusterConfig()

public boolean hasPrivateClusterConfig()

Configuration for private cluster.

.google.container.v1.PrivateClusterConfig private_cluster_config = 37;

Returns
Type Description
boolean

Whether the privateClusterConfig field is set.

hasReleaseChannel()

public boolean hasReleaseChannel()

Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version.

.google.container.v1.ReleaseChannel release_channel = 41;

Returns
Type Description
boolean

Whether the releaseChannel field is set.

hasResourceUsageExportConfig()

public boolean hasResourceUsageExportConfig()

Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.

.google.container.v1.ResourceUsageExportConfig resource_usage_export_config = 33;

Returns
Type Description
boolean

Whether the resourceUsageExportConfig field is set.

hasSatisfiesPzi()

public boolean hasSatisfiesPzi()

Output only. Reserved for future use.

optional bool satisfies_pzi = 153 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the satisfiesPzi field is set.

hasSatisfiesPzs()

public boolean hasSatisfiesPzs()

Output only. Reserved for future use.

optional bool satisfies_pzs = 152 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the satisfiesPzs field is set.

hasSecurityPostureConfig()

public boolean hasSecurityPostureConfig()

Enable/Disable Security Posture API features for the cluster.

.google.container.v1.SecurityPostureConfig security_posture_config = 145;

Returns
Type Description
boolean

Whether the securityPostureConfig field is set.

hasShieldedNodes()

public boolean hasShieldedNodes()

Shielded Nodes configuration.

.google.container.v1.ShieldedNodes shielded_nodes = 40;

Returns
Type Description
boolean

Whether the shieldedNodes field is set.

hasVerticalPodAutoscaling()

public boolean hasVerticalPodAutoscaling()

Cluster-level Vertical Pod Autoscaling configuration.

.google.container.v1.VerticalPodAutoscaling vertical_pod_autoscaling = 39;

Returns
Type Description
boolean

Whether the verticalPodAutoscaling field is set.

hasWorkloadIdentityConfig()

public boolean hasWorkloadIdentityConfig()

Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.

.google.container.v1.WorkloadIdentityConfig workload_identity_config = 43;

Returns
Type Description
boolean

Whether the workloadIdentityConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAddonsConfig(AddonsConfig value)

public Cluster.Builder mergeAddonsConfig(AddonsConfig value)

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

.google.container.v1.AddonsConfig addons_config = 10;

Parameter
Name Description
value AddonsConfig
Returns
Type Description
Cluster.Builder

mergeAuthenticatorGroupsConfig(AuthenticatorGroupsConfig value)

public Cluster.Builder mergeAuthenticatorGroupsConfig(AuthenticatorGroupsConfig value)

Configuration controlling RBAC group membership information.

.google.container.v1.AuthenticatorGroupsConfig authenticator_groups_config = 34;

Parameter
Name Description
value AuthenticatorGroupsConfig
Returns
Type Description
Cluster.Builder

mergeAutopilot(Autopilot value)

public Cluster.Builder mergeAutopilot(Autopilot value)

Autopilot configuration for the cluster.

.google.container.v1.Autopilot autopilot = 128;

Parameter
Name Description
value Autopilot
Returns
Type Description
Cluster.Builder

mergeAutoscaling(ClusterAutoscaling value)

public Cluster.Builder mergeAutoscaling(ClusterAutoscaling value)

Cluster-level autoscaling configuration.

.google.container.v1.ClusterAutoscaling autoscaling = 26;

Parameter
Name Description
value ClusterAutoscaling
Returns
Type Description
Cluster.Builder

mergeBinaryAuthorization(BinaryAuthorization value)

public Cluster.Builder mergeBinaryAuthorization(BinaryAuthorization value)

Configuration for Binary Authorization.

.google.container.v1.BinaryAuthorization binary_authorization = 24;

Parameter
Name Description
value BinaryAuthorization
Returns
Type Description
Cluster.Builder

mergeConfidentialNodes(ConfidentialNodes value)

public Cluster.Builder mergeConfidentialNodes(ConfidentialNodes value)

Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled.

.google.container.v1.ConfidentialNodes confidential_nodes = 50;

Parameter
Name Description
value ConfidentialNodes
Returns
Type Description
Cluster.Builder

mergeCostManagementConfig(CostManagementConfig value)

public Cluster.Builder mergeCostManagementConfig(CostManagementConfig value)

Configuration for the fine-grained cost management feature.

.google.container.v1.CostManagementConfig cost_management_config = 45;

Parameter
Name Description
value CostManagementConfig
Returns
Type Description
Cluster.Builder

mergeDatabaseEncryption(DatabaseEncryption value)

public Cluster.Builder mergeDatabaseEncryption(DatabaseEncryption value)

Configuration of etcd encryption.

.google.container.v1.DatabaseEncryption database_encryption = 38;

Parameter
Name Description
value DatabaseEncryption
Returns
Type Description
Cluster.Builder

mergeDefaultMaxPodsConstraint(MaxPodsConstraint value)

public Cluster.Builder mergeDefaultMaxPodsConstraint(MaxPodsConstraint value)

The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.

.google.container.v1.MaxPodsConstraint default_max_pods_constraint = 30;

Parameter
Name Description
value MaxPodsConstraint
Returns
Type Description
Cluster.Builder

mergeEnableK8SBetaApis(K8sBetaAPIConfig value)

public Cluster.Builder mergeEnableK8SBetaApis(K8sBetaAPIConfig value)

Beta APIs Config

.google.container.v1.K8sBetaAPIConfig enable_k8s_beta_apis = 143;

Parameter
Name Description
value K8sBetaAPIConfig
Returns
Type Description
Cluster.Builder

mergeEnterpriseConfig(EnterpriseConfig value)

public Cluster.Builder mergeEnterpriseConfig(EnterpriseConfig value)

GKE Enterprise Configuration.

.google.container.v1.EnterpriseConfig enterprise_config = 149;

Parameter
Name Description
value EnterpriseConfig
Returns
Type Description
Cluster.Builder

mergeFleet(Fleet value)

public Cluster.Builder mergeFleet(Fleet value)

Fleet information for the cluster.

.google.container.v1.Fleet fleet = 140;

Parameter
Name Description
value Fleet
Returns
Type Description
Cluster.Builder

mergeFrom(Cluster other)

public Cluster.Builder mergeFrom(Cluster other)
Parameter
Name Description
other Cluster
Returns
Type Description
Cluster.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Cluster.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cluster.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Cluster.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Cluster.Builder
Overrides

mergeIdentityServiceConfig(IdentityServiceConfig value)

public Cluster.Builder mergeIdentityServiceConfig(IdentityServiceConfig value)

Configuration for Identity Service component.

.google.container.v1.IdentityServiceConfig identity_service_config = 54;

Parameter
Name Description
value IdentityServiceConfig
Returns
Type Description
Cluster.Builder

mergeIpAllocationPolicy(IPAllocationPolicy value)

public Cluster.Builder mergeIpAllocationPolicy(IPAllocationPolicy value)

Configuration for cluster IP allocation.

.google.container.v1.IPAllocationPolicy ip_allocation_policy = 20;

Parameter
Name Description
value IPAllocationPolicy
Returns
Type Description
Cluster.Builder

mergeLegacyAbac(LegacyAbac value)

public Cluster.Builder mergeLegacyAbac(LegacyAbac value)

Configuration for the legacy ABAC authorization mode.

.google.container.v1.LegacyAbac legacy_abac = 18;

Parameter
Name Description
value LegacyAbac
Returns
Type Description
Cluster.Builder

mergeLoggingConfig(LoggingConfig value)

public Cluster.Builder mergeLoggingConfig(LoggingConfig value)

Logging configuration for the cluster.

.google.container.v1.LoggingConfig logging_config = 132;

Parameter
Name Description
value LoggingConfig
Returns
Type Description
Cluster.Builder

mergeMaintenancePolicy(MaintenancePolicy value)

public Cluster.Builder mergeMaintenancePolicy(MaintenancePolicy value)

Configure the maintenance policy for this cluster.

.google.container.v1.MaintenancePolicy maintenance_policy = 23;

Parameter
Name Description
value MaintenancePolicy
Returns
Type Description
Cluster.Builder

mergeMasterAuth(MasterAuth value)

public Cluster.Builder mergeMasterAuth(MasterAuth value)

The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, username will be set to "admin", a random password will be generated, and a client certificate will be issued.

.google.container.v1.MasterAuth master_auth = 5;

Parameter
Name Description
value MasterAuth
Returns
Type Description
Cluster.Builder

mergeMasterAuthorizedNetworksConfig(MasterAuthorizedNetworksConfig value)

public Cluster.Builder mergeMasterAuthorizedNetworksConfig(MasterAuthorizedNetworksConfig value)

The configuration options for master authorized networks feature.

.google.container.v1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 22;

Parameter
Name Description
value MasterAuthorizedNetworksConfig
Returns
Type Description
Cluster.Builder

mergeMeshCertificates(MeshCertificates value)

public Cluster.Builder mergeMeshCertificates(MeshCertificates value)

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

.google.container.v1.MeshCertificates mesh_certificates = 67;

Parameter
Name Description
value MeshCertificates
Returns
Type Description
Cluster.Builder

mergeMonitoringConfig(MonitoringConfig value)

public Cluster.Builder mergeMonitoringConfig(MonitoringConfig value)

Monitoring configuration for the cluster.

.google.container.v1.MonitoringConfig monitoring_config = 133;

Parameter
Name Description
value MonitoringConfig
Returns
Type Description
Cluster.Builder

mergeNetworkConfig(NetworkConfig value)

public Cluster.Builder mergeNetworkConfig(NetworkConfig value)

Configuration for cluster networking.

.google.container.v1.NetworkConfig network_config = 27;

Parameter
Name Description
value NetworkConfig
Returns
Type Description
Cluster.Builder

mergeNetworkPolicy(NetworkPolicy value)

public Cluster.Builder mergeNetworkPolicy(NetworkPolicy value)

Configuration options for the NetworkPolicy feature.

.google.container.v1.NetworkPolicy network_policy = 19;

Parameter
Name Description
value NetworkPolicy
Returns
Type Description
Cluster.Builder

mergeNodeConfig(NodeConfig value) (deprecated)

public Cluster.Builder mergeNodeConfig(NodeConfig value)

Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see node_pool.config)

If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.

.google.container.v1.NodeConfig node_config = 4 [deprecated = true];

Parameter
Name Description
value NodeConfig
Returns
Type Description
Cluster.Builder

mergeNodePoolAutoConfig(NodePoolAutoConfig value)

public Cluster.Builder mergeNodePoolAutoConfig(NodePoolAutoConfig value)

Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

.google.container.v1.NodePoolAutoConfig node_pool_auto_config = 136;

Parameter
Name Description
value NodePoolAutoConfig
Returns
Type Description
Cluster.Builder

mergeNodePoolDefaults(NodePoolDefaults value)

public Cluster.Builder mergeNodePoolDefaults(NodePoolDefaults value)

Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.

optional .google.container.v1.NodePoolDefaults node_pool_defaults = 131;

Parameter
Name Description
value NodePoolDefaults
Returns
Type Description
Cluster.Builder

mergeNotificationConfig(NotificationConfig value)

public Cluster.Builder mergeNotificationConfig(NotificationConfig value)

Notification configuration of the cluster.

.google.container.v1.NotificationConfig notification_config = 49;

Parameter
Name Description
value NotificationConfig
Returns
Type Description
Cluster.Builder

mergePrivateClusterConfig(PrivateClusterConfig value)

public Cluster.Builder mergePrivateClusterConfig(PrivateClusterConfig value)

Configuration for private cluster.

.google.container.v1.PrivateClusterConfig private_cluster_config = 37;

Parameter
Name Description
value PrivateClusterConfig
Returns
Type Description
Cluster.Builder

mergeReleaseChannel(ReleaseChannel value)

public Cluster.Builder mergeReleaseChannel(ReleaseChannel value)

Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version.

.google.container.v1.ReleaseChannel release_channel = 41;

Parameter
Name Description
value ReleaseChannel
Returns
Type Description
Cluster.Builder

mergeResourceUsageExportConfig(ResourceUsageExportConfig value)

public Cluster.Builder mergeResourceUsageExportConfig(ResourceUsageExportConfig value)

Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.

.google.container.v1.ResourceUsageExportConfig resource_usage_export_config = 33;

Parameter
Name Description
value ResourceUsageExportConfig
Returns
Type Description
Cluster.Builder

mergeSecurityPostureConfig(SecurityPostureConfig value)

public Cluster.Builder mergeSecurityPostureConfig(SecurityPostureConfig value)

Enable/Disable Security Posture API features for the cluster.

.google.container.v1.SecurityPostureConfig security_posture_config = 145;

Parameter
Name Description
value SecurityPostureConfig
Returns
Type Description
Cluster.Builder

mergeShieldedNodes(ShieldedNodes value)

public Cluster.Builder mergeShieldedNodes(ShieldedNodes value)

Shielded Nodes configuration.

.google.container.v1.ShieldedNodes shielded_nodes = 40;

Parameter
Name Description
value ShieldedNodes
Returns
Type Description
Cluster.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Cluster.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Cluster.Builder
Overrides

mergeVerticalPodAutoscaling(VerticalPodAutoscaling value)

public Cluster.Builder mergeVerticalPodAutoscaling(VerticalPodAutoscaling value)

Cluster-level Vertical Pod Autoscaling configuration.

.google.container.v1.VerticalPodAutoscaling vertical_pod_autoscaling = 39;

Parameter
Name Description
value VerticalPodAutoscaling
Returns
Type Description
Cluster.Builder

mergeWorkloadIdentityConfig(WorkloadIdentityConfig value)

public Cluster.Builder mergeWorkloadIdentityConfig(WorkloadIdentityConfig value)

Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.

.google.container.v1.WorkloadIdentityConfig workload_identity_config = 43;

Parameter
Name Description
value WorkloadIdentityConfig
Returns
Type Description
Cluster.Builder

putAllResourceLabels(Map<String,String> values)

public Cluster.Builder putAllResourceLabels(Map<String,String> values)

The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

map<string, string> resource_labels = 15;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Cluster.Builder

putResourceLabels(String key, String value)

public Cluster.Builder putResourceLabels(String key, String value)

The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

map<string, string> resource_labels = 15;

Parameters
Name Description
key String
value String
Returns
Type Description
Cluster.Builder

removeConditions(int index)

public Cluster.Builder removeConditions(int index)

Which conditions caused the current cluster state.

repeated .google.container.v1.StatusCondition conditions = 118;

Parameter
Name Description
index int
Returns
Type Description
Cluster.Builder

removeNodePools(int index)

public Cluster.Builder removeNodePools(int index)

The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

repeated .google.container.v1.NodePool node_pools = 12;

Parameter
Name Description
index int
Returns
Type Description
Cluster.Builder

removeResourceLabels(String key)

public Cluster.Builder removeResourceLabels(String key)

The resource labels for the cluster to use to annotate any related Google Compute Engine resources.

map<string, string> resource_labels = 15;

Parameter
Name Description
key String
Returns
Type Description
Cluster.Builder

setAddonsConfig(AddonsConfig value)

public Cluster.Builder setAddonsConfig(AddonsConfig value)

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

.google.container.v1.AddonsConfig addons_config = 10;

Parameter
Name Description
value AddonsConfig
Returns
Type Description
Cluster.Builder

setAddonsConfig(AddonsConfig.Builder builderForValue)

public Cluster.Builder setAddonsConfig(AddonsConfig.Builder builderForValue)

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

.google.container.v1.AddonsConfig addons_config = 10;

Parameter
Name Description
builderForValue AddonsConfig.Builder
Returns
Type Description
Cluster.Builder

setAuthenticatorGroupsConfig(AuthenticatorGroupsConfig value)

public Cluster.Builder setAuthenticatorGroupsConfig(AuthenticatorGroupsConfig value)

Configuration controlling RBAC group membership information.

.google.container.v1.AuthenticatorGroupsConfig authenticator_groups_config = 34;

Parameter
Name Description
value AuthenticatorGroupsConfig
Returns
Type Description
Cluster.Builder

setAuthenticatorGroupsConfig(AuthenticatorGroupsConfig.Builder builderForValue)

public Cluster.Builder setAuthenticatorGroupsConfig(AuthenticatorGroupsConfig.Builder builderForValue)

Configuration controlling RBAC group membership information.

.google.container.v1.AuthenticatorGroupsConfig authenticator_groups_config = 34;

Parameter
Name Description
builderForValue AuthenticatorGroupsConfig.Builder
Returns
Type Description
Cluster.Builder

setAutopilot(Autopilot value)

public Cluster.Builder setAutopilot(Autopilot value)

Autopilot configuration for the cluster.

.google.container.v1.Autopilot autopilot = 128;

Parameter
Name Description
value Autopilot
Returns
Type Description
Cluster.Builder

setAutopilot(Autopilot.Builder builderForValue)

public Cluster.Builder setAutopilot(Autopilot.Builder builderForValue)

Autopilot configuration for the cluster.

.google.container.v1.Autopilot autopilot = 128;

Parameter
Name Description
builderForValue Autopilot.Builder
Returns
Type Description
Cluster.Builder

setAutoscaling(ClusterAutoscaling value)

public Cluster.Builder setAutoscaling(ClusterAutoscaling value)

Cluster-level autoscaling configuration.

.google.container.v1.ClusterAutoscaling autoscaling = 26;

Parameter
Name Description
value ClusterAutoscaling
Returns
Type Description
Cluster.Builder

setAutoscaling(ClusterAutoscaling.Builder builderForValue)

public Cluster.Builder setAutoscaling(ClusterAutoscaling.Builder builderForValue)

Cluster-level autoscaling configuration.

.google.container.v1.ClusterAutoscaling autoscaling = 26;

Parameter
Name Description
builderForValue ClusterAutoscaling.Builder
Returns
Type Description
Cluster.Builder

setBinaryAuthorization(BinaryAuthorization value)

public Cluster.Builder setBinaryAuthorization(BinaryAuthorization value)

Configuration for Binary Authorization.

.google.container.v1.BinaryAuthorization binary_authorization = 24;

Parameter
Name Description
value BinaryAuthorization
Returns
Type Description
Cluster.Builder

setBinaryAuthorization(BinaryAuthorization.Builder builderForValue)

public Cluster.Builder setBinaryAuthorization(BinaryAuthorization.Builder builderForValue)

Configuration for Binary Authorization.

.google.container.v1.BinaryAuthorization binary_authorization = 24;

Parameter
Name Description
builderForValue BinaryAuthorization.Builder
Returns
Type Description
Cluster.Builder

setClusterIpv4Cidr(String value)

public Cluster.Builder setClusterIpv4Cidr(String value)

The IP address range of the container pods in this cluster, in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8.

string cluster_ipv4_cidr = 9;

Parameter
Name Description
value String

The clusterIpv4Cidr to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setClusterIpv4CidrBytes(ByteString value)

public Cluster.Builder setClusterIpv4CidrBytes(ByteString value)

The IP address range of the container pods in this cluster, in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8.

string cluster_ipv4_cidr = 9;

Parameter
Name Description
value ByteString

The bytes for clusterIpv4Cidr to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setConditions(int index, StatusCondition value)

public Cluster.Builder setConditions(int index, StatusCondition value)

Which conditions caused the current cluster state.

repeated .google.container.v1.StatusCondition conditions = 118;

Parameters
Name Description
index int
value StatusCondition
Returns
Type Description
Cluster.Builder

setConditions(int index, StatusCondition.Builder builderForValue)

public Cluster.Builder setConditions(int index, StatusCondition.Builder builderForValue)

Which conditions caused the current cluster state.

repeated .google.container.v1.StatusCondition conditions = 118;

Parameters
Name Description
index int
builderForValue StatusCondition.Builder
Returns
Type Description
Cluster.Builder

setConfidentialNodes(ConfidentialNodes value)

public Cluster.Builder setConfidentialNodes(ConfidentialNodes value)

Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled.

.google.container.v1.ConfidentialNodes confidential_nodes = 50;

Parameter
Name Description
value ConfidentialNodes
Returns
Type Description
Cluster.Builder

setConfidentialNodes(ConfidentialNodes.Builder builderForValue)

public Cluster.Builder setConfidentialNodes(ConfidentialNodes.Builder builderForValue)

Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled.

.google.container.v1.ConfidentialNodes confidential_nodes = 50;

Parameter
Name Description
builderForValue ConfidentialNodes.Builder
Returns
Type Description
Cluster.Builder

setCostManagementConfig(CostManagementConfig value)

public Cluster.Builder setCostManagementConfig(CostManagementConfig value)

Configuration for the fine-grained cost management feature.

.google.container.v1.CostManagementConfig cost_management_config = 45;

Parameter
Name Description
value CostManagementConfig
Returns
Type Description
Cluster.Builder

setCostManagementConfig(CostManagementConfig.Builder builderForValue)

public Cluster.Builder setCostManagementConfig(CostManagementConfig.Builder builderForValue)

Configuration for the fine-grained cost management feature.

.google.container.v1.CostManagementConfig cost_management_config = 45;

Parameter
Name Description
builderForValue CostManagementConfig.Builder
Returns
Type Description
Cluster.Builder

setCreateTime(String value)

public Cluster.Builder setCreateTime(String value)

Output only. The time the cluster was created, in RFC3339 text format.

string create_time = 106 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The createTime to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setCreateTimeBytes(ByteString value)

public Cluster.Builder setCreateTimeBytes(ByteString value)

Output only. The time the cluster was created, in RFC3339 text format.

string create_time = 106 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for createTime to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setCurrentMasterVersion(String value)

public Cluster.Builder setCurrentMasterVersion(String value)

Output only. The current software version of the master endpoint.

string current_master_version = 104 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The currentMasterVersion to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setCurrentMasterVersionBytes(ByteString value)

public Cluster.Builder setCurrentMasterVersionBytes(ByteString value)

Output only. The current software version of the master endpoint.

string current_master_version = 104 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for currentMasterVersion to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setCurrentNodeCount(int value) (deprecated)

public Cluster.Builder setCurrentNodeCount(int value)

Deprecated. google.container.v1.Cluster.current_node_count is deprecated. See google/container/v1/cluster_service.proto;l=2029

Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.

int32 current_node_count = 112 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The currentNodeCount to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setCurrentNodeVersion(String value) (deprecated)

public Cluster.Builder setCurrentNodeVersion(String value)

Deprecated. google.container.v1.Cluster.current_node_version is deprecated. See google/container/v1/cluster_service.proto;l=1994

Output only. Deprecated, use NodePools.version instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.

string current_node_version = 105 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The currentNodeVersion to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setCurrentNodeVersionBytes(ByteString value) (deprecated)

public Cluster.Builder setCurrentNodeVersionBytes(ByteString value)

Deprecated. google.container.v1.Cluster.current_node_version is deprecated. See google/container/v1/cluster_service.proto;l=1994

Output only. Deprecated, use NodePools.version instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.

string current_node_version = 105 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for currentNodeVersion to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setDatabaseEncryption(DatabaseEncryption value)

public Cluster.Builder setDatabaseEncryption(DatabaseEncryption value)

Configuration of etcd encryption.

.google.container.v1.DatabaseEncryption database_encryption = 38;

Parameter
Name Description
value DatabaseEncryption
Returns
Type Description
Cluster.Builder

setDatabaseEncryption(DatabaseEncryption.Builder builderForValue)

public Cluster.Builder setDatabaseEncryption(DatabaseEncryption.Builder builderForValue)

Configuration of etcd encryption.

.google.container.v1.DatabaseEncryption database_encryption = 38;

Parameter
Name Description
builderForValue DatabaseEncryption.Builder
Returns
Type Description
Cluster.Builder

setDefaultMaxPodsConstraint(MaxPodsConstraint value)

public Cluster.Builder setDefaultMaxPodsConstraint(MaxPodsConstraint value)

The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.

.google.container.v1.MaxPodsConstraint default_max_pods_constraint = 30;

Parameter
Name Description
value MaxPodsConstraint
Returns
Type Description
Cluster.Builder

setDefaultMaxPodsConstraint(MaxPodsConstraint.Builder builderForValue)

public Cluster.Builder setDefaultMaxPodsConstraint(MaxPodsConstraint.Builder builderForValue)

The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.

.google.container.v1.MaxPodsConstraint default_max_pods_constraint = 30;

Parameter
Name Description
builderForValue MaxPodsConstraint.Builder
Returns
Type Description
Cluster.Builder

setDescription(String value)

public Cluster.Builder setDescription(String value)

An optional description of this cluster.

string description = 2;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Cluster.Builder setDescriptionBytes(ByteString value)

An optional description of this cluster.

string description = 2;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setEnableK8SBetaApis(K8sBetaAPIConfig value)

public Cluster.Builder setEnableK8SBetaApis(K8sBetaAPIConfig value)

Beta APIs Config

.google.container.v1.K8sBetaAPIConfig enable_k8s_beta_apis = 143;

Parameter
Name Description
value K8sBetaAPIConfig
Returns
Type Description
Cluster.Builder

setEnableK8SBetaApis(K8sBetaAPIConfig.Builder builderForValue)

public Cluster.Builder setEnableK8SBetaApis(K8sBetaAPIConfig.Builder builderForValue)

Beta APIs Config

.google.container.v1.K8sBetaAPIConfig enable_k8s_beta_apis = 143;

Parameter
Name Description
builderForValue K8sBetaAPIConfig.Builder
Returns
Type Description
Cluster.Builder

setEnableKubernetesAlpha(boolean value)

public Cluster.Builder setEnableKubernetesAlpha(boolean value)

Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.

bool enable_kubernetes_alpha = 14;

Parameter
Name Description
value boolean

The enableKubernetesAlpha to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setEnableTpu(boolean value)

public Cluster.Builder setEnableTpu(boolean value)

Enable the ability to use Cloud TPUs in this cluster.

bool enable_tpu = 115;

Parameter
Name Description
value boolean

The enableTpu to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setEndpoint(String value)

public Cluster.Builder setEndpoint(String value)

Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at https://username:password@endpoint/.

See the masterAuth property of this resource for username and password information.

string endpoint = 102 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The endpoint to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setEndpointBytes(ByteString value)

public Cluster.Builder setEndpointBytes(ByteString value)

Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at https://username:password@endpoint/.

See the masterAuth property of this resource for username and password information.

string endpoint = 102 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for endpoint to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setEnterpriseConfig(EnterpriseConfig value)

public Cluster.Builder setEnterpriseConfig(EnterpriseConfig value)

GKE Enterprise Configuration.

.google.container.v1.EnterpriseConfig enterprise_config = 149;

Parameter
Name Description
value EnterpriseConfig
Returns
Type Description
Cluster.Builder

setEnterpriseConfig(EnterpriseConfig.Builder builderForValue)

public Cluster.Builder setEnterpriseConfig(EnterpriseConfig.Builder builderForValue)

GKE Enterprise Configuration.

.google.container.v1.EnterpriseConfig enterprise_config = 149;

Parameter
Name Description
builderForValue EnterpriseConfig.Builder
Returns
Type Description
Cluster.Builder

setEtag(String value)

public Cluster.Builder setEtag(String value)

This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.

string etag = 139;

Parameter
Name Description
value String

The etag to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public Cluster.Builder setEtagBytes(ByteString value)

This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.

string etag = 139;

Parameter
Name Description
value ByteString

The bytes for etag to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setExpireTime(String value)

public Cluster.Builder setExpireTime(String value)

Output only. The time the cluster will be automatically deleted in RFC3339 text format.

string expire_time = 113 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The expireTime to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setExpireTimeBytes(ByteString value)

public Cluster.Builder setExpireTimeBytes(ByteString value)

Output only. The time the cluster will be automatically deleted in RFC3339 text format.

string expire_time = 113 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for expireTime to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Cluster.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Cluster.Builder
Overrides

setFleet(Fleet value)

public Cluster.Builder setFleet(Fleet value)

Fleet information for the cluster.

.google.container.v1.Fleet fleet = 140;

Parameter
Name Description
value Fleet
Returns
Type Description
Cluster.Builder

setFleet(Fleet.Builder builderForValue)

public Cluster.Builder setFleet(Fleet.Builder builderForValue)

Fleet information for the cluster.

.google.container.v1.Fleet fleet = 140;

Parameter
Name Description
builderForValue Fleet.Builder
Returns
Type Description
Cluster.Builder

setId(String value)

public Cluster.Builder setId(String value)

Output only. Unique id for the cluster.

string id = 129 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The id to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setIdBytes(ByteString value)

public Cluster.Builder setIdBytes(ByteString value)

Output only. Unique id for the cluster.

string id = 129 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for id to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setIdentityServiceConfig(IdentityServiceConfig value)

public Cluster.Builder setIdentityServiceConfig(IdentityServiceConfig value)

Configuration for Identity Service component.

.google.container.v1.IdentityServiceConfig identity_service_config = 54;

Parameter
Name Description
value IdentityServiceConfig
Returns
Type Description
Cluster.Builder

setIdentityServiceConfig(IdentityServiceConfig.Builder builderForValue)

public Cluster.Builder setIdentityServiceConfig(IdentityServiceConfig.Builder builderForValue)

Configuration for Identity Service component.

.google.container.v1.IdentityServiceConfig identity_service_config = 54;

Parameter
Name Description
builderForValue IdentityServiceConfig.Builder
Returns
Type Description
Cluster.Builder

setInitialClusterVersion(String value)

public Cluster.Builder setInitialClusterVersion(String value)

The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion.

Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:

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

string initial_cluster_version = 103;

Parameter
Name Description
value String

The initialClusterVersion to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setInitialClusterVersionBytes(ByteString value)

public Cluster.Builder setInitialClusterVersionBytes(ByteString value)

The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion.

Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior:

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

string initial_cluster_version = 103;

Parameter
Name Description
value ByteString

The bytes for initialClusterVersion to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setInitialNodeCount(int value) (deprecated)

public Cluster.Builder setInitialNodeCount(int value)

Deprecated. google.container.v1.Cluster.initial_node_count is deprecated. See google/container/v1/cluster_service.proto;l=1775

The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time.

This field is deprecated, use node_pool.initial_node_count instead.

int32 initial_node_count = 3 [deprecated = true];

Parameter
Name Description
value int

The initialNodeCount to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setInstanceGroupUrls(int index, String value) (deprecated)

public Cluster.Builder setInstanceGroupUrls(int index, String value)

Deprecated. google.container.v1.Cluster.instance_group_urls is deprecated. See google/container/v1/cluster_service.proto;l=2024

Output only. Deprecated. Use node_pools.instance_group_urls.

repeated string instance_group_urls = 111 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int

The index to set the value at.
value String

The instanceGroupUrls to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setIpAllocationPolicy(IPAllocationPolicy value)

public Cluster.Builder setIpAllocationPolicy(IPAllocationPolicy value)

Configuration for cluster IP allocation.

.google.container.v1.IPAllocationPolicy ip_allocation_policy = 20;

Parameter
Name Description
value IPAllocationPolicy
Returns
Type Description
Cluster.Builder

setIpAllocationPolicy(IPAllocationPolicy.Builder builderForValue)

public Cluster.Builder setIpAllocationPolicy(IPAllocationPolicy.Builder builderForValue)

Configuration for cluster IP allocation.

.google.container.v1.IPAllocationPolicy ip_allocation_policy = 20;

Parameter
Name Description
builderForValue IPAllocationPolicy.Builder
Returns
Type Description
Cluster.Builder

setLabelFingerprint(String value)

public Cluster.Builder setLabelFingerprint(String value)

The fingerprint of the set of labels for this cluster.

string label_fingerprint = 16;

Parameter
Name Description
value String

The labelFingerprint to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setLabelFingerprintBytes(ByteString value)

public Cluster.Builder setLabelFingerprintBytes(ByteString value)

The fingerprint of the set of labels for this cluster.

string label_fingerprint = 16;

Parameter
Name Description
value ByteString

The bytes for labelFingerprint to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setLegacyAbac(LegacyAbac value)

public Cluster.Builder setLegacyAbac(LegacyAbac value)

Configuration for the legacy ABAC authorization mode.

.google.container.v1.LegacyAbac legacy_abac = 18;

Parameter
Name Description
value LegacyAbac
Returns
Type Description
Cluster.Builder

setLegacyAbac(LegacyAbac.Builder builderForValue)

public Cluster.Builder setLegacyAbac(LegacyAbac.Builder builderForValue)

Configuration for the legacy ABAC authorization mode.

.google.container.v1.LegacyAbac legacy_abac = 18;

Parameter
Name Description
builderForValue LegacyAbac.Builder
Returns
Type Description
Cluster.Builder

setLocation(String value)

public Cluster.Builder setLocation(String value)

Output only. The name of the Google Compute Engine zone or region in which the cluster resides.

string location = 114 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The location to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setLocationBytes(ByteString value)

public Cluster.Builder setLocationBytes(ByteString value)

Output only. The name of the Google Compute Engine zone or region in which the cluster resides.

string location = 114 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for location to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setLocations(int index, String value)

public Cluster.Builder setLocations(int index, String value)

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

This field provides a default value if NodePool.Locations are not specified during node pool creation.

Warning: changing cluster locations will update the NodePool.Locations of all node pools and will result in nodes being added and/or removed.

repeated string locations = 13;

Parameters
Name Description
index int

The index to set the value at.
value String

The locations to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setLoggingConfig(LoggingConfig value)

public Cluster.Builder setLoggingConfig(LoggingConfig value)

Logging configuration for the cluster.

.google.container.v1.LoggingConfig logging_config = 132;

Parameter
Name Description
value LoggingConfig
Returns
Type Description
Cluster.Builder

setLoggingConfig(LoggingConfig.Builder builderForValue)

public Cluster.Builder setLoggingConfig(LoggingConfig.Builder builderForValue)

Logging configuration for the cluster.

.google.container.v1.LoggingConfig logging_config = 132;

Parameter
Name Description
builderForValue LoggingConfig.Builder
Returns
Type Description
Cluster.Builder

setLoggingService(String value)

public Cluster.Builder setLoggingService(String value)

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 logging_service = 6;

Parameter
Name Description
value String

The loggingService to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setLoggingServiceBytes(ByteString value)

public Cluster.Builder setLoggingServiceBytes(ByteString value)

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 logging_service = 6;

Parameter
Name Description
value ByteString

The bytes for loggingService to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setMaintenancePolicy(MaintenancePolicy value)

public Cluster.Builder setMaintenancePolicy(MaintenancePolicy value)

Configure the maintenance policy for this cluster.

.google.container.v1.MaintenancePolicy maintenance_policy = 23;

Parameter
Name Description
value MaintenancePolicy
Returns
Type Description
Cluster.Builder

setMaintenancePolicy(MaintenancePolicy.Builder builderForValue)

public Cluster.Builder setMaintenancePolicy(MaintenancePolicy.Builder builderForValue)

Configure the maintenance policy for this cluster.

.google.container.v1.MaintenancePolicy maintenance_policy = 23;

Parameter
Name Description
builderForValue MaintenancePolicy.Builder
Returns
Type Description
Cluster.Builder

setMasterAuth(MasterAuth value)

public Cluster.Builder setMasterAuth(MasterAuth value)

The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, username will be set to "admin", a random password will be generated, and a client certificate will be issued.

.google.container.v1.MasterAuth master_auth = 5;

Parameter
Name Description
value MasterAuth
Returns
Type Description
Cluster.Builder

setMasterAuth(MasterAuth.Builder builderForValue)

public Cluster.Builder setMasterAuth(MasterAuth.Builder builderForValue)

The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, username will be set to "admin", a random password will be generated, and a client certificate will be issued.

.google.container.v1.MasterAuth master_auth = 5;

Parameter
Name Description
builderForValue MasterAuth.Builder
Returns
Type Description
Cluster.Builder

setMasterAuthorizedNetworksConfig(MasterAuthorizedNetworksConfig value)

public Cluster.Builder setMasterAuthorizedNetworksConfig(MasterAuthorizedNetworksConfig value)

The configuration options for master authorized networks feature.

.google.container.v1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 22;

Parameter
Name Description
value MasterAuthorizedNetworksConfig
Returns
Type Description
Cluster.Builder

setMasterAuthorizedNetworksConfig(MasterAuthorizedNetworksConfig.Builder builderForValue)

public Cluster.Builder setMasterAuthorizedNetworksConfig(MasterAuthorizedNetworksConfig.Builder builderForValue)

The configuration options for master authorized networks feature.

.google.container.v1.MasterAuthorizedNetworksConfig master_authorized_networks_config = 22;

Parameter
Name Description
builderForValue MasterAuthorizedNetworksConfig.Builder
Returns
Type Description
Cluster.Builder

setMeshCertificates(MeshCertificates value)

public Cluster.Builder setMeshCertificates(MeshCertificates value)

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

.google.container.v1.MeshCertificates mesh_certificates = 67;

Parameter
Name Description
value MeshCertificates
Returns
Type Description
Cluster.Builder

setMeshCertificates(MeshCertificates.Builder builderForValue)

public Cluster.Builder setMeshCertificates(MeshCertificates.Builder builderForValue)

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

.google.container.v1.MeshCertificates mesh_certificates = 67;

Parameter
Name Description
builderForValue MeshCertificates.Builder
Returns
Type Description
Cluster.Builder

setMonitoringConfig(MonitoringConfig value)

public Cluster.Builder setMonitoringConfig(MonitoringConfig value)

Monitoring configuration for the cluster.

.google.container.v1.MonitoringConfig monitoring_config = 133;

Parameter
Name Description
value MonitoringConfig
Returns
Type Description
Cluster.Builder

setMonitoringConfig(MonitoringConfig.Builder builderForValue)

public Cluster.Builder setMonitoringConfig(MonitoringConfig.Builder builderForValue)

Monitoring configuration for the cluster.

.google.container.v1.MonitoringConfig monitoring_config = 133;

Parameter
Name Description
builderForValue MonitoringConfig.Builder
Returns
Type Description
Cluster.Builder

setMonitoringService(String value)

public Cluster.Builder setMonitoringService(String value)

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 monitoring_service = 7;

Parameter
Name Description
value String

The monitoringService to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setMonitoringServiceBytes(ByteString value)

public Cluster.Builder setMonitoringServiceBytes(ByteString value)

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 monitoring_service = 7;

Parameter
Name Description
value ByteString

The bytes for monitoringService to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setName(String value)

public Cluster.Builder setName(String value)

The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions:

  • Lowercase letters, numbers, and hyphens only.
  • Must start with a letter.
  • Must end with a number or a letter.

string name = 1;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Cluster.Builder setNameBytes(ByteString value)

The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions:

  • Lowercase letters, numbers, and hyphens only.
  • Must start with a letter.
  • Must end with a number or a letter.

string name = 1;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setNetwork(String value)

public Cluster.Builder setNetwork(String value)

The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.

string network = 8;

Parameter
Name Description
value String

The network to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setNetworkBytes(ByteString value)

public Cluster.Builder setNetworkBytes(ByteString value)

The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.

string network = 8;

Parameter
Name Description
value ByteString

The bytes for network to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setNetworkConfig(NetworkConfig value)

public Cluster.Builder setNetworkConfig(NetworkConfig value)

Configuration for cluster networking.

.google.container.v1.NetworkConfig network_config = 27;

Parameter
Name Description
value NetworkConfig
Returns
Type Description
Cluster.Builder

setNetworkConfig(NetworkConfig.Builder builderForValue)

public Cluster.Builder setNetworkConfig(NetworkConfig.Builder builderForValue)

Configuration for cluster networking.

.google.container.v1.NetworkConfig network_config = 27;

Parameter
Name Description
builderForValue NetworkConfig.Builder
Returns
Type Description
Cluster.Builder

setNetworkPolicy(NetworkPolicy value)

public Cluster.Builder setNetworkPolicy(NetworkPolicy value)

Configuration options for the NetworkPolicy feature.

.google.container.v1.NetworkPolicy network_policy = 19;

Parameter
Name Description
value NetworkPolicy
Returns
Type Description
Cluster.Builder

setNetworkPolicy(NetworkPolicy.Builder builderForValue)

public Cluster.Builder setNetworkPolicy(NetworkPolicy.Builder builderForValue)

Configuration options for the NetworkPolicy feature.

.google.container.v1.NetworkPolicy network_policy = 19;

Parameter
Name Description
builderForValue NetworkPolicy.Builder
Returns
Type Description
Cluster.Builder

setNodeConfig(NodeConfig value) (deprecated)

public Cluster.Builder setNodeConfig(NodeConfig value)

Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see node_pool.config)

If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.

.google.container.v1.NodeConfig node_config = 4 [deprecated = true];

Parameter
Name Description
value NodeConfig
Returns
Type Description
Cluster.Builder

setNodeConfig(NodeConfig.Builder builderForValue) (deprecated)

public Cluster.Builder setNodeConfig(NodeConfig.Builder builderForValue)

Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see node_pool.config)

If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.

.google.container.v1.NodeConfig node_config = 4 [deprecated = true];

Parameter
Name Description
builderForValue NodeConfig.Builder
Returns
Type Description
Cluster.Builder

setNodeIpv4CidrSize(int value)

public Cluster.Builder setNodeIpv4CidrSize(int value)

Output only. The size of the address space on each node for hosting containers. This is provisioned from within the container_ipv4_cidr range. This field will only be set when cluster is in route-based network mode.

int32 node_ipv4_cidr_size = 109 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The nodeIpv4CidrSize to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setNodePoolAutoConfig(NodePoolAutoConfig value)

public Cluster.Builder setNodePoolAutoConfig(NodePoolAutoConfig value)

Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

.google.container.v1.NodePoolAutoConfig node_pool_auto_config = 136;

Parameter
Name Description
value NodePoolAutoConfig
Returns
Type Description
Cluster.Builder

setNodePoolAutoConfig(NodePoolAutoConfig.Builder builderForValue)

public Cluster.Builder setNodePoolAutoConfig(NodePoolAutoConfig.Builder builderForValue)

Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.

.google.container.v1.NodePoolAutoConfig node_pool_auto_config = 136;

Parameter
Name Description
builderForValue NodePoolAutoConfig.Builder
Returns
Type Description
Cluster.Builder

setNodePoolDefaults(NodePoolDefaults value)

public Cluster.Builder setNodePoolDefaults(NodePoolDefaults value)

Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.

optional .google.container.v1.NodePoolDefaults node_pool_defaults = 131;

Parameter
Name Description
value NodePoolDefaults
Returns
Type Description
Cluster.Builder

setNodePoolDefaults(NodePoolDefaults.Builder builderForValue)

public Cluster.Builder setNodePoolDefaults(NodePoolDefaults.Builder builderForValue)

Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.

optional .google.container.v1.NodePoolDefaults node_pool_defaults = 131;

Parameter
Name Description
builderForValue NodePoolDefaults.Builder
Returns
Type Description
Cluster.Builder

setNodePools(int index, NodePool value)

public Cluster.Builder setNodePools(int index, NodePool value)

The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

repeated .google.container.v1.NodePool node_pools = 12;

Parameters
Name Description
index int
value NodePool
Returns
Type Description
Cluster.Builder

setNodePools(int index, NodePool.Builder builderForValue)

public Cluster.Builder setNodePools(int index, NodePool.Builder builderForValue)

The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.

repeated .google.container.v1.NodePool node_pools = 12;

Parameters
Name Description
index int
builderForValue NodePool.Builder
Returns
Type Description
Cluster.Builder

setNotificationConfig(NotificationConfig value)

public Cluster.Builder setNotificationConfig(NotificationConfig value)

Notification configuration of the cluster.

.google.container.v1.NotificationConfig notification_config = 49;

Parameter
Name Description
value NotificationConfig
Returns
Type Description
Cluster.Builder

setNotificationConfig(NotificationConfig.Builder builderForValue)

public Cluster.Builder setNotificationConfig(NotificationConfig.Builder builderForValue)

Notification configuration of the cluster.

.google.container.v1.NotificationConfig notification_config = 49;

Parameter
Name Description
builderForValue NotificationConfig.Builder
Returns
Type Description
Cluster.Builder

setPrivateClusterConfig(PrivateClusterConfig value)

public Cluster.Builder setPrivateClusterConfig(PrivateClusterConfig value)

Configuration for private cluster.

.google.container.v1.PrivateClusterConfig private_cluster_config = 37;

Parameter
Name Description
value PrivateClusterConfig
Returns
Type Description
Cluster.Builder

setPrivateClusterConfig(PrivateClusterConfig.Builder builderForValue)

public Cluster.Builder setPrivateClusterConfig(PrivateClusterConfig.Builder builderForValue)

Configuration for private cluster.

.google.container.v1.PrivateClusterConfig private_cluster_config = 37;

Parameter
Name Description
builderForValue PrivateClusterConfig.Builder
Returns
Type Description
Cluster.Builder

setReleaseChannel(ReleaseChannel value)

public Cluster.Builder setReleaseChannel(ReleaseChannel value)

Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version.

.google.container.v1.ReleaseChannel release_channel = 41;

Parameter
Name Description
value ReleaseChannel
Returns
Type Description
Cluster.Builder

setReleaseChannel(ReleaseChannel.Builder builderForValue)

public Cluster.Builder setReleaseChannel(ReleaseChannel.Builder builderForValue)

Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version.

.google.container.v1.ReleaseChannel release_channel = 41;

Parameter
Name Description
builderForValue ReleaseChannel.Builder
Returns
Type Description
Cluster.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Cluster.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Cluster.Builder
Overrides

setResourceUsageExportConfig(ResourceUsageExportConfig value)

public Cluster.Builder setResourceUsageExportConfig(ResourceUsageExportConfig value)

Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.

.google.container.v1.ResourceUsageExportConfig resource_usage_export_config = 33;

Parameter
Name Description
value ResourceUsageExportConfig
Returns
Type Description
Cluster.Builder

setResourceUsageExportConfig(ResourceUsageExportConfig.Builder builderForValue)

public Cluster.Builder setResourceUsageExportConfig(ResourceUsageExportConfig.Builder builderForValue)

Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.

.google.container.v1.ResourceUsageExportConfig resource_usage_export_config = 33;

Parameter
Name Description
builderForValue ResourceUsageExportConfig.Builder
Returns
Type Description
Cluster.Builder

setSatisfiesPzi(boolean value)

public Cluster.Builder setSatisfiesPzi(boolean value)

Output only. Reserved for future use.

optional bool satisfies_pzi = 153 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The satisfiesPzi to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setSatisfiesPzs(boolean value)

public Cluster.Builder setSatisfiesPzs(boolean value)

Output only. Reserved for future use.

optional bool satisfies_pzs = 152 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value boolean

The satisfiesPzs to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setSecurityPostureConfig(SecurityPostureConfig value)

public Cluster.Builder setSecurityPostureConfig(SecurityPostureConfig value)

Enable/Disable Security Posture API features for the cluster.

.google.container.v1.SecurityPostureConfig security_posture_config = 145;

Parameter
Name Description
value SecurityPostureConfig
Returns
Type Description
Cluster.Builder

setSecurityPostureConfig(SecurityPostureConfig.Builder builderForValue)

public Cluster.Builder setSecurityPostureConfig(SecurityPostureConfig.Builder builderForValue)

Enable/Disable Security Posture API features for the cluster.

.google.container.v1.SecurityPostureConfig security_posture_config = 145;

Parameter
Name Description
builderForValue SecurityPostureConfig.Builder
Returns
Type Description
Cluster.Builder

setSelfLink(String value)

public Cluster.Builder setSelfLink(String value)

Output only. Server-defined URL for the resource.

string self_link = 100 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The selfLink to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setSelfLinkBytes(ByteString value)

public Cluster.Builder setSelfLinkBytes(ByteString value)

Output only. Server-defined URL for the resource.

string self_link = 100 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for selfLink to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setServicesIpv4Cidr(String value)

public Cluster.Builder setServicesIpv4Cidr(String value)

Output only. The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the container CIDR.

string services_ipv4_cidr = 110 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The servicesIpv4Cidr to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setServicesIpv4CidrBytes(ByteString value)

public Cluster.Builder setServicesIpv4CidrBytes(ByteString value)

Output only. The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the container CIDR.

string services_ipv4_cidr = 110 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for servicesIpv4Cidr to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setShieldedNodes(ShieldedNodes value)

public Cluster.Builder setShieldedNodes(ShieldedNodes value)

Shielded Nodes configuration.

.google.container.v1.ShieldedNodes shielded_nodes = 40;

Parameter
Name Description
value ShieldedNodes
Returns
Type Description
Cluster.Builder

setShieldedNodes(ShieldedNodes.Builder builderForValue)

public Cluster.Builder setShieldedNodes(ShieldedNodes.Builder builderForValue)

Shielded Nodes configuration.

.google.container.v1.ShieldedNodes shielded_nodes = 40;

Parameter
Name Description
builderForValue ShieldedNodes.Builder
Returns
Type Description
Cluster.Builder

setStatus(Cluster.Status value)

public Cluster.Builder setStatus(Cluster.Status value)

Output only. The current status of this cluster.

.google.container.v1.Cluster.Status status = 107 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Cluster.Status

The status to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setStatusMessage(String value) (deprecated)

public Cluster.Builder setStatusMessage(String value)

Deprecated. google.container.v1.Cluster.status_message is deprecated. See google/container/v1/cluster_service.proto;l=2007

Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.

string status_message = 108 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The statusMessage to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setStatusMessageBytes(ByteString value) (deprecated)

public Cluster.Builder setStatusMessageBytes(ByteString value)

Deprecated. google.container.v1.Cluster.status_message is deprecated. See google/container/v1/cluster_service.proto;l=2007

Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.

string status_message = 108 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for statusMessage to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setStatusValue(int value)

public Cluster.Builder setStatusValue(int value)

Output only. The current status of this cluster.

.google.container.v1.Cluster.Status status = 107 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for status to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setSubnetwork(String value)

public Cluster.Builder setSubnetwork(String value)

The name of the Google Compute Engine subnetwork to which the cluster is connected.

string subnetwork = 11;

Parameter
Name Description
value String

The subnetwork to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setSubnetworkBytes(ByteString value)

public Cluster.Builder setSubnetworkBytes(ByteString value)

The name of the Google Compute Engine subnetwork to which the cluster is connected.

string subnetwork = 11;

Parameter
Name Description
value ByteString

The bytes for subnetwork to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setTpuIpv4CidrBlock(String value)

public Cluster.Builder setTpuIpv4CidrBlock(String value)

Output only. The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. 1.2.3.4/29).

string tpu_ipv4_cidr_block = 116 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The tpuIpv4CidrBlock to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setTpuIpv4CidrBlockBytes(ByteString value)

public Cluster.Builder setTpuIpv4CidrBlockBytes(ByteString value)

Output only. The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. 1.2.3.4/29).

string tpu_ipv4_cidr_block = 116 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for tpuIpv4CidrBlock to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Cluster.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Cluster.Builder
Overrides

setVerticalPodAutoscaling(VerticalPodAutoscaling value)

public Cluster.Builder setVerticalPodAutoscaling(VerticalPodAutoscaling value)

Cluster-level Vertical Pod Autoscaling configuration.

.google.container.v1.VerticalPodAutoscaling vertical_pod_autoscaling = 39;

Parameter
Name Description
value VerticalPodAutoscaling
Returns
Type Description
Cluster.Builder

setVerticalPodAutoscaling(VerticalPodAutoscaling.Builder builderForValue)

public Cluster.Builder setVerticalPodAutoscaling(VerticalPodAutoscaling.Builder builderForValue)

Cluster-level Vertical Pod Autoscaling configuration.

.google.container.v1.VerticalPodAutoscaling vertical_pod_autoscaling = 39;

Parameter
Name Description
builderForValue VerticalPodAutoscaling.Builder
Returns
Type Description
Cluster.Builder

setWorkloadIdentityConfig(WorkloadIdentityConfig value)

public Cluster.Builder setWorkloadIdentityConfig(WorkloadIdentityConfig value)

Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.

.google.container.v1.WorkloadIdentityConfig workload_identity_config = 43;

Parameter
Name Description
value WorkloadIdentityConfig
Returns
Type Description
Cluster.Builder

setWorkloadIdentityConfig(WorkloadIdentityConfig.Builder builderForValue)

public Cluster.Builder setWorkloadIdentityConfig(WorkloadIdentityConfig.Builder builderForValue)

Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.

.google.container.v1.WorkloadIdentityConfig workload_identity_config = 43;

Parameter
Name Description
builderForValue WorkloadIdentityConfig.Builder
Returns
Type Description
Cluster.Builder

setZone(String value) (deprecated)

public Cluster.Builder setZone(String value)

Deprecated. google.container.v1.Cluster.zone is deprecated. See google/container/v1/cluster_service.proto;l=1959

Output only. The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.

string zone = 101 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The zone to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.

setZoneBytes(ByteString value) (deprecated)

public Cluster.Builder setZoneBytes(ByteString value)

Deprecated. google.container.v1.Cluster.zone is deprecated. See google/container/v1/cluster_service.proto;l=1959

Output only. The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.

string zone = 101 [deprecated = true, (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for zone to set.
Returns
Type Description
Cluster.Builder

This builder for chaining.