Skip to content

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 PaginationInfo to a PaginationInfo object.

PARAMETER DESCRIPTION
message

The protobuf message to convert.

TYPE: PaginationInfo

RETURNS DESCRIPTION
PaginationInfo

The resulting PaginationInfo object.
Source code in src/frequenz/client/common/pagination/proto/v1alpha8/_pagination_info.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
def pagination_info_from_proto(message: PaginationInfoPb) -> PaginationInfo:
    """Convert a protobuf PaginationInfo to a PaginationInfo object.

    Args:
        message: The protobuf message to convert.

    Returns:
        The resulting 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 PaginationInfo.

PARAMETER DESCRIPTION
info

The PaginationInfo object to convert.

TYPE: PaginationInfo

RETURNS DESCRIPTION
PaginationInfo

The resulting protobuf message.
Source code in src/frequenz/client/common/pagination/proto/v1alpha8/_pagination_info.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
def pagination_info_to_proto(info: PaginationInfo) -> PaginationInfoPb:
    """Convert a PaginationInfo object to a protobuf PaginationInfo.

    Args:
        info: The PaginationInfo object to convert.

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