File: //snap/google-cloud-cli/current/lib/surface/filestore/zones/list.py
# -*- coding: utf-8 -*- #
# Copyright 2025 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.
"""Command for listing Filestore zones."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.filestore import filestore_client
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.filestore import locations_util
from googlecloudsdk.command_lib.filestore.locations import flags
from googlecloudsdk.core import properties
from googlecloudsdk.core import resources
@base.UniverseCompatible
@base.ReleaseTracks(base.ReleaseTrack.GA)
class List(base.ListCommand):
"""List all Filestore zones."""
_API_VERSION = filestore_client.V1_API_VERSION
@staticmethod
def Args(parser):
parser.display_info.AddFormat(flags.LOCATIONS_LIST_FORMAT)
def UriFunc(resource):
registry = filestore_client.GetFilestoreRegistry()
ref = registry.Parse(
resource.name, collection=filestore_client.LOCATIONS_COLLECTION
)
return ref.SelfLink()
parser.display_info.AddUriFunc(UriFunc)
def Run(self, args):
project_ref = resources.REGISTRY.Parse(
properties.VALUES.core.project.GetOrFail(), collection='file.projects'
)
client = filestore_client.FilestoreClient(version=self._API_VERSION)
all_locations = list(client.ListLocations(project_ref, limit=None))
return list(
locations_util.ExtractZonesFromLocationsListResponse(
all_locations, limit=args.limit
)
)
@base.ReleaseTracks(base.ReleaseTrack.BETA)
class ListBeta(List):
"""List all Filestore zones."""
_API_VERSION = filestore_client.BETA_API_VERSION
@staticmethod
def Args(parser):
parser.display_info.AddFormat(flags.LOCATIONS_LIST_FORMAT)
def UriFunc(resource):
registry = filestore_client.GetFilestoreRegistry(
filestore_client.BETA_API_VERSION
)
ref = registry.Parse(
resource.name, collection=filestore_client.LOCATIONS_COLLECTION
)
return ref.SelfLink()
parser.display_info.AddUriFunc(UriFunc)
@base.ReleaseTracks(base.ReleaseTrack.ALPHA)
class ListAlpha(List):
"""List all Filestore zones."""
_API_VERSION = filestore_client.ALPHA_API_VERSION
@staticmethod
def Args(parser):
parser.display_info.AddFormat(flags.LOCATIONS_LIST_FORMAT)
def UriFunc(resource):
registry = filestore_client.GetFilestoreRegistry(
filestore_client.ALPHA_API_VERSION
)
ref = registry.Parse(
resource.name, collection=filestore_client.LOCATIONS_COLLECTION
)
return ref.SelfLink()
parser.display_info.AddUriFunc(UriFunc)
List.detailed_help = {
'DESCRIPTION': 'List all Filestore zones.',
'EXAMPLES': """\
The following command lists a maximum of five Filestore zones sorted
alphabetically by name in descending order:
$ {command} --limit=5 --sort-by=~name
""",
}