feat: add helper methods metric_descriptor_path and parse_metric_descriptor_path (googleapis#12465)

gcf-owl-bot[bot] · web-flow · commit 06d3f6fc3fa1 · 2024-03-18T11:23:59.000-04:00
BEGIN_COMMIT_OVERRIDE chore: Update gapic-generator-python to v1.15.0 END_COMMIT_OVERRIDE - [ ] Regenerate this pull request now. PiperOrigin-RevId: 616192742 Source-Link: googleapis/googleapis@2ac4161 Source-Link: https://github.com/googleapis/googleapis-gen/commit/e57565057c4f28fa0de75c03412195a0ba7e42e1 Copy-Tag: eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLW1vbml0b3JpbmcvLk93bEJvdC55YW1sIiwiaCI6ImU1NzU2NTA1N2M0ZjI4ZmEwZGU3NWMwMzQxMjE5NWEwYmE3ZTQyZTEifQ== --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
diff --git a/packages/google-cloud-monitoring/google/cloud/monitoring_v3/services/metric_service/async_client.py b/packages/google-cloud-monitoring/google/cloud/monitoring_v3/services/metric_service/async_client.py
@@ -71,6 +71,10 @@ class MetricServiceAsyncClient:
     _DEFAULT_ENDPOINT_TEMPLATE = MetricServiceClient._DEFAULT_ENDPOINT_TEMPLATE
     _DEFAULT_UNIVERSE = MetricServiceClient._DEFAULT_UNIVERSE
 
+    metric_descriptor_path = staticmethod(MetricServiceClient.metric_descriptor_path)
+    parse_metric_descriptor_path = staticmethod(
+        MetricServiceClient.parse_metric_descriptor_path
+    )
     monitored_resource_descriptor_path = staticmethod(
         MetricServiceClient.monitored_resource_descriptor_path
     )
diff --git a/packages/google-cloud-monitoring/google/cloud/monitoring_v3/services/metric_service/client.py b/packages/google-cloud-monitoring/google/cloud/monitoring_v3/services/metric_service/client.py
@@ -187,6 +187,26 @@ def transport(self) -> MetricServiceTransport:
         """
         return self._transport
 
+    @staticmethod
+    def metric_descriptor_path(
+        project: str,
+        metric_descriptor: str,
+    ) -> str:
+        """Returns a fully-qualified metric_descriptor string."""
+        return "projects/{project}/metricDescriptors/{metric_descriptor}".format(
+            project=project,
+            metric_descriptor=metric_descriptor,
+        )
+
+    @staticmethod
+    def parse_metric_descriptor_path(path: str) -> Dict[str, str]:
+        """Parses a metric_descriptor path into its component segments."""
+        m = re.match(
+            r"^projects/(?P<project>.+?)/metricDescriptors/(?P<metric_descriptor>.+?)$",
+            path,
+        )
+        return m.groupdict() if m else {}
+
     @staticmethod
     def monitored_resource_descriptor_path(
         project: str,
diff --git a/packages/google-cloud-monitoring/tests/unit/gapic/monitoring_v3/test_metric_service.py b/packages/google-cloud-monitoring/tests/unit/gapic/monitoring_v3/test_metric_service.py
@@ -4536,6 +4536,29 @@ def test_metric_service_transport_channel_mtls_with_adc(transport_class):
             assert transport.grpc_channel == mock_grpc_channel
 
 
+def test_metric_descriptor_path():
+    project = "squid"
+    metric_descriptor = "clam"
+    expected = "projects/{project}/metricDescriptors/{metric_descriptor}".format(
+        project=project,
+        metric_descriptor=metric_descriptor,
+    )
+    actual = MetricServiceClient.metric_descriptor_path(project, metric_descriptor)
+    assert expected == actual
+
+
+def test_parse_metric_descriptor_path():
+    expected = {
+        "project": "whelk",
+        "metric_descriptor": "octopus",
+    }
+    path = MetricServiceClient.metric_descriptor_path(**expected)
+
+    # Check that the path construction is reversible.
+    actual = MetricServiceClient.parse_metric_descriptor_path(path)
+    assert expected == actual
+
+
 def test_monitored_resource_descriptor_path():
     project = "oyster"
     monitored_resource_descriptor = "nudibranch"
