Thanks to visit codestin.com
Credit goes to github.com

Skip to content
This repository was archived by the owner on Dec 31, 2023. It is now read-only.

docs(samples): add doc strings to explain the project ID format #469

Merged
merged 3 commits into from
Aug 6, 2022
Merged

docs(samples): add doc strings to explain the project ID format #469

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ddddadf
improvement: add doc strings to explain the project ID format
Shabirmean Aug 2, 2022
931faa9
fix: argument desc mismatch
Shabirmean Aug 2, 2022
1499287
Merge branch 'main' into improv/add-doc
parthea Aug 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 47 additions & 1 deletion samples/snippets/v3/alerts-client/snippets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,13 @@

# [START monitoring_alert_list_policies]
def list_alert_policies(project_name):
"""List alert policies in a project.

Arguments:
project_name (str): The Google Cloud Project to use. The project name
must be in the format - 'projects/<PROJECT_NAME>'.
"""

client = monitoring_v3.AlertPolicyServiceClient()
policies = client.list_alert_policies(name=project_name)
print(
Expand All @@ -44,6 +51,13 @@ def list_alert_policies(project_name):

# [START monitoring_alert_list_channels]
def list_notification_channels(project_name):
"""List alert notification channels in a project.

Arguments:
project_name (str): The Google Cloud Project to use. The project name
must be in the format - 'projects/<PROJECT_NAME>'.
"""

client = monitoring_v3.NotificationChannelServiceClient()
channels = client.list_notification_channels(name=project_name)
print(
Expand All @@ -62,7 +76,8 @@ def enable_alert_policies(project_name, enable, filter_=None):
"""Enable or disable alert policies in a project.

Arguments:
project_name (str)
project_name (str): The Google Cloud Project to use. The project name
must be in the format - 'projects/<PROJECT_NAME>'.
enable (bool): Enable or disable the policies.
filter_ (str, optional): Only enable/disable alert policies that match
this filter_. See
Expand Down Expand Up @@ -95,6 +110,17 @@ def enable_alert_policies(project_name, enable, filter_=None):

# [START monitoring_alert_replace_channels]
def replace_notification_channels(project_name, alert_policy_id, channel_ids):
"""Replace notification channel of an alert.

Arguments:
project_name (str): The Google Cloud Project to use. The project name
must be in the format - 'projects/<PROJECT_NAME>'.
alert_policy_id (str): The ID of the alert policy whose notification
channels are to be replaced.
channel_ids (str): ID of notification channel to be added as channel
for the given alert policy.
"""

_, project_id = project_name.split("/")
alert_client = monitoring_v3.AlertPolicyServiceClient()
channel_client = monitoring_v3.NotificationChannelServiceClient()
Expand All @@ -119,6 +145,17 @@ def replace_notification_channels(project_name, alert_policy_id, channel_ids):

# [START monitoring_alert_delete_channel]
def delete_notification_channels(project_name, channel_ids, force=None):
"""Delete alert notification channels.

Arguments:
project_name (str): The Google Cloud Project to use. The project name
must be in the format - 'projects/<PROJECT_NAME>'.
channel_ids list(str): List of IDs of notification channels to delete.
force (bool): If true, the notification channels are deleted regardless
of its in use by alert policies. If false, channels that are still
referenced by an existing alerting policy will fail to be deleted.
"""

channel_client = monitoring_v3.NotificationChannelServiceClient()
for channel_id in channel_ids:
channel_name = "{}/notificationChannels/{}".format(project_name, channel_id)
Expand All @@ -136,6 +173,15 @@ def delete_notification_channels(project_name, channel_ids, force=None):

# [START monitoring_alert_backup_policies]
def backup(project_name, backup_filename):
"""Backup alert policies from a project to a local file.

Arguments:
project_name (str): The Google Cloud Project to use. The project name
must be in the format - 'projects/<PROJECT_NAME>'
backup_filename (str): Name of the file (along with its path) to which
the alert policies will be written as backup.
"""

alert_client = monitoring_v3.AlertPolicyServiceClient()
channel_client = monitoring_v3.NotificationChannelServiceClient()
record = {
Expand Down