Interface ClusterOrBuilder (2.8.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.v1.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.v1.AddonsConfig addons_config = 10;

Returns

Type	Description
AddonsConfigOrBuilder

getAuthenticatorGroupsConfig()

public abstract AuthenticatorGroupsConfig getAuthenticatorGroupsConfig()

Configuration controlling RBAC group membership information.

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

Returns

Type	Description
AuthenticatorGroupsConfig	The authenticatorGroupsConfig.

getAuthenticatorGroupsConfigOrBuilder()

public abstract AuthenticatorGroupsConfigOrBuilder getAuthenticatorGroupsConfigOrBuilder()

Configuration controlling RBAC group membership information.

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

Returns

Type	Description
AuthenticatorGroupsConfigOrBuilder

getAutopilot()

public abstract Autopilot getAutopilot()

Autopilot configuration for the cluster.

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

Returns

Type	Description
Autopilot	The autopilot.

getAutopilotOrBuilder()

public abstract AutopilotOrBuilder getAutopilotOrBuilder()

Autopilot configuration for the cluster.

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

Returns

Type	Description
AutopilotOrBuilder

getAutoscaling()

public abstract ClusterAutoscaling getAutoscaling()

Cluster-level autoscaling configuration.

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

Returns

Type	Description
ClusterAutoscaling	The autoscaling.

getAutoscalingOrBuilder()

public abstract ClusterAutoscalingOrBuilder getAutoscalingOrBuilder()

Cluster-level autoscaling configuration.

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

Returns

Type	Description
ClusterAutoscalingOrBuilder

getBinaryAuthorization()

public abstract BinaryAuthorization getBinaryAuthorization()

Configuration for Binary Authorization.

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

Returns

Type	Description
BinaryAuthorization	The binaryAuthorization.

getBinaryAuthorizationOrBuilder()

public abstract BinaryAuthorizationOrBuilder getBinaryAuthorizationOrBuilder()

Configuration for Binary Authorization.

.google.container.v1.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.

getConditions(int index)

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

getConditionsCount()

public abstract int getConditionsCount()

Which conditions caused the current cluster state.

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

Returns

Type	Description
int

getConditionsList()

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

getConfidentialNodesOrBuilder()

public abstract 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 abstract CostManagementConfig getCostManagementConfig()

Configuration for the fine-grained cost management feature.

.google.container.v1.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.v1.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;

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;

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;

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;

Returns

Type	Description
ByteString	The bytes for currentMasterVersion.

getCurrentNodeCount() (deprecated)

public abstract int getCurrentNodeCount()

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

[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];

Returns

Type	Description
int	The currentNodeCount.

getCurrentNodeVersion() (deprecated)

public abstract String getCurrentNodeVersion()

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

[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];

Returns

Type	Description
String	The currentNodeVersion.

getCurrentNodeVersionBytes() (deprecated)

public abstract ByteString getCurrentNodeVersionBytes()

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

string current_node_version = 105 [deprecated = true];

Returns

Type	Description
ByteString	The bytes for currentNodeVersion.

getDatabaseEncryption()

public abstract DatabaseEncryption getDatabaseEncryption()

Configuration of etcd encryption.

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

Returns

Type	Description
DatabaseEncryption	The databaseEncryption.

getDatabaseEncryptionOrBuilder()

public abstract DatabaseEncryptionOrBuilder getDatabaseEncryptionOrBuilder()

Configuration of etcd encryption.

.google.container.v1.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.v1.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.v1.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.

getEnableKubernetesAlpha()

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

Enable the ability to use Cloud TPUs in this cluster.

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;

Returns

Type	Description
String	The endpoint.

getEndpointBytes()

public abstract ByteString getEndpointBytes()

string endpoint = 102;

Returns

Type	Description
ByteString	The bytes for endpoint.

getExpireTime()

public abstract String getExpireTime()

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

string expire_time = 113;

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;

Returns

Type	Description
ByteString	The bytes for expireTime.

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.v1.IdentityServiceConfig identity_service_config = 54;

Returns

Type	Description
IdentityServiceConfig	The identityServiceConfig.

getIdentityServiceConfigOrBuilder()

public abstract IdentityServiceConfigOrBuilder getIdentityServiceConfigOrBuilder()

Configuration for Identity Service component.

.google.container.v1.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()

"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.v1.Cluster.initial_node_count is deprecated. See google/container/v1/cluster_service.proto;l=1423

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.v1.Cluster.instance_group_urls is deprecated. See google/container/v1/cluster_service.proto;l=1663

Deprecated. Use node_pools.instance_group_urls.

repeated string instance_group_urls = 111 [deprecated = true];

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.v1.Cluster.instance_group_urls is deprecated. See google/container/v1/cluster_service.proto;l=1663

Deprecated. Use node_pools.instance_group_urls.

repeated string instance_group_urls = 111 [deprecated = true];

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.v1.Cluster.instance_group_urls is deprecated. See google/container/v1/cluster_service.proto;l=1663

Deprecated. Use node_pools.instance_group_urls.

repeated string instance_group_urls = 111 [deprecated = true];

Returns

Type	Description
int	The count of instanceGroupUrls.

getInstanceGroupUrlsList() (deprecated)

public abstract List<String> getInstanceGroupUrlsList()

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

Deprecated. Use node_pools.instance_group_urls.

repeated string instance_group_urls = 111 [deprecated = true];

Returns

Type	Description
List<String>	A list containing the instanceGroupUrls.

getIpAllocationPolicy()

public abstract IPAllocationPolicy getIpAllocationPolicy()

Configuration for cluster IP allocation.

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

Returns

Type	Description
IPAllocationPolicy	The ipAllocationPolicy.

getIpAllocationPolicyOrBuilder()

public abstract IPAllocationPolicyOrBuilder getIpAllocationPolicyOrBuilder()

Configuration for cluster IP allocation.

.google.container.v1.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.v1.LegacyAbac legacy_abac = 18;

Returns

Type	Description
LegacyAbac	The legacyAbac.

getLegacyAbacOrBuilder()

public abstract LegacyAbacOrBuilder getLegacyAbacOrBuilder()

Configuration for the legacy ABAC authorization mode.

.google.container.v1.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;

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;

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)

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()

repeated string locations = 13;

Returns

Type	Description
int	The count of locations.

getLocationsList()

public abstract List<String> getLocationsList()

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.v1.LoggingConfig logging_config = 132;

Returns

Type	Description
LoggingConfig	The loggingConfig.

getLoggingConfigOrBuilder()

public abstract LoggingConfigOrBuilder getLoggingConfigOrBuilder()

Logging configuration for the cluster.

.google.container.v1.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.v1.MaintenancePolicy maintenance_policy = 23;

Returns

Type	Description
MaintenancePolicy	The maintenancePolicy.