feat: Add new gcloud commands, API clients, and third-party libraries across various services.

gcloud auth application-default login/google-cloud-sdk/lib/surface/colab/executions/__init__.py

@@ -0,0 +1,28 @@
+# -*- 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.
+"""The gcloud colab executions command group."""
+
+from googlecloudsdk.calliope import base
+
+
+@base.DefaultUniverseOnly
+@base.ReleaseTracks(base.ReleaseTrack.GA, base.ReleaseTrack.BETA)
+class Executions(base.Group):
+  # pylint: disable=g-doc - this is required for help text.
+  """Manage Colab Enterprise notebook execution jobs.
+
+  For more information about executions, see
+  https://cloud.google.com/colab/docs/schedule-notebook-run.
+  """

gcloud auth application-default login/google-cloud-sdk/lib/surface/colab/executions/create.py

@@ -0,0 +1,79 @@
+# -*- 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.
+
+"""Create command for Colab Enterprise Executions."""
+
+from googlecloudsdk.api_lib.ai import operations
+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': """
+        Create a notebook execution to be used on a Colab Enterprise runtime.
+    """,
+    'EXAMPLES': """
+        To create an execution of a notebook file with Cloud Storage URI `gs://my-bucket/my-notebook.ipynb`, with an execution job display name `my-execution`, compute configured from runtime template `my-runtime-template-id`, running with service account `my-service-account@my-project.iam.gserviceaccount.com`, with results uploaded to Cloud Storage bucket `gs://my-bucket/results`, and in region `us-central1` run:
+
+         $ {command} --display-name=my-execution --runtime-template=my-runtime-template-id --gcs-notebook-uri=gs://my-bucket/my-notebook.ipynb --service-account=my-service-account@my-project.iam.gserviceaccount.com --gcs-output-uri=gs://my-bucket/results --region=us-central1
+    """,
+}
+
+
+@base.DefaultUniverseOnly
+@base.ReleaseTracks(base.ReleaseTrack.GA, base.ReleaseTrack.BETA)
+class Create(base.CreateCommand):
+  """Create an execution."""
+
+  @staticmethod
+  def Args(parser):
+    """Register flags for this command."""
+    flags.AddCreateExecutionFlags(parser)
+
+  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']
+    with endpoint_util.AiplatformEndpointOverrides(
+        version='BETA', region=region
+    ):
+      api_client = util.GetClient(release_track)
+      executions_service = (
+          api_client.projects_locations_notebookExecutionJobs
+      )
+      operation = executions_service.Create(
+          executions_util.CreateExecutionCreateRequest(
+              args, messages
+          )
+      )
+      return util.WaitForOpMaybe(
+          operations_client=operations.OperationsClient(client=api_client),
+          op=operation,
+          op_ref=executions_util.ParseExecutionOperation(
+              operation.name
+          ),
+          asynchronous=util.GetAsyncConfig(args),
+          kind='notebook execution',
+          log_method='create',
+          message='Waiting for execution to be created...',
+      )
+
+
+Create.detailed_help = _DETAILED_HELP

gcloud auth application-default login/google-cloud-sdk/lib/surface/colab/executions/delete.py

@@ -0,0 +1,80 @@
+# -*- 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.
+
+"""Delete command for Colab Enterprise Executions."""
+
+from googlecloudsdk.api_lib.ai import operations
+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': """
+        Delete a Colab Enterprise notebook execution.
+    """,
+    'EXAMPLES': """
+        To delete an execution with id `my-execution`, in region `us-central1`, run:
+
+         $ {command} my-execution --region=us-central1
+    """,
+}
+
+
+@base.DefaultUniverseOnly
+@base.ReleaseTracks(base.ReleaseTrack.GA, base.ReleaseTrack.BETA)
+class Delete(base.DeleteCommand):
+  """Delete an execution."""
+
+  @staticmethod
+  def Args(parser):
+    """Register flags for this command."""
+    flags.AddDeleteExecutionFlags(parser)
+
+  def Run(self, args):
+    """This is what gets called when the user runs this command."""
+    release_track = self.ReleaseTrack()
+    messages = util.GetMessages(self.ReleaseTrack())
+    execution_ref = args.CONCEPTS.execution.Parse()
+    region = execution_ref.AsDict()['locationsId']
+    with endpoint_util.AiplatformEndpointOverrides(
+        version='BETA', region=region
+    ):
+      api_client = util.GetClient(release_track)
+      executions_service = (
+          api_client.projects_locations_notebookExecutionJobs
+      )
+      executions_util.ValidateAndGetColabExecution(args, messages, executions_service)
+      operation = executions_service.Delete(
+          executions_util.CreateExecutionDeleteRequest(
+              args, messages
+          )
+      )
+      return util.WaitForOpMaybe(
+          operations_client=operations.OperationsClient(client=api_client),
+          op=operation,
+          op_ref=executions_util.ParseExecutionOperation(
+              operation.name
+          ),
+          asynchronous=util.GetAsyncConfig(args),
+          kind='notebook execution',
+          log_method='delete',
+          message='Waiting for execution to be deleted...',
+      )
+
+
+Delete.detailed_help = _DETAILED_HELP

gcloud auth application-default login/google-cloud-sdk/lib/surface/colab/executions/describe.py

@@ -0,0 +1,66 @@
+# -*- 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.
+
+"""Describe command for Colab Enterprise Executions."""
+
+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': """
+        Describe a Colab Enterprise notebook execution.
+    """,
+    'EXAMPLES': """
+        To describe a notebook execution with id `my-execution` in region `us-central1`, run:
+
+        $ {command} my-execution --region=us-central1
+    """,
+}
+
+
+@base.DefaultUniverseOnly
+@base.ReleaseTracks(base.ReleaseTrack.GA, base.ReleaseTrack.BETA)
+class Describe(base.DescribeCommand):
+  """Describe an execution."""
+
+  @staticmethod
+  def Args(parser):
+    """Register flags for this command."""
+    flags.AddDescribeExecutionFlags(parser)
+
+  def Run(self, args):
+    """This is what gets called when the user runs this command."""
+    release_track = self.ReleaseTrack()
+    messages = util.GetMessages(self.ReleaseTrack())
+    execution_ref = args.CONCEPTS.execution.Parse()
+    region = execution_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 executions_util.ValidateAndGetColabExecution(
+          args, messages, executions_service
+      )
+
+
+Describe.detailed_help = _DETAILED_HELP

gcloud auth application-default login/google-cloud-sdk/lib/surface/colab/executions/list.py

@@ -0,0 +1,80 @@
+# -*- 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 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 Colab Enterprise notebook 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.GA, base.ReleaseTrack.BETA)
+class List(base.ListCommand):
+  """List your Colab Enterprise notebook execution jobs."""
+
+  @staticmethod
+  def Args(parser):
+    """Register flags for this command."""
+    flags.AddListExecutionsFlags(parser)
+    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."""
+    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(
+          service=executions_service,
+          request=executions_util.CreateExecutionListRequest(args, messages),
+          field='notebookExecutionJobs',
+          limit=args.limit,
+          batch_size_attribute='pageSize',
+          batch_size=args.page_size,
+          predicate=lambda execution: not executions_util.IsWorkbenchExecution(
+              execution
+          ),
+      )
+
+
+List.detailed_help = _DETAILED_HELP