File: //snap/google-cloud-cli/current/lib/surface/compute/snapshots/update.py
# -*- coding: utf-8 -*- #
# Copyright 2017 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 for labels update to snapshots."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.compute import base_classes
from googlecloudsdk.api_lib.compute.operations import poller
from googlecloudsdk.api_lib.util import waiter
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.compute import flags as compute_flags
from googlecloudsdk.command_lib.compute import scope as compute_scope
from googlecloudsdk.command_lib.compute.snapshots import flags as snapshots_flags
from googlecloudsdk.command_lib.util.args import labels_util
DETAILED_HELP = {
'EXAMPLES':
"""\
To update labels ``k0'' and ``k1'' and remove labels with key ``k3'', run:
$ {command} example-snapshot --update-labels=k0=value1,k1=value2 --remove-labels=k3
``k0'' and ``k1'' will be added as new labels if not already present.
Labels can be used to identify the snapshot and to filter them like:
$ {parent_command} list --filter='labels.k1:value2'
To list only the labels when describing a resource, use --format:
$ {parent_command} describe example-snapshot --format="default(labels)"
""",
}
def _GAArgs(parser):
"""Set Args based on Release Track."""
Update.SnapshotArg = snapshots_flags.MakeSnapshotArg()
Update.SnapshotArg.AddArgument(parser, operation_type='update')
labels_util.AddUpdateLabelsFlags(parser)
def _BetaArgs(parser):
"""Set Args based on Release Track."""
Update.SnapshotArg = snapshots_flags.MakeSnapshotArgForRegionalSnapshots()
Update.SnapshotArg.AddArgument(parser, operation_type='update')
labels_util.AddUpdateLabelsFlags(parser)
def _AlphaArgs(parser):
"""Set Args based on Release Track."""
Update.SnapshotArg = snapshots_flags.MakeSnapshotArgForRegionalSnapshots()
Update.SnapshotArg.AddArgument(parser, operation_type='update')
labels_util.AddUpdateLabelsFlags(parser)
@base.ReleaseTracks(base.ReleaseTrack.GA)
@base.UniverseCompatible
class Update(base.UpdateCommand):
r"""Update a Compute Engine snapshot.
*{command}* updates labels for a Compute Engine snapshot.
"""
detailed_help = DETAILED_HELP
@staticmethod
def Args(parser):
_GAArgs(parser)
def Run(self, args):
return self._Run(args)
def _Run(self, args, support_region=False):
holder = base_classes.ComputeApiHolder(self.ReleaseTrack())
client = holder.client.apitools_client
messages = holder.client.messages
snapshot_ref = Update.SnapshotArg.ResolveAsResource(
args,
holder.resources,
scope_lister=compute_flags.GetDefaultScopeLister(holder.client),
default_scope=compute_scope.ScopeEnum.GLOBAL,)
if (
support_region
and snapshot_ref.Collection() == 'compute.regionSnapshots'
):
labels_diff = labels_util.GetAndValidateOpsFromArgs(args)
regional_snapshot = client.regionSnapshots.Get(
messages.ComputeRegionSnapshotsGetRequest(**snapshot_ref.AsDict())
)
labels_update = labels_diff.Apply(
messages.RegionSetLabelsRequest.LabelsValue, regional_snapshot.labels
)
if not labels_update.needs_update:
return regional_snapshot
request = messages.ComputeRegionSnapshotsSetLabelsRequest(
project=snapshot_ref.project,
resource=snapshot_ref.snapshot,
region=snapshot_ref.region,
regionSetLabelsRequest=messages.RegionSetLabelsRequest(
labelFingerprint=regional_snapshot.labelFingerprint,
labels=labels_update.labels,
),
)
operation = client.regionSnapshots.SetLabels(request)
operation_ref = holder.resources.Parse(
operation.selfLink, collection='compute.regionOperations'
)
operation_poller = poller.Poller(client.regionSnapshots)
return waiter.WaitFor(
operation_poller,
operation_ref,
'Updating labels of snapshot [{0}]'.format(snapshot_ref.Name()),
)
else:
labels_diff = labels_util.GetAndValidateOpsFromArgs(args)
snapshot = client.snapshots.Get(
messages.ComputeSnapshotsGetRequest(**snapshot_ref.AsDict())
)
labels_update = labels_diff.Apply(
messages.GlobalSetLabelsRequest.LabelsValue, snapshot.labels
)
if not labels_update.needs_update:
return snapshot
request = messages.ComputeSnapshotsSetLabelsRequest(
project=snapshot_ref.project,
resource=snapshot_ref.snapshot,
globalSetLabelsRequest=
messages.GlobalSetLabelsRequest(
labelFingerprint=snapshot.labelFingerprint,
labels=labels_update.labels))
operation = client.snapshots.SetLabels(request)
operation_ref = holder.resources.Parse(
operation.selfLink, collection='compute.globalOperations')
operation_poller = poller.Poller(client.snapshots)
return waiter.WaitFor(
operation_poller, operation_ref,
'Updating labels of snapshot [{0}]'.format(
snapshot_ref.Name()))
@base.ReleaseTracks(base.ReleaseTrack.BETA)
class UpdateBeta(Update):
"""Update a Compute Engine snapshot."""
@staticmethod
def Args(parser):
_BetaArgs(parser)
def Run(self, args):
return self._Run(
args,
support_region=True,
)
@base.ReleaseTracks(base.ReleaseTrack.ALPHA)
class UpdateAlpha(Update):
"""Update a Compute Engine snapshot."""
@staticmethod
def Args(parser):
_AlphaArgs(parser)
def Run(self, args):
return self._Run(
args,
support_region=True,
)