File: //snap/google-cloud-cli/394/lib/googlecloudsdk/command_lib/monitoring/resource_args.py
# -*- coding: utf-8 -*- #
# Copyright 2018 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 resource flags for Cloud Monitoring commands."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
from googlecloudsdk.calliope.concepts import concepts
from googlecloudsdk.command_lib.util.concepts import concept_parsers
from googlecloudsdk.command_lib.util.concepts import presentation_specs
def AlertAttributeConfig():
return concepts.ResourceParameterAttributeConfig(
name='alert', help_text='Name of the alert.'
)
def AlertPolicyAttributeConfig():
return concepts.ResourceParameterAttributeConfig(
name='policy',
help_text='Name of the alerting policy.')
def ConditionAttributeConfig():
return concepts.ResourceParameterAttributeConfig(
name='condition',
help_text='Name of the alerting policy condition.')
def NotificationChannelAttributeConfig():
return concepts.ResourceParameterAttributeConfig(
name='notification_channels',
help_text='Name of the Notification Channel.')
def SnoozeAttributeConfig():
return concepts.ResourceParameterAttributeConfig(
name='snooze',
help_text='Name of the snooze.')
def UptimeCheckAttributeConfig():
return concepts.ResourceParameterAttributeConfig(
name='check_id',
help_text='Name of the uptime check or synthetic monitor.')
def GetAlertResourceSpec():
return concepts.ResourceSpec(
'monitoring.projects.alerts',
resource_name='Alert',
alertsId=AlertAttributeConfig(),
projectsId=concepts.DEFAULT_PROJECT_ATTRIBUTE_CONFIG,
)
def GetAlertPolicyResourceSpec():
return concepts.ResourceSpec(
'monitoring.projects.alertPolicies',
resource_name='Alert Policy',
alertPoliciesId=AlertPolicyAttributeConfig(),
projectsId=concepts.DEFAULT_PROJECT_ATTRIBUTE_CONFIG)
def GetConditionResourceSpec():
return concepts.ResourceSpec(
'monitoring.projects.alertPolicies.conditions',
resource_name='condition',
conditionsId=ConditionAttributeConfig(),
alertPoliciesId=AlertPolicyAttributeConfig(),
projectsId=concepts.DEFAULT_PROJECT_ATTRIBUTE_CONFIG)
def GetNotificationChannelResourceSpec():
return concepts.ResourceSpec(
'monitoring.projects.notificationChannels',
resource_name='Notification Channel',
notificationChannelsId=NotificationChannelAttributeConfig(),
projectsId=concepts.DEFAULT_PROJECT_ATTRIBUTE_CONFIG)
def GetSnoozeResourceSpec():
return concepts.ResourceSpec(
'monitoring.projects.snoozes',
resource_name='Snooze',
snoozesId=SnoozeAttributeConfig(),
projectsId=concepts.DEFAULT_PROJECT_ATTRIBUTE_CONFIG)
def GetUptimeCheckResourceSpec():
return concepts.ResourceSpec(
'monitoring.projects.uptimeCheckConfigs',
resource_name='uptime check or synthetic monitor',
uptimeCheckConfigsId=UptimeCheckAttributeConfig(),
projectsId=concepts.DEFAULT_PROJECT_ATTRIBUTE_CONFIG)
def CreateAlertPolicyResourceArg(verb, positional=True):
if positional:
name = 'alert_policy'
else:
name = '--policy'
help_text = 'Name of the Alert Policy ' + verb
return presentation_specs.ResourcePresentationSpec(
name,
GetAlertPolicyResourceSpec(),
help_text,
required=True)
def CreateConditionResourceArg(verb):
help_text = 'The name of the Condition to {}.'.format(verb)
return presentation_specs.ResourcePresentationSpec(
'condition',
GetConditionResourceSpec(),
help_text,
required=True,
prefixes=False)
def CreateNotificationChannelResourceArg(arg_name, extra_help, required=True,
plural=False):
"""Create a resource argument for a Cloud Monitoring Notification Channel.
Args:
arg_name: str, the name for the arg.
extra_help: str, the extra_help to describe the resource. This should start
with the verb, such as 'to update', that is acting on the resource.
required: bool, if the arg is required.
plural: bool, if True, use a resource argument that returns a list.
Returns:
the PresentationSpec for the resource argument.
"""
if plural:
help_stem = 'Names of one or more Notification Channels '
else:
help_stem = 'Name of the Notification Channel '
return presentation_specs.ResourcePresentationSpec(
arg_name,
GetNotificationChannelResourceSpec(),
help_stem + extra_help,
required=required,
plural=plural)
def CreateSnoozeResourceArg(verb):
name = 'snooze'
help_text = 'Name of the Snooze ' + verb
return presentation_specs.ResourcePresentationSpec(
name,
GetSnoozeResourceSpec(),
help_text,
required=True)
def CreateUptimeResourceArg(verb):
name = 'check_id'
help_text = 'Name of the uptime check or synthetic monitor ' + verb
return presentation_specs.ResourcePresentationSpec(
name,
GetUptimeCheckResourceSpec(),
help_text,
required=True)
def AddResourceArgs(parser, resources):
"""Add resource arguments.
Args:
parser: the parser for the command.
resources: a list of resource args to add.
"""
concept_parsers.ConceptParser(resources).AddToParser(parser)
def GetAlertResourceUriFunc():
return lambda x: x.name
def AddProjectResourceArg(parser, help_text, required=True):
"""Add a resource argument for a Google Cloud Platform Console project.
Args:
parser: argparse.ArgumentParser, the parser for the command.
help_text: str, the help text for the arg.
required: bool, if the arg is required.
"""
concept_parsers.ConceptParser([
presentation_specs.ResourcePresentationSpec(
'--project',
concepts.ResourceSpec(
'cloudresourcemanager.projects',
resource_name='project',
projectId=concepts.DEFAULT_PROJECT_ATTRIBUTE_CONFIG,
),
'Project ' + help_text,
required=required,
)
]).AddToParser(parser)