File: //snap/google-cloud-cli/current/lib/surface/bms/ssh_keys/list.py
# -*- coding: utf-8 -*- #
# Copyright 2022 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.
"""'Bare Metal Solution SSH keys list command."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
import abc
from googlecloudsdk.api_lib.bms.bms_client import BmsClient
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.bms import flags
from googlecloudsdk.core import log
from googlecloudsdk.core import properties
import six
DETAILED_HELP = {
'DESCRIPTION':
"""
List the SSH keys added to the project in Bare Metal Solution.
""",
'EXAMPLES':
"""
To list all SSH keys within the project, run:
$ {command}
""",
}
@base.ReleaseTracks(base.ReleaseTrack.ALPHA, base.ReleaseTrack.GA)
class List(six.with_metaclass(abc.ABCMeta, base.CacheCommand)):
"""List the SSH keys added to the project in Bare Metal Solution."""
@staticmethod
def Args(parser):
"""Register flags for this command."""
flags.FILTER_FLAG_NO_SORTBY_DOC.AddToParser(parser)
flags.LIMIT_FLAG_NO_SORTBY_DOC.AddToParser(parser)
# The default format picks out the components of the relative name: given
# projects/myproject/locations/global/sshKeys/my-test
# it takes -1 (my-test), and -5 (myproject).
parser.display_info.AddFormat(
'table(name.segment(-1):label=NAME,'
'name.segment(-5):label=PROJECT)')
def Run(self, args):
client = BmsClient()
project = properties.VALUES.core.project.Get(required=True)
return client.ListSshKeys(project_resource=project, limit=args.limit)
def Epilog(self, resources_were_displayed):
"""Called after resources are displayed if the default format was used.
Args:
resources_were_displayed: True if resources were displayed.
"""
if not resources_were_displayed:
log.status.Print('Listed 0 items.')
List.detailed_help = DETAILED_HELP