File: //snap/google-cloud-cli/current/lib/googlecloudsdk/command_lib/scc/muteconfigs/flags.py
# -*- coding: utf-8 -*- #
# Copyright 2023 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.
"""Shared flags definitions for muteconfigs commands."""
from __future__ import absolute_import
from __future__ import division
from __future__ import print_function
from __future__ import unicode_literals
from googlecloudsdk.calliope import base
MUTE_CONFIG_FLAG = base.Argument(
"mute_config",
help="ID of the mute config or the full resource name of the mute config."
)
DESCRIPTION_FLAG = base.Argument(
"--description",
required=False,
help="The text that will be used to describe a mute configuration."
)
DISPLAY_NAME_FLAG = base.Argument(
"--display-name",
required=False,
help="""The text that will be used to represent a mute configuration display name."""
)
EXPIRY_TIME_FLAG = base.Argument(
"--expiry-time",
required=False,
help="""The expiry of the mute config. Only applicable for dynamic
configs. If the expiry is set, when the config expires, it is removed from
all findings. See `$ gcloud topic datetimes` for information on
supported time formats.""",
)
FILTER_FLAG = base.Argument(
"--filter",
required=False,
help="""The filter string which will applied to findings muted by a mute configuration."""
)
TYPE_FLAG = base.ChoiceArgument(
"--type",
choices=["static", "dynamic"],
metavar="TYPE",
required=False,
help_str="The mute configuration type. Immutable after creation.",
default="static",
)
def AddParentGroup(parser, required=False):
"""Adds a parent group to the parser."""
parent_group = parser.add_group(mutex=True, required=required)
parent_group.add_argument(
"--organization",
help="""Organization where the mute config resides. Formatted as ``organizations/123'' or just ``123''.""",
)
parent_group.add_argument(
"--folder",
help="""Folder where the mute config resides. Formatted as ``folders/456'' or just ``456''.""",
)
parent_group.add_argument(
"--project",
help="""Project (id or number) where the mute config resides. Formatted as ``projects/789'' or just ``789''.""",
)
return parser