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_time_series/__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 Vertex AI Tensorboard Time Series."""
+
+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 TensorboardTimeSeries(base.Group):
+  """Manage Vertex AI Tensorboard time series."""
+
+  category = base.VERTEX_AI_CATEGORY

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

@@ -0,0 +1,88 @@
+# -*- 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 time series 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_time_series 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 tensorboards_util
+from googlecloudsdk.command_lib.ai import validation
+from googlecloudsdk.core import log
+
+
+def _AddArgs(parser):
+  flags.AddTensorboardRunResourceArg(parser,
+                                     'to create a Tensorboard time series')
+  flags.GetDisplayNameArg(
+      'tensorboard-time-series', required=True).AddToParser(parser)
+  flags.GetDescriptionArg('tensorboard-time-series').AddToParser(parser)
+  tensorboards_util.GetTensorboardTimeSeriesTypeArg(
+      'tensorboard-time-series').choice_arg.AddToParser(parser)
+  flags.GetPluginNameArg('tensorboard-time-series').AddToParser(parser)
+  flags.GetPluginDataArg('tensorboard-time-series').AddToParser(parser)
+
+
+def _Run(args, version):
+  """Create a new Vertex AI Tensorboard time series."""
+  validation.ValidateDisplayName(args.display_name)
+
+  tensorboard_run_ref = args.CONCEPTS.tensorboard_run.Parse()
+  region = tensorboard_run_ref.AsDict()['locationsId']
+  with endpoint_util.AiplatformEndpointOverrides(version, region=region):
+    tensorboard_runs_client = client.TensorboardTimeSeriesClient(
+        version=version)
+    response = tensorboard_runs_client.Create(tensorboard_run_ref, args)
+    response_msg = encoding.MessageToPyValue(response)
+    if 'name' in response_msg:
+      log.status.Print(
+          ('Created Vertex AI Tensorboard time series: {}.').format(
+              response_msg['name']))
+    return response
+
+
+@base.ReleaseTracks(base.ReleaseTrack.BETA, base.ReleaseTrack.ALPHA)
+class CreateBeta(base.CreateCommand):
+  """Create a new Vertex AI Tensorboard time series."""
+
+  detailed_help = {
+      'EXAMPLES':
+          """\
+          To create a Tensorboard Time Series in Tensorboard `12345`, Tensorboard Experiment `my-tensorboard-experiment, and in Tensorboard Run `my-tensorboard-run`, with the display name `my tensorboard time series` and type Scalar:
+
+              $ {command} my-tensorboard-run --tensorboard-experiment-id=my-tensorboard-experiment --tensorboard-id=12345 --display-name="my tensorboard time series" --type=SCALAR
+
+          You may also provide a description:
+
+              $ {command} my-tensorboard-run --tensorboard-experiment-id=my-tensorboard-experiment --tensorboard-id=12345 --display-name="my tensorboard time series" --type=SCALAR --description="my description"
+
+          To create a Tensorboard Time Series in Tensorboard `12345`, Tensorboard Experiment `my-tensorboard-experiment, Tensorboard Run `my-tensorboard-run`, region `us-central1`, and project `my-project`:
+
+              $ {command} projects/my-project/locations/us-central1/tensorboards/12345/experiments/my-tensorboard-experiment/runs/my-tensorboard-run --display-name="my tensorboard time series" --type=SCALAR
+          """,
+  }
+
+  @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/tensorboard_time_series/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 time series 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_time_series 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_time_series_ref = args.CONCEPTS.tensorboard_time_series.Parse()
+  region = tensorboard_time_series_ref.AsDict()['locationsId']
+  with endpoint_util.AiplatformEndpointOverrides(
+      version=version, region=region):
+    operation = client.TensorboardTimeSeriesClient(
+        version=version).Delete(tensorboard_time_series_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 Delete(base.DeleteCommand):
+  """Delete an existing Vertex AI Tensorboard time series."""
+
+  detailed_help = {
+      'EXAMPLES':
+          """\
+          To delete a Tensorboard Time Series `123` in Tensorboard `12345`, Tensorboard Experiment `my-tensorboard-experiment`, Tensorboard Run `my-tensorboard-run`, region `us-central1`, and project `my-project`:
+
+              $ {command} projects/my-project/locations/us-central1/tensorboards/12345/experiments/my-tensorboard-experiment/runs/my-tensorboard-run/timeSeries/123
+
+          Or with flags:
+
+              $ {command} 123 --tensorboard-id=12345 --tensorboard-experiment-id=my-tensorboard-experiment --tensorboard-run-id=my-tensorboard-run
+          """,
+  }
+
+  @staticmethod
+  def Args(parser):
+    flags.AddTensorboardTimeSeriesResourceArg(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_time_series/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 time series in Vertex AI."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+from googlecloudsdk.api_lib.ai.tensorboard_time_series 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_time_series_ref = args.CONCEPTS.tensorboard_time_series.Parse()
+  region = tensorboard_time_series_ref.AsDict()['locationsId']
+  with endpoint_util.AiplatformEndpointOverrides(
+      version=version, region=region):
+    response = client.TensorboardTimeSeriesClient(
+        version=version).Get(tensorboard_time_series_ref)
+    return response
+
+
+@base.ReleaseTracks(base.ReleaseTrack.BETA, base.ReleaseTrack.ALPHA)
+class DescribeBeta(base.DescribeCommand):
+  """Get detailed Tensorboard time series information about the given Tensorboard time series id."""
+
+  detailed_help = {
+      'EXAMPLES':
+          """\
+          To describe a Tensorboard Time Series `123` in Tensorboard `12345`, Tensorboard Experiment `my-tensorboard-experiment, Tensorboard Run `my-tensorboard-run`, region `us-central1`, and project `my-project`:
+
+              $ {command} projects/my-project/locations/us-central1/tensorboards/12345/experiments/my-tensorboard-experiment/runs/my-tensorboard-run/timeSeries/123
+
+          Or with flags:
+
+              $ {command} 123 --tensorboard-id=12345 --tensorboard-experiment-id=my-tensorboard-experiment --tensorboard-run-id=my-tensorboard-run
+          """,
+  }
+
+  @staticmethod
+  def Args(parser):
+    flags.AddTensorboardTimeSeriesResourceArg(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_time_series/list.py

@@ -0,0 +1,77 @@
+# -*- 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 time series in Vertex AI."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+from googlecloudsdk.api_lib.ai.tensorboard_time_series 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_run):
+  ref = resources.REGISTRY.ParseRelativeName(
+      tensorboard_run.name,
+      constants.TENSORBOARD_TIME_SERIES_COLLECTION,
+      api_version=constants.AI_PLATFORM_API_VERSION[constants.BETA_VERSION])
+  return ref.SelfLink()
+
+
+def _AddArgs(parser):
+  concept_parsers.ConceptParser.ForResource(
+      '--tensorboard-run-id',
+      flags.GetTensorboardRunResourceSpec(),
+      'To list Tensorboard time series',
+      required=True).AddToParser(parser)
+
+
+def _Run(args, version):
+  tensorboard_run_ref = args.CONCEPTS.tensorboard_run_id.Parse()
+  region = tensorboard_run_ref.AsDict()['locationsId']
+  with endpoint_util.AiplatformEndpointOverrides(
+      version=version, region=region):
+    return client.TensorboardTimeSeriesClient(version=version).List(
+        tensorboard_run_ref=tensorboard_run_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 time series of the given project, region, and Tensorboard run."""
+
+  detailed_help = {
+      'EXAMPLES':
+          """\
+          To list Tensorboard Time Series in Tensorboard `12345`, Tensorboard Experiment `my-tensorboard-experiment`, and Tensorboard Run `my-tensorboard-run`:
+
+              $ {command} --tensorboard-id=12345 --tensorboard-experiment-id=my-tensorboard-experiment --tensorboard-run-id=my-tensorboard-run
+          """,
+  }
+
+  @staticmethod
+  def Args(parser):
+    _AddArgs(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_time_series/read.py

@@ -0,0 +1,68 @@
+# -*- 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 read Tensorboard time series data in Vertex AI."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+from googlecloudsdk.api_lib.ai.tensorboard_time_series 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 _AddArgs(parser):
+  flags.AddTensorboardTimeSeriesResourceArg(parser, 'to read data')
+  flags.AddTensorboardTimeSeriesMaxDataPointsArg().AddToParser(parser)
+  flags.AddFilterArg('tensorboard-time-series').AddToParser(parser)
+
+
+def _Run(args, version):
+  tensorboard_time_series_ref = args.CONCEPTS.tensorboard_time_series.Parse()
+  region = tensorboard_time_series_ref.AsDict()['locationsId']
+  with endpoint_util.AiplatformEndpointOverrides(
+      version=version, region=region):
+    response = client.TensorboardTimeSeriesClient(version=version).Read(
+        tensorboard_time_series_ref=tensorboard_time_series_ref,
+        max_data_points=args.max_data_points,
+        data_filter=args.filter)
+    return response
+
+
+@base.ReleaseTracks(base.ReleaseTrack.BETA, base.ReleaseTrack.ALPHA)
+class ReadBeta(base.Command):
+  """Read the Tensorboard time series data from the given Tensorboard time series id."""
+
+  detailed_help = {
+      'EXAMPLES':
+          """\
+          To read Tensorboard Time Series `123` data in Tensorboard `12345`, Tensorboard Experiment `my-tensorboard-experiment, Tensorboard Run `my-tensorboard-run`, region `us-central1`, and project `my-project`:
+
+              $ {command} projects/my-project/locations/us-central1/tensorboards/12345/experiments/my-tensorboard-experiment/runs/my-tensorboard-run/timeSeries/123
+
+          Or with flags:
+
+              $ {command} 123 --tensorboard-id=12345 --tensorboard-experiment-id=my-tensorboard-experiment --tensorboard-run-id=my-tensorboard-run
+          """,
+  }
+
+  @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/tensorboard_time_series/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 time series in Vertex AI."""
+
+from __future__ import absolute_import
+from __future__ import division
+from __future__ import unicode_literals
+
+from googlecloudsdk.api_lib.ai.tensorboard_time_series 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.core import log
+
+
+def _AddArgs(parser):
+  flags.AddTensorboardTimeSeriesResourceArg(parser, 'to update')
+  flags.GetDisplayNameArg(
+      'tensorboard time series', required=False).AddToParser(parser)
+  flags.GetDescriptionArg('tensorboard time series').AddToParser(parser)
+  flags.GetPluginNameArg('tensorboard-time-series').AddToParser(parser)
+  flags.GetPluginDataArg('tensorboard-time-series').AddToParser(parser)
+
+
+def _Run(args, version):
+  """Update an existing Vertex AI Tensorboard time series."""
+  tensorboard_time_series_ref = args.CONCEPTS.tensorboard_time_series.Parse()
+  args.region = tensorboard_time_series_ref.AsDict()['locationsId']
+  with endpoint_util.AiplatformEndpointOverrides(version, region=args.region):
+    try:
+      op = client.TensorboardTimeSeriesClient(version=version).Patch(
+          tensorboard_time_series_ref, args)
+    except errors.NoFieldsSpecifiedError:
+      available_update_args = [
+          'display_name', 'description', 'plugin_name', 'plugin_data'
+      ]
+      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 time series')
+      return op
+
+
+@base.ReleaseTracks(base.ReleaseTrack.BETA, base.ReleaseTrack.ALPHA)
+class UpdateBeta(base.UpdateCommand):
+  """Update an existing Vertex AI Tensorboard time series."""
+
+  detailed_help = {
+      'EXAMPLES':
+          """\
+          To update a Tensorboard Time Series `123` in Tensorboard `12345`, Tensorboard Experiment `my-tensorboard-experiment`, Tensorboard Run `my-tensorboard-run`, region `us-central1`, and project `my-project`, with the display name `updated display name`:
+
+              $ {command} projects/my-project/locations/us-central1/tensorboards/12345/experiments/my-tensorboard-experiment/runs/my-tensorboard-run/timeSeries/123 --display-name="updated display name"
+
+          Or with flags:
+
+              $ {command} 123 --tensorboard-id=12345 --tensorboard-experiment-id=my-tensorboard-experiment --tensorboard-run-id=my-tensorboard-run --display-name="updated display name"
+          """,
+  }
+
+  @staticmethod
+  def Args(parser):
+    _AddArgs(parser)
+
+  def Run(self, args):
+    return _Run(args, constants.BETA_VERSION)