GetClusterResult class

Result data returned by getCluster.

Constructors

GetClusterResult({required AddonsConfigResponse addonsConfig, required AuthenticatorGroupsConfigResponse authenticatorGroupsConfig, required AutopilotResponse autopilot, required ClusterAutoscalingResponse autoscaling, required BinaryAuthorizationResponse binaryAuthorization, required String clusterIpv4Cidr, required List<StatusConditionResponse> conditions, required ConfidentialNodesResponse confidentialNodes, required CostManagementConfigResponse costManagementConfig, required String createTime, required String currentMasterVersion, required int currentNodeCount, required String currentNodeVersion, required DatabaseEncryptionResponse databaseEncryption, required MaxPodsConstraintResponse defaultMaxPodsConstraint, required String description, required K8sBetaAPIConfigResponse enableK8sBetaApis, required bool enableKubernetesAlpha, required bool enableTpu, required String endpoint, required EnterpriseConfigResponse enterpriseConfig, required String etag, required String expireTime, required FleetResponse fleet, required IdentityServiceConfigResponse identityServiceConfig, required String initialClusterVersion, required int initialNodeCount, required List<String> instanceGroupUrls, required IPAllocationPolicyResponse ipAllocationPolicy, required String labelFingerprint, required LegacyAbacResponse legacyAbac, required String location, required List<String> locations, required LoggingConfigResponse loggingConfig, required String loggingService, required MaintenancePolicyResponse maintenancePolicy, required MasterAuthResponse masterAuth, required MasterAuthorizedNetworksConfigResponse masterAuthorizedNetworksConfig, required MeshCertificatesResponse meshCertificates, required MonitoringConfigResponse monitoringConfig, required String monitoringService, required String name, required String network, required NetworkConfigResponse networkConfig, required NetworkPolicyResponse networkPolicy, required NodeConfigResponse nodeConfig, required int nodeIpv4CidrSize, required NodePoolAutoConfigResponse nodePoolAutoConfig, required NodePoolDefaultsResponse nodePoolDefaults, required List<NodePoolResponse> nodePools, required NotificationConfigResponse notificationConfig, required ParentProductConfigResponse parentProductConfig, required PrivateClusterConfigResponse privateClusterConfig, required ReleaseChannelResponse releaseChannel, required Map<String, String> resourceLabels, required ResourceUsageExportConfigResponse resourceUsageExportConfig, required SecurityPostureConfigResponse securityPostureConfig, required String selfLink, required String servicesIpv4Cidr, required ShieldedNodesResponse shieldedNodes, required String status, required String statusMessage, required String subnetwork, required String tpuIpv4CidrBlock, required VerticalPodAutoscalingResponse verticalPodAutoscaling, required WorkloadIdentityConfigResponse workloadIdentityConfig, required String zone})
Creates a new GetClusterResult. addonsConfig Configurations for the various addons available to run in the cluster. authenticatorGroupsConfig Configuration controlling RBAC group membership information. autopilot Autopilot configuration for the cluster. autoscaling Cluster-level autoscaling configuration. binaryAuthorization Configuration for Binary Authorization. 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. conditions Which conditions caused the current cluster state. confidentialNodes Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled. costManagementConfig Configuration for the fine-grained cost management feature. createTime Output only The time the cluster was created, in RFC3339 text format. currentMasterVersion Output only The current software version of the master endpoint. currentNodeCount Output only The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. 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. databaseEncryption Configuration of etcd encryption. 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. description An optional description of this cluster. enableK8sBetaApis Beta APIs Config 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. enableTpu Enable the ability to use Cloud TPUs in this cluster. 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. enterpriseConfig GKE Enterprise Configuration. 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. expireTime Output only The time the cluster will be automatically deleted in RFC3339 text format. fleet Fleet information for the cluster. identityServiceConfig Configuration for Identity Service component. 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 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. instanceGroupUrls Deprecated. Use node_pools.instance_group_urls. ipAllocationPolicy Configuration for cluster IP allocation. labelFingerprint The fingerprint of the set of labels for this cluster. legacyAbac Configuration for the legacy ABAC authorization mode. location Output only The name of the Google Compute Engine zone or region in which the cluster resides. 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. loggingConfig Logging configuration for the cluster. 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. maintenancePolicy Configure the maintenance policy for this cluster. 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. masterAuthorizedNetworksConfig The configuration options for master authorized networks feature. meshCertificates Configuration for issuance of mTLS keys and certificates to Kubernetes pods. monitoringConfig Monitoring configuration for the cluster. 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. 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. network The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used. networkConfig Configuration for cluster networking. networkPolicy Configuration options for the NetworkPolicy feature. 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. 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. nodePoolAutoConfig Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. nodePoolDefaults Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object. nodePools The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified. notificationConfig Notification configuration of the cluster. 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. privateClusterConfig Configuration for private cluster. 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. resourceLabels The resource labels for the cluster to use to annotate any related Google Compute Engine resources. resourceUsageExportConfig Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified. securityPostureConfig Enable/Disable Security Posture API features for the cluster. selfLink Output only Server-defined URL for the resource. 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. shieldedNodes Shielded Nodes configuration. status Output only The current status of this cluster. statusMessage Output only Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. subnetwork The name of the Google Compute Engine subnetwork to which the cluster is connected. tpuIpv4CidrBlock Output only The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. 1.2.3.4/29). verticalPodAutoscaling Cluster-level Vertical Pod Autoscaling configuration. workloadIdentityConfig Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. zone Output only The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.
const
GetClusterResult.fromMap(Map<String, dynamic> map)
factory

Properties

addonsConfig → AddonsConfigResponse
Configurations for the various addons available to run in the cluster.
final
authenticatorGroupsConfig → AuthenticatorGroupsConfigResponse
Configuration controlling RBAC group membership information.
final
autopilot → AutopilotResponse
Autopilot configuration for the cluster.
final
autoscaling → ClusterAutoscalingResponse
Cluster-level autoscaling configuration.
final
binaryAuthorization → BinaryAuthorizationResponse
Configuration for Binary Authorization.
final
clusterIpv4Cidr → String
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.
final
conditions → List<StatusConditionResponse>
Which conditions caused the current cluster state.
final
confidentialNodes → ConfidentialNodesResponse
Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled.
final
costManagementConfig → CostManagementConfigResponse
Configuration for the fine-grained cost management feature.
final
createTime → String
Output only The time the cluster was created, in RFC3339 text format.
final
currentMasterVersion → String
Output only The current software version of the master endpoint.
final
currentNodeCount → int
Output only The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
final
currentNodeVersion → String
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.
final
databaseEncryption → DatabaseEncryptionResponse
Configuration of etcd encryption.
final
defaultMaxPodsConstraint → MaxPodsConstraintResponse
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.
final
description → String
An optional description of this cluster.
final
enableK8sBetaApis → K8sBetaAPIConfigResponse
Beta APIs Config
final
enableKubernetesAlpha → bool
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.
final
enableTpu → bool
Enable the ability to use Cloud TPUs in this cluster.
final
endpoint → String
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.
final
enterpriseConfig → EnterpriseConfigResponse
GKE Enterprise Configuration.
final
etag → String
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.
final
expireTime → String
Output only The time the cluster will be automatically deleted in RFC3339 text format.
final
fleet → FleetResponse
Fleet information for the cluster.
final
hashCode → int
The hash code for this object.
no setterinherited
identityServiceConfig → IdentityServiceConfigResponse
Configuration for Identity Service component.
final
initialClusterVersion → String
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
final
initialNodeCount → int
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.
final
instanceGroupUrls → List<String>
Deprecated. Use node_pools.instance_group_urls.
final
ipAllocationPolicy → IPAllocationPolicyResponse
Configuration for cluster IP allocation.
final
labelFingerprint → String
The fingerprint of the set of labels for this cluster.
final
legacyAbac → LegacyAbacResponse
Configuration for the legacy ABAC authorization mode.
final
location → String
Output only The name of the Google Compute Engine zone or region in which the cluster resides.
final
locations → List<String>
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.
final
loggingConfig → LoggingConfigResponse
Logging configuration for the cluster.
final
loggingService → String
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.
final
maintenancePolicy → MaintenancePolicyResponse
Configure the maintenance policy for this cluster.
final
masterAuth → MasterAuthResponse
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.
final
masterAuthorizedNetworksConfig → MasterAuthorizedNetworksConfigResponse
The configuration options for master authorized networks feature.
final
meshCertificates → MeshCertificatesResponse
Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
final
monitoringConfig → MonitoringConfigResponse
Monitoring configuration for the cluster.
final
monitoringService → String
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.
final
name → String
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.
final
network → String
The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.
final
networkConfig → NetworkConfigResponse
Configuration for cluster networking.
final
networkPolicy → NetworkPolicyResponse
Configuration options for the NetworkPolicy feature.
final
nodeConfig → NodeConfigResponse
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.
final
nodeIpv4CidrSize → int
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.
final
nodePoolAutoConfig → NodePoolAutoConfigResponse
Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
final
nodePoolDefaults → NodePoolDefaultsResponse
Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.
final
nodePools → List<NodePoolResponse>
The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.
final
notificationConfig → NotificationConfigResponse
Notification configuration of the cluster.
final
parentProductConfig → ParentProductConfigResponse
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.
final
privateClusterConfig → PrivateClusterConfigResponse
Configuration for private cluster.
final
releaseChannel → ReleaseChannelResponse
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.
final
resourceLabels → Map<String, String>
The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
final
resourceUsageExportConfig → ResourceUsageExportConfigResponse
Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityPostureConfig → SecurityPostureConfigResponse
Enable/Disable Security Posture API features for the cluster.
final
Output only Server-defined URL for the resource.
final
servicesIpv4Cidr → String
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.
final
shieldedNodes → ShieldedNodesResponse
Shielded Nodes configuration.
final
status → String
Output only The current status of this cluster.
final
statusMessage → String
Output only Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
final
subnetwork → String
The name of the Google Compute Engine subnetwork to which the cluster is connected.
final
tpuIpv4CidrBlock → String
Output only The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. 1.2.3.4/29).
final
verticalPodAutoscaling → VerticalPodAutoscalingResponse
Cluster-level Vertical Pod Autoscaling configuration.
final
workloadIdentityConfig → WorkloadIdentityConfigResponse
Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.
final
zone → String
Output only The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited