File: //snap/google-cloud-cli/396/lib/surface/alloydb/clusters/list.py
# -*- coding: utf-8 -*- #
# Copyright 2021 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.
"""Lists AlloyDB clusters."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.alloydb import api_util
from googlecloudsdk.calliope import base
from googlecloudsdk.core import properties
CLUSTER_FORMAT = """
table(
name,
network,
state:label=STATUS
)
"""
@base.ReleaseTracks(base.ReleaseTrack.ALPHA, base.ReleaseTrack.BETA,
base.ReleaseTrack.GA)
class List(base.ListCommand):
"""List AlloyDB clusters in a given project and region.
List AlloyDB clusters in a given project in alphabetical
order based on the cluster name.
"""
detailed_help = {
'DESCRIPTION':
'{description}',
'EXAMPLES':
"""\
To list clusters, run:
$ {command} --region=us-central1
""",
}
@staticmethod
def Args(parser):
"""Constructs and sends request.
Args:
parser: argparse.Parser: Parser object for command line inputs.
"""
parser.add_argument(
'--region',
default='-',
help=('Regional location (e.g. asia-east1, us-east1). See the full '
'list of regions at '
'https://cloud.google.com/sql/docs/instance-locations. '
'Default: list clusters in all regions.'))
parser.display_info.AddFormat(CLUSTER_FORMAT)
def Run(self, args):
"""Constructs and sends request.
Args:
args: argparse.Namespace, An object that contains the values for the
arguments specified in the .Args() method.
Returns:
ProcessHttpResponse of the request made.
"""
client = api_util.AlloyDBClient(self.ReleaseTrack())
alloydb_client = client.alloydb_client
alloydb_messages = client.alloydb_messages
location_ref = client.resource_parser.Create(
'alloydb.projects.locations',
projectsId=properties.VALUES.core.project.GetOrFail,
locationsId=args.region)
result = api_util.YieldFromListHandlingUnreachable(
alloydb_client.projects_locations_clusters,
alloydb_messages.AlloydbProjectsLocationsClustersListRequest(
parent=location_ref.RelativeName()
),
field='clusters',
limit=args.limit,
batch_size=args.page_size,
batch_size_attribute='pageSize',
)
return result