Index

frequenz.client.common.pagination

Pagination types used by common clients.

Classes

frequenz.client.common.pagination.PaginationInfo dataclass

Information about the pagination of a list request.

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

@dataclass(frozen=True, kw_only=True)
class PaginationInfo:
    """Information about the pagination of a list request."""

    total_items: int
    """The total number of items that match the request."""

    next_page_token: str | None = None
    """The token identifying the next page of results."""

Attributes

next_page_token class-attribute instance-attribute

next_page_token: str | None = None

The token identifying the next page of results.

total_items instance-attribute

total_items: int

The total number of items that match the request.