Index

frequenz.client.common.metrics.proto

Deprecated compatibility shim for metrics proto conversion functions.

Classes

Functions

frequenz.client.common.metrics.proto.aggregated_metric_sample_from_proto

aggregated_metric_sample_from_proto(
    message: AggregatedMetricValue,
) -> AggregatedMetricValue

Convert a protobuf message to a AggregatedMetricValue object.

PARAMETER	DESCRIPTION
message	The protobuf message to convert. TYPE: AggregatedMetricValue

RETURNS	DESCRIPTION
AggregatedMetricValue	The resulting AggregatedMetricValue object.

Source code in src/frequenz/client/common/metrics/proto/__init__.py

@deprecated(_DEPRECATED_MESSAGE)
def aggregated_metric_sample_from_proto(
    message: metrics_pb2.AggregatedMetricValue,
) -> AggregatedMetricValue:
    """Convert a protobuf message to a `AggregatedMetricValue` object.

    Args:
        message: The protobuf message to convert.

    Returns:
        The resulting `AggregatedMetricValue` object.
    """
    return v1alpha8.aggregated_metric_sample_from_proto(message)

frequenz.client.common.metrics.proto.bounds_from_proto

bounds_from_proto(message: Bounds) -> Bounds

Create a Bounds object from a protobuf message.

PARAMETER	DESCRIPTION
message	The protobuf message to convert. TYPE: Bounds

RETURNS	DESCRIPTION
Bounds	The corresponding Bounds object.

Source code in src/frequenz/client/common/metrics/proto/__init__.py

@deprecated(_DEPRECATED_MESSAGE)
def bounds_from_proto(message: bounds_pb2.Bounds) -> Bounds:
    """Create a `Bounds` object from a protobuf message.

    Args:
        message: The protobuf message to convert.

    Returns:
        The corresponding `Bounds` object.
    """
    return v1alpha8.bounds_from_proto(message)

frequenz.client.common.metrics.proto.bounds_from_proto_with_issues

bounds_from_proto_with_issues(
    message: Bounds,
    *,
    major_issues: list[str],
    minor_issues: list[str]
) -> Bounds | None

Create a Bounds object from a protobuf message, collecting issues.

PARAMETER	DESCRIPTION
message	The protobuf message to convert. TYPE: Bounds
major_issues	A list to append major issues to. TYPE: list[str]
minor_issues	A list to append minor issues to. TYPE: list[str]

RETURNS	DESCRIPTION
Bounds | None	The corresponding Bounds object.

Source code in src/frequenz/client/common/metrics/proto/__init__.py

@deprecated(_DEPRECATED_MESSAGE)
def bounds_from_proto_with_issues(
    message: bounds_pb2.Bounds,
    *,
    major_issues: list[str],
    minor_issues: list[str],
) -> Bounds | None:
    """Create a `Bounds` object from a protobuf message, collecting issues.

    Args:
        message: The protobuf message to convert.
        major_issues: A list to append major issues to.
        minor_issues: A list to append minor issues to.

    Returns:
        The corresponding `Bounds` object.
    """
    return v1alpha8.bounds_from_proto_with_issues(
        message, major_issues=major_issues, minor_issues=minor_issues
    )

frequenz.client.common.metrics.proto.metric_connection_from_proto_with_issues

metric_connection_from_proto_with_issues(
    message: MetricConnection,
    *,
    major_issues: list[str],
    minor_issues: list[str]
) -> MetricConnection

Convert a protobuf message to a MetricConnection object.

PARAMETER	DESCRIPTION
message	The protobuf message to convert. TYPE: MetricConnection
major_issues	A list to append major issues to. TYPE: list[str]
minor_issues	A list to append minor issues to. TYPE: list[str]

RETURNS	DESCRIPTION
MetricConnection	The resulting MetricConnection object.

Source code in src/frequenz/client/common/metrics/proto/__init__.py

@deprecated(_DEPRECATED_MESSAGE)
def metric_connection_from_proto_with_issues(
    message: metrics_pb2.MetricConnection,
    *,
    major_issues: list[str],
    minor_issues: list[str],
) -> MetricConnection:
    """Convert a protobuf message to a `MetricConnection` object.

    Args:
        message: The protobuf message to convert.
        major_issues: A list to append major issues to.
        minor_issues: A list to append minor issues to.

    Returns:
        The resulting `MetricConnection` object.
    """
    return v1alpha8.metric_connection_from_proto_with_issues(
        message, major_issues=major_issues, minor_issues=minor_issues
    )

frequenz.client.common.metrics.proto.metric_sample_from_proto_with_issues

metric_sample_from_proto_with_issues(
    message: MetricSample,
    *,
    major_issues: list[str],
    minor_issues: list[str]
) -> MetricSample

Convert a protobuf message to a MetricSample object.

PARAMETER	DESCRIPTION
message	The protobuf message to convert. TYPE: MetricSample
major_issues	A list to append major issues to. TYPE: list[str]
minor_issues	A list to append minor issues to. TYPE: list[str]

RETURNS	DESCRIPTION
MetricSample	The resulting MetricSample object.

Source code in src/frequenz/client/common/metrics/proto/__init__.py

@deprecated(_DEPRECATED_MESSAGE)
def metric_sample_from_proto_with_issues(
    message: metrics_pb2.MetricSample,
    *,
    major_issues: list[str],
    minor_issues: list[str],
) -> MetricSample:
    """Convert a protobuf message to a `MetricSample` object.

    Args:
        message: The protobuf message to convert.
        major_issues: A list to append major issues to.
        minor_issues: A list to append minor issues to.

    Returns:
        The resulting `MetricSample` object.
    """
    return v1alpha8.metric_sample_from_proto_with_issues(
        message, major_issues=major_issues, minor_issues=minor_issues
    )