def list_groups(self):
"""List all groups for the project.
Example::
>>> for group in client.list_groups():
... print((group.display_name, group.name))
:rtype: list of :class:`~google.cloud.monitoring.group.Group`
:returns: A list of group instances.
"""
return Group._list(self)
def list_groups(self):
"""List all groups for the project.
Example::
>>> for group in client.list_groups():
... print((group.display_name, group.name))
:rtype: list of :class:`~google.cloud.monitoring.group.Group`
:returns: A list of group instances.
"""
return Group._list(self)
def group(self,
group_id=None,
display_name=None,
parent_id=None,
filter_string=None,
is_cluster=False):
"""Factory constructor for group object.
.. note::
This will not make an HTTP request; it simply instantiates
a group object owned by this client.
:type group_id: str
:param group_id: (Optional) The ID of the group.
:type display_name: str
:param display_name:
(Optional) A user-assigned name for this group, used only for
display purposes.
:type parent_id: str
:param parent_id:
(Optional) The ID of the group's parent, if it has one.
:type filter_string: str
:param filter_string:
(Optional) The filter string used to determine which monitored
resources belong to this group.
:type is_cluster: bool
:param is_cluster:
If true, the members of this group are considered to be a cluster.
The system can perform additional analysis on groups that are
clusters.
:rtype: :class:`Group`
:returns: The group created with the passed-in arguments.
:raises:
:exc:`ValueError` if both ``group_id`` and ``name`` are specified.
"""
return Group(
self,
group_id=group_id,
display_name=display_name,
parent_id=parent_id,
filter_string=filter_string,
is_cluster=is_cluster,
)
def fetch_group(self, group_id):
"""Fetch a group from the API based on it's ID.
Example::
>>> try:
>>> group = client.fetch_group('1234')
>>> except google.cloud.exceptions.NotFound:
>>> print('That group does not exist!')
:type group_id: str
:param group_id: The ID of the group.
:rtype: :class:`~google.cloud.monitoring.group.Group`
:returns: The group instance.
:raises: :class:`google.cloud.exceptions.NotFound` if the group
is not found.
"""
return Group._fetch(self, group_id)
def fetch_group(self, group_id):
"""Fetch a group from the API based on it's ID.
Example::
>>> try:
>>> group = client.fetch_group('1234')
>>> except google.cloud.exceptions.NotFound:
>>> print('That group does not exist!')
:type group_id: string
:param group_id: The ID of the group.
:rtype: :class:`~google.cloud.monitoring.group.Group`
:returns: The group instance.
:raises: :class:`google.cloud.exceptions.NotFound` if the group
is not found.
"""
return Group._fetch(self, group_id)
