Class Cluster (2.49.0) 

public final class Cluster extends GeneratedMessageV3 implements ClusterOrBuilder

A Google Kubernetes Engine cluster.

Protobuf type google.container.v1.Cluster

Inheritance

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

Implements

ClusterOrBuilder

Static Fields

ADDONS_CONFIG_FIELD_NUMBER

public static final int ADDONS_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

AUTHENTICATOR_GROUPS_CONFIG_FIELD_NUMBER

public static final int AUTHENTICATOR_GROUPS_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

AUTOPILOT_FIELD_NUMBER

public static final int AUTOPILOT_FIELD_NUMBER
Field Value
Type Description
int

AUTOSCALING_FIELD_NUMBER

public static final int AUTOSCALING_FIELD_NUMBER
Field Value
Type Description
int

BINARY_AUTHORIZATION_FIELD_NUMBER

public static final int BINARY_AUTHORIZATION_FIELD_NUMBER
Field Value
Type Description
int

CLUSTER_IPV4_CIDR_FIELD_NUMBER

public static final int CLUSTER_IPV4_CIDR_FIELD_NUMBER
Field Value
Type Description
int

CONDITIONS_FIELD_NUMBER

public static final int CONDITIONS_FIELD_NUMBER
Field Value
Type Description
int

CONFIDENTIAL_NODES_FIELD_NUMBER

public static final int CONFIDENTIAL_NODES_FIELD_NUMBER
Field Value
Type Description
int

COST_MANAGEMENT_CONFIG_FIELD_NUMBER

public static final int COST_MANAGEMENT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

CURRENT_MASTER_VERSION_FIELD_NUMBER

public static final int CURRENT_MASTER_VERSION_FIELD_NUMBER
Field Value
Type Description
int

CURRENT_NODE_COUNT_FIELD_NUMBER

public static final int CURRENT_NODE_COUNT_FIELD_NUMBER
Field Value
Type Description
int

CURRENT_NODE_VERSION_FIELD_NUMBER

public static final int CURRENT_NODE_VERSION_FIELD_NUMBER
Field Value
Type Description
int

DATABASE_ENCRYPTION_FIELD_NUMBER

public static final int DATABASE_ENCRYPTION_FIELD_NUMBER
Field Value
Type Description
int

DEFAULT_MAX_PODS_CONSTRAINT_FIELD_NUMBER

public static final int DEFAULT_MAX_PODS_CONSTRAINT_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_K8S_BETA_APIS_FIELD_NUMBER

public static final int ENABLE_K8S_BETA_APIS_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_KUBERNETES_ALPHA_FIELD_NUMBER

public static final int ENABLE_KUBERNETES_ALPHA_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_TPU_FIELD_NUMBER

public static final int ENABLE_TPU_FIELD_NUMBER
Field Value
Type Description
int

ENDPOINT_FIELD_NUMBER

public static final int ENDPOINT_FIELD_NUMBER
Field Value
Type Description
int

ENTERPRISE_CONFIG_FIELD_NUMBER

public static final int ENTERPRISE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

EXPIRE_TIME_FIELD_NUMBER

public static final int EXPIRE_TIME_FIELD_NUMBER
Field Value
Type Description
int

FLEET_FIELD_NUMBER

public static final int FLEET_FIELD_NUMBER
Field Value
Type Description
int

IDENTITY_SERVICE_CONFIG_FIELD_NUMBER

public static final int IDENTITY_SERVICE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

INITIAL_CLUSTER_VERSION_FIELD_NUMBER

public static final int INITIAL_CLUSTER_VERSION_FIELD_NUMBER
Field Value
Type Description
int

INITIAL_NODE_COUNT_FIELD_NUMBER

public static final int INITIAL_NODE_COUNT_FIELD_NUMBER
Field Value
Type Description
int

INSTANCE_GROUP_URLS_FIELD_NUMBER

public static final int INSTANCE_GROUP_URLS_FIELD_NUMBER
Field Value
Type Description
int

IP_ALLOCATION_POLICY_FIELD_NUMBER

public static final int IP_ALLOCATION_POLICY_FIELD_NUMBER
Field Value
Type Description
int

LABEL_FINGERPRINT_FIELD_NUMBER

public static final int LABEL_FINGERPRINT_FIELD_NUMBER
Field Value
Type Description
int

LEGACY_ABAC_FIELD_NUMBER

public static final int LEGACY_ABAC_FIELD_NUMBER
Field Value
Type Description
int

LOCATIONS_FIELD_NUMBER

public static final int LOCATIONS_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_FIELD_NUMBER

public static final int LOCATION_FIELD_NUMBER
Field Value
Type Description
int

LOGGING_CONFIG_FIELD_NUMBER

public static final int LOGGING_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

LOGGING_SERVICE_FIELD_NUMBER

public static final int LOGGING_SERVICE_FIELD_NUMBER
Field Value
Type Description
int

MAINTENANCE_POLICY_FIELD_NUMBER

public static final int MAINTENANCE_POLICY_FIELD_NUMBER
Field Value
Type Description
int

MASTER_AUTHORIZED_NETWORKS_CONFIG_FIELD_NUMBER

public static final int MASTER_AUTHORIZED_NETWORKS_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

MASTER_AUTH_FIELD_NUMBER

public static final int MASTER_AUTH_FIELD_NUMBER
Field Value
Type Description
int

MESH_CERTIFICATES_FIELD_NUMBER

public static final int MESH_CERTIFICATES_FIELD_NUMBER
Field Value
Type Description
int

MONITORING_CONFIG_FIELD_NUMBER

public static final int MONITORING_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

MONITORING_SERVICE_FIELD_NUMBER

public static final int MONITORING_SERVICE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

NETWORK_CONFIG_FIELD_NUMBER

public static final int NETWORK_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

NETWORK_FIELD_NUMBER

public static final int NETWORK_FIELD_NUMBER
Field Value
Type Description
int

NETWORK_POLICY_FIELD_NUMBER

public static final int NETWORK_POLICY_FIELD_NUMBER
Field Value
Type Description
int

NODE_CONFIG_FIELD_NUMBER

public static final int NODE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

NODE_IPV4_CIDR_SIZE_FIELD_NUMBER

public static final int NODE_IPV4_CIDR_SIZE_FIELD_NUMBER
Field Value
Type Description
int

NODE_POOLS_FIELD_NUMBER

public static final int NODE_POOLS_FIELD_NUMBER
Field Value
Type Description
int

NODE_POOL_AUTO_CONFIG_FIELD_NUMBER

public static final int NODE_POOL_AUTO_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

NODE_POOL_DEFAULTS_FIELD_NUMBER

public static final int NODE_POOL_DEFAULTS_FIELD_NUMBER
Field Value
Type Description
int

NOTIFICATION_CONFIG_FIELD_NUMBER

public static final int NOTIFICATION_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

PRIVATE_CLUSTER_CONFIG_FIELD_NUMBER

public static final int PRIVATE_CLUSTER_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

RELEASE_CHANNEL_FIELD_NUMBER

public static final int RELEASE_CHANNEL_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_LABELS_FIELD_NUMBER

public static final int RESOURCE_LABELS_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_USAGE_EXPORT_CONFIG_FIELD_NUMBER

public static final int RESOURCE_USAGE_EXPORT_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZI_FIELD_NUMBER

public static final int SATISFIES_PZI_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZS_FIELD_NUMBER

public static final int SATISFIES_PZS_FIELD_NUMBER
Field Value
Type Description
int

SECURITY_POSTURE_CONFIG_FIELD_NUMBER

public static final int SECURITY_POSTURE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int 
public static final int SELF_LINK_FIELD_NUMBER
Field Value
Type Description
int

SERVICES_IPV4_CIDR_FIELD_NUMBER

public static final int SERVICES_IPV4_CIDR_FIELD_NUMBER
Field Value
Type Description
int

SHIELDED_NODES_FIELD_NUMBER

public static final int SHIELDED_NODES_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

STATUS_MESSAGE_FIELD_NUMBER

public static final int STATUS_MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

SUBNETWORK_FIELD_NUMBER

public static final int SUBNETWORK_FIELD_NUMBER
Field Value
Type Description
int

TPU_IPV4_CIDR_BLOCK_FIELD_NUMBER

public static final int TPU_IPV4_CIDR_BLOCK_FIELD_NUMBER
Field Value
Type Description
int

VERTICAL_POD_AUTOSCALING_FIELD_NUMBER

public static final int VERTICAL_POD_AUTOSCALING_FIELD_NUMBER
Field Value
Type Description
int

WORKLOAD_IDENTITY_CONFIG_FIELD_NUMBER

public static final int WORKLOAD_IDENTITY_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

ZONE_FIELD_NUMBER

public static final int ZONE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Cluster getDefaultInstance()
Returns
Type Description
Cluster

getDescriptor()

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

newBuilder()

public static Cluster.Builder newBuilder()
Returns
Type Description
Cluster.Builder

newBuilder(Cluster prototype)

public static Cluster.Builder newBuilder(Cluster prototype)
Parameter
Name Description
prototype Cluster
Returns
Type Description
Cluster.Builder

parseDelimitedFrom(InputStream input)

public static Cluster parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Cluster
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Cluster parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cluster
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Cluster parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Cluster
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Cluster parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cluster
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Cluster parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Cluster
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Cluster parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cluster
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Cluster parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Cluster
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Cluster parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cluster
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Cluster parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Cluster
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Cluster parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cluster
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Cluster parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Cluster
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Cluster parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Cluster
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Cluster> parser()
Returns
Type Description
Parser<Cluster>

Methods

containsResourceLabels(String key)

public boolean containsResourceLabels(String key)

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

map<string, string> resource_labels = 15;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAddonsConfig()

public AddonsConfig getAddonsConfig()

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

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

Returns
Type Description
AddonsConfig

The addonsConfig.

getAddonsConfigOrBuilder()

public AddonsConfigOrBuilder getAddonsConfigOrBuilder()

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

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

Returns
Type Description
AddonsConfigOrBuilder

getAuthenticatorGroupsConfig()

public AuthenticatorGroupsConfig getAuthenticatorGroupsConfig()

Configuration controlling RBAC group membership information.

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

Returns
Type Description
AuthenticatorGroupsConfig

The authenticatorGroupsConfig.

getAuthenticatorGroupsConfigOrBuilder()

public AuthenticatorGroupsConfigOrBuilder getAuthenticatorGroupsConfigOrBuilder()

Configuration controlling RBAC group membership information.

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

Returns
Type Description
AuthenticatorGroupsConfigOrBuilder

getAutopilot()

public Autopilot getAutopilot()

Autopilot configuration for the cluster.

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

Returns
Type Description
Autopilot

The autopilot.

getAutopilotOrBuilder()

public AutopilotOrBuilder getAutopilotOrBuilder()

Autopilot configuration for the cluster.

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

Returns
Type Description
AutopilotOrBuilder

getAutoscaling()

public ClusterAutoscaling getAutoscaling()

Cluster-level autoscaling configuration.

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

Returns
Type Description
ClusterAutoscaling

The autoscaling.

getAutoscalingOrBuilder()

public ClusterAutoscalingOrBuilder getAutoscalingOrBuilder()

Cluster-level autoscaling configuration.

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

Returns
Type Description
ClusterAutoscalingOrBuilder

getBinaryAuthorization()

public BinaryAuthorization getBinaryAuthorization()

Configuration for Binary Authorization.

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

Returns
Type Description
BinaryAuthorization

The binaryAuthorization.

getBinaryAuthorizationOrBuilder()

public BinaryAuthorizationOrBuilder getBinaryAuthorizationOrBuilder()

Configuration for Binary Authorization.

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

Returns
Type Description
BinaryAuthorizationOrBuilder

getClusterIpv4Cidr()

public String getClusterIpv4Cidr()

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

string cluster_ipv4_cidr = 9;

Returns
Type Description
String

The clusterIpv4Cidr.

getClusterIpv4CidrBytes()

public ByteString getClusterIpv4CidrBytes()

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

string cluster_ipv4_cidr = 9;

Returns
Type Description
ByteString

The bytes for clusterIpv4Cidr.

getConditions(int index)

public StatusCondition getConditions(int index)

Which conditions caused the current cluster state.

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

Parameter
Name Description
index int
Returns
Type Description
StatusCondition

getConditionsCount()

public int getConditionsCount()

Which conditions caused the current cluster state.

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

Returns
Type Description
int

getConditionsList()

public List<StatusCondition> getConditionsList()

Which conditions caused the current cluster state.

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

Returns
Type Description
List<StatusCondition>

getConditionsOrBuilder(int index)

public StatusConditionOrBuilder getConditionsOrBuilder(int index)

Which conditions caused the current cluster state.

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

Parameter
Name Description
index int
Returns
Type Description
StatusConditionOrBuilder

getConditionsOrBuilderList()

public List<? extends StatusConditionOrBuilder> getConditionsOrBuilderList()

Which conditions caused the current cluster state.

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

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

getConfidentialNodes()

public ConfidentialNodes getConfidentialNodes()

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

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

Returns
Type Description
ConfidentialNodes

The confidentialNodes.

getConfidentialNodesOrBuilder()

public ConfidentialNodesOrBuilder getConfidentialNodesOrBuilder()

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

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

Returns
Type Description
ConfidentialNodesOrBuilder

getCostManagementConfig()

public CostManagementConfig getCostManagementConfig()

Configuration for the fine-grained cost management feature.

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

Returns
Type Description
CostManagementConfig

The costManagementConfig.

getCostManagementConfigOrBuilder()

public CostManagementConfigOrBuilder getCostManagementConfigOrBuilder()

Configuration for the fine-grained cost management feature.

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

Returns
Type Description
CostManagementConfigOrBuilder

getCreateTime()

public String getCreateTime()

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

string create_time = 106;

Returns
Type Description
String

The createTime.

getCreateTimeBytes()

public ByteString getCreateTimeBytes()

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

string create_time = 106;

Returns
Type Description
ByteString

The bytes for createTime.

getCurrentMasterVersion()

public String getCurrentMasterVersion()

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

string current_master_version = 104;

Returns
Type Description
String

The currentMasterVersion.

getCurrentMasterVersionBytes()

public ByteString getCurrentMasterVersionBytes()

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

string current_master_version = 104;

Returns
Type Description
ByteString

The bytes for currentMasterVersion.

getCurrentNodeCount() (deprecated)

public int getCurrentNodeCount()

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

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

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

[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 ByteString getCurrentNodeVersionBytes()

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

[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
ByteString

The bytes for currentNodeVersion.

getDatabaseEncryption()

public DatabaseEncryption getDatabaseEncryption()

Configuration of etcd encryption.

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

Returns
Type Description
DatabaseEncryption

The databaseEncryption.

getDatabaseEncryptionOrBuilder()

public DatabaseEncryptionOrBuilder getDatabaseEncryptionOrBuilder()

Configuration of etcd encryption.

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

Returns
Type Description
DatabaseEncryptionOrBuilder

getDefaultInstanceForType()

public Cluster getDefaultInstanceForType()
Returns
Type Description
Cluster

getDefaultMaxPodsConstraint()

public MaxPodsConstraint getDefaultMaxPodsConstraint()

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

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

Returns
Type Description
MaxPodsConstraint

The defaultMaxPodsConstraint.

getDefaultMaxPodsConstraintOrBuilder()

public MaxPodsConstraintOrBuilder getDefaultMaxPodsConstraintOrBuilder()

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

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

Returns
Type Description
MaxPodsConstraintOrBuilder

getDescription()

public String getDescription()

An optional description of this cluster.

string description = 2;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of this cluster.

string description = 2;

Returns
Type Description
ByteString

The bytes for description.

getEnableK8SBetaApis()

public K8sBetaAPIConfig getEnableK8SBetaApis()

Beta APIs Config

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

Returns
Type Description
K8sBetaAPIConfig

The enableK8sBetaApis.

getEnableK8SBetaApisOrBuilder()

public K8sBetaAPIConfigOrBuilder getEnableK8SBetaApisOrBuilder()

Beta APIs Config

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

Returns
Type Description
K8sBetaAPIConfigOrBuilder

getEnableKubernetesAlpha()

public boolean getEnableKubernetesAlpha()

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

bool enable_kubernetes_alpha = 14;

Returns
Type Description
boolean

The enableKubernetesAlpha.

getEnableTpu()

public boolean getEnableTpu()

Enable the ability to use Cloud TPUs in this cluster.

bool enable_tpu = 115;

Returns
Type Description
boolean

The enableTpu.

getEndpoint()

public String getEndpoint()

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

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

string endpoint = 102;

Returns
Type Description
String

The endpoint.

getEndpointBytes()

public ByteString getEndpointBytes()

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

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

string endpoint = 102;

Returns
Type Description
ByteString

The bytes for endpoint.

getEnterpriseConfig()

public EnterpriseConfig getEnterpriseConfig()

GKE Enterprise Configuration.

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

Returns
Type Description
EnterpriseConfig

The enterpriseConfig.

getEnterpriseConfigOrBuilder()

public EnterpriseConfigOrBuilder getEnterpriseConfigOrBuilder()

GKE Enterprise Configuration.

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

Returns
Type Description
EnterpriseConfigOrBuilder

getEtag()

public String getEtag()

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

string etag = 139;

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

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

string etag = 139;

Returns
Type Description
ByteString

The bytes for etag.

getExpireTime()

public String getExpireTime()

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

string expire_time = 113;

Returns
Type Description
String

The expireTime.

getExpireTimeBytes()

public ByteString getExpireTimeBytes()

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

string expire_time = 113;

Returns
Type Description
ByteString

The bytes for expireTime.

getFleet()

public Fleet getFleet()

Fleet information for the cluster.

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

Returns
Type Description
Fleet

The fleet.

getFleetOrBuilder()

public FleetOrBuilder getFleetOrBuilder()

Fleet information for the cluster.

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

Returns
Type Description
FleetOrBuilder

getId()

public String getId()

Output only. Unique id for the cluster.

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

Returns
Type Description
String

The id.

getIdBytes()

public ByteString getIdBytes()

Output only. Unique id for the cluster.

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

Returns
Type Description
ByteString

The bytes for id.

getIdentityServiceConfig()

public IdentityServiceConfig getIdentityServiceConfig()

Configuration for Identity Service component.

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

Returns
Type Description
IdentityServiceConfig

The identityServiceConfig.

getIdentityServiceConfigOrBuilder()

public IdentityServiceConfigOrBuilder getIdentityServiceConfigOrBuilder()

Configuration for Identity Service component.

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

Returns
Type Description
IdentityServiceConfigOrBuilder

getInitialClusterVersion()

public String getInitialClusterVersion()

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

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

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

string initial_cluster_version = 103;

Returns
Type Description
String

The initialClusterVersion.

getInitialClusterVersionBytes()

public ByteString getInitialClusterVersionBytes()

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

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

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

string initial_cluster_version = 103;

Returns
Type Description
ByteString

The bytes for initialClusterVersion.

getInitialNodeCount() (deprecated)

public int getInitialNodeCount()

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

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

This field is deprecated, use node_pool.initial_node_count instead.

int32 initial_node_count = 3 [deprecated = true];

Returns
Type Description
int

The initialNodeCount.

getInstanceGroupUrls(int index) (deprecated)

public String getInstanceGroupUrls(int index)

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

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

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

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

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

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

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

Deprecated. Use node_pools.instance_group_urls.

repeated string instance_group_urls = 111 [deprecated = true];

Returns
Type Description
ProtocolStringList

A list containing the instanceGroupUrls.

getIpAllocationPolicy()

public IPAllocationPolicy getIpAllocationPolicy()

Configuration for cluster IP allocation.

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

Returns
Type Description
IPAllocationPolicy

The ipAllocationPolicy.

getIpAllocationPolicyOrBuilder()

public IPAllocationPolicyOrBuilder getIpAllocationPolicyOrBuilder()

Configuration for cluster IP allocation.

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

Returns
Type Description
IPAllocationPolicyOrBuilder

getLabelFingerprint()

public String getLabelFingerprint()

The fingerprint of the set of labels for this cluster.

string label_fingerprint = 16;

Returns
Type Description
String

The labelFingerprint.

getLabelFingerprintBytes()

public ByteString getLabelFingerprintBytes()

The fingerprint of the set of labels for this cluster.

string label_fingerprint = 16;

Returns
Type Description
ByteString

The bytes for labelFingerprint.

getLegacyAbac()

public LegacyAbac getLegacyAbac()

Configuration for the legacy ABAC authorization mode.

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

Returns
Type Description
LegacyAbac

The legacyAbac.

getLegacyAbacOrBuilder()

public LegacyAbacOrBuilder getLegacyAbacOrBuilder()

Configuration for the legacy ABAC authorization mode.

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

Returns
Type Description
LegacyAbacOrBuilder

getLocation()

public String getLocation()

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

string location = 114;

Returns
Type Description
String

The location.

getLocationBytes()

public ByteString getLocationBytes()

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

string location = 114;

Returns
Type Description
ByteString

The bytes for location.

getLocations(int index)

public String getLocations(int index)

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

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

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

repeated string locations = 13;

Parameter
Name Description
index int

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

The locations at the given index.

getLocationsBytes(int index)

public ByteString getLocationsBytes(int index)

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

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

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

repeated string locations = 13;

Parameter
Name Description
index int

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

The bytes of the locations at the given index.

getLocationsCount()

public int getLocationsCount()

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

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

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

repeated string locations = 13;

Returns
Type Description
int

The count of locations.

getLocationsList()

public ProtocolStringList getLocationsList()

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

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

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

repeated string locations = 13;

Returns
Type Description
ProtocolStringList

A list containing the locations.

getLoggingConfig()

public LoggingConfig getLoggingConfig()

Logging configuration for the cluster.

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

Returns
Type Description
LoggingConfig

The loggingConfig.

getLoggingConfigOrBuilder()

public LoggingConfigOrBuilder getLoggingConfigOrBuilder()

Logging configuration for the cluster.

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

Returns
Type Description
LoggingConfigOrBuilder

getLoggingService()

public String getLoggingService()

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

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

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

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

string logging_service = 6;

Returns
Type Description
String

The loggingService.

getLoggingServiceBytes()

public ByteString getLoggingServiceBytes()

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

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

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

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

string logging_service = 6;

Returns
Type Description
ByteString

The bytes for loggingService.

getMaintenancePolicy()

public MaintenancePolicy getMaintenancePolicy()

Configure the maintenance policy for this cluster.

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

Returns
Type Description
MaintenancePolicy

The maintenancePolicy.

getMaintenancePolicyOrBuilder()

public MaintenancePolicyOrBuilder getMaintenancePolicyOrBuilder()

Configure the maintenance policy for this cluster.

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

Returns
Type Description
MaintenancePolicyOrBuilder

getMasterAuth()

public MasterAuth getMasterAuth()

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

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

Returns
Type Description
MasterAuth

The masterAuth.

getMasterAuthOrBuilder()

public MasterAuthOrBuilder getMasterAuthOrBuilder()

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

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

Returns
Type Description
MasterAuthOrBuilder

getMasterAuthorizedNetworksConfig()

public MasterAuthorizedNetworksConfig getMasterAuthorizedNetworksConfig()

The configuration options for master authorized networks feature.

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

Returns
Type Description
MasterAuthorizedNetworksConfig

The masterAuthorizedNetworksConfig.

getMasterAuthorizedNetworksConfigOrBuilder()

public MasterAuthorizedNetworksConfigOrBuilder getMasterAuthorizedNetworksConfigOrBuilder()

The configuration options for master authorized networks feature.

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

Returns
Type Description
MasterAuthorizedNetworksConfigOrBuilder

getMeshCertificates()

public MeshCertificates getMeshCertificates()

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

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

Returns
Type Description
MeshCertificates

The meshCertificates.

getMeshCertificatesOrBuilder()

public MeshCertificatesOrBuilder getMeshCertificatesOrBuilder()

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

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

Returns
Type Description
MeshCertificatesOrBuilder

getMonitoringConfig()

public MonitoringConfig getMonitoringConfig()

Monitoring configuration for the cluster.

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

Returns
Type Description
MonitoringConfig

The monitoringConfig.

getMonitoringConfigOrBuilder()

public MonitoringConfigOrBuilder getMonitoringConfigOrBuilder()

Monitoring configuration for the cluster.

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

Returns
Type Description
MonitoringConfigOrBuilder

getMonitoringService()

public String getMonitoringService()

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

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

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

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

string monitoring_service = 7;

Returns
Type Description
String

The monitoringService.

getMonitoringServiceBytes()

public ByteString getMonitoringServiceBytes()

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

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

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

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

string monitoring_service = 7;

Returns
Type Description
ByteString

The bytes for monitoringService.

getName()

public String getName()

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

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

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

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

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getNetwork()

public String getNetwork()

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

string network = 8;

Returns
Type Description
String

The network.

getNetworkBytes()

public ByteString getNetworkBytes()

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

string network = 8;

Returns
Type Description
ByteString

The bytes for network.

getNetworkConfig()

public NetworkConfig getNetworkConfig()

Configuration for cluster networking.

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

Returns
Type Description
NetworkConfig

The networkConfig.

getNetworkConfigOrBuilder()

public NetworkConfigOrBuilder getNetworkConfigOrBuilder()

Configuration for cluster networking.

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

Returns
Type Description
NetworkConfigOrBuilder

getNetworkPolicy()

public NetworkPolicy getNetworkPolicy()

Configuration options for the NetworkPolicy feature.

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

Returns
Type Description
NetworkPolicy

The networkPolicy.

getNetworkPolicyOrBuilder()

public NetworkPolicyOrBuilder getNetworkPolicyOrBuilder()

Configuration options for the NetworkPolicy feature.

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

Returns
Type Description
NetworkPolicyOrBuilder

getNodeConfig() (deprecated)

public NodeConfig getNodeConfig()

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

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

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

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

Returns
Type Description
NodeConfig

The nodeConfig.

getNodeConfigOrBuilder() (deprecated)

public NodeConfigOrBuilder getNodeConfigOrBuilder()

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

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

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

Returns
Type Description
NodeConfigOrBuilder

getNodeIpv4CidrSize()

public int getNodeIpv4CidrSize()

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

int32 node_ipv4_cidr_size = 109;

Returns
Type Description
int

The nodeIpv4CidrSize.

getNodePoolAutoConfig()

public NodePoolAutoConfig getNodePoolAutoConfig()

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

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

Returns
Type Description
NodePoolAutoConfig

The nodePoolAutoConfig.

getNodePoolAutoConfigOrBuilder()

public NodePoolAutoConfigOrBuilder getNodePoolAutoConfigOrBuilder()

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

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

Returns
Type Description
NodePoolAutoConfigOrBuilder

getNodePoolDefaults()

public NodePoolDefaults getNodePoolDefaults()

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

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

Returns
Type Description
NodePoolDefaults

The nodePoolDefaults.

getNodePoolDefaultsOrBuilder()

public NodePoolDefaultsOrBuilder getNodePoolDefaultsOrBuilder()

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

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

Returns
Type Description
NodePoolDefaultsOrBuilder

getNodePools(int index)

public NodePool getNodePools(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
NodePool

getNodePoolsCount()

public int getNodePoolsCount()

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

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

Returns
Type Description
int

getNodePoolsList()

public List<NodePool> getNodePoolsList()

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

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

Returns
Type Description
List<NodePool>

getNodePoolsOrBuilder(int index)

public NodePoolOrBuilder getNodePoolsOrBuilder(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
NodePoolOrBuilder

getNodePoolsOrBuilderList()

public List<? extends NodePoolOrBuilder> getNodePoolsOrBuilderList()

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

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

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

getNotificationConfig()

public NotificationConfig getNotificationConfig()

Notification configuration of the cluster.

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

Returns
Type Description
NotificationConfig

The notificationConfig.

getNotificationConfigOrBuilder()

public NotificationConfigOrBuilder getNotificationConfigOrBuilder()

Notification configuration of the cluster.

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

Returns
Type Description
NotificationConfigOrBuilder

getParserForType()

public Parser<Cluster> getParserForType()
Returns
Type Description
Parser<Cluster>
Overrides

getPrivateClusterConfig()

public PrivateClusterConfig getPrivateClusterConfig()

Configuration for private cluster.

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

Returns
Type Description
PrivateClusterConfig

The privateClusterConfig.

getPrivateClusterConfigOrBuilder()

public PrivateClusterConfigOrBuilder getPrivateClusterConfigOrBuilder()

Configuration for private cluster.

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

Returns
Type Description
PrivateClusterConfigOrBuilder

getReleaseChannel()

public ReleaseChannel getReleaseChannel()

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

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

Returns
Type Description
ReleaseChannel

The releaseChannel.

getReleaseChannelOrBuilder()

public ReleaseChannelOrBuilder getReleaseChannelOrBuilder()

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

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

Returns
Type Description
ReleaseChannelOrBuilder

getResourceLabels() (deprecated)

public Map<String,String> getResourceLabels()

Use #getResourceLabelsMap() instead.

Returns
Type Description
Map<String,String>

getResourceLabelsCount()

public int getResourceLabelsCount()

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

map<string, string> resource_labels = 15;

Returns
Type Description
int

getResourceLabelsMap()

public Map<String,String> getResourceLabelsMap()

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

map<string, string> resource_labels = 15;

Returns
Type Description
Map<String,String>

getResourceLabelsOrDefault(String key, String defaultValue)

public String getResourceLabelsOrDefault(String key, String defaultValue)

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

map<string, string> resource_labels = 15;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getResourceLabelsOrThrow(String key)

public String getResourceLabelsOrThrow(String key)

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

map<string, string> resource_labels = 15;

Parameter
Name Description
key String
Returns
Type Description
String

getResourceUsageExportConfig()

public ResourceUsageExportConfig getResourceUsageExportConfig()

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

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

Returns
Type Description
ResourceUsageExportConfig

The resourceUsageExportConfig.

getResourceUsageExportConfigOrBuilder()

public ResourceUsageExportConfigOrBuilder getResourceUsageExportConfigOrBuilder()

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

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

Returns
Type Description
ResourceUsageExportConfigOrBuilder

getSatisfiesPzi()

public boolean getSatisfiesPzi()

Output only. Reserved for future use.

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

Returns
Type Description
boolean

The satisfiesPzi.

getSatisfiesPzs()

public boolean getSatisfiesPzs()

Output only. Reserved for future use.

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

Returns
Type Description
boolean

The satisfiesPzs.

getSecurityPostureConfig()

public SecurityPostureConfig getSecurityPostureConfig()

Enable/Disable Security Posture API features for the cluster.

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

Returns
Type Description
SecurityPostureConfig

The securityPostureConfig.

getSecurityPostureConfigOrBuilder()

public SecurityPostureConfigOrBuilder getSecurityPostureConfigOrBuilder()

Enable/Disable Security Posture API features for the cluster.

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

Returns
Type Description
SecurityPostureConfigOrBuilder

getSelfLink()

public String getSelfLink()

[Output only] Server-defined URL for the resource.

string self_link = 100;

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

[Output only] Server-defined URL for the resource.

string self_link = 100;

Returns
Type Description
ByteString

The bytes for selfLink.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServicesIpv4Cidr()

public String getServicesIpv4Cidr()

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

string services_ipv4_cidr = 110;

Returns
Type Description
String

The servicesIpv4Cidr.

getServicesIpv4CidrBytes()

public ByteString getServicesIpv4CidrBytes()

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

string services_ipv4_cidr = 110;

Returns
Type Description
ByteString

The bytes for servicesIpv4Cidr.

getShieldedNodes()

public ShieldedNodes getShieldedNodes()

Shielded Nodes configuration.

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

Returns
Type Description
ShieldedNodes

The shieldedNodes.

getShieldedNodesOrBuilder()

public ShieldedNodesOrBuilder getShieldedNodesOrBuilder()

Shielded Nodes configuration.

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

Returns
Type Description
ShieldedNodesOrBuilder

getStatus()

public Cluster.Status getStatus()

[Output only] The current status of this cluster.

.google.container.v1.Cluster.Status status = 107;

Returns
Type Description
Cluster.Status

The status.

getStatusMessage() (deprecated)

public String getStatusMessage()

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

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

string status_message = 108 [deprecated = true];

Returns
Type Description
String

The statusMessage.

getStatusMessageBytes() (deprecated)

public ByteString getStatusMessageBytes()

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

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

string status_message = 108 [deprecated = true];

Returns
Type Description
ByteString

The bytes for statusMessage.

getStatusValue()

public int getStatusValue()

[Output only] The current status of this cluster.

.google.container.v1.Cluster.Status status = 107;

Returns
Type Description
int

The enum numeric value on the wire for status.

getSubnetwork()

public String getSubnetwork()

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

string subnetwork = 11;

Returns
Type Description
String

The subnetwork.

getSubnetworkBytes()

public ByteString getSubnetworkBytes()

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

string subnetwork = 11;

Returns
Type Description
ByteString

The bytes for subnetwork.

getTpuIpv4CidrBlock()

public String getTpuIpv4CidrBlock()

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

string tpu_ipv4_cidr_block = 116;

Returns
Type Description
String

The tpuIpv4CidrBlock.

getTpuIpv4CidrBlockBytes()

public ByteString getTpuIpv4CidrBlockBytes()

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

string tpu_ipv4_cidr_block = 116;

Returns
Type Description
ByteString

The bytes for tpuIpv4CidrBlock.

getVerticalPodAutoscaling()

public VerticalPodAutoscaling getVerticalPodAutoscaling()

Cluster-level Vertical Pod Autoscaling configuration.

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

Returns
Type Description
VerticalPodAutoscaling

The verticalPodAutoscaling.

getVerticalPodAutoscalingOrBuilder()

public VerticalPodAutoscalingOrBuilder getVerticalPodAutoscalingOrBuilder()

Cluster-level Vertical Pod Autoscaling configuration.

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

Returns
Type Description
VerticalPodAutoscalingOrBuilder

getWorkloadIdentityConfig()

public WorkloadIdentityConfig getWorkloadIdentityConfig()

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

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

Returns
Type Description
WorkloadIdentityConfig

The workloadIdentityConfig.

getWorkloadIdentityConfigOrBuilder()

public WorkloadIdentityConfigOrBuilder getWorkloadIdentityConfigOrBuilder()

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

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

Returns
Type Description
WorkloadIdentityConfigOrBuilder

getZone() (deprecated)

public String getZone()

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

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

Returns
Type Description
String

The zone.

getZoneBytes() (deprecated)

public ByteString getZoneBytes()

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

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

Returns
Type Description
ByteString

The bytes for zone.

hasAddonsConfig()

public boolean hasAddonsConfig()

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

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

Returns
Type Description
boolean

Whether the addonsConfig field is set.

hasAuthenticatorGroupsConfig()

public boolean hasAuthenticatorGroupsConfig()

Configuration controlling RBAC group membership information.

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

Returns
Type Description
boolean

Whether the authenticatorGroupsConfig field is set.

hasAutopilot()

public boolean hasAutopilot()

Autopilot configuration for the cluster.

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

Returns
Type Description
boolean

Whether the autopilot field is set.

hasAutoscaling()

public boolean hasAutoscaling()

Cluster-level autoscaling configuration.

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

Returns
Type Description
boolean

Whether the autoscaling field is set.

hasBinaryAuthorization()

public boolean hasBinaryAuthorization()

Configuration for Binary Authorization.

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

Returns
Type Description
boolean

Whether the binaryAuthorization field is set.

hasConfidentialNodes()

public boolean hasConfidentialNodes()

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

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

Returns
Type Description
boolean

Whether the confidentialNodes field is set.

hasCostManagementConfig()

public boolean hasCostManagementConfig()

Configuration for the fine-grained cost management feature.

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

Returns
Type Description
boolean

Whether the costManagementConfig field is set.

hasDatabaseEncryption()

public boolean hasDatabaseEncryption()

Configuration of etcd encryption.

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

Returns
Type Description
boolean

Whether the databaseEncryption field is set.

hasDefaultMaxPodsConstraint()

public boolean hasDefaultMaxPodsConstraint()

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

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

Returns
Type Description
boolean

Whether the defaultMaxPodsConstraint field is set.

hasEnableK8SBetaApis()

public boolean hasEnableK8SBetaApis()

Beta APIs Config

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

Returns
Type Description
boolean

Whether the enableK8sBetaApis field is set.

hasEnterpriseConfig()

public boolean hasEnterpriseConfig()

GKE Enterprise Configuration.

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

Returns
Type Description
boolean

Whether the enterpriseConfig field is set.

hasFleet()

public boolean hasFleet()

Fleet information for the cluster.

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

Returns
Type Description
boolean

Whether the fleet field is set.

hasIdentityServiceConfig()

public boolean hasIdentityServiceConfig()

Configuration for Identity Service component.

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

Returns
Type Description
boolean

Whether the identityServiceConfig field is set.

hasIpAllocationPolicy()

public boolean hasIpAllocationPolicy()

Configuration for cluster IP allocation.

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

Returns
Type Description
boolean

Whether the ipAllocationPolicy field is set.

hasLegacyAbac()

public boolean hasLegacyAbac()

Configuration for the legacy ABAC authorization mode.

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

Returns
Type Description
boolean

Whether the legacyAbac field is set.

hasLoggingConfig()

public boolean hasLoggingConfig()

Logging configuration for the cluster.

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

Returns
Type Description
boolean

Whether the loggingConfig field is set.

hasMaintenancePolicy()

public boolean hasMaintenancePolicy()

Configure the maintenance policy for this cluster.

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

Returns
Type Description
boolean

Whether the maintenancePolicy field is set.

hasMasterAuth()

public boolean hasMasterAuth()

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

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

Returns
Type Description
boolean

Whether the masterAuth field is set.

hasMasterAuthorizedNetworksConfig()

public boolean hasMasterAuthorizedNetworksConfig()

The configuration options for master authorized networks feature.

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

Returns
Type Description
boolean

Whether the masterAuthorizedNetworksConfig field is set.

hasMeshCertificates()

public boolean hasMeshCertificates()

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

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

Returns
Type Description
boolean

Whether the meshCertificates field is set.

hasMonitoringConfig()

public boolean hasMonitoringConfig()

Monitoring configuration for the cluster.

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

Returns
Type Description
boolean

Whether the monitoringConfig field is set.

hasNetworkConfig()

public boolean hasNetworkConfig()

Configuration for cluster networking.

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

Returns
Type Description
boolean

Whether the networkConfig field is set.

hasNetworkPolicy()

public boolean hasNetworkPolicy()

Configuration options for the NetworkPolicy feature.

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

Returns
Type Description
boolean

Whether the networkPolicy field is set.

hasNodeConfig() (deprecated)

public boolean hasNodeConfig()

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

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

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

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

Returns
Type Description
boolean

Whether the nodeConfig field is set.

hasNodePoolAutoConfig()

public boolean hasNodePoolAutoConfig()

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

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

Returns
Type Description
boolean

Whether the nodePoolAutoConfig field is set.

hasNodePoolDefaults()

public boolean hasNodePoolDefaults()

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

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

Returns
Type Description
boolean

Whether the nodePoolDefaults field is set.

hasNotificationConfig()

public boolean hasNotificationConfig()

Notification configuration of the cluster.

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

Returns
Type Description
boolean

Whether the notificationConfig field is set.

hasPrivateClusterConfig()

public boolean hasPrivateClusterConfig()

Configuration for private cluster.

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

Returns
Type Description
boolean

Whether the privateClusterConfig field is set.

hasReleaseChannel()

public boolean hasReleaseChannel()

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

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

Returns
Type Description
boolean

Whether the releaseChannel field is set.

hasResourceUsageExportConfig()

public boolean hasResourceUsageExportConfig()

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

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

Returns
Type Description
boolean

Whether the resourceUsageExportConfig field is set.

hasSatisfiesPzi()

public boolean hasSatisfiesPzi()

Output only. Reserved for future use.

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

Returns
Type Description
boolean

Whether the satisfiesPzi field is set.

hasSatisfiesPzs()

public boolean hasSatisfiesPzs()

Output only. Reserved for future use.

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

Returns
Type Description
boolean

Whether the satisfiesPzs field is set.

hasSecurityPostureConfig()

public boolean hasSecurityPostureConfig()

Enable/Disable Security Posture API features for the cluster.

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

Returns
Type Description
boolean

Whether the securityPostureConfig field is set.

hasShieldedNodes()

public boolean hasShieldedNodes()

Shielded Nodes configuration.

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

Returns
Type Description
boolean

Whether the shieldedNodes field is set.

hasVerticalPodAutoscaling()

public boolean hasVerticalPodAutoscaling()

Cluster-level Vertical Pod Autoscaling configuration.

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

Returns
Type Description
boolean

Whether the verticalPodAutoscaling field is set.

hasWorkloadIdentityConfig()

public boolean hasWorkloadIdentityConfig()

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

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

Returns
Type Description
boolean

Whether the workloadIdentityConfig field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Cluster.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Cluster.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException