File: //snap/google-cloud-cli/current/lib/surface/resource_manager/settings/describe.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.
"""Describe command for the Resource Settings CLI."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.api_lib.resource_manager.settings import utils as api_utils
from googlecloudsdk.calliope import base
from googlecloudsdk.command_lib.resource_manager.settings import arguments
from googlecloudsdk.command_lib.resource_manager.settings import utils
@base.Hidden
@base.DefaultUniverseOnly
@base.ReleaseTracks(base.ReleaseTrack.ALPHA)
class Describe(base.DescribeCommand):
r"""Get a resource setting.
Get a resource setting
## EXAMPLES
To describe the resource settings ``iam-projectCreatorRoles'' with the
Project ``foo-project'', run:
$ {command} iam-projectCreatorRoles --project=foo-project
"""
@staticmethod
def Args(parser):
arguments.AddSettingsNameArgToParser(parser)
arguments.AddResourceFlagsToParser(parser)
parser.add_argument(
'--effective',
action='store_true',
help='Describe the effective setting.',
)
def Run(self, args):
"""Get the (effective) resource settings.
If --effective is not specified, it is a regular resource setting.
If --effective is specified, it is an effective setting.
Args:
args: argparse.Namespace, An object that contains the values for the
arguments specified in the Args method.
Returns:
The retrieved settings.
"""
if args.effective:
settings_service = api_utils.GetEffectiveServiceFromArgs(args)
setting_name = utils.GetEffectiveSettingsPathFromArgs(args)
get_request = api_utils.GetDescribeRequestFromArgs(
args, setting_name, True
)
setting_value = settings_service.Get(get_request)
return setting_value
else:
settings_service = api_utils.GetServiceFromArgs(args)
setting_name = utils.GetSettingsPathFromArgs(args)
get_request = api_utils.GetDescribeRequestFromArgs(
args, setting_name, False
)
setting_value = settings_service.Get(get_request)
return setting_value