File: //snap/google-cloud-cli/current/lib/surface/notebooks/instances/list.py
# -*- coding: utf-8 -*- #
# Copyright 2020 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.
"""'notebooks instances list' command."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from apitools.base.py import list_pager
from googlecloudsdk.api_lib.notebooks import instances as instance_util
from googlecloudsdk.api_lib.notebooks import util
from googlecloudsdk.calliope import base
from googlecloudsdk.calliope import parser_errors
from googlecloudsdk.command_lib.notebooks import flags
from googlecloudsdk.core import properties
DETAILED_HELP = {
'DESCRIPTION':
"""
Request for listing instances.
""",
'EXAMPLES':
"""
To list instances in a particular location, run:
$ {command} --location=us-central1-a
""",
}
@base.ReleaseTracks(base.ReleaseTrack.ALPHA, base.ReleaseTrack.BETA,
base.ReleaseTrack.GA)
class List(base.ListCommand):
"""Request for listing instances."""
@classmethod
def Args(cls, parser):
"""Register flags for this command."""
parser.display_info.AddFormat("""
table(name.segment(-1),
name.segment(-3):label=LOCATION,
name.segment(-5):label=PROJECT,
state,
machineType.segment(-1),
network.segment(-1),
subnet.segment(-1))
""")
parser.display_info.AddUriFunc(instance_util.GetInstanceURI)
flags.AddListInstanceFlags(parser)
def Run(self, args):
"""This is what gets called when the user runs this command."""
release_track = self.ReleaseTrack()
client = util.GetClient(release_track)
messages = util.GetMessages(release_track)
if (not args.IsSpecified('location')) and (
not properties.VALUES.notebooks.location.IsExplicitlySet()):
raise parser_errors.RequiredError(argument='--location')
instance_service = client.projects_locations_instances
return list_pager.YieldFromList(
instance_service,
instance_util.CreateInstanceListRequest(args, messages),
field='instances',
limit=args.limit,
batch_size_attribute='pageSize')
List.detailed_help = DETAILED_HELP