GetClusterResult

data class GetClusterResult(val addonsConfig: AddonsConfigResponse, val authenticatorGroupsConfig: AuthenticatorGroupsConfigResponse, val autopilot: AutopilotResponse, val autoscaling: ClusterAutoscalingResponse, val binaryAuthorization: BinaryAuthorizationResponse, val clusterIpv4Cidr: String, val clusterTelemetry: ClusterTelemetryResponse, val conditions: List<StatusConditionResponse>, val confidentialNodes: ConfidentialNodesResponse, val costManagementConfig: CostManagementConfigResponse, val createTime: String, val currentMasterVersion: String, val currentNodeCount: Int, val currentNodeVersion: String, val databaseEncryption: DatabaseEncryptionResponse, val defaultMaxPodsConstraint: MaxPodsConstraintResponse, val description: String, val enableKubernetesAlpha: Boolean, val enableTpu: Boolean, val endpoint: String, val etag: String, val expireTime: String, val fleet: FleetResponse, val identityServiceConfig: IdentityServiceConfigResponse, val initialClusterVersion: String, val initialNodeCount: Int, val instanceGroupUrls: List<String>, val ipAllocationPolicy: IPAllocationPolicyResponse, val labelFingerprint: String, val legacyAbac: LegacyAbacResponse, val location: String, val locations: List<String>, val loggingConfig: LoggingConfigResponse, val loggingService: String, val maintenancePolicy: MaintenancePolicyResponse, val master: MasterResponse, val masterAuth: MasterAuthResponse, val masterAuthorizedNetworksConfig: MasterAuthorizedNetworksConfigResponse, val masterIpv4CidrBlock: String, val meshCertificates: MeshCertificatesResponse, val monitoringConfig: MonitoringConfigResponse, val monitoringService: String, val name: String, val network: String, val networkConfig: NetworkConfigResponse, val networkPolicy: NetworkPolicyResponse, val nodeConfig: NodeConfigResponse, val nodeIpv4CidrSize: Int, val nodePoolAutoConfig: NodePoolAutoConfigResponse, val nodePoolDefaults: NodePoolDefaultsResponse, val nodePools: List<NodePoolResponse>, val notificationConfig: NotificationConfigResponse, val podSecurityPolicyConfig: PodSecurityPolicyConfigResponse, val privateCluster: Boolean, val privateClusterConfig: PrivateClusterConfigResponse, val protectConfig: ProtectConfigResponse, val releaseChannel: ReleaseChannelResponse, val resourceLabels: Map<String, String>, val resourceUsageExportConfig: ResourceUsageExportConfigResponse, val selfLink: String, val servicesIpv4Cidr: String, val shieldedNodes: ShieldedNodesResponse, val status: String, val statusMessage: String, val subnetwork: String, val tpuConfig: TpuConfigResponse, val tpuIpv4CidrBlock: String, val verticalPodAutoscaling: VerticalPodAutoscalingResponse, val workloadAltsConfig: WorkloadALTSConfigResponse, val workloadCertificates: WorkloadCertificatesResponse, val workloadIdentityConfig: WorkloadIdentityConfigResponse, val zone: String)

Constructors

Link copied to clipboard
fun GetClusterResult(addonsConfig: AddonsConfigResponse, authenticatorGroupsConfig: AuthenticatorGroupsConfigResponse, autopilot: AutopilotResponse, autoscaling: ClusterAutoscalingResponse, binaryAuthorization: BinaryAuthorizationResponse, clusterIpv4Cidr: String, clusterTelemetry: ClusterTelemetryResponse, conditions: List<StatusConditionResponse>, confidentialNodes: ConfidentialNodesResponse, costManagementConfig: CostManagementConfigResponse, createTime: String, currentMasterVersion: String, currentNodeCount: Int, currentNodeVersion: String, databaseEncryption: DatabaseEncryptionResponse, defaultMaxPodsConstraint: MaxPodsConstraintResponse, description: String, enableKubernetesAlpha: Boolean, enableTpu: Boolean, endpoint: String, etag: String, expireTime: String, fleet: FleetResponse, identityServiceConfig: IdentityServiceConfigResponse, initialClusterVersion: String, initialNodeCount: Int, instanceGroupUrls: List<String>, ipAllocationPolicy: IPAllocationPolicyResponse, labelFingerprint: String, legacyAbac: LegacyAbacResponse, location: String, locations: List<String>, loggingConfig: LoggingConfigResponse, loggingService: String, maintenancePolicy: MaintenancePolicyResponse, master: MasterResponse, masterAuth: MasterAuthResponse, masterAuthorizedNetworksConfig: MasterAuthorizedNetworksConfigResponse, masterIpv4CidrBlock: String, meshCertificates: MeshCertificatesResponse, monitoringConfig: MonitoringConfigResponse, monitoringService: String, name: String, network: String, networkConfig: NetworkConfigResponse, networkPolicy: NetworkPolicyResponse, nodeConfig: NodeConfigResponse, nodeIpv4CidrSize: Int, nodePoolAutoConfig: NodePoolAutoConfigResponse, nodePoolDefaults: NodePoolDefaultsResponse, nodePools: List<NodePoolResponse>, notificationConfig: NotificationConfigResponse, podSecurityPolicyConfig: PodSecurityPolicyConfigResponse, privateCluster: Boolean, privateClusterConfig: PrivateClusterConfigResponse, protectConfig: ProtectConfigResponse, releaseChannel: ReleaseChannelResponse, resourceLabels: Map<String, String>, resourceUsageExportConfig: ResourceUsageExportConfigResponse, selfLink: String, servicesIpv4Cidr: String, shieldedNodes: ShieldedNodesResponse, status: String, statusMessage: String, subnetwork: String, tpuConfig: TpuConfigResponse, tpuIpv4CidrBlock: String, verticalPodAutoscaling: VerticalPodAutoscalingResponse, workloadAltsConfig: WorkloadALTSConfigResponse, workloadCertificates: WorkloadCertificatesResponse, workloadIdentityConfig: WorkloadIdentityConfigResponse, zone: String)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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

Link copied to clipboard

Configuration controlling RBAC group membership information.

Link copied to clipboard

Autopilot configuration for the cluster.

Link copied to clipboard

Cluster-level autoscaling configuration.

Link copied to clipboard

Configuration for Binary Authorization.

Link copied to clipboard

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.

Link copied to clipboard

Telemetry integration for the cluster.

Link copied to clipboard

Which conditions caused the current cluster state.

Link copied to clipboard

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

Link copied to clipboard

Configuration for the fine-grained cost management feature.

Link copied to clipboard

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

Link copied to clipboard

Output only The current software version of the master endpoint.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Configuration of etcd encryption.

Link copied to clipboard

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.

Link copied to clipboard

An optional description of this cluster.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Fleet information for the cluster.

Link copied to clipboard

Configuration for Identity Service component.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Deprecated. Use node_pools.instance_group_urls.

Link copied to clipboard

Configuration for cluster IP allocation.

Link copied to clipboard

The fingerprint of the set of labels for this cluster.

Link copied to clipboard

Configuration for the legacy ABAC authorization mode.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Logging configuration for the cluster.

Link copied to clipboard

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.

Link copied to clipboard

Configure the maintenance policy for this cluster.

Link copied to clipboard

Configuration for master components.

Link copied to clipboard

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.

Link copied to clipboard

The configuration options for master authorized networks feature.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Monitoring configuration for the cluster.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used. On output this shows the network ID instead of the name.

Link copied to clipboard

Configuration for cluster networking.

Link copied to clipboard

Configuration options for the NetworkPolicy feature.

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Notification configuration of the cluster.

Link copied to clipboard

Configuration for the PodSecurityPolicy feature.

Link copied to clipboard

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

Link copied to clipboard

Configuration for private cluster.

Link copied to clipboard

Enable/Disable Protect API features for the cluster.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Output only Server-defined URL for the resource.

Link copied to clipboard

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.

Link copied to clipboard

Shielded Nodes configuration.

Link copied to clipboard

Output only The current status of this cluster.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Configuration for Cloud TPU support;

Link copied to clipboard

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

Link copied to clipboard

Cluster-level Vertical Pod Autoscaling configuration.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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