Class Cluster

A Google Kubernetes Engine cluster.

Inheritance

object

Cluster

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Container.v1.Data

Assembly: Google.Apis.Container.v1.dll

Syntax

public class Cluster : IDirectResponseSchema

Properties

AddonsConfig

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

Declaration

[JsonProperty("addonsConfig")]
public virtual AddonsConfig AddonsConfig { get; set; }

Property Value

Type	Description
AddonsConfig

AuthenticatorGroupsConfig

Configuration controlling RBAC group membership information.

Declaration

[JsonProperty("authenticatorGroupsConfig")]
public virtual AuthenticatorGroupsConfig AuthenticatorGroupsConfig { get; set; }

Property Value

Type	Description
AuthenticatorGroupsConfig

Autopilot

Autopilot configuration for the cluster.

Declaration

[JsonProperty("autopilot")]
public virtual Autopilot Autopilot { get; set; }

Property Value

Type	Description
Autopilot

Autoscaling

Cluster-level autoscaling configuration.

Declaration

[JsonProperty("autoscaling")]
public virtual ClusterAutoscaling Autoscaling { get; set; }

Property Value

Type	Description
ClusterAutoscaling

BinaryAuthorization

Configuration for Binary Authorization.

Declaration

[JsonProperty("binaryAuthorization")]
public virtual BinaryAuthorization BinaryAuthorization { get; set; }

Property Value

Type	Description
BinaryAuthorization

ClusterIpv4Cidr

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.

Declaration

[JsonProperty("clusterIpv4Cidr")]
public virtual string ClusterIpv4Cidr { get; set; }

Property Value

Type	Description
string

CompliancePostureConfig

Enable/Disable Compliance Posture features for the cluster.

Declaration

[JsonProperty("compliancePostureConfig")]
public virtual CompliancePostureConfig CompliancePostureConfig { get; set; }

Property Value

Type	Description
CompliancePostureConfig

Conditions

Which conditions caused the current cluster state.

Declaration

[JsonProperty("conditions")]
public virtual IList<StatusCondition> Conditions { get; set; }

Property Value

Type	Description
IList<StatusCondition>

ConfidentialNodes

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

Declaration

[JsonProperty("confidentialNodes")]
public virtual ConfidentialNodes ConfidentialNodes { get; set; }

Property Value

Type	Description
ConfidentialNodes

ControlPlaneEndpointsConfig

Configuration for all cluster's control plane endpoints.

Declaration

[JsonProperty("controlPlaneEndpointsConfig")]
public virtual ControlPlaneEndpointsConfig ControlPlaneEndpointsConfig { get; set; }

Property Value

Type	Description
ControlPlaneEndpointsConfig

CostManagementConfig

Configuration for the fine-grained cost management feature.

Declaration

[JsonProperty("costManagementConfig")]
public virtual CostManagementConfig CostManagementConfig { get; set; }

Property Value

Type	Description
CostManagementConfig

CreateTime

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

Declaration

[JsonProperty("createTime")]
public virtual string CreateTime { get; set; }

Property Value

Type	Description
string

CurrentMasterVersion

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

Declaration

[JsonProperty("currentMasterVersion")]
public virtual string CurrentMasterVersion { get; set; }

Property Value

Type	Description
string

CurrentNodeCount

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

Declaration

[JsonProperty("currentNodeCount")]
public virtual int? CurrentNodeCount { get; set; }

Property Value

Type	Description
int?

CurrentNodeVersion

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.

Declaration

[JsonProperty("currentNodeVersion")]
public virtual string CurrentNodeVersion { get; set; }

Property Value

Type	Description
string

DatabaseEncryption

Configuration of etcd encryption.

Declaration

[JsonProperty("databaseEncryption")]
public virtual DatabaseEncryption DatabaseEncryption { get; set; }

Property Value

Type	Description
DatabaseEncryption

DefaultMaxPodsConstraint

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.

Declaration

[JsonProperty("defaultMaxPodsConstraint")]
public virtual MaxPodsConstraint DefaultMaxPodsConstraint { get; set; }

Property Value

Type	Description
MaxPodsConstraint

Description

An optional description of this cluster.

Declaration

[JsonProperty("description")]
public virtual string Description { get; set; }

Property Value

Type	Description
string

ETag

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.

Declaration

[JsonProperty("etag")]
public virtual string ETag { get; set; }

Property Value

Type	Description
string

EnableK8sBetaApis

Beta APIs Config

Declaration

[JsonProperty("enableK8sBetaApis")]
public virtual K8sBetaAPIConfig EnableK8sBetaApis { get; set; }

Property Value

Type	Description
K8sBetaAPIConfig

EnableKubernetesAlpha

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.

Declaration

[JsonProperty("enableKubernetesAlpha")]
public virtual bool? EnableKubernetesAlpha { get; set; }

Property Value

Type	Description
bool?

EnableTpu

Enable the ability to use Cloud TPUs in this cluster.

Declaration

[JsonProperty("enableTpu")]
public virtual bool? EnableTpu { get; set; }

Property Value

Type	Description
bool?

Endpoint

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.

Declaration

[JsonProperty("endpoint")]
public virtual string Endpoint { get; set; }

Property Value

Type	Description
string

EnterpriseConfig

GKE Enterprise Configuration.

Declaration

[JsonProperty("enterpriseConfig")]
public virtual EnterpriseConfig EnterpriseConfig { get; set; }

Property Value

Type	Description
EnterpriseConfig

ExpireTime

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

Declaration

[JsonProperty("expireTime")]
public virtual string ExpireTime { get; set; }

Property Value

Type	Description
string

Fleet

Fleet information for the cluster.

Declaration

[JsonProperty("fleet")]
public virtual Fleet Fleet { get; set; }

Property Value

Type	Description
Fleet

Id

Output only. Unique id for the cluster.

Declaration

[JsonProperty("id")]
public virtual string Id { get; set; }

Property Value

Type	Description
string

IdentityServiceConfig

Configuration for Identity Service component.

Declaration

[JsonProperty("identityServiceConfig")]
public virtual IdentityServiceConfig IdentityServiceConfig { get; set; }

Property Value

Type	Description
IdentityServiceConfig

InitialClusterVersion

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

Declaration

[JsonProperty("initialClusterVersion")]
public virtual string InitialClusterVersion { get; set; }

Property Value

Type	Description
string

InitialNodeCount

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.

Declaration

[JsonProperty("initialNodeCount")]
public virtual int? InitialNodeCount { get; set; }

Property Value

Type	Description
int?

InstanceGroupUrls

Output only. Deprecated. Use node_pools.instance_group_urls.

Declaration

[JsonProperty("instanceGroupUrls")]
public virtual IList<string> InstanceGroupUrls { get; set; }

Property Value

Type	Description
IList<string>

IpAllocationPolicy

Configuration for cluster IP allocation.

Declaration

[JsonProperty("ipAllocationPolicy")]
public virtual IPAllocationPolicy IpAllocationPolicy { get; set; }

Property Value

Type	Description
IPAllocationPolicy

LabelFingerprint

The fingerprint of the set of labels for this cluster.

Declaration

[JsonProperty("labelFingerprint")]
public virtual string LabelFingerprint { get; set; }

Property Value

Type	Description
string

LegacyAbac

Configuration for the legacy ABAC authorization mode.

Declaration

[JsonProperty("legacyAbac")]
public virtual LegacyAbac LegacyAbac { get; set; }

Property Value

Type	Description
LegacyAbac

Location

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

Declaration

[JsonProperty("location")]
public virtual string Location { get; set; }

Property Value

Type	Description
string

Locations

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.

Declaration

[JsonProperty("locations")]
public virtual IList<string> Locations { get; set; }

Property Value

Type	Description
IList<string>

LoggingConfig

Logging configuration for the cluster.

Declaration

[JsonProperty("loggingConfig")]
public virtual LoggingConfig LoggingConfig { get; set; }

Property Value

Type	Description
LoggingConfig

LoggingService

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.

Declaration

[JsonProperty("loggingService")]
public virtual string LoggingService { get; set; }

Property Value

Type	Description
string

MaintenancePolicy

Configure the maintenance policy for this cluster.

Declaration

[JsonProperty("maintenancePolicy")]
public virtual MaintenancePolicy MaintenancePolicy { get; set; }

Property Value

Type	Description
MaintenancePolicy

MasterAuth

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.

Declaration

[JsonProperty("masterAuth")]
public virtual MasterAuth MasterAuth { get; set; }

Property Value

Type	Description
MasterAuth

MasterAuthorizedNetworksConfig

The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead.

Declaration

[JsonProperty("masterAuthorizedNetworksConfig")]
public virtual MasterAuthorizedNetworksConfig MasterAuthorizedNetworksConfig { get; set; }

Property Value

Type	Description
MasterAuthorizedNetworksConfig

MeshCertificates

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

Declaration

[JsonProperty("meshCertificates")]
public virtual MeshCertificates MeshCertificates { get; set; }

Property Value

Type	Description
MeshCertificates

MonitoringConfig

Monitoring configuration for the cluster.

Declaration

[JsonProperty("monitoringConfig")]
public virtual MonitoringConfig MonitoringConfig { get; set; }

Property Value

Type	Description
MonitoringConfig

MonitoringService

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.

Declaration

[JsonProperty("monitoringService")]
public virtual string MonitoringService { get; set; }

Property Value

Type	Description
string

Name

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.

Declaration

[JsonProperty("name")]
public virtual string Name { get; set; }

Property Value

Type	Description
string

Network

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

Declaration

[JsonProperty("network")]
public virtual string Network { get; set; }

Property Value

Type	Description
string

NetworkConfig

Configuration for cluster networking.

Declaration

[JsonProperty("networkConfig")]
public virtual NetworkConfig NetworkConfig { get; set; }

Property Value

Type	Description
NetworkConfig

NetworkPolicy

Configuration options for the NetworkPolicy feature.

Declaration

[JsonProperty("networkPolicy")]
public virtual NetworkPolicy NetworkPolicy { get; set; }

Property Value

Type	Description
NetworkPolicy

NodeConfig

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.

Declaration

[JsonProperty("nodeConfig")]
public virtual NodeConfig NodeConfig { get; set; }

Property Value

Type	Description
NodeConfig

NodeIpv4CidrSize

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.

Declaration

[JsonProperty("nodeIpv4CidrSize")]
public virtual int? NodeIpv4CidrSize { get; set; }

Property Value

Type	Description
int?

NodePoolAutoConfig

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

Declaration

[JsonProperty("nodePoolAutoConfig")]
public virtual NodePoolAutoConfig NodePoolAutoConfig { get; set; }

Property Value

Type	Description
NodePoolAutoConfig

NodePoolDefaults

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

Declaration

[JsonProperty("nodePoolDefaults")]
public virtual NodePoolDefaults NodePoolDefaults { get; set; }

Property Value

Type	Description
NodePoolDefaults

NodePools

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

Declaration

[JsonProperty("nodePools")]
public virtual IList<NodePool> NodePools { get; set; }

Property Value

Type	Description
IList<NodePool>

NotificationConfig

Notification configuration of the cluster.

Declaration

[JsonProperty("notificationConfig")]
public virtual NotificationConfig NotificationConfig { get; set; }

Property Value

Type	Description
NotificationConfig

ParentProductConfig

The configuration of the parent product of the cluster. This field is used by Google internal products that are built on top of the GKE cluster and take the ownership of the cluster.

Declaration

[JsonProperty("parentProductConfig")]
public virtual ParentProductConfig ParentProductConfig { get; set; }

Property Value

Type	Description
ParentProductConfig

PrivateClusterConfig

Configuration for private cluster.

Declaration

[JsonProperty("privateClusterConfig")]
public virtual PrivateClusterConfig PrivateClusterConfig { get; set; }

Property Value

Type	Description
PrivateClusterConfig

RbacBindingConfig

RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created.

Declaration

[JsonProperty("rbacBindingConfig")]
public virtual RBACBindingConfig RbacBindingConfig { get; set; }

Property Value

Type	Description
RBACBindingConfig

ReleaseChannel

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.

Declaration

[JsonProperty("releaseChannel")]
public virtual ReleaseChannel ReleaseChannel { get; set; }

Property Value

Type	Description
ReleaseChannel

ResourceLabels

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

Declaration

[JsonProperty("resourceLabels")]
public virtual IDictionary<string, string> ResourceLabels { get; set; }

Property Value

Type	Description
IDictionary<string, string>

ResourceUsageExportConfig

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

Declaration

[JsonProperty("resourceUsageExportConfig")]
public virtual ResourceUsageExportConfig ResourceUsageExportConfig { get; set; }

Property Value

Type	Description
ResourceUsageExportConfig

SatisfiesPzi

Output only. Reserved for future use.

Declaration

[JsonProperty("satisfiesPzi")]
public virtual bool? SatisfiesPzi { get; set; }

Property Value

Type	Description
bool?

SatisfiesPzs

Output only. Reserved for future use.

Declaration

[JsonProperty("satisfiesPzs")]
public virtual bool? SatisfiesPzs { get; set; }

Property Value

Type	Description
bool?

SecretManagerConfig

Secret CSI driver configuration.

Declaration

[JsonProperty("secretManagerConfig")]
public virtual SecretManagerConfig SecretManagerConfig { get; set; }

Property Value

Type	Description
SecretManagerConfig

SecurityPostureConfig

Enable/Disable Security Posture API features for the cluster.

Declaration

[JsonProperty("securityPostureConfig")]
public virtual SecurityPostureConfig SecurityPostureConfig { get; set; }

Property Value

Type	Description
SecurityPostureConfig

SelfLink

Output only. Server-defined URL for the resource.

Declaration

[JsonProperty("selfLink")]
public virtual string SelfLink { get; set; }

Property Value

Type	Description
string

ServicesIpv4Cidr

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.

Declaration

[JsonProperty("servicesIpv4Cidr")]
public virtual string ServicesIpv4Cidr { get; set; }

Property Value

Type	Description
string

ShieldedNodes

Shielded Nodes configuration.

Declaration

[JsonProperty("shieldedNodes")]
public virtual ShieldedNodes ShieldedNodes { get; set; }

Property Value

Type	Description
ShieldedNodes

Status

Output only. The current status of this cluster.

Declaration

[JsonProperty("status")]
public virtual string Status { get; set; }

Property Value

Type	Description
string

StatusMessage

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

Declaration

[JsonProperty("statusMessage")]
public virtual string StatusMessage { get; set; }

Property Value

Type	Description
string

Subnetwork

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

Declaration

[JsonProperty("subnetwork")]
public virtual string Subnetwork { get; set; }

Property Value

Type	Description
string

TpuIpv4CidrBlock

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

Declaration

[JsonProperty("tpuIpv4CidrBlock")]
public virtual string TpuIpv4CidrBlock { get; set; }

Property Value

Type	Description
string

UserManagedKeysConfig

The Custom keys configuration for the cluster.

Declaration

[JsonProperty("userManagedKeysConfig")]
public virtual UserManagedKeysConfig UserManagedKeysConfig { get; set; }

Property Value

Type	Description
UserManagedKeysConfig

VerticalPodAutoscaling

Cluster-level Vertical Pod Autoscaling configuration.

Declaration

[JsonProperty("verticalPodAutoscaling")]
public virtual VerticalPodAutoscaling VerticalPodAutoscaling { get; set; }

Property Value

Type	Description
VerticalPodAutoscaling

WorkloadIdentityConfig

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

Declaration

[JsonProperty("workloadIdentityConfig")]
public virtual WorkloadIdentityConfig WorkloadIdentityConfig { get; set; }

Property Value

Type	Description
WorkloadIdentityConfig

Zone

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

Declaration

[JsonProperty("zone")]
public virtual string Zone { get; set; }

Property Value

Type	Description
string

Implements

IDirectResponseSchema