HEX
Server: Apache/2.4.65 (Ubuntu)
System: Linux ielts-store-v2 6.8.0-1036-gcp #38~22.04.1-Ubuntu SMP Thu Aug 14 01:19:18 UTC 2025 x86_64
User: root (0)
PHP: 7.2.34-54+ubuntu20.04.1+deb.sury.org+1
Disabled: pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,
Upload Files
File: //snap/google-cloud-cli/396/lib/googlecloudsdk/api_lib/ai/tensorboard_experiments/client.py
# -*- 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.
"""Utilities for AI Platform Tensorboard experiments API."""

from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals

from apitools.base.py import list_pager
from googlecloudsdk.api_lib.util import apis
from googlecloudsdk.api_lib.util import common_args
from googlecloudsdk.command_lib.ai import constants
from googlecloudsdk.command_lib.ai import errors
from googlecloudsdk.command_lib.util.args import labels_util


class TensorboardExperimentsClient(object):
  """High-level client for the AI Platform Tensorboard experiment surface."""

  def __init__(self,
               client=None,
               messages=None,
               version=constants.BETA_VERSION):
    self.client = client or apis.GetClientInstance(
        constants.AI_PLATFORM_API_NAME,
        constants.AI_PLATFORM_API_VERSION[version])
    self.messages = messages or self.client.MESSAGES_MODULE
    self._service = self.client.projects_locations_tensorboards_experiments
    self._version = version

  def Create(self, tensorboard_ref, args):
    return self.CreateBeta(tensorboard_ref, args)

  def CreateBeta(self, tensorboard_ref, args):
    """Create a new Tensorboard experiment."""
    labels = labels_util.ParseCreateArgs(
        args, self.messages.GoogleCloudAiplatformV1beta1TensorboardExperiment
        .LabelsValue)
    request = self.messages.AiplatformProjectsLocationsTensorboardsExperimentsCreateRequest(
        parent=tensorboard_ref.RelativeName(),
        googleCloudAiplatformV1beta1TensorboardExperiment=self.messages
        .GoogleCloudAiplatformV1beta1TensorboardExperiment(
            displayName=args.display_name,
            description=args.description,
            labels=labels),
        tensorboardExperimentId=args.tensorboard_experiment_id)
    return self._service.Create(request)

  def List(self, tensorboard_ref, limit=1000, page_size=50, sort_by=None):
    request = self.messages.AiplatformProjectsLocationsTensorboardsExperimentsListRequest(
        parent=tensorboard_ref.RelativeName(),
        orderBy=common_args.ParseSortByArg(sort_by))
    return list_pager.YieldFromList(
        self._service,
        request,
        field='tensorboardExperiments',
        batch_size_attribute='pageSize',
        batch_size=page_size,
        limit=limit)

  def Get(self, tensorboard_exp_ref):
    request = self.messages.AiplatformProjectsLocationsTensorboardsExperimentsGetRequest(
        name=tensorboard_exp_ref.RelativeName())
    return self._service.Get(request)

  def Delete(self, tensorboard_exp_ref):
    request = (
        self.messages
        .AiplatformProjectsLocationsTensorboardsExperimentsDeleteRequest(
            name=tensorboard_exp_ref.RelativeName()))
    return self._service.Delete(request)

  def Patch(self, tensorboard_exp_ref, args):
    return self.PatchBeta(tensorboard_exp_ref, args)

  def PatchBeta(self, tensorboard_exp_ref, args):
    """Update a Tensorboard experiment."""
    tensorboard_exp = (
        self.messages.GoogleCloudAiplatformV1beta1TensorboardExperiment())
    update_mask = []

    def GetLabels():
      return self.Get(tensorboard_exp_ref).labels

    labels_update = labels_util.ProcessUpdateArgsLazy(
        args, self.messages.GoogleCloudAiplatformV1beta1TensorboardExperiment
        .LabelsValue, GetLabels)
    if labels_update.needs_update:
      tensorboard_exp.labels = labels_update.labels
      update_mask.append('labels')

    if args.display_name is not None:
      tensorboard_exp.displayName = args.display_name
      update_mask.append('display_name')

    if args.description is not None:
      tensorboard_exp.description = args.description
      update_mask.append('description')

    if not update_mask:
      raise errors.NoFieldsSpecifiedError('No updates requested.')

    request = self.messages.AiplatformProjectsLocationsTensorboardsExperimentsPatchRequest(
        name=tensorboard_exp_ref.RelativeName(),
        googleCloudAiplatformV1beta1TensorboardExperiment=tensorboard_exp,
        updateMask=','.join(update_mask))
    return self._service.Patch(request)