def test_list_alert_policies(self):
# Setup Expected Response
next_page_token = ""
alert_policies_element = {}
alert_policies = [alert_policies_element]
expected_response = {
"next_page_token": next_page_token,
"alert_policies": alert_policies,
}
expected_response = alert_service_pb2.ListAlertPoliciesResponse(
**expected_response
)
# Mock the API response
channel = ChannelStub(responses=[expected_response])
patch = mock.patch("google.api_core.grpc_helpers.create_channel")
with patch as create_channel:
create_channel.return_value = channel
client = monitoring_v3.AlertPolicyServiceClient()
# Setup Request
name = client.project_path("[PROJECT]")
paged_list_response = client.list_alert_policies(name)
resources = list(paged_list_response)
assert len(resources) == 1
assert expected_response.alert_policies[0] == resources[0]
assert len(channel.requests) == 1
expected_request = alert_service_pb2.ListAlertPoliciesRequest(name=name)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def test_list_alert_policies(self):
# Setup Expected Response
next_page_token = ''
alert_policies_element = {}
alert_policies = [alert_policies_element]
expected_response = {
'next_page_token': next_page_token,
'alert_policies': alert_policies
}
expected_response = alert_service_pb2.ListAlertPoliciesResponse(
**expected_response)
# Mock the API response
channel = ChannelStub(responses=[expected_response])
client = monitoring_v3.AlertPolicyServiceClient(channel=channel)
# Setup Request
name = client.project_path('[PROJECT]')
paged_list_response = client.list_alert_policies(name)
resources = list(paged_list_response)
assert len(resources) == 1
assert expected_response.alert_policies[0] == resources[0]
assert len(channel.requests) == 1
expected_request = alert_service_pb2.ListAlertPoliciesRequest(
name=name)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def list_alert_policies(
self,
name,
filter_=None,
order_by=None,
page_size=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Lists the existing alerting policies for the project.
Example:
>>> from google.cloud import monitoring_v3
>>>
>>> client = monitoring_v3.AlertPolicyServiceClient()
>>>
>>> name = client.project_path('[PROJECT]')
>>>
>>> # Iterate over all results
>>> for element in client.list_alert_policies(name):
... # process element
... pass
>>>
>>>
>>> # Alternatively:
>>>
>>> # Iterate over results one page at a time
>>> for page in client.list_alert_policies(name).pages:
... for element in page:
... # process element
... pass
Args:
name (str): The project whose alert policies are to be listed. The format is
projects/[PROJECT_ID]
Note that this field names the parent container in which the alerting
policies to be listed are stored. To retrieve a single alerting policy
by name, use the ``GetAlertPolicy`` operation, instead.
filter_ (str): If provided, this field specifies the criteria that must be met by alert
policies to be included in the response.
For more details, see `sorting and
filtering <https://cloud.google.com/monitoring/api/v3/sorting-and-filtering>`__.
order_by (str): A comma-separated list of fields by which to sort the result. Supports
the same set of field references as the ``filter`` field. Entries can be
prefixed with a minus sign to sort by the field in descending order.
For more details, see `sorting and
filtering <https://cloud.google.com/monitoring/api/v3/sorting-and-filtering>`__.
page_size (int): The maximum number of resources contained in the
underlying API response. If page streaming is performed per-
resource, this parameter does not affect the return value. If page
streaming is performed per-page, this determines the maximum number
of resources in a page.
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will not
be retried.
timeout (Optional[float]): The amount of time, in seconds, to wait
for the request to complete. Note that if ``retry`` is
specified, the timeout applies to each individual attempt.
metadata (Optional[Sequence[Tuple[str, str]]]): Additional metadata
that is provided to the method.
Returns:
A :class:`~google.gax.PageIterator` instance. By default, this
is an iterable of :class:`~google.cloud.monitoring_v3.types.AlertPolicy` instances.
This object can also be configured to iterate over the pages
of the response through the `options` parameter.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request
failed for any reason.
google.api_core.exceptions.RetryError: If the request failed due
to a retryable error and retry attempts failed.
ValueError: If the parameters are invalid.
"""
if metadata is None:
metadata = []
metadata = list(metadata)
# Wrap the transport method to add retry and timeout logic.
if "list_alert_policies" not in self._inner_api_calls:
self._inner_api_calls[
"list_alert_policies"] = google.api_core.gapic_v1.method.wrap_method(
self.transport.list_alert_policies,
default_retry=self._method_configs["ListAlertPolicies"].
retry,
default_timeout=self._method_configs["ListAlertPolicies"].
timeout,
client_info=self._client_info,
)
request = alert_service_pb2.ListAlertPoliciesRequest(
name=name, filter=filter_, order_by=order_by, page_size=page_size)
if metadata is None:
metadata = []
metadata = list(metadata)
try:
routing_header = [("name", name)]
except AttributeError:
pass
else:
routing_metadata = google.api_core.gapic_v1.routing_header.to_grpc_metadata(
routing_header)
metadata.append(routing_metadata)
iterator = google.api_core.page_iterator.GRPCIterator(
client=None,
method=functools.partial(
self._inner_api_calls["list_alert_policies"],
retry=retry,
timeout=timeout,
metadata=metadata,
),
request=request,
items_field="alert_policies",
request_token_field="page_token",
response_token_field="next_page_token",
)
return iterator