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

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

@@ -0,0 +1,89 @@
+# -*- 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 Schedules."""
+
+from googlecloudsdk.api_lib.colab_enterprise import util
+from googlecloudsdk.api_lib.notebook_executor import schedules as schedules_util
+from googlecloudsdk.calliope import base
+from googlecloudsdk.command_lib.ai import endpoint_util
+from googlecloudsdk.command_lib.notebook_executor import flags
+from googlecloudsdk.core import log
+
+_DETAILED_HELP = {
+    'DESCRIPTION': """
+        Create a schedule to run a Colab Enterprise notebook execution job.
+    """,
+    'EXAMPLES': """
+      To create a schedule in region `us-central1` with the following schedule properties:
+        - display name: `my-schedule`,
+        - cron schedule: `TZ=America/Los_Angeles * * * * *`,
+        - maximum concurrent runs allowed: 1,
+        - start time: 2025-01-01T00:00:00-06:00,
+
+      for a notebook execution job:
+        - with display name `my-execution`,
+        - running notebook file from Cloud Storage URI `gs://my-bucket/my-notebook.ipynb`,
+        - 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`
+
+      Run the following command:
+        $ {command} --region=us-central1 --display-name=my-schedule --cron-schedule='TZ=America/Los_Angeles * * * * *' --max-concurrent-runs=1 --start-time=2025-01-01T00:00:00-06:00 --execution-display-name=my-execution --notebook-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
+    """,
+}
+
+
+@base.DefaultUniverseOnly
+@base.ReleaseTracks(base.ReleaseTrack.GA, base.ReleaseTrack.BETA)
+class Create(base.CreateCommand):
+  """Create a schedule."""
+
+  @staticmethod
+  def Args(parser):
+    """Register flags for this command.
+
+    Args:
+      parser: argparse parser for the command
+    """
+    flags.AddCreateOrUpdateScheduleFlags(parser, is_update=False)
+
+  def Run(self, args):
+    """This is what gets called when the user runs this command.
+
+    Args:
+      args: argparse.Namespace, The arguments that this command was invoked
+        with.
+
+    Returns:
+      The API response for creating the schedule.
+    """
+    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)
+      schedules_service = api_client.projects_locations_schedules
+      schedule = schedules_service.Create(
+          schedules_util.CreateScheduleCreateRequest(args, messages)
+      )
+      log.CreatedResource(resource=schedule.name, kind='schedule')
+      return schedule
+
+
+Create.detailed_help = _DETAILED_HELP

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

@@ -0,0 +1,82 @@
+# -*- 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 Schedules."""
+
+from googlecloudsdk.api_lib.ai import operations
+from googlecloudsdk.api_lib.colab_enterprise import util
+from googlecloudsdk.api_lib.notebook_executor import schedules as schedules_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 schedule.
+    """,
+    'EXAMPLES': """
+        To delete a schedule with id `my-schedule`, in region `us-central1`, run:
+
+         $ {command} my-schedule --region=us-central1
+    """,
+}
+
+
+@base.DefaultUniverseOnly
+@base.ReleaseTracks(base.ReleaseTrack.GA, base.ReleaseTrack.BETA)
+class Delete(base.DeleteCommand):
+  """Delete a schedule."""
+
+  @staticmethod
+  def Args(parser):
+    """Register flags for this command."""
+    flags.AddDeleteScheduleFlags(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())
+    schedule_ref = args.CONCEPTS.schedule.Parse()
+    region = schedule_ref.AsDict()['locationsId']
+    with endpoint_util.AiplatformEndpointOverrides(
+        version='BETA', region=region
+    ):
+      api_client = util.GetClient(release_track)
+      schedules_service = (
+          api_client.projects_locations_schedules
+      )
+      schedules_util.ValidateAndGetColabSchedule(
+          args, messages, schedules_service
+      )
+      operation = schedules_service.Delete(
+          schedules_util.CreateScheduleDeleteRequest(
+              args, messages
+          )
+      )
+      return util.WaitForOpMaybe(
+          operations_client=operations.OperationsClient(client=api_client),
+          op=operation,
+          op_ref=schedules_util.ParseScheduleOperation(
+              operation.name
+          ),
+          asynchronous=util.GetAsyncConfig(args),
+          kind='schedule',
+          log_method='delete',
+          message='Waiting for schedule to be deleted...',
+      )
+
+
+Delete.detailed_help = _DETAILED_HELP

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

@@ -0,0 +1,76 @@
+# -*- 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 Schedules."""
+
+from googlecloudsdk.api_lib.colab_enterprise import util
+from googlecloudsdk.api_lib.notebook_executor import schedules as schedules_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 schedule.
+    """,
+    'EXAMPLES': """
+        To describe a schedule with id `my-schedule` in region `us-central1`, run:
+
+        $ {command} my-schedule --region=us-central1
+    """,
+}
+
+
+@base.DefaultUniverseOnly
+@base.ReleaseTracks(base.ReleaseTrack.GA, base.ReleaseTrack.BETA)
+class Describe(base.DescribeCommand):
+  """Describe a schedule."""
+
+  @staticmethod
+  def Args(parser):
+    """Register flags for this command.
+
+    Args:
+      parser: argparse parser for the command
+    """
+    flags.AddDescribeScheduleFlags(parser)
+
+  def Run(self, args):
+    """This is what gets called when the user runs this command.
+
+    Args:
+      args: argparse.Namespace, The arguments that this command was invoked
+        with.
+
+    Returns:
+      The API response for describing the schedule.
+    """
+    release_track = self.ReleaseTrack()
+    messages = util.GetMessages(self.ReleaseTrack())
+    schedule_ref = args.CONCEPTS.schedule.Parse()
+    region = schedule_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)
+      schedules_service = api_client.projects_locations_schedules
+      return schedules_util.ValidateAndGetColabSchedule(
+          args, messages, schedules_service
+      )
+
+
+Describe.detailed_help = _DETAILED_HELP

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

@@ -0,0 +1,83 @@
+# -*- 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 Schedules."""
+
+from apitools.base.py import list_pager
+from googlecloudsdk.api_lib.colab_enterprise import util
+from googlecloudsdk.api_lib.notebook_executor import schedules as schedules_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 execution schedules in a given region.
+    """,
+    'EXAMPLES': """
+        To list your schedules 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 schedules."""
+
+  @staticmethod
+  def Args(parser):
+    """Register flags for this command."""
+    flags.AddListSchedulesFlags(parser)
+    parser.display_info.AddFormat("""
+        table(name.segment(-1):label=ID,
+        displayName,
+        state,
+        cron,
+        nextRunTime)
+    """)
+
+  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)
+      schedules_service = (
+          api_client.projects_locations_schedules
+      )
+      return list_pager.YieldFromList(
+          service=schedules_service,
+          request=schedules_util.CreateScheduleListRequest(
+              args, messages
+          ),
+          field='schedules',
+          limit=args.limit,
+          batch_size_attribute='pageSize',
+          batch_size=args.page_size,
+          predicate=lambda schedule: not schedules_util.FilterWorkbenchSchedule(
+              schedule
+          ),
+      )
+
+List.detailed_help = _DETAILED_HELP

gcloud auth application-default login/google-cloud-sdk/lib/surface/colab/schedules/pause.py

@@ -0,0 +1,72 @@
+# -*- 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.
+
+"""Pause command for Colab Enterprise Schedules."""
+
+from googlecloudsdk.api_lib.colab_enterprise import util
+from googlecloudsdk.api_lib.notebook_executor import schedules as schedules_util
+from googlecloudsdk.calliope import base
+from googlecloudsdk.command_lib.ai import endpoint_util
+from googlecloudsdk.command_lib.notebook_executor import flags
+from googlecloudsdk.core import log
+
+
+_DETAILED_HELP = {
+    'DESCRIPTION': """
+        Pause a Colab Enterprise notebook execution schedule.
+    """,
+    'EXAMPLES': """
+        To pause a schedule with id `my-schedule`, in region `us-central1`, run:
+
+         $ {command} my-schedule --region=us-central1
+    """,
+}
+
+
+@base.DefaultUniverseOnly
+@base.ReleaseTracks(base.ReleaseTrack.GA, base.ReleaseTrack.BETA)
+class Pause(base.UpdateCommand):
+  """Pause a schedule."""
+
+  @staticmethod
+  def Args(parser):
+    """Register flags for this command."""
+    flags.AddPauseScheduleFlags(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())
+    schedule_ref = args.CONCEPTS.schedule.Parse()
+    region = schedule_ref.AsDict()['locationsId']
+    with endpoint_util.AiplatformEndpointOverrides(
+        version='BETA', region=region
+    ):
+      api_client = util.GetClient(release_track)
+      schedules_service = (
+          api_client.projects_locations_schedules
+      )
+      schedules_util.ValidateAndGetColabSchedule(
+          args, messages, schedules_service
+      )
+      api_response = schedules_service.Pause(
+          schedules_util.CreateSchedulePauseRequest(
+              args, messages
+          )
+      )
+      log.status.Print('Paused schedule.')
+      return api_response
+
+Pause.detailed_help = _DETAILED_HELP

gcloud auth application-default login/google-cloud-sdk/lib/surface/colab/schedules/resume.py

@@ -0,0 +1,72 @@
+# -*- 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.
+
+"""Resume command for Colab Enterprise Schedules."""
+
+from googlecloudsdk.api_lib.colab_enterprise import util
+from googlecloudsdk.api_lib.notebook_executor import schedules as schedules_util
+from googlecloudsdk.calliope import base
+from googlecloudsdk.command_lib.ai import endpoint_util
+from googlecloudsdk.command_lib.notebook_executor import flags
+from googlecloudsdk.core import log
+
+
+_DETAILED_HELP = {
+    'DESCRIPTION': """
+        Resume a Colab Enterprise notebook execution schedule.
+    """,
+    'EXAMPLES': """
+        To resume a paused schedule with id `my-schedule`, in region `us-central1`, run:
+
+         $ {command} my-schedule --region=us-central1
+    """,
+}
+
+
+@base.DefaultUniverseOnly
+@base.ReleaseTracks(base.ReleaseTrack.GA, base.ReleaseTrack.BETA)
+class Resume(base.UpdateCommand):
+  """Resume a schedule."""
+
+  @staticmethod
+  def Args(parser):
+    """Register flags for this command."""
+    flags.AddResumeScheduleFlags(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())
+    schedule_ref = args.CONCEPTS.schedule.Parse()
+    region = schedule_ref.AsDict()['locationsId']
+    with endpoint_util.AiplatformEndpointOverrides(
+        version='BETA', region=region
+    ):
+      api_client = util.GetClient(release_track)
+      schedules_service = (
+          api_client.projects_locations_schedules
+      )
+      schedules_util.ValidateAndGetColabSchedule(
+          args, messages, schedules_service
+      )
+      api_response = schedules_service.Resume(
+          schedules_util.CreateScheduleResumeRequest(
+              args, messages
+          )
+      )
+      log.status.Print('Resumed schedule.')
+      return api_response
+
+Resume.detailed_help = _DETAILED_HELP

gcloud auth application-default login/google-cloud-sdk/lib/surface/colab/schedules/update.py

@@ -0,0 +1,83 @@
+# -*- 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.
+
+"""Update command for Colab Enterprise Schedules."""
+
+from googlecloudsdk.api_lib.colab_enterprise import util
+from googlecloudsdk.api_lib.notebook_executor import schedules as schedules_util
+from googlecloudsdk.calliope import base
+from googlecloudsdk.command_lib.ai import endpoint_util
+from googlecloudsdk.command_lib.notebook_executor import flags
+from googlecloudsdk.core import log
+
+_DETAILED_HELP = {
+    'DESCRIPTION': """
+        Update a Colab Enterprise notebook execution schedule.
+    """,
+    'EXAMPLES': """
+        To update the cron schedule and max runs of a schedule with id `my-schedule`, in region `us-central1`, run:
+
+        $ {command} my-schedule --region=us-central1 --cron-schedule='TZ=America/Los_Angeles 0 0 * * 0' --max-runs=2
+    """,
+}
+
+
+@base.DefaultUniverseOnly
+@base.ReleaseTracks(base.ReleaseTrack.GA, base.ReleaseTrack.BETA)
+class Update(base.UpdateCommand):
+  """Update a schedule."""
+
+  @staticmethod
+  def Args(parser):
+    """Register flags for this command.
+
+    Args:
+      parser: argparse parser for the command
+    """
+    flags.AddCreateOrUpdateScheduleFlags(parser, is_update=True)
+
+  def Run(self, args):
+    """This is what gets called when the user runs this command.
+
+    Args:
+      args: argparse.Namespace, The arguments that this command was invoked
+        with.
+
+    Returns:
+      The API response for updating the schedule.
+    """
+    release_track = self.ReleaseTrack()
+    messages = util.GetMessages(self.ReleaseTrack())
+    schedule_ref = args.CONCEPTS.schedule.Parse()
+    region = schedule_ref.AsDict()['locationsId']
+    with endpoint_util.AiplatformEndpointOverrides(
+        version='BETA', region=region
+    ):
+      api_client = util.GetClient(release_track)
+      schedules_service = (
+          api_client.projects_locations_schedules
+      )
+      # Although API will error if schedule is not of notebook execution type,
+      # validate client-side for better ux / consistency with other commands.
+      schedules_util.ValidateAndGetColabSchedule(
+          args, messages, schedules_service
+      )
+      schedule = schedules_service.Patch(
+          schedules_util.CreateSchedulePatchRequest(args, messages)
+      )
+      log.UpdatedResource(resource=schedule.name, kind='schedule')
+      return schedule
+
+Update.detailed_help = _DETAILED_HELP