def test_list_metric_descriptors(self): # Setup Expected Response next_page_token = "" metric_descriptors_element = {} metric_descriptors = [metric_descriptors_element] expected_response = { "next_page_token": next_page_token, "metric_descriptors": metric_descriptors, } expected_response = metric_service_pb2.ListMetricDescriptorsResponse( **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.MetricServiceClient() # Setup Request name = client.project_path("[PROJECT]") paged_list_response = client.list_metric_descriptors(name) resources = list(paged_list_response) assert len(resources) == 1 assert expected_response.metric_descriptors[0] == resources[0] assert len(channel.requests) == 1 expected_request = metric_service_pb2.ListMetricDescriptorsRequest( name=name) actual_request = channel.requests[0][1] assert expected_request == actual_request
def test_list_metric_descriptors(self): # Setup Expected Response next_page_token = '' metric_descriptors_element = {} metric_descriptors = [metric_descriptors_element] expected_response = { 'next_page_token': next_page_token, 'metric_descriptors': metric_descriptors } expected_response = metric_service_pb2.ListMetricDescriptorsResponse( **expected_response) # Mock the API response channel = ChannelStub(responses=[expected_response]) client = monitoring_v3.MetricServiceClient(channel=channel) # Setup Request name = client.project_path('[PROJECT]') paged_list_response = client.list_metric_descriptors(name) resources = list(paged_list_response) assert len(resources) == 1 assert expected_response.metric_descriptors[0] == resources[0] assert len(channel.requests) == 1 expected_request = metric_service_pb2.ListMetricDescriptorsRequest( name=name) actual_request = channel.requests[0][1] assert expected_request == actual_request
def list_metric_descriptors( self, name, filter_=None, page_size=None, retry=google.api_core.gapic_v1.method.DEFAULT, timeout=google.api_core.gapic_v1.method.DEFAULT, metadata=None, ): """ Lists metric descriptors that match a filter. This method does not require a Stackdriver account. Example: >>> from google.cloud import monitoring_v3 >>> >>> client = monitoring_v3.MetricServiceClient() >>> >>> name = client.project_path('[PROJECT]') >>> >>> # Iterate over all results >>> for element in client.list_metric_descriptors(name): ... # process element ... pass >>> >>> >>> # Alternatively: >>> >>> # Iterate over results one page at a time >>> for page in client.list_metric_descriptors(name).pages: ... for element in page: ... # process element ... pass Args: name (str): The project on which to execute the request. The format is ``"projects/{project_id_or_number}"``. filter_ (str): If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the `filter <https://cloud.google.com/monitoring/api/v3/filters>`__ specifies which metric descriptors are to be returned. For example, the following filter matches all `custom metrics <https://cloud.google.com/monitoring/custom-metrics>`__: :: metric.type = starts_with("custom.googleapis.com/") 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 be retried using a default configuration. 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.api_core.page_iterator.PageIterator` instance. An iterable of :class:`~google.cloud.monitoring_v3.types.MetricDescriptor` instances. You can also iterate over the pages of the response using its `pages` property. 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_metric_descriptors" not in self._inner_api_calls: self._inner_api_calls[ "list_metric_descriptors"] = google.api_core.gapic_v1.method.wrap_method( self.transport.list_metric_descriptors, default_retry=self. _method_configs["ListMetricDescriptors"].retry, default_timeout=self. _method_configs["ListMetricDescriptors"].timeout, client_info=self._client_info, ) request = metric_service_pb2.ListMetricDescriptorsRequest( name=name, filter=filter_, 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_metric_descriptors"], retry=retry, timeout=timeout, metadata=metadata, ), request=request, items_field="metric_descriptors", request_token_field="page_token", response_token_field="next_page_token", ) return iterator
def list_metric_descriptors( self, name, filter_=None, page_size=None, retry=google.api_core.gapic_v1.method.DEFAULT, timeout=google.api_core.gapic_v1.method.DEFAULT, metadata=None): """ Lists metric descriptors that match a filter. This method does not require a Stackdriver account. Example: >>> from google.cloud import monitoring_v3 >>> >>> client = monitoring_v3.MetricServiceClient() >>> >>> name = client.project_path('[PROJECT]') >>> >>> >>> # Iterate over all results >>> for element in client.list_metric_descriptors(name): ... # process element ... pass >>> >>> # Or iterate over results one page at a time >>> for page in client.list_metric_descriptors(name, options=CallOptions(page_token=INITIAL_PAGE)): ... for element in page: ... # process element ... pass Args: name (str): The project on which to execute the request. The format is ``\"projects/{project_id_or_number}\"``. filter_ (str): If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the `filter <https://cloud.google.com/monitoring/api/v3/filters>`_ specifies which metric descriptors are to be returned. For example, the following filter matches all `custom metrics <https://cloud.google.com/monitoring/custom-metrics>`_: :: metric.type = starts_with(\"custom.googleapis.com/\") 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.MetricDescriptor` 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) request = metric_service_pb2.ListMetricDescriptorsRequest( name=name, filter=filter_, page_size=page_size, ) iterator = google.api_core.page_iterator.GRPCIterator( client=None, method=functools.partial(self._list_metric_descriptors, retry=retry, timeout=timeout, metadata=metadata), request=request, items_field='metric_descriptors', request_token_field='page_token', response_token_field='next_page_token', ) return iterator