File: //snap/google-cloud-cli/current/lib/surface/colab/runtime_templates/list.py
# -*- coding: utf-8 -*- #
# Copyright 2024 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.
"""List command for Colab Enterprise Runtime Templates."""
from apitools.base.py import list_pager
from googlecloudsdk.api_lib.colab_enterprise import runtime_templates as runtime_templates_util
from googlecloudsdk.api_lib.colab_enterprise import util
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.ai import endpoint_util
from googlecloudsdk.command_lib.colab_enterprise import flags
_DETAILED_HELP = {
'DESCRIPTION': """
List your project's Colab Enterprise notebook runtime templates in a given region.
""",
'EXAMPLES': """
To list your runtime templates in region 'us-central1', run:
$ {command} --region=us-central1
""",
}
@base.DefaultUniverseOnly
@base.ReleaseTracks(base.ReleaseTrack.GA, base.ReleaseTrack.BETA)
class List(base.ListCommand):
"""List your runtime templates."""
@staticmethod
def Args(parser):
"""Register flags for this command."""
flags.AddListRuntimeTemplatesFlags(parser)
parser.display_info.AddFormat("""
table(name.segment(-1):label=ID,
displayName.segment(-1),
name.segment(-3):label=REGION,
machineSpec.machineType.segment(-1))
""")
def Run(self, args):
"""This is what gets called when the user runs this command."""
release_track = self.ReleaseTrack()
messages = util.GetMessages(self.ReleaseTrack())
region_ref = args.CONCEPTS.region.Parse()
region = region_ref.AsDict()['locationsId']
# Override to regionalize domain as used by the AIPlatform API.
with endpoint_util.AiplatformEndpointOverrides(
version='BETA', region=region
):
api_client = util.GetClient(release_track)
runtime_templates_service = (
api_client.projects_locations_notebookRuntimeTemplates
)
return list_pager.YieldFromList(
service=runtime_templates_service,
request=runtime_templates_util.CreateRuntimeTemplateListRequest(
args, messages
),
field='notebookRuntimeTemplates',
limit=args.limit,
batch_size_attribute='pageSize',
batch_size=args.page_size,
)
List.detailed_help = _DETAILED_HELP