Skip to content

feat: add helper methods metric_descriptor_path and parse_metric_descriptor_path #12465

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ohmayr merged 4 commits into from
Mar 18, 2024
Merged

feat: add helper methods metric_descriptor_path and parse_metric_descriptor_path #12465

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
44d9502
chore: Update gapic-generator-python to v1.15.0
gcf-owl-bot[bot] Mar 15, 2024
51b8fa3
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Mar 15, 2024
309dcb6
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Mar 15, 2024
3f59871
Merge branch 'owl-bot-copy-packages-google-cloud-monitoring' of https…
gcf-owl-bot[bot] Mar 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions ...oogle-cloud-monitoring/google/cloud/monitoring_v3/services/metric_service/async_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
)
Expand Down
20 changes: 20 additions & 0 deletions ...ages/google-cloud-monitoring/google/cloud/monitoring_v3/services/metric_service/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
23 changes: 23 additions & 0 deletions packages/google-cloud-monitoring/tests/unit/gapic/monitoring_v3/test_metric_service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down