Interface ClusterOrBuilder (2.56.0) 

public interface ClusterOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsResourceLabels(String key)

public abstract 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 abstract AddonsConfig getAddonsConfig()

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

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

Returns
Type Description
AddonsConfig

The addonsConfig.

getAddonsConfigOrBuilder()

public abstract AddonsConfigOrBuilder getAddonsConfigOrBuilder()

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

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

Returns
Type Description
AddonsConfigOrBuilder

getAuthenticatorGroupsConfig()

public abstract AuthenticatorGroupsConfig getAuthenticatorGroupsConfig()

Configuration controlling RBAC group membership information.

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

Returns
Type Description
AuthenticatorGroupsConfig

The authenticatorGroupsConfig.

getAuthenticatorGroupsConfigOrBuilder()

public abstract AuthenticatorGroupsConfigOrBuilder getAuthenticatorGroupsConfigOrBuilder()

Configuration controlling RBAC group membership information.

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

Returns
Type Description
AuthenticatorGroupsConfigOrBuilder

getAutopilot()

public abstract Autopilot getAutopilot()

Autopilot configuration for the cluster.

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

Returns
Type Description
Autopilot

The autopilot.

getAutopilotOrBuilder()

public abstract AutopilotOrBuilder getAutopilotOrBuilder()

Autopilot configuration for the cluster.

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

Returns
Type Description
AutopilotOrBuilder

getAutoscaling()

public abstract ClusterAutoscaling getAutoscaling()

Cluster-level autoscaling configuration.

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

Returns
Type Description
ClusterAutoscaling

The autoscaling.

getAutoscalingOrBuilder()

public abstract ClusterAutoscalingOrBuilder getAutoscalingOrBuilder()

Cluster-level autoscaling configuration.

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

Returns
Type Description
ClusterAutoscalingOrBuilder

getBinaryAuthorization()

public abstract BinaryAuthorization getBinaryAuthorization()

Configuration for Binary Authorization.

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

Returns
Type Description
BinaryAuthorization

The binaryAuthorization.

getBinaryAuthorizationOrBuilder()

public abstract BinaryAuthorizationOrBuilder getBinaryAuthorizationOrBuilder()

Configuration for Binary Authorization.

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

Returns
Type Description
BinaryAuthorizationOrBuilder

getClusterIpv4Cidr()

public abstract 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 abstract 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.

getClusterTelemetry()

public abstract ClusterTelemetry getClusterTelemetry()

Telemetry integration for the cluster.

.google.container.v1beta1.ClusterTelemetry cluster_telemetry = 46;

Returns
Type Description
ClusterTelemetry

The clusterTelemetry.

getClusterTelemetryOrBuilder()

public abstract ClusterTelemetryOrBuilder getClusterTelemetryOrBuilder()

Telemetry integration for the cluster.

.google.container.v1beta1.ClusterTelemetry cluster_telemetry = 46;

Returns
Type Description
ClusterTelemetryOrBuilder

getCompliancePostureConfig()

public abstract CompliancePostureConfig getCompliancePostureConfig()

Enable/Disable Compliance Posture features for the cluster.

.google.container.v1beta1.CompliancePostureConfig compliance_posture_config = 151;

Returns
Type Description
CompliancePostureConfig

The compliancePostureConfig.

getCompliancePostureConfigOrBuilder()

public abstract CompliancePostureConfigOrBuilder getCompliancePostureConfigOrBuilder()

Enable/Disable Compliance Posture features for the cluster.

.google.container.v1beta1.CompliancePostureConfig compliance_posture_config = 151;

Returns
Type Description
CompliancePostureConfigOrBuilder

getConditions(int index)

public abstract StatusCondition getConditions(int index)

Which conditions caused the current cluster state.

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

Parameter
Name Description
index int
Returns
Type Description
StatusCondition

getConditionsCount()

public abstract int getConditionsCount()

Which conditions caused the current cluster state.

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

Returns
Type Description
int

getConditionsList()

public abstract List<StatusCondition> getConditionsList()

Which conditions caused the current cluster state.

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

Returns
Type Description
List<StatusCondition>

getConditionsOrBuilder(int index)

public abstract StatusConditionOrBuilder getConditionsOrBuilder(int index)

Which conditions caused the current cluster state.

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

Parameter
Name Description
index int
Returns
Type Description
StatusConditionOrBuilder

getConditionsOrBuilderList()

public abstract List<? extends StatusConditionOrBuilder> getConditionsOrBuilderList()

Which conditions caused the current cluster state.

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

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

getConfidentialNodes()

public abstract ConfidentialNodes getConfidentialNodes()

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

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

Returns
Type Description
ConfidentialNodes

The confidentialNodes.

getConfidentialNodesOrBuilder()

public abstract ConfidentialNodesOrBuilder getConfidentialNodesOrBuilder()

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

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

Returns
Type Description
ConfidentialNodesOrBuilder

getCostManagementConfig()

public abstract CostManagementConfig getCostManagementConfig()

Configuration for the fine-grained cost management feature.

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

Returns
Type Description
CostManagementConfig

The costManagementConfig.

getCostManagementConfigOrBuilder()

public abstract CostManagementConfigOrBuilder getCostManagementConfigOrBuilder()

Configuration for the fine-grained cost management feature.

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

Returns
Type Description
CostManagementConfigOrBuilder

getCreateTime()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract int getCurrentNodeCount()

Deprecated. google.container.v1beta1.Cluster.current_node_count is deprecated. See google/container/v1beta1/cluster_service.proto;l=2313

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 abstract String getCurrentNodeVersion()

Deprecated. google.container.v1beta1.Cluster.current_node_version is deprecated. See google/container/v1beta1/cluster_service.proto;l=2278

Output only. Deprecated, use NodePool.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 abstract ByteString getCurrentNodeVersionBytes()

Deprecated. google.container.v1beta1.Cluster.current_node_version is deprecated. See google/container/v1beta1/cluster_service.proto;l=2278

Output only. Deprecated, use NodePool.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 abstract DatabaseEncryption getDatabaseEncryption()

Configuration of etcd encryption.

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

Returns
Type Description
DatabaseEncryption

The databaseEncryption.

getDatabaseEncryptionOrBuilder()

public abstract DatabaseEncryptionOrBuilder getDatabaseEncryptionOrBuilder()

Configuration of etcd encryption.

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

Returns
Type Description
DatabaseEncryptionOrBuilder

getDefaultMaxPodsConstraint()

public abstract 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.v1beta1.MaxPodsConstraint default_max_pods_constraint = 30;

Returns
Type Description
MaxPodsConstraint

The defaultMaxPodsConstraint.

getDefaultMaxPodsConstraintOrBuilder()

public abstract 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.v1beta1.MaxPodsConstraint default_max_pods_constraint = 30;

Returns
Type Description
MaxPodsConstraintOrBuilder

getDescription()

public abstract String getDescription()

An optional description of this cluster.

string description = 2;

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

An optional description of this cluster.

string description = 2;

Returns
Type Description
ByteString

The bytes for description.

getEnableK8SBetaApis()

public abstract K8sBetaAPIConfig getEnableK8SBetaApis()

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

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

Returns
Type Description
K8sBetaAPIConfig

The enableK8sBetaApis.

getEnableK8SBetaApisOrBuilder()

public abstract K8sBetaAPIConfigOrBuilder getEnableK8SBetaApisOrBuilder()

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

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

Returns
Type Description
K8sBetaAPIConfigOrBuilder

getEnableKubernetesAlpha()

public abstract boolean getEnableKubernetesAlpha()

Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) 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 abstract boolean getEnableTpu()

Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead.

bool enable_tpu = 115;

Returns
Type Description
boolean

The enableTpu.

getEndpoint()

public abstract 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 abstract 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 abstract EnterpriseConfig getEnterpriseConfig()

GKE Enterprise Configuration.

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

Returns
Type Description
EnterpriseConfig

The enterpriseConfig.

getEnterpriseConfigOrBuilder()

public abstract EnterpriseConfigOrBuilder getEnterpriseConfigOrBuilder()

GKE Enterprise Configuration.

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

Returns
Type Description
EnterpriseConfigOrBuilder

getEtag()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract Fleet getFleet()

Fleet information for the cluster.

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

Returns
Type Description
Fleet

The fleet.

getFleetOrBuilder()

public abstract FleetOrBuilder getFleetOrBuilder()

Fleet information for the cluster.

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

Returns
Type Description
FleetOrBuilder

getId()

public abstract 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 abstract 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 abstract IdentityServiceConfig getIdentityServiceConfig()

Configuration for Identity Service component.

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

Returns
Type Description
IdentityServiceConfig

The identityServiceConfig.

getIdentityServiceConfigOrBuilder()

public abstract IdentityServiceConfigOrBuilder getIdentityServiceConfigOrBuilder()

Configuration for Identity Service component.

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

Returns
Type Description
IdentityServiceConfigOrBuilder

getInitialClusterVersion()

public abstract 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 abstract 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 abstract int getInitialNodeCount()

Deprecated. google.container.v1beta1.Cluster.initial_node_count is deprecated. See google/container/v1beta1/cluster_service.proto;l=2027

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 abstract String getInstanceGroupUrls(int index)

Deprecated. google.container.v1beta1.Cluster.instance_group_urls is deprecated. See google/container/v1beta1/cluster_service.proto;l=2308

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 abstract ByteString getInstanceGroupUrlsBytes(int index)

Deprecated. google.container.v1beta1.Cluster.instance_group_urls is deprecated. See google/container/v1beta1/cluster_service.proto;l=2308

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 abstract int getInstanceGroupUrlsCount()

Deprecated. google.container.v1beta1.Cluster.instance_group_urls is deprecated. See google/container/v1beta1/cluster_service.proto;l=2308

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 abstract List<String> getInstanceGroupUrlsList()

Deprecated. google.container.v1beta1.Cluster.instance_group_urls is deprecated. See google/container/v1beta1/cluster_service.proto;l=2308

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
List<String>

A list containing the instanceGroupUrls.

getIpAllocationPolicy()

public abstract IPAllocationPolicy getIpAllocationPolicy()

Configuration for cluster IP allocation.

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

Returns
Type Description
IPAllocationPolicy

The ipAllocationPolicy.

getIpAllocationPolicyOrBuilder()

public abstract IPAllocationPolicyOrBuilder getIpAllocationPolicyOrBuilder()

Configuration for cluster IP allocation.

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

Returns
Type Description
IPAllocationPolicyOrBuilder

getLabelFingerprint()

public abstract String getLabelFingerprint()

The fingerprint of the set of labels for this cluster.

string label_fingerprint = 16;

Returns
Type Description
String

The labelFingerprint.

getLabelFingerprintBytes()

public abstract 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 abstract LegacyAbac getLegacyAbac()

Configuration for the legacy ABAC authorization mode.

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

Returns
Type Description
LegacyAbac

The legacyAbac.

getLegacyAbacOrBuilder()

public abstract LegacyAbacOrBuilder getLegacyAbacOrBuilder()

Configuration for the legacy ABAC authorization mode.

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

Returns
Type Description
LegacyAbacOrBuilder

getLocation()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>

A list containing the locations.

getLoggingConfig()

public abstract LoggingConfig getLoggingConfig()

Logging configuration for the cluster.

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

Returns
Type Description
LoggingConfig

The loggingConfig.

getLoggingConfigOrBuilder()

public abstract LoggingConfigOrBuilder getLoggingConfigOrBuilder()

Logging configuration for the cluster.

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

Returns
Type Description
LoggingConfigOrBuilder

getLoggingService()

public abstract 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 abstract 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 abstract MaintenancePolicy getMaintenancePolicy()

Configure the maintenance policy for this cluster.

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

Returns
Type Description
MaintenancePolicy

The maintenancePolicy.

getMaintenancePolicyOrBuilder()

public abstract MaintenancePolicyOrBuilder getMaintenancePolicyOrBuilder()

Configure the maintenance policy for this cluster.

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

Returns
Type Description
MaintenancePolicyOrBuilder

getMaster()

public abstract Master getMaster()

Configuration for master components.

.google.container.v1beta1.Master master = 124;

Returns
Type Description
Master

The master.

getMasterAuth()

public abstract 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.v1beta1.MasterAuth master_auth = 5;

Returns
Type Description
MasterAuth

The masterAuth.

getMasterAuthOrBuilder()

public abstract 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.v1beta1.MasterAuth master_auth = 5;

Returns
Type Description
MasterAuthOrBuilder

getMasterAuthorizedNetworksConfig()

public abstract MasterAuthorizedNetworksConfig getMasterAuthorizedNetworksConfig()

The configuration options for master authorized networks feature.

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

Returns
Type Description
MasterAuthorizedNetworksConfig

The masterAuthorizedNetworksConfig.

getMasterAuthorizedNetworksConfigOrBuilder()

public abstract MasterAuthorizedNetworksConfigOrBuilder getMasterAuthorizedNetworksConfigOrBuilder()

The configuration options for master authorized networks feature.

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

Returns
Type Description
MasterAuthorizedNetworksConfigOrBuilder

getMasterIpv4CidrBlock() (deprecated)

public abstract String getMasterIpv4CidrBlock()

Deprecated. google.container.v1beta1.Cluster.master_ipv4_cidr_block is deprecated. See google/container/v1beta1/cluster_service.proto;l=2172

The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead.

string master_ipv4_cidr_block = 29 [deprecated = true];

Returns
Type Description
String

The masterIpv4CidrBlock.

getMasterIpv4CidrBlockBytes() (deprecated)

public abstract ByteString getMasterIpv4CidrBlockBytes()

Deprecated. google.container.v1beta1.Cluster.master_ipv4_cidr_block is deprecated. See google/container/v1beta1/cluster_service.proto;l=2172

The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead.

string master_ipv4_cidr_block = 29 [deprecated = true];

Returns
Type Description
ByteString

The bytes for masterIpv4CidrBlock.

getMasterOrBuilder()

public abstract MasterOrBuilder getMasterOrBuilder()

Configuration for master components.

.google.container.v1beta1.Master master = 124;

Returns
Type Description
MasterOrBuilder

getMeshCertificates()

public abstract MeshCertificates getMeshCertificates()

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

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

Returns
Type Description
MeshCertificates

The meshCertificates.

getMeshCertificatesOrBuilder()

public abstract MeshCertificatesOrBuilder getMeshCertificatesOrBuilder()

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

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

Returns
Type Description
MeshCertificatesOrBuilder

getMonitoringConfig()

public abstract MonitoringConfig getMonitoringConfig()

Monitoring configuration for the cluster.

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

Returns
Type Description
MonitoringConfig

The monitoringConfig.

getMonitoringConfigOrBuilder()

public abstract MonitoringConfigOrBuilder getMonitoringConfigOrBuilder()

Monitoring configuration for the cluster.

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

Returns
Type Description
MonitoringConfigOrBuilder

getMonitoringService()

public abstract 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 abstract 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.

getName()

public abstract 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 abstract 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 abstract 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. On output this shows the network ID instead of the name.

string network = 8;

Returns
Type Description
String

The network.

getNetworkBytes()

public abstract 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. On output this shows the network ID instead of the name.

string network = 8;

Returns
Type Description
ByteString

The bytes for network.

getNetworkConfig()

public abstract NetworkConfig getNetworkConfig()

Configuration for cluster networking.

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

Returns
Type Description
NetworkConfig

The networkConfig.

getNetworkConfigOrBuilder()

public abstract NetworkConfigOrBuilder getNetworkConfigOrBuilder()

Configuration for cluster networking.

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

Returns
Type Description
NetworkConfigOrBuilder

getNetworkPolicy()

public abstract NetworkPolicy getNetworkPolicy()

Configuration options for the NetworkPolicy feature.

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

Returns
Type Description
NetworkPolicy

The networkPolicy.

getNetworkPolicyOrBuilder()

public abstract NetworkPolicyOrBuilder getNetworkPolicyOrBuilder()

Configuration options for the NetworkPolicy feature.

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

Returns
Type Description
NetworkPolicyOrBuilder

getNodeConfig() (deprecated)

public abstract NodeConfig getNodeConfig()

Deprecated. google.container.v1beta1.Cluster.node_config is deprecated. See google/container/v1beta1/cluster_service.proto;l=2040

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.v1beta1.NodeConfig node_config = 4 [deprecated = true];

Returns
Type Description
NodeConfig

The nodeConfig.

getNodeConfigOrBuilder() (deprecated)

public abstract 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.v1beta1.NodeConfig node_config = 4 [deprecated = true];

Returns
Type Description
NodeConfigOrBuilder

getNodeIpv4CidrSize()

public abstract 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 abstract NodePoolAutoConfig getNodePoolAutoConfig()

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

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

Returns
Type Description
NodePoolAutoConfig

The nodePoolAutoConfig.

getNodePoolAutoConfigOrBuilder()

public abstract NodePoolAutoConfigOrBuilder getNodePoolAutoConfigOrBuilder()

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

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

Returns
Type Description
NodePoolAutoConfigOrBuilder

getNodePoolDefaults()

public abstract NodePoolDefaults getNodePoolDefaults()

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

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

Returns
Type Description
NodePoolDefaults

The nodePoolDefaults.

getNodePoolDefaultsOrBuilder()

public abstract NodePoolDefaultsOrBuilder getNodePoolDefaultsOrBuilder()

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

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

Returns
Type Description
NodePoolDefaultsOrBuilder

getNodePools(int index)

public abstract 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.v1beta1.NodePool node_pools = 12;

Parameter
Name Description
index int
Returns
Type Description
NodePool

getNodePoolsCount()

public abstract 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.v1beta1.NodePool node_pools = 12;

Returns
Type Description
int

getNodePoolsList()

public abstract 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.v1beta1.NodePool node_pools = 12;

Returns
Type Description
List<NodePool>

getNodePoolsOrBuilder(int index)

public abstract 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.v1beta1.NodePool node_pools = 12;

Parameter
Name Description
index int
Returns
Type Description
NodePoolOrBuilder

getNodePoolsOrBuilderList()

public abstract 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.v1beta1.NodePool node_pools = 12;

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

getNotificationConfig()

public abstract NotificationConfig getNotificationConfig()

Notification configuration of the cluster.

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

Returns
Type Description
NotificationConfig

The notificationConfig.

getNotificationConfigOrBuilder()

public abstract NotificationConfigOrBuilder getNotificationConfigOrBuilder()

Notification configuration of the cluster.

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

Returns
Type Description
NotificationConfigOrBuilder

getPodSecurityPolicyConfig()

public abstract PodSecurityPolicyConfig getPodSecurityPolicyConfig()

Configuration for the PodSecurityPolicy feature.

.google.container.v1beta1.PodSecurityPolicyConfig pod_security_policy_config = 25;

Returns
Type Description
PodSecurityPolicyConfig

The podSecurityPolicyConfig.

getPodSecurityPolicyConfigOrBuilder()

public abstract PodSecurityPolicyConfigOrBuilder getPodSecurityPolicyConfigOrBuilder()

Configuration for the PodSecurityPolicy feature.

.google.container.v1beta1.PodSecurityPolicyConfig pod_security_policy_config = 25;

Returns
Type Description
PodSecurityPolicyConfigOrBuilder

getPrivateCluster() (deprecated)

public abstract boolean getPrivateCluster()

Deprecated. google.container.v1beta1.Cluster.private_cluster is deprecated. See google/container/v1beta1/cluster_service.proto;l=2165

If this is a private cluster setup. Private clusters are clusters that, by default have no external IP addresses on the nodes and where nodes and the master communicate over private IP addresses. This field is deprecated, use private_cluster_config.enable_private_nodes instead.

bool private_cluster = 28 [deprecated = true];

Returns
Type Description
boolean

The privateCluster.

getPrivateClusterConfig()

public abstract PrivateClusterConfig getPrivateClusterConfig()

Configuration for private cluster.

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

Returns
Type Description
PrivateClusterConfig

The privateClusterConfig.

getPrivateClusterConfigOrBuilder()

public abstract PrivateClusterConfigOrBuilder getPrivateClusterConfigOrBuilder()

Configuration for private cluster.

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

Returns
Type Description
PrivateClusterConfigOrBuilder

getProtectConfig() (deprecated)

public abstract ProtectConfig getProtectConfig()

Deprecated. google.container.v1beta1.Cluster.protect_config is deprecated. See google/container/v1beta1/cluster_service.proto;l=2367

Deprecated: Use SecurityPostureConfig instead. Enable/Disable Protect API features for the cluster.

optional .google.container.v1beta1.ProtectConfig protect_config = 137 [deprecated = true];

Returns
Type Description
ProtectConfig

The protectConfig.

getProtectConfigOrBuilder() (deprecated)

public abstract ProtectConfigOrBuilder getProtectConfigOrBuilder()

Deprecated: Use SecurityPostureConfig instead. Enable/Disable Protect API features for the cluster.

optional .google.container.v1beta1.ProtectConfig protect_config = 137 [deprecated = true];

Returns
Type Description
ProtectConfigOrBuilder

getReleaseChannel()

public abstract 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.v1beta1.ReleaseChannel release_channel = 41;

Returns
Type Description
ReleaseChannel

The releaseChannel.

getReleaseChannelOrBuilder()

public abstract 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.v1beta1.ReleaseChannel release_channel = 41;

Returns
Type Description
ReleaseChannelOrBuilder

getResourceLabels() (deprecated)

public abstract Map<String,String> getResourceLabels()

Use #getResourceLabelsMap() instead.

Returns
Type Description
Map<String,String>

getResourceLabelsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract ResourceUsageExportConfig getResourceUsageExportConfig()

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

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

Returns
Type Description
ResourceUsageExportConfig

The resourceUsageExportConfig.

getResourceUsageExportConfigOrBuilder()

public abstract ResourceUsageExportConfigOrBuilder getResourceUsageExportConfigOrBuilder()

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

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

Returns
Type Description
ResourceUsageExportConfigOrBuilder

getSatisfiesPzi()

public abstract 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 abstract 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.

getSecretManagerConfig()

public abstract SecretManagerConfig getSecretManagerConfig()

Secret CSI driver configuration.

.google.container.v1beta1.SecretManagerConfig secret_manager_config = 150;

Returns
Type Description
SecretManagerConfig

The secretManagerConfig.

getSecretManagerConfigOrBuilder()

public abstract SecretManagerConfigOrBuilder getSecretManagerConfigOrBuilder()

Secret CSI driver configuration.

.google.container.v1beta1.SecretManagerConfig secret_manager_config = 150;

Returns
Type Description
SecretManagerConfigOrBuilder

getSecurityPostureConfig()

public abstract SecurityPostureConfig getSecurityPostureConfig()

Enable/Disable Security Posture API features for the cluster.

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

Returns
Type Description
SecurityPostureConfig

The securityPostureConfig.

getSecurityPostureConfigOrBuilder()

public abstract SecurityPostureConfigOrBuilder getSecurityPostureConfigOrBuilder()

Enable/Disable Security Posture API features for the cluster.

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

Returns
Type Description
SecurityPostureConfigOrBuilder

getSelfLink()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract ShieldedNodes getShieldedNodes()

Shielded Nodes configuration.

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

Returns
Type Description
ShieldedNodes

The shieldedNodes.

getShieldedNodesOrBuilder()

public abstract ShieldedNodesOrBuilder getShieldedNodesOrBuilder()

Shielded Nodes configuration.

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

Returns
Type Description
ShieldedNodesOrBuilder

getStatus()

public abstract Cluster.Status getStatus()

Output only. The current status of this cluster.

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

Returns
Type Description
Cluster.Status

The status.

getStatusMessage() (deprecated)

public abstract String getStatusMessage()

Deprecated. google.container.v1beta1.Cluster.status_message is deprecated. See google/container/v1beta1/cluster_service.proto;l=2291

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 abstract ByteString getStatusMessageBytes()

Deprecated. google.container.v1beta1.Cluster.status_message is deprecated. See google/container/v1beta1/cluster_service.proto;l=2291

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 abstract int getStatusValue()

Output only. The current status of this cluster.

.google.container.v1beta1.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 abstract String getSubnetwork()

The name of the Google Compute Engine subnetwork to which the cluster is connected. On output this shows the subnetwork ID instead of the name.

string subnetwork = 11;

Returns
Type Description
String

The subnetwork.

getSubnetworkBytes()

public abstract ByteString getSubnetworkBytes()

The name of the Google Compute Engine subnetwork to which the cluster is connected. On output this shows the subnetwork ID instead of the name.

string subnetwork = 11;

Returns
Type Description
ByteString

The bytes for subnetwork.

getTpuConfig()

public abstract TpuConfig getTpuConfig()

Configuration for Cloud TPU support;

.google.container.v1beta1.TpuConfig tpu_config = 47;

Returns
Type Description
TpuConfig

The tpuConfig.

getTpuConfigOrBuilder()

public abstract TpuConfigOrBuilder getTpuConfigOrBuilder()

Configuration for Cloud TPU support;

.google.container.v1beta1.TpuConfig tpu_config = 47;

Returns
Type Description
TpuConfigOrBuilder

getTpuIpv4CidrBlock()

public abstract 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 abstract 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 abstract VerticalPodAutoscaling getVerticalPodAutoscaling()

Cluster-level Vertical Pod Autoscaling configuration.

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

Returns
Type Description
VerticalPodAutoscaling

The verticalPodAutoscaling.

getVerticalPodAutoscalingOrBuilder()

public abstract VerticalPodAutoscalingOrBuilder getVerticalPodAutoscalingOrBuilder()

Cluster-level Vertical Pod Autoscaling configuration.

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

Returns
Type Description
VerticalPodAutoscalingOrBuilder

getWorkloadAltsConfig()

public abstract WorkloadALTSConfig getWorkloadAltsConfig()

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

.google.container.v1beta1.WorkloadALTSConfig workload_alts_config = 53;

Returns
Type Description
WorkloadALTSConfig

The workloadAltsConfig.

getWorkloadAltsConfigOrBuilder()

public abstract WorkloadALTSConfigOrBuilder getWorkloadAltsConfigOrBuilder()

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

.google.container.v1beta1.WorkloadALTSConfig workload_alts_config = 53;

Returns
Type Description
WorkloadALTSConfigOrBuilder

getWorkloadCertificates()

public abstract WorkloadCertificates getWorkloadCertificates()

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

.google.container.v1beta1.WorkloadCertificates workload_certificates = 52;

Returns
Type Description
WorkloadCertificates

The workloadCertificates.

getWorkloadCertificatesOrBuilder()

public abstract WorkloadCertificatesOrBuilder getWorkloadCertificatesOrBuilder()

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

.google.container.v1beta1.WorkloadCertificates workload_certificates = 52;

Returns
Type Description
WorkloadCertificatesOrBuilder

getWorkloadIdentityConfig()

public abstract WorkloadIdentityConfig getWorkloadIdentityConfig()

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

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

Returns
Type Description
WorkloadIdentityConfig

The workloadIdentityConfig.

getWorkloadIdentityConfigOrBuilder()

public abstract WorkloadIdentityConfigOrBuilder getWorkloadIdentityConfigOrBuilder()

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

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

Returns
Type Description
WorkloadIdentityConfigOrBuilder

getZone() (deprecated)

public abstract String getZone()

Deprecated. google.container.v1beta1.Cluster.zone is deprecated. See google/container/v1beta1/cluster_service.proto;l=2243

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 abstract ByteString getZoneBytes()

Deprecated. google.container.v1beta1.Cluster.zone is deprecated. See google/container/v1beta1/cluster_service.proto;l=2243

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 abstract boolean hasAddonsConfig()

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

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

Returns
Type Description
boolean

Whether the addonsConfig field is set.

hasAuthenticatorGroupsConfig()

public abstract boolean hasAuthenticatorGroupsConfig()

Configuration controlling RBAC group membership information.

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

Returns
Type Description
boolean

Whether the authenticatorGroupsConfig field is set.

hasAutopilot()

public abstract boolean hasAutopilot()

Autopilot configuration for the cluster.

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

Returns
Type Description
boolean

Whether the autopilot field is set.

hasAutoscaling()

public abstract boolean hasAutoscaling()

Cluster-level autoscaling configuration.

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

Returns
Type Description
boolean

Whether the autoscaling field is set.

hasBinaryAuthorization()

public abstract boolean hasBinaryAuthorization()

Configuration for Binary Authorization.

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

Returns
Type Description
boolean

Whether the binaryAuthorization field is set.

hasClusterTelemetry()

public abstract boolean hasClusterTelemetry()

Telemetry integration for the cluster.

.google.container.v1beta1.ClusterTelemetry cluster_telemetry = 46;

Returns
Type Description
boolean

Whether the clusterTelemetry field is set.

hasCompliancePostureConfig()

public abstract boolean hasCompliancePostureConfig()

Enable/Disable Compliance Posture features for the cluster.

.google.container.v1beta1.CompliancePostureConfig compliance_posture_config = 151;

Returns
Type Description
boolean

Whether the compliancePostureConfig field is set.

hasConfidentialNodes()

public abstract boolean hasConfidentialNodes()

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

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

Returns
Type Description
boolean

Whether the confidentialNodes field is set.

hasCostManagementConfig()

public abstract boolean hasCostManagementConfig()

Configuration for the fine-grained cost management feature.

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

Returns
Type Description
boolean

Whether the costManagementConfig field is set.

hasDatabaseEncryption()

public abstract boolean hasDatabaseEncryption()

Configuration of etcd encryption.

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

Returns
Type Description
boolean

Whether the databaseEncryption field is set.

hasDefaultMaxPodsConstraint()

public abstract 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.v1beta1.MaxPodsConstraint default_max_pods_constraint = 30;

Returns
Type Description
boolean

Whether the defaultMaxPodsConstraint field is set.

hasEnableK8SBetaApis()

public abstract boolean hasEnableK8SBetaApis()

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

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

Returns
Type Description
boolean

Whether the enableK8sBetaApis field is set.

hasEnterpriseConfig()

public abstract boolean hasEnterpriseConfig()

GKE Enterprise Configuration.

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

Returns
Type Description
boolean

Whether the enterpriseConfig field is set.

hasFleet()

public abstract boolean hasFleet()

Fleet information for the cluster.

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

Returns
Type Description
boolean

Whether the fleet field is set.

hasIdentityServiceConfig()

public abstract boolean hasIdentityServiceConfig()

Configuration for Identity Service component.

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

Returns
Type Description
boolean

Whether the identityServiceConfig field is set.

hasIpAllocationPolicy()

public abstract boolean hasIpAllocationPolicy()

Configuration for cluster IP allocation.

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

Returns
Type Description
boolean

Whether the ipAllocationPolicy field is set.

hasLegacyAbac()

public abstract boolean hasLegacyAbac()

Configuration for the legacy ABAC authorization mode.

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

Returns
Type Description
boolean

Whether the legacyAbac field is set.

hasLoggingConfig()

public abstract boolean hasLoggingConfig()

Logging configuration for the cluster.

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

Returns
Type Description
boolean

Whether the loggingConfig field is set.

hasMaintenancePolicy()

public abstract boolean hasMaintenancePolicy()

Configure the maintenance policy for this cluster.

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

Returns
Type Description
boolean

Whether the maintenancePolicy field is set.

hasMaster()

public abstract boolean hasMaster()

Configuration for master components.

.google.container.v1beta1.Master master = 124;

Returns
Type Description
boolean

Whether the master field is set.

hasMasterAuth()

public abstract 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.v1beta1.MasterAuth master_auth = 5;

Returns
Type Description
boolean

Whether the masterAuth field is set.

hasMasterAuthorizedNetworksConfig()

public abstract boolean hasMasterAuthorizedNetworksConfig()

The configuration options for master authorized networks feature.

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

Returns
Type Description
boolean

Whether the masterAuthorizedNetworksConfig field is set.

hasMeshCertificates()

public abstract boolean hasMeshCertificates()

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

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

Returns
Type Description
boolean

Whether the meshCertificates field is set.

hasMonitoringConfig()

public abstract boolean hasMonitoringConfig()

Monitoring configuration for the cluster.

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

Returns
Type Description
boolean

Whether the monitoringConfig field is set.

hasNetworkConfig()

public abstract boolean hasNetworkConfig()

Configuration for cluster networking.

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

Returns
Type Description
boolean

Whether the networkConfig field is set.

hasNetworkPolicy()

public abstract boolean hasNetworkPolicy()

Configuration options for the NetworkPolicy feature.

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

Returns
Type Description
boolean

Whether the networkPolicy field is set.

hasNodeConfig() (deprecated)

public abstract boolean hasNodeConfig()

Deprecated. google.container.v1beta1.Cluster.node_config is deprecated. See google/container/v1beta1/cluster_service.proto;l=2040

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.v1beta1.NodeConfig node_config = 4 [deprecated = true];

Returns
Type Description
boolean

Whether the nodeConfig field is set.

hasNodePoolAutoConfig()

public abstract boolean hasNodePoolAutoConfig()

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

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

Returns
Type Description
boolean

Whether the nodePoolAutoConfig field is set.

hasNodePoolDefaults()

public abstract boolean hasNodePoolDefaults()

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

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

Returns
Type Description
boolean

Whether the nodePoolDefaults field is set.

hasNotificationConfig()

public abstract boolean hasNotificationConfig()

Notification configuration of the cluster.

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

Returns
Type Description
boolean

Whether the notificationConfig field is set.

hasPodSecurityPolicyConfig()

public abstract boolean hasPodSecurityPolicyConfig()

Configuration for the PodSecurityPolicy feature.

.google.container.v1beta1.PodSecurityPolicyConfig pod_security_policy_config = 25;

Returns
Type Description
boolean

Whether the podSecurityPolicyConfig field is set.

hasPrivateClusterConfig()

public abstract boolean hasPrivateClusterConfig()

Configuration for private cluster.

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

Returns
Type Description
boolean

Whether the privateClusterConfig field is set.

hasProtectConfig() (deprecated)

public abstract boolean hasProtectConfig()

Deprecated. google.container.v1beta1.Cluster.protect_config is deprecated. See google/container/v1beta1/cluster_service.proto;l=2367

Deprecated: Use SecurityPostureConfig instead. Enable/Disable Protect API features for the cluster.

optional .google.container.v1beta1.ProtectConfig protect_config = 137 [deprecated = true];

Returns
Type Description
boolean

Whether the protectConfig field is set.

hasReleaseChannel()

public abstract 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.v1beta1.ReleaseChannel release_channel = 41;

Returns
Type Description
boolean

Whether the releaseChannel field is set.

hasResourceUsageExportConfig()

public abstract boolean hasResourceUsageExportConfig()

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

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

Returns
Type Description
boolean

Whether the resourceUsageExportConfig field is set.

hasSatisfiesPzi()

public abstract 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 abstract 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.

hasSecretManagerConfig()

public abstract boolean hasSecretManagerConfig()

Secret CSI driver configuration.

.google.container.v1beta1.SecretManagerConfig secret_manager_config = 150;

Returns
Type Description
boolean

Whether the secretManagerConfig field is set.

hasSecurityPostureConfig()

public abstract boolean hasSecurityPostureConfig()

Enable/Disable Security Posture API features for the cluster.

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

Returns
Type Description
boolean

Whether the securityPostureConfig field is set.

hasShieldedNodes()

public abstract boolean hasShieldedNodes()

Shielded Nodes configuration.

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

Returns
Type Description
boolean

Whether the shieldedNodes field is set.

hasTpuConfig()

public abstract boolean hasTpuConfig()

Configuration for Cloud TPU support;

.google.container.v1beta1.TpuConfig tpu_config = 47;

Returns
Type Description
boolean

Whether the tpuConfig field is set.

hasVerticalPodAutoscaling()

public abstract boolean hasVerticalPodAutoscaling()

Cluster-level Vertical Pod Autoscaling configuration.

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

Returns
Type Description
boolean

Whether the verticalPodAutoscaling field is set.

hasWorkloadAltsConfig()

public abstract boolean hasWorkloadAltsConfig()

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

.google.container.v1beta1.WorkloadALTSConfig workload_alts_config = 53;

Returns
Type Description
boolean

Whether the workloadAltsConfig field is set.

hasWorkloadCertificates()

public abstract boolean hasWorkloadCertificates()

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

.google.container.v1beta1.WorkloadCertificates workload_certificates = 52;

Returns
Type Description
boolean

Whether the workloadCertificates field is set.

hasWorkloadIdentityConfig()

public abstract boolean hasWorkloadIdentityConfig()

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

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

Returns
Type Description
boolean

Whether the workloadIdentityConfig field is set.