File: //snap/google-cloud-cli/396/lib/surface/compute/networks/subnets/list.py
# -*- 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.
"""Command for listing subnetworks."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.compute import base_classes
from googlecloudsdk.api_lib.compute import lister
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.compute.networks.subnets import flags
from googlecloudsdk.command_lib.util.apis import arg_utils
@base.ReleaseTracks(base.ReleaseTrack.GA)
@base.UniverseCompatible
class List(base.ListCommand):
"""List subnetworks."""
_include_view = True
_default_list_format = flags.DEFAULT_LIST_FORMAT_WITH_IPV6_FIELD
_utilization_details_list_format = (
flags.DEFAULT_LIST_FORMAT_WITH_UTILIZATION_FIELD
)
@classmethod
def Args(cls, parser):
if cls._include_view:
parser.display_info.AddFormat(cls._utilization_details_list_format)
else:
parser.display_info.AddFormat(cls._default_list_format)
lister.AddRegionsArg(parser)
parser.display_info.AddCacheUpdater(flags.SubnetworksCompleter)
parser.add_argument(
'--network',
help='Only show subnetworks of a specific network.')
if cls._include_view:
parser.add_argument(
'--view',
choices={
'WITH_UTILIZATION': (
'Output includes the IP address utilization data of all'
' subnetwork ranges, showing total allocated and free IPv4'
' and IPv6 IP addresses.'
),
},
type=arg_utils.ChoiceToEnumName,
action='append',
help=(
'Specifies the information to include in the output.'
),
)
def _GetSubnetworkViews(self, view, request_message):
views = []
if view is None:
return views
for v in view:
if v == 'WITH_UTILIZATION':
views.append(request_message.ViewsValueValuesEnum.WITH_UTILIZATION)
return views
def Run(self, args):
holder = base_classes.ComputeApiHolder(self.ReleaseTrack())
client = holder.client
request_data = lister.ParseMultiScopeFlags(args, holder.resources)
if self._include_view:
list_implementation = lister.MultiScopeLister(
client=client,
regional_service=client.apitools_client.subnetworks,
aggregation_service=client.apitools_client.subnetworks,
subnetwork_views_flag=self._GetSubnetworkViews(
args.view, client.messages.ComputeSubnetworksListRequest
),
)
else:
list_implementation = lister.MultiScopeLister(
client=client,
regional_service=client.apitools_client.subnetworks,
aggregation_service=client.apitools_client.subnetworks,
)
for resource in lister.Invoke(request_data, list_implementation):
if args.network is None:
yield resource
elif 'network' in resource:
network_ref = holder.resources.Parse(resource['network'])
if network_ref.Name() == args.network:
yield resource
@base.ReleaseTracks(base.ReleaseTrack.BETA)
@base.UniverseCompatible
class ListBeta(List):
"""Create a subnet in the Beta release track."""
_include_view = True
@base.ReleaseTracks(base.ReleaseTrack.ALPHA)
@base.UniverseCompatible
class ListAlpha(ListBeta):
"""Describe a subnet in the Alpha release track."""
_include_view = True
List.detailed_help = base_classes.GetRegionalListerHelp('subnetworks')