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

gcloud auth application-default login/google-cloud-sdk/lib/surface/ai/tensorboard_runs/__init__.py

@@ -0,0 +1,28 @@
+# -*- coding: utf-8 -*- #
+# Copyright 2021 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.
+"""Command group for ai-platform Tensorboard Run."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+from googlecloudsdk.calliope import base
+
+
+@base.ReleaseTracks(base.ReleaseTrack.ALPHA, base.ReleaseTrack.BETA)
+class TensorboardRun(base.Group):
+  """Manage Vertex AI Tensorboard runs."""
+
+  category = base.VERTEX_AI_CATEGORY

gcloud auth application-default login/google-cloud-sdk/lib/surface/ai/tensorboard_runs/create.py

@@ -0,0 +1,82 @@
+# -*- coding: utf-8 -*- #
+# Copyright 2021 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.
+"""Vertex AI Tensorboard run create command."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+from apitools.base.py import encoding
+from googlecloudsdk.api_lib.ai.tensorboard_runs import client
+from googlecloudsdk.calliope import base
+from googlecloudsdk.command_lib.ai import constants
+from googlecloudsdk.command_lib.ai import endpoint_util
+from googlecloudsdk.command_lib.ai import flags
+from googlecloudsdk.command_lib.ai import validation
+from googlecloudsdk.command_lib.util.args import labels_util
+from googlecloudsdk.core import log
+
+
+def _AddArgs(parser):
+  flags.AddTensorboardExperimentResourceArg(parser,
+                                            'to create a Tensorboard run')
+  flags.GetDisplayNameArg('tensorboard-run', required=True).AddToParser(parser)
+  flags.GetDescriptionArg('tensorboard-run').AddToParser(parser)
+  labels_util.AddCreateLabelsFlags(parser)
+  flags.GetTensorboardRunIdArg(required=True).AddToParser(parser)
+
+
+def _Run(args, version):
+  """Create a new Vertex AI Tensorboard run."""
+  tensorboard_exp_ref = args.CONCEPTS.tensorboard_experiment.Parse()
+  region = tensorboard_exp_ref.AsDict()['locationsId']
+  with endpoint_util.AiplatformEndpointOverrides(version, region=region):
+    tensorboard_runs_client = client.TensorboardRunsClient(version=version)
+    response = tensorboard_runs_client.Create(tensorboard_exp_ref, args)
+    response_msg = encoding.MessageToPyValue(response)
+    if 'name' in response_msg:
+      log.status.Print(('Created Vertex AI Tensorboard run: {}.').format(
+          response_msg['name']))
+    return response
+
+
+@base.ReleaseTracks(base.ReleaseTrack.BETA, base.ReleaseTrack.ALPHA)
+class CreateBeta(base.CreateCommand):
+  """Create a new Vertex AI Tensorboard run."""
+
+  detailed_help = {
+      'EXAMPLES':
+          """\
+          To create a Tensorboard Run `my-tensorboard-run` in Tensorboard `12345` and Tensorboard Experiment `my-tensorboard-experiment, with the display name `my tensorboard run`:
+
+              $ {command} my-tensorboard-experiment --tensorboard-run-id=my-tensorboard-run --tensorboard-id=12345 --display-name="my tensorboard run"
+
+          You may also provide a description and/or labels:
+
+              $ {command} my-tensorboard-experiment --tensorboard-run-id=my-tensorboard-run --tensorboard-id=12345 --description="my description" --labels="label1=value1" --labels="label2=value2"
+
+          To create a Tensorboard Run `my-tensorboard-run` in Tensorboard `12345`, Tensorboard Experiment `my-tensorboard-experiment, region `us-central1`, and project `my-project`:
+
+              $ {command} projects/my-project/locations/us-central1/tensorboards/12345/experiments/my-tensorboard-experiment --tensorboard-run-id=my-tensorboard-run
+          """,
+  }
+
+  @staticmethod
+  def Args(parser):
+    _AddArgs(parser)
+
+  def Run(self, args):
+    validation.ValidateDisplayName(args.display_name)
+    return _Run(args, constants.BETA_VERSION)

gcloud auth application-default login/google-cloud-sdk/lib/surface/ai/tensorboard_runs/delete.py

@@ -0,0 +1,66 @@
+# -*- coding: utf-8 -*- #
+# Copyright 2021 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.
+"""Command to delete a Tensorboard run in Vertex AI."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+from googlecloudsdk.api_lib.ai import operations
+from googlecloudsdk.api_lib.ai.tensorboard_runs import client
+from googlecloudsdk.calliope import base
+from googlecloudsdk.command_lib.ai import constants
+from googlecloudsdk.command_lib.ai import endpoint_util
+from googlecloudsdk.command_lib.ai import flags
+from googlecloudsdk.command_lib.ai import operations_util
+from googlecloudsdk.command_lib.ai import tensorboards_util
+
+
+def _Run(args, version):
+  tensorboard_run_ref = args.CONCEPTS.tensorboard_run.Parse()
+  region = tensorboard_run_ref.AsDict()['locationsId']
+  with endpoint_util.AiplatformEndpointOverrides(
+      version=version, region=region):
+    operation = client.TensorboardRunsClient(
+        version=version).Delete(tensorboard_run_ref)
+    return operations_util.WaitForOpMaybe(
+        operations_client=operations.OperationsClient(),
+        op=operation,
+        op_ref=tensorboards_util.ParseTensorboardOperation(operation.name))
+
+
+@base.ReleaseTracks(base.ReleaseTrack.BETA, base.ReleaseTrack.ALPHA)
+class DeleteBeta(base.DeleteCommand):
+  """Delete an existing Vertex AI Tensorboard run."""
+
+  detailed_help = {
+      'EXAMPLES':
+          """\
+          To delete a Tensorboard Run `my-tensorboard-run` in Tensorboard `12345`, Tensorboard Experiment `my-tensorboard-experiment`, region `us-central1`, and project `my-project`:
+
+              $ {command} projects/my-project/locations/us-central1/tensorboards/12345/experiments/my-tensorboard-experiment/runs/my-tensorboard-run
+
+          Or with flags:
+
+              $ {command} my-tensorboard-run --tensorboard-id=12345 --tensorboard-experiment-id=my-tensorboard-experiment
+          """,
+  }
+
+  @staticmethod
+  def Args(parser):
+    flags.AddTensorboardRunResourceArg(parser, 'to delete')
+
+  def Run(self, args):
+    return _Run(args, constants.BETA_VERSION)

gcloud auth application-default login/google-cloud-sdk/lib/surface/ai/tensorboard_runs/describe.py

@@ -0,0 +1,60 @@
+# -*- coding: utf-8 -*- #
+# Copyright 2021 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.
+"""Command to get a Tensorboard run in Vertex AI."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+from googlecloudsdk.api_lib.ai.tensorboard_runs import client
+from googlecloudsdk.calliope import base
+from googlecloudsdk.command_lib.ai import constants
+from googlecloudsdk.command_lib.ai import endpoint_util
+from googlecloudsdk.command_lib.ai import flags
+
+
+def _Run(args, version):
+  tensorboard_run_ref = args.CONCEPTS.tensorboard_run.Parse()
+  region = tensorboard_run_ref.AsDict()['locationsId']
+  with endpoint_util.AiplatformEndpointOverrides(
+      version=version, region=region):
+    response = client.TensorboardRunsClient(
+        version=version).Get(tensorboard_run_ref)
+    return response
+
+
+@base.ReleaseTracks(base.ReleaseTrack.BETA, base.ReleaseTrack.ALPHA)
+class DescribeBeta(base.DescribeCommand):
+  """Get detailed Tensorboard run information about the given Tensorboard run id."""
+
+  detailed_help = {
+      'EXAMPLES':
+          """\
+          To describe a Tensorboard Run `my-tensorboard-run` in Tensorboard `12345`, Tensorboard Experiment `my-tensorboard-experiment`, region `us-central1`, and project `my-project`:
+
+              $ {command} projects/my-project/locations/us-central1/tensorboards/12345/experiments/my-tensorboard-experiment/runs/my-tensorboard-run
+
+          Or with flags:
+
+              $ {command} my-tensorboard-run --tensorboard-id=12345 --tensorboard-experiment-id=my-tensorboard-experiment
+          """,
+  }
+
+  @staticmethod
+  def Args(parser):
+    flags.AddTensorboardRunResourceArg(parser, 'to describe')
+
+  def Run(self, args):
+    return _Run(args, constants.BETA_VERSION)

gcloud auth application-default login/google-cloud-sdk/lib/surface/ai/tensorboard_runs/list.py

@@ -0,0 +1,81 @@
+# -*- coding: utf-8 -*- #
+# Copyright 2021 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.
+"""Command to list Tensorboard runs in Vertex AI."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+from googlecloudsdk.api_lib.ai.tensorboard_runs import client
+from googlecloudsdk.calliope import base
+from googlecloudsdk.command_lib.ai import constants
+from googlecloudsdk.command_lib.ai import endpoint_util
+from googlecloudsdk.command_lib.ai import flags
+from googlecloudsdk.command_lib.util.concepts import concept_parsers
+from googlecloudsdk.core import resources
+
+
+def _GetUriBeta(tensorboard_exp):
+  ref = resources.REGISTRY.ParseRelativeName(
+      tensorboard_exp.name,
+      constants.TENSORBOARD_RUNS_COLLECTION,
+      api_version=constants.AI_PLATFORM_API_VERSION[constants.BETA_VERSION])
+  return ref.SelfLink()
+
+
+def _AddArgs(parser):
+  concept_parsers.ConceptParser.ForResource(
+      '--tensorboard-experiment-id',
+      flags.GetTensorboardExperimentResourceSpec(),
+      'To list Tensorboard runs',
+      required=True).AddToParser(parser)
+
+
+def _Run(args, version):
+  tensorboard_exp_ref = args.CONCEPTS.tensorboard_experiment_id.Parse()
+  region = tensorboard_exp_ref.AsDict()['locationsId']
+  with endpoint_util.AiplatformEndpointOverrides(
+      version=version, region=region):
+    return client.TensorboardRunsClient(version=version).List(
+        tensorboard_exp_ref=tensorboard_exp_ref,
+        limit=args.limit,
+        page_size=args.page_size,
+        sort_by=args.sort_by)
+
+
+@base.ReleaseTracks(base.ReleaseTrack.BETA, base.ReleaseTrack.ALPHA)
+class ListBeta(base.ListCommand):
+  """List the Tensorboard runs of the given project, region, and Tensorboard experiment."""
+
+  detailed_help = {
+      'EXAMPLES':
+          """\
+          To list Tensorboard Runs in Tensorboard `12345` and Tensorboard Experiment `my-tensorboard-experiment`:
+
+              $ {command} --tensorboard-id=12345 --tensorboard-experiment-id=my-tensorboard-experiment
+          """,
+  }
+
+  @staticmethod
+  def Args(parser):
+    concept_parsers.ConceptParser.ForResource(
+        '--tensorboard-experiment-id',
+        flags.GetTensorboardExperimentResourceSpec(),
+        'To list Tensorboard runs',
+        required=True).AddToParser(parser)
+    parser.display_info.AddUriFunc(_GetUriBeta)
+
+  def Run(self, args):
+    return _Run(args, constants.BETA_VERSION)

gcloud auth application-default login/google-cloud-sdk/lib/surface/ai/tensorboard_runs/update.py

@@ -0,0 +1,82 @@
+# -*- coding: utf-8 -*- #
+# Copyright 2021 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.
+"""Command to update a Tensorboard run in Vertex AI."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+from googlecloudsdk.api_lib.ai.tensorboard_runs import client
+from googlecloudsdk.calliope import base
+from googlecloudsdk.command_lib.ai import constants
+from googlecloudsdk.command_lib.ai import endpoint_util
+from googlecloudsdk.command_lib.ai import errors
+from googlecloudsdk.command_lib.ai import flags
+from googlecloudsdk.command_lib.util.args import labels_util
+from googlecloudsdk.core import log
+
+
+def _AddArgs(parser):
+  flags.AddTensorboardRunResourceArg(parser, 'to update')
+  flags.GetDisplayNameArg('tensorboard run', required=False).AddToParser(parser)
+  flags.GetDescriptionArg('tensorboard run').AddToParser(parser)
+  labels_util.AddUpdateLabelsFlags(parser)
+
+
+def _Run(args, version):
+  """Update an existing Vertex AI Tensorboard run."""
+  tensorboard_run_ref = args.CONCEPTS.tensorboard_run.Parse()
+  args.region = tensorboard_run_ref.AsDict()['locationsId']
+  with endpoint_util.AiplatformEndpointOverrides(version, region=args.region):
+    try:
+      op = client.TensorboardRunsClient(version=version).Patch(
+          tensorboard_run_ref, args)
+    except errors.NoFieldsSpecifiedError:
+      available_update_args = [
+          'display_name', 'update_labels', 'clear_labels', 'remove_labels',
+          'description'
+      ]
+      if not any(args.IsSpecified(arg) for arg in available_update_args):
+        raise
+      log.status.Print('No update to perform.')
+      return None
+    else:
+      log.UpdatedResource(op.name, kind='Vertex AI Tensorboard run')
+      return op
+
+
+@base.ReleaseTracks(base.ReleaseTrack.BETA, base.ReleaseTrack.ALPHA)
+class UpdateBeta(base.UpdateCommand):
+  """Update an existing Vertex AI Tensorboard run."""
+
+  detailed_help = {
+      'EXAMPLES':
+          """\
+          To update Tensorboard Time Run `my-tensorboard-run` in Tensorboard `12345`, Tensorboard Experiment `my-tensorboard-experiment`, with the display name `updated display name`:
+
+              $ {command} projects/my-project/locations/us-central1/tensorboards/12345/experiments/my-tensorboard-experiment/runs/my-tensorboard-run --display-name="updated display name"
+
+          Or with flags:
+
+              $ {command} my-tensorboard-run --tensorboard-id=12345 --tensorboard-experiment-id=my-tensorboard-experiment --display-name="updated display name"
+          """,
+  }
+
+  @staticmethod
+  def Args(parser):
+    _AddArgs(parser)
+
+  def Run(self, args):
+    return _Run(args, constants.BETA_VERSION)