File: //snap/google-cloud-cli/current/lib/surface/quotas/preferences/update.py
# -*- coding: utf-8 -*- #
# Copyright 2024 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.
"""QuotaPreference update command."""
import json
from apitools.base.py import encoding
from googlecloudsdk.api_lib.quotas import quota_preference
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.quotas import flags
from googlecloudsdk.core import log
@base.ReleaseTracks(base.ReleaseTrack.ALPHA)
@base.UniverseCompatible
class UpdateAlpha(base.UpdateCommand):
"""Update the parameters of a single QuotaPreference.
This command updates an existing or creates a new QuotaPreference. It can
updates the config in any states, not just the ones pending approval.
## EXAMPLES
To update a quota preference with id `my-preference` in region `us-central1`
that applies to the `default_limit` quota for `projects/12321`, run:
$ {command} my-preference
--service=example.$$UNIVERSE_DOMAIN$$
--project=12321
--quota-id=default_limit
--preferred-value=100
--dimensions=region=us-central1
To create a new quota preference for `organizations/789`, run:
$ {command} my-preference
--service=example.$$UNIVERSE_DOMAIN$$
--organization=789
--quota-id=default_limit
--preferred-value=200
--allow-missing
"""
@staticmethod
def Args(parser):
"""Args is called by calliope to gather arguments for this command.
Args:
parser: An argparse parser that you can use to add arguments that go on
the command line after this command. Positional arguments are allowed.
"""
# required flags
flags.PreferenceId().AddToParser(parser)
flags.Service().AddToParser(parser)
flags.PreferredValue().AddToParser(parser)
flags.QuotaId(positional=False).AddToParser(parser)
flags.AddResourceFlags(parser, 'quota preference to update')
# optional flags
flags.Dimensions().AddToParser(parser)
flags.Email().AddToParser(parser)
flags.Justification().AddToParser(parser)
flags.AllowMissing().AddToParser(parser)
flags.ValidateOnly().AddToParser(parser)
flags.AllowsQuotaDecreaseBelowUsage().AddToParser(parser)
flags.AllowHighPercentageQuotaDecrease().AddToParser(parser)
def Run(self, args):
"""Run command.
Args:
args: argparse.Namespace, The arguments that this command was invoked
with.
Returns:
The updated QuotaPreference. If `--validate-only` is specified, it returns
None or any possible error.
"""
# This is because alpha gcloud points to GA version of the API.
self.updated_resource = quota_preference.UpdateQuotaPreference(
args, release_track=base.ReleaseTrack.GA
)
self.validate_only = args.validate_only
return self.updated_resource
def Epilog(self, resources_were_displayed: bool = True):
if resources_were_displayed and not self.validate_only:
log.status.Print(
json.dumps(
encoding.MessageToDict(self.updated_resource),
sort_keys=True,
indent=4,
separators=(',', ':'),
)
)
@base.ReleaseTracks(base.ReleaseTrack.BETA)
@base.UniverseCompatible
class UpdateBeta(base.UpdateCommand):
"""Update the parameters of a single QuotaPreference.
This command updates an existing or creates a new QuotaPreference. It can
updates the config in any states, not just the ones pending approval.
## EXAMPLES
To update a quota preference with id `my-preference` in region `us-central1`
that applies to the `default_limit` quota for `projects/12321`, run:
$ {command} my-preference
--service=example.$$UNIVERSE_DOMAIN$$
--project=12321
--quota-id=default_limit
--preferred-value=100
--dimensions=region=us-central1
To create a new quota preference for `organizations/789`, run:
$ {command} my-preference
--service=example.$$UNIVERSE_DOMAIN$$
--organization=789
--quota-id=default_limit
--preferred-value=200
--allow-missing
"""
@staticmethod
def Args(parser):
"""Args is called by calliope to gather arguments for this command.
Args:
parser: An argparse parser that you can use to add arguments that go on
the command line after this command. Positional arguments are allowed.
"""
# Required flags.
flags.PreferenceId().AddToParser(parser)
flags.Service().AddToParser(parser)
flags.PreferredValue().AddToParser(parser)
flags.QuotaId(positional=False).AddToParser(parser)
flags.AddResourceFlags(parser, 'quota preference to update')
# optional flags
flags.Dimensions().AddToParser(parser)
flags.Email().AddToParser(parser)
flags.Justification().AddToParser(parser)
flags.AllowMissing().AddToParser(parser)
flags.ValidateOnly().AddToParser(parser)
flags.AllowsQuotaDecreaseBelowUsage().AddToParser(parser)
flags.AllowHighPercentageQuotaDecrease().AddToParser(parser)
def Run(self, args):
"""Run command.
Args:
args: argparse.Namespace, The arguments that this command was invoked
with.
Returns:
The updated QuotaPreference. If `--validate-only` is specified, it returns
None or any possible error.
"""
self.updated_resource = quota_preference.UpdateQuotaPreference(
args, release_track=base.ReleaseTrack.BETA
)
self.validate_only = args.validate_only
return self.updated_resource
def Epilog(self, resources_were_displayed=True):
if resources_were_displayed and not self.validate_only:
log.status.Print(
json.dumps(
encoding.MessageToDict(self.updated_resource),
sort_keys=True,
indent=4,
separators=(',', ':'),
)
)