File: //snap/google-cloud-cli/current/lib/surface/workbench/executions/list.py
# -*- coding: utf-8 -*- #
# Copyright 2025 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 Workbench Executions."""
from apitools.base.py import list_pager
from googlecloudsdk.api_lib.colab_enterprise import util
from googlecloudsdk.api_lib.notebook_executor import executions as executions_util
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.ai import endpoint_util
from googlecloudsdk.command_lib.notebook_executor import flags
_DETAILED_HELP = {
'DESCRIPTION': """
List your project's Workbench executions in a given region.
""",
'EXAMPLES': """
To list your executions in region `us-central1`, run:
$ {command} --region=us-central1
""",
}
@base.DefaultUniverseOnly
@base.ReleaseTracks(base.ReleaseTrack.BETA)
class List(base.ListCommand):
"""List your notebook execution jobs."""
@staticmethod
def Args(parser):
"""Register flags for this command.
Args:
parser: argparse parser to add flags to.
"""
flags.AddListExecutionsFlags(parser, for_workbench=True)
parser.display_info.AddFormat("""
table(name.segment(-1):label=ID,
displayName,
name.segment(-3):label=REGION,
gcsOutputUri,
jobState)
""")
def Run(self, args):
"""This is what gets called when the user runs this command.
Args:
args: The arguments that the command was run with.
Returns:
A list of Workbench executions in the specified region.
"""
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)
executions_service = (
api_client.projects_locations_notebookExecutionJobs
)
return list_pager.YieldFromList(
# TODO: b/384799644 - replace with API-side filtering to reduce
# latency when available.
predicate=executions_util.IsWorkbenchExecution,
service=executions_service,
request=executions_util.CreateExecutionListRequest(
args, messages
),
field='notebookExecutionJobs',
limit=args.limit,
batch_size_attribute='pageSize',
batch_size=args.page_size,
)
List.detailed_help = _DETAILED_HELP