# -*- coding: utf-8 -*- # # Copyright 2015 Google LLC. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """List cluster command.""" from typing import Any, Dict from apitools.base.py import list_pager from googlecloudsdk.api_lib.dataproc import constants from googlecloudsdk.api_lib.dataproc import dataproc as dp from googlecloudsdk.api_lib.dataproc import util from googlecloudsdk.calliope import base from googlecloudsdk.command_lib.dataproc import flags from googlecloudsdk.core import properties def _HasScheduledDelete(cluster: Dict[str, Any]) -> str: if 'config' in cluster and 'lifecycleConfig' in cluster['config']: lifecycle_config = cluster['config']['lifecycleConfig'] if ( 'idleDeleteTtl' in lifecycle_config or 'autoDeleteTtl' in lifecycle_config or 'autoDeleteTime' in lifecycle_config ): return 'enabled' return '' def _HasScheduledStop(cluster: Dict[str, Any]) -> str: if 'config' in cluster and 'lifecycleConfig' in cluster['config']: lifecycle_config = cluster['config']['lifecycleConfig'] if ( 'idleStopTtl' in lifecycle_config or 'autoStopTtl' in lifecycle_config or 'autoStopTime' in lifecycle_config ): return 'enabled' return '' @base.UniverseCompatible class List(base.ListCommand): """View a list of clusters in a project. View a list of clusters in a project. An optional filter can be used to constrain the clusters returned. Filters are case-sensitive and have the following syntax: field = value [AND [field = value]] ... where `field` is one of `status.state`, `clusterName`, or `labels.[KEY]`, and `[KEY]` is a label key. `value` can be ```*``` to match all values. `status.state` can be one of the following: `ACTIVE`, `INACTIVE`, `CREATING`, `RUNNING`, `ERROR`, `DELETING`, or `UPDATING`. `ACTIVE` contains the `CREATING`, `UPDATING`, and `RUNNING` states. `INACTIVE` contains the `DELETING` and `ERROR` states. `clusterName` is the name of the cluster provided at creation time. Only the logical `AND` operator is supported; space-separated items are treated as having an implicit `AND` operator. ## EXAMPLES To see the list of all clusters in Dataproc's 'us-central1' region, run: $ {command} --region='us-central1' To show a cluster in Dataproc's 'global' region with the name 'mycluster', run: $ {command} --region='global' --filter='clusterName = mycluster' To see the list of all clusters in Dataproc's 'global' region with specified labels, run: $ {command} --region='global' --filter='labels.env = staging AND labels.starred = *' To see a list of all active clusters in Dataproc's 'europe-west1' region with specified labels, run: $ {command} --region='europe-west1' --filter='status.state = ACTIVE AND labels.env = staging AND labels.starred = *' """ @staticmethod def Args(parser): flags.AddRegionFlag(parser) base.URI_FLAG.RemoveFromParser(parser) base.PAGE_SIZE_FLAG.SetDefault(parser, constants.DEFAULT_PAGE_SIZE) parser.display_info.AddFormat(""" table( clusterName:label=NAME, config.gceClusterConfig.yesno(yes=GCE, no=GKE):label=PLATFORM, config.workerConfig.numInstances:label=PRIMARY_WORKER_COUNT, config.secondaryWorkerConfig.numInstances:label=SECONDARY_WORKER_COUNT, status.state:label=STATUS, config.firstof( gkeClusterConfig.namespacedGkeDeploymentTarget.targetGkeCluster, gceClusterConfig.zoneUri ).scope('locations').segment(0):label=ZONE, has_scheduled_delete():label=SCHEDULED_DELETE, has_scheduled_stop():label=SCHEDULED_STOP ) """) parser.display_info.AddTransforms({ 'has_scheduled_delete': _HasScheduledDelete, 'has_scheduled_stop': _HasScheduledStop, }) def Run(self, args): dataproc = dp.Dataproc(self.ReleaseTrack()) project = properties.VALUES.core.project.GetOrFail() region = util.ResolveRegion() request = self.GetRequest(dataproc.messages, project, region, args) return list_pager.YieldFromList( dataproc.client.projects_regions_clusters, request, limit=args.limit, field='clusters', batch_size=args.page_size, batch_size_attribute='pageSize', ) @staticmethod def GetRequest(messages, project, region, args): # Explicitly null out args.filter if present because by default args.filter # also acts as a postfilter to the things coming back from the backend backend_filter = None if args.filter: backend_filter = args.filter args.filter = None return messages.DataprocProjectsRegionsClustersListRequest( projectId=project, region=region, filter=backend_filter )