def test_get_metric_descriptor(self):
# Setup Expected Response
name_2 = 'name2-1052831874'
type_ = 'type3575610'
unit = 'unit3594628'
description = 'description-1724546052'
display_name = 'displayName1615086568'
expected_response = {
'name': name_2,
'type': type_,
'unit': unit,
'description': description,
'display_name': display_name
}
expected_response = api_metric_pb2.MetricDescriptor(
**expected_response)
# Mock the API response
channel = ChannelStub(responses=[expected_response])
client = monitoring_v3.MetricServiceClient(channel=channel)
# Setup Request
name = client.metric_descriptor_path('[PROJECT]',
'[METRIC_DESCRIPTOR]')
response = client.get_metric_descriptor(name)
assert expected_response == response
assert len(channel.requests) == 1
expected_request = metric_service_pb2.GetMetricDescriptorRequest(
name=name)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def get_metric_descriptor(self,
name,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None):
"""
Gets a single metric descriptor. This method does not require a Stackdriver account.
Example:
>>> from google.cloud import monitoring_v3
>>>
>>> client = monitoring_v3.MetricServiceClient()
>>>
>>> name = client.metric_descriptor_path('[PROJECT]', '[METRIC_DESCRIPTOR]')
>>>
>>> response = client.get_metric_descriptor(name)
Args:
name (str): The metric descriptor on which to execute the request. The format is
``"projects/{project_id_or_number}/metricDescriptors/{metric_id}"``. An
example value of ``{metric_id}`` is
``"compute.googleapis.com/instance/disk/read_bytes_count"``.
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.cloud.monitoring_v3.types.MetricDescriptor` instance.
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 'get_metric_descriptor' not in self._inner_api_calls:
self._inner_api_calls[
'get_metric_descriptor'] = google.api_core.gapic_v1.method.wrap_method(
self.transport.get_metric_descriptor,
default_retry=self._method_configs['GetMetricDescriptor'].
retry,
default_timeout=self.
_method_configs['GetMetricDescriptor'].timeout,
client_info=self._client_info,
)
request = metric_service_pb2.GetMetricDescriptorRequest(name=name, )
return self._inner_api_calls['get_metric_descriptor'](
request, retry=retry, timeout=timeout, metadata=metadata)
def test_get_metric_descriptor(self):
# Setup Expected Response
name_2 = "name2-1052831874"
type_ = "type3575610"
unit = "unit3594628"
description = "description-1724546052"
display_name = "displayName1615086568"
expected_response = {
"name": name_2,
"type": type_,
"unit": unit,
"description": description,
"display_name": display_name,
}
expected_response = api_metric_pb2.MetricDescriptor(
**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.metric_descriptor_path("[PROJECT]",
"[METRIC_DESCRIPTOR]")
response = client.get_metric_descriptor(name)
assert expected_response == response
assert len(channel.requests) == 1
expected_request = metric_service_pb2.GetMetricDescriptorRequest(
name=name)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
