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/tensorboards/__init__.py

@@ -0,0 +1,29 @@
+# -*- coding: utf-8 -*- #
+# Copyright 2020 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."""
+
+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,
+                    base.ReleaseTrack.GA)
+class Tensorboard(base.Group):
+  """Manage Vertex AI Tensorboards."""
+
+  category = base.VERTEX_AI_CATEGORY

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

@@ -0,0 +1,119 @@
+# -*- 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 endpoints 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 import operations
+from googlecloudsdk.api_lib.ai.tensorboards 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
+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.AddRegionResourceArg(parser, 'to create a Tensorboard')
+  flags.GetDisplayNameArg('tensorboard').AddToParser(parser)
+  flags.GetDescriptionArg('tensorboard').AddToParser(parser)
+  flags.AddKmsKeyResourceArg(parser, 'tensorboard')
+  labels_util.AddCreateLabelsFlags(parser)
+
+
+def _Run(args, version):
+  """Create a new Vertex AI Tensorboard."""
+  validation.ValidateDisplayName(args.display_name)
+
+  region_ref = args.CONCEPTS.region.Parse()
+  args.region = region_ref.AsDict()['locationsId']
+  with endpoint_util.AiplatformEndpointOverrides(version, region=args.region):
+    tensorboards_client = client.TensorboardsClient(version=version)
+    operation_client = operations.OperationsClient()
+    op = tensorboards_client.Create(region_ref, args)
+    response_msg = operations_util.WaitForOpMaybe(
+        operation_client, op,
+        tensorboards_util.ParseTensorboardOperation(op.name))
+    if response_msg is not None:
+      response = encoding.MessageToPyValue(response_msg)
+      if 'name' in response:
+        log.status.Print(
+            ('Created Vertex AI Tensorboard: {}.').format(response['name']))
+    return response_msg
+
+
+@base.ReleaseTracks(base.ReleaseTrack.GA)
+class CreateGa(base.CreateCommand):
+  """Create a new Vertex AI Tensorboard."""
+
+  detailed_help = {
+      'EXAMPLES':
+          """\
+          To create a Tensorboard with the display name `my tensorboard`:
+
+              $ {command} --display-name="my tensorboard"
+
+          You may also provide a description:
+
+              $ {command} --description="my description"
+
+          You may also provide labels:
+
+              $ {command} --labels="label1=value1" --labels="label2=value2"
+          """,
+  }
+
+  @staticmethod
+  def Args(parser):
+    _AddArgs(parser)
+
+  def Run(self, args):
+    return _Run(args, constants.GA_VERSION)
+
+
+@base.ReleaseTracks(base.ReleaseTrack.BETA, base.ReleaseTrack.ALPHA)
+class CreateBeta(base.CreateCommand):
+  """Create a new Vertex AI Tensorboard."""
+
+  detailed_help = {
+      'EXAMPLES':
+          """\
+          To create a Tensorboard with the display name `my tensorboard`:
+
+              $ {command} --display-name="my tensorboard"
+
+          You may also provide a description:
+
+              $ {command} --description="my description"
+
+          You may also provide labels:
+
+              $ {command} --labels="label1=value1" --labels="label2=value2"
+          """,
+  }
+
+  @staticmethod
+  def Args(parser):
+    _AddArgs(parser)
+
+  def Run(self, args):
+    return _Run(args, constants.BETA_VERSION)

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

@@ -0,0 +1,91 @@
+# -*- 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 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.tensorboards 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_ref = args.CONCEPTS.tensorboard.Parse()
+  region = tensorboard_ref.AsDict()['locationsId']
+  with endpoint_util.AiplatformEndpointOverrides(
+      version=version, region=region):
+    operation = client.TensorboardsClient(
+        version=version).Delete(tensorboard_ref)
+    return operations_util.WaitForOpMaybe(
+        operations_client=operations.OperationsClient(),
+        op=operation,
+        op_ref=tensorboards_util.ParseTensorboardOperation(operation.name))
+
+
+@base.ReleaseTracks(base.ReleaseTrack.GA)
+class DeleteGa(base.DeleteCommand):
+  """Delete an existing Vertex AI Tensorboard."""
+
+  detailed_help = {
+      'EXAMPLES':
+          """\
+          To delete a Tensorboard `12345` in region `us-central1` and project `my-project`:
+
+              $ {command} projects/my-project/locations/us-central1/tensorboards/12345
+
+          Or with flags:
+
+              $ {command} 12345
+          """,
+  }
+
+  @staticmethod
+  def Args(parser):
+    flags.AddTensorboardResourceArg(parser, 'to delete')
+
+  def Run(self, args):
+    return _Run(args, constants.GA_VERSION)
+
+
+@base.ReleaseTracks(base.ReleaseTrack.BETA, base.ReleaseTrack.ALPHA)
+class DeleteBeta(base.DeleteCommand):
+  """Delete an existing Vertex AI Tensorboard."""
+
+  detailed_help = {
+      'EXAMPLES':
+          """\
+          To delete a Tensorboard `12345` in region `us-central1` and project `my-project`:
+
+              $ {command} projects/my-project/locations/us-central1/tensorboards/12345
+
+          Or with flags:
+
+              $ {command} 12345
+          """,
+  }
+
+  @staticmethod
+  def Args(parser):
+    flags.AddTensorboardResourceArg(parser, 'to delete')
+
+  def Run(self, args):
+    return _Run(args, constants.BETA_VERSION)

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

@@ -0,0 +1,84 @@
+# -*- 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 in Vertex AI."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+from googlecloudsdk.api_lib.ai.tensorboards 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_ref = args.CONCEPTS.tensorboard.Parse()
+  region = tensorboard_ref.AsDict()['locationsId']
+  with endpoint_util.AiplatformEndpointOverrides(
+      version=version, region=region):
+    response = client.TensorboardsClient(version=version).Get(tensorboard_ref)
+    return response
+
+
+@base.ReleaseTracks(base.ReleaseTrack.GA)
+class DescribeGa(base.DescribeCommand):
+  """Gets detailed Tensorboard information about the given Tensorboard id."""
+
+  detailed_help = {
+      'EXAMPLES':
+          """\
+          To describe a Tensorboard `12345` in region `us-central1` and project `my-project`:
+
+              $ {command} projects/my-project/locations/us-central1/tensorboards/12345
+
+          Or with flags:
+
+              $ {command} 12345
+          """,
+  }
+
+  @staticmethod
+  def Args(parser):
+    flags.AddTensorboardResourceArg(parser, 'to describe')
+
+  def Run(self, args):
+    return _Run(args, constants.GA_VERSION)
+
+
+@base.ReleaseTracks(base.ReleaseTrack.BETA, base.ReleaseTrack.ALPHA)
+class DescribeBeta(base.DescribeCommand):
+  """Gets detailed Tensorboard information about the given Tensorboard id."""
+
+  detailed_help = {
+      'EXAMPLES':
+          """\
+          To describe a Tensorboard `12345` in region `us-central1` and project `my-project`:
+
+              $ {command} projects/my-project/locations/us-central1/tensorboards/12345
+
+          Or with flags:
+
+              $ {command} 12345
+          """,
+  }
+
+  @staticmethod
+  def Args(parser):
+    flags.AddTensorboardResourceArg(parser, 'to describe')
+
+  def Run(self, args):
+    return _Run(args, constants.BETA_VERSION)

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

@@ -0,0 +1,98 @@
+# -*- 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 Tensorboards in Vertex AI."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+from googlecloudsdk.api_lib.ai.tensorboards 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.core import resources
+
+
+def _GetUriGa(tensorboard):
+  ref = resources.REGISTRY.ParseRelativeName(
+      tensorboard.name,
+      constants.TENSORBOARDS_COLLECTION,
+      api_version=constants.AI_PLATFORM_API_VERSION[constants.GA_VERSION])
+  return ref.SelfLink()
+
+
+def _GetUriBeta(tensorboard):
+  ref = resources.REGISTRY.ParseRelativeName(
+      tensorboard.name,
+      constants.TENSORBOARDS_COLLECTION,
+      api_version=constants.AI_PLATFORM_API_VERSION[constants.BETA_VERSION])
+  return ref.SelfLink()
+
+
+def _Run(args, version):
+  region_ref = args.CONCEPTS.region.Parse()
+  region = region_ref.AsDict()['locationsId']
+  with endpoint_util.AiplatformEndpointOverrides(
+      version=version, region=region):
+    return client.TensorboardsClient(version=version).List(
+        limit=args.limit,
+        page_size=args.page_size,
+        region_ref=region_ref,
+        sort_by=args.sort_by)
+
+
+@base.ReleaseTracks(base.ReleaseTrack.GA)
+class ListGa(base.ListCommand):
+  """Lists the Tensorboards of the given project and region."""
+
+  detailed_help = {
+      'EXAMPLES':
+          """\
+          To list Tensorboards:
+
+              $ {command}
+          """,
+  }
+
+  @staticmethod
+  def Args(parser):
+    flags.AddRegionResourceArg(parser, 'to list Tensorboards')
+    parser.display_info.AddUriFunc(_GetUriGa)
+
+  def Run(self, args):
+    return _Run(args, constants.GA_VERSION)
+
+
+@base.ReleaseTracks(base.ReleaseTrack.BETA, base.ReleaseTrack.ALPHA)
+class ListBeta(base.ListCommand):
+  """Lists the Tensorboards of the given project and region."""
+
+  detailed_help = {
+      'EXAMPLES':
+          """\
+          To list Tensorboards:
+
+              $ {command}
+          """,
+  }
+
+  @staticmethod
+  def Args(parser):
+    flags.AddRegionResourceArg(parser, 'to list Tensorboards')
+    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/tensorboards/update.py

@@ -0,0 +1,104 @@
+# -*- coding: utf-8 -*- #
+# Copyright 2020 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 endpoints update command."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+from googlecloudsdk.api_lib.ai.tensorboards 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.AddTensorboardResourceArg(parser, 'to update')
+  flags.GetDisplayNameArg('tensorboard', required=False).AddToParser(parser)
+  flags.GetDescriptionArg('tensorboard').AddToParser(parser)
+  labels_util.AddUpdateLabelsFlags(parser)
+
+
+def _Run(args, version):
+  """Update an existing Vertex AI Tensorboard."""
+
+  tensorboard_ref = args.CONCEPTS.tensorboard.Parse()
+  args.region = tensorboard_ref.AsDict()['locationsId']
+  with endpoint_util.AiplatformEndpointOverrides(version, region=args.region):
+    tensorboards_client = client.TensorboardsClient(version=version)
+
+    try:
+      op = tensorboards_client.Patch(tensorboard_ref, args)
+    except errors.NoFieldsSpecifiedError:
+      available_update_args = [
+          'display_name',
+          'description',
+          'update_labels',
+          'clear_labels',
+          'remove_labels',
+      ]
+      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')
+      return op
+
+
+@base.ReleaseTracks(base.ReleaseTrack.GA)
+class UpdateGa(base.UpdateCommand):
+  """Update an existing Vertex AI Tensorboard."""
+
+  detailed_help = {
+      'EXAMPLES':
+          """\
+          To update a Tensorboard `12345`, in region `us-central1` and project `my-project`, with the display name `updated display name`:
+
+              $ {command} projects/my-project/locations/us-central1/tensorboards/12345 --display-name="updated display name"
+          """,
+  }
+
+  @staticmethod
+  def Args(parser):
+    _AddArgs(parser)
+
+  def Run(self, args):
+    return _Run(args, constants.GA_VERSION)
+
+
+@base.ReleaseTracks(base.ReleaseTrack.BETA, base.ReleaseTrack.ALPHA)
+class UpdateBeta(base.UpdateCommand):
+  """Update an existing Vertex AI Tensorboard."""
+
+  detailed_help = {
+      'EXAMPLES':
+          """\
+          To update a Tensorboard `12345`, in region `us-central1` and project `my-project`, with the display name `updated display name`:
+
+              $ {command} projects/my-project/locations/us-central1/tensorboards/12345 --display-name="updated display name"
+          """,
+  }
+
+  @staticmethod
+  def Args(parser):
+    _AddArgs(parser)
+
+  def Run(self, args):
+    return _Run(args, constants.BETA_VERSION)