File: //snap/google-cloud-cli/current/lib/surface/firebase/test/network_profiles/describe.py
# -*- coding: utf-8 -*- #
# Copyright 2017 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.
"""The 'gcloud firebase test network-profiles describe' command."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.firebase.test import exceptions
from googlecloudsdk.api_lib.firebase.test import util
from googlecloudsdk.calliope import base
class Describe(base.DescribeCommand):
"""Describe a network profile."""
detailed_help = {
'DESCRIPTION': """Describe a network profile.
Run `$ {parent_command} --help` for descriptions of the network profile
parameters.
""",
'EXAMPLES': """To describe a network profile, run:
{command} GSM
To describe a network profiles in JSON format, run:
{command} GSM --format=json
"""
}
@staticmethod
def Args(parser):
"""Method called by Calliope to register flags for this command.
Args:
parser: An argparse parser used to add arguments that follow this
command in the CLI. Positional arguments are allowed.
"""
# Positional arg
parser.add_argument(
'profile_id',
help=
'The network profile to describe, found using $ {parent_command} list.')
def Run(self, args):
"""Run the 'gcloud firebase test network-profiles describe' command.
Args:
args: an argparse namespace. All the arguments that were provided to this
command invocation (i.e. group and command arguments combined).
Returns:
The testing_v1_messages.NetworkConfiguration object to describe.
"""
catalog = util.GetNetworkProfileCatalog(self.context)
for profile in catalog.configurations:
if profile.id == args.profile_id:
return profile
raise exceptions.NetworkProfileNotFoundError(args.profile_id)