File: //snap/google-cloud-cli/394/lib/surface/bms/nfs_shares/update.py
# -*- coding: utf-8 -*- #
# Copyright 2022 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.
"""Bare Metal Solution NFS share update command."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.bms.bms_client import BmsClient
from googlecloudsdk.api_lib.util import waiter
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.bms import flags
from googlecloudsdk.command_lib.bms import util
from googlecloudsdk.command_lib.util.args import labels_util
from googlecloudsdk.core import log
from googlecloudsdk.core import resources
DETAILED_HELP = {
'DESCRIPTION':
"""
Update a Bare Metal Solution NFS share.
This call returns immediately, but the update operation may take
several minutes to complete. To check if the operation is complete,
use the `describe` command for the NFS share.
""",
'EXAMPLES':
"""
To update an NFS share called ``my-share'' in region ``us-central1'' with
a new label ``key1=value1'', run:
$ {command} my-share --region=us-central1 --update-labels=key1=value1
To clear all labels, run:
$ {command} my-share --region=us-central1 --clear-labels
To remove label ``key1'', run:
$ {command} my-share --region=us-central1 --remove-labels=key1
""",
}
@base.ReleaseTracks(base.ReleaseTrack.GA)
class Update(base.UpdateCommand):
"""Update a Bare Metal Solution NFS share."""
@staticmethod
def Args(parser):
"""Register flags for this command."""
flags.AddNfsShareArgToParser(parser, positional=True)
labels_util.AddUpdateLabelsFlags(parser)
base.ASYNC_FLAG.AddToParser(parser)
flags.AddNfsUpdateAllowedClientArgs(parser=parser, hidden=False)
def Run(self, args):
labels_diff = labels_util.Diff.FromUpdateArgs(args)
nfs_share = args.CONCEPTS.nfs_share.Parse()
client = BmsClient()
orig_resource = client.GetNfsShare(nfs_share)
labels_update = labels_diff.Apply(client.messages.NfsShare.LabelsValue,
orig_resource.labels).GetOrNone()
updated_allowed_clients = _ApplyNFSAllowedClientsUpdates(
client=client,
args=args,
existing_nfs=orig_resource,
nfs_share_resource=nfs_share)
op_ref = client.UpdateNfsShare(nfs_share_resource=nfs_share,
labels=labels_update,
allowed_clients=updated_allowed_clients)
if op_ref.done:
log.UpdatedResource(nfs_share.Name(), kind='NFS share')
return op_ref
if args.async_:
log.status.Print('Update request issued for: [{}]\nCheck operation '
'[{}] for status.'.format(nfs_share.Name(),
op_ref.name))
return op_ref
op_resource = resources.REGISTRY.ParseRelativeName(
op_ref.name,
collection='baremetalsolution.projects.locations.operations',
api_version='v2')
poller = waiter.CloudOperationPollerNoResources(client.operation_service)
res = waiter.WaitFor(
poller, op_resource,
'Waiting for operation [{}] to complete'.format(op_ref.name))
log.UpdatedResource(nfs_share.Name(), kind='NFS share')
return res
@base.ReleaseTracks(base.ReleaseTrack.ALPHA)
class UpdateAlpha(Update):
"""Update a Bare Metal Solution NFS share."""
@staticmethod
def Args(parser):
# Flags which are only available in ALPHA should be added to parser here.
Update.Args(parser)
def _ApplyNFSAllowedClientsUpdates(client, args, existing_nfs,
nfs_share_resource):
"""Applies the changes in args to the allowed_clients in existing_nfs.
Returns None if no changes were to be applied.
Args:
client: BmsClient.
args: The arguments passed to the command.
existing_nfs: The existing nfs.
nfs_share_resource: The ref to the NFS share.
Returns:
List of allowed clients after applying updates or None if there are
no changes.
"""
if args.IsKnownAndSpecified(
'clear_allowed_clients') and args.clear_allowed_clients:
return []
if args.IsKnownAndSpecified('add_allowed_client'):
new_clients = client.ParseAllowedClientsDicts(
nfs_share_resource=nfs_share_resource,
allowed_clients_dicts=args.add_allowed_client)
return existing_nfs.allowedClients + new_clients
if args.IsKnownAndSpecified('remove_allowed_client'):
return util.RemoveAllowedClients(
nfs_share_resource=nfs_share_resource,
allowed_clients=existing_nfs.allowedClients,
remove_key_dicts=args.remove_allowed_client)
Update.detailed_help = DETAILED_HELP