File: //snap/google-cloud-cli/396/lib/surface/ai/endpoints/update.py
# -*- 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.endpoints 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.ai import region_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.AddEndpointResourceArg(
parser, 'to update', prompt_func=region_util.PromptForOpRegion)
flags.GetDisplayNameArg('endpoint', required=False).AddToParser(parser)
flags.GetDescriptionArg('endpoint').AddToParser(parser)
flags.AddTrafficSplitGroupArgs(parser)
flags.AddRequestResponseLoggingConfigUpdateGroupArgs(parser)
labels_util.AddUpdateLabelsFlags(parser)
def _Run(args, version):
"""Update an existing Vertex AI endpoint."""
validation.ValidateDisplayName(args.display_name)
endpoint_ref = args.CONCEPTS.endpoint.Parse()
args.region = endpoint_ref.AsDict()['locationsId']
with endpoint_util.AiplatformEndpointOverrides(version, region=args.region):
endpoints_client = client.EndpointsClient(version=version)
def GetLabels():
return endpoints_client.Get(endpoint_ref).labels
try:
if version == constants.GA_VERSION:
op = endpoints_client.Patch(
endpoint_ref,
labels_util.ProcessUpdateArgsLazy(
args, endpoints_client.messages.GoogleCloudAiplatformV1Endpoint
.LabelsValue, GetLabels),
display_name=args.display_name,
description=args.description,
traffic_split=args.traffic_split,
clear_traffic_split=args.clear_traffic_split,
request_response_logging_table=args.request_response_logging_table,
request_response_logging_rate=args.request_response_logging_rate,
disable_request_response_logging=args
.disable_request_response_logging)
else:
op = endpoints_client.PatchBeta(
endpoint_ref,
labels_util.ProcessUpdateArgsLazy(
args, endpoints_client.messages
.GoogleCloudAiplatformV1beta1Endpoint.LabelsValue, GetLabels),
display_name=args.display_name,
description=args.description,
traffic_split=args.traffic_split,
clear_traffic_split=args.clear_traffic_split,
request_response_logging_table=args.request_response_logging_table,
request_response_logging_rate=args.request_response_logging_rate,
disable_request_response_logging=args
.disable_request_response_logging)
except errors.NoFieldsSpecifiedError:
available_update_args = [
'display_name', 'traffic_split', 'clear_traffic_split',
'update_labels', 'clear_labels', 'remove_labels', 'description',
'request_response_logging_table', 'request_response_logging_rate',
'disable_request_response_logging'
]
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 endpoint')
return op
@base.ReleaseTracks(base.ReleaseTrack.GA)
@base.UniverseCompatible
class UpdateGa(base.UpdateCommand):
"""Update an existing Vertex AI endpoint.
## EXAMPLES
To update an endpoint ``123'' under project ``example'' in region
``us-central1'', run:
$ {command} 123 --project=example --region=us-central1
--display-name=new_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)
@base.UniverseCompatible
class UpdateBeta(UpdateGa):
"""Update an existing Vertex AI endpoint.
## EXAMPLES
To update an endpoint ``123'' under project ``example'' in region
``us-central1'', run:
$ {command} 123 --project=example --region=us-central1
--display-name=new_name
"""
def Run(self, args):
return _Run(args, constants.BETA_VERSION)