v1alpha8

frequenz.client.common.pagination.proto.v1alpha8

Conversion of pagination objects from/to protobuf v1alpha8.

Functions:

frequenz.client.common.pagination.proto.v1alpha8.pagination_info_from_proto

pagination_info_from_proto(
    message: PaginationInfo,
) -> PaginationInfo

Convert a protobuf message to a PaginationInfo object.

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

RETURNS	DESCRIPTION
PaginationInfo	The corresponding PaginationInfo object.

Source code in src/frequenz/client/common/pagination/proto/v1alpha8/_pagination_info.py

def pagination_info_from_proto(message: PaginationInfoPb) -> PaginationInfo:
    """Convert a protobuf message to a [`PaginationInfo`][....PaginationInfo] object.

    Args:
        message: The protobuf message to convert.

    Returns:
        The corresponding [`PaginationInfo`][....PaginationInfo] object.
    """
    return PaginationInfo(
        total_items=message.total_items,
        next_page_token=message.next_page_token if message.next_page_token else None,
    )

frequenz.client.common.pagination.proto.v1alpha8.pagination_info_to_proto

pagination_info_to_proto(
    info: PaginationInfo,
) -> PaginationInfo

Convert a PaginationInfo object to a protobuf message.

PARAMETER	DESCRIPTION
info	The PaginationInfo object to convert. TYPE: PaginationInfo

RETURNS	DESCRIPTION
PaginationInfo	The corresponding protobuf message.

Source code in src/frequenz/client/common/pagination/proto/v1alpha8/_pagination_info.py

def pagination_info_to_proto(info: PaginationInfo) -> PaginationInfoPb:
    """Convert a [`PaginationInfo`][....PaginationInfo] object to a protobuf message.

    Args:
        info: The [`PaginationInfo`][....PaginationInfo] object to convert.

    Returns:
        The corresponding protobuf message.
    """
    return PaginationInfoPb(
        total_items=info.total_items,
        next_page_token=info.next_page_token,
    )