singer_sdk.pagination.BaseOffsetPaginator#
- class singer_sdk.pagination.BaseOffsetPaginator#
Paginator class for APIs that use page offset.
- __init__(start_value: int, page_size: int, *args: Any, **kwargs: Any) None #
Create a new paginator.
- Parameters:
start_value – Initial value.
page_size – Constant page size.
args – Paginator positional arguments.
kwargs – Paginator keyword arguments.
- get_next(response: Response) int | None #
Get the next page offset.
- Parameters:
response – API response object.
- Returns:
The next page offset.
- abstract has_more(response: Response) bool #
Override this method to check if the endpoint has any pages left.
- Parameters:
response – API response object.
- Returns:
Boolean flag used to indicate if the endpoint has more pages.