singer_sdk.pagination.HeaderLinkPaginator

class singer_sdk.pagination.HeaderLinkPaginator

Paginator class for APIs supporting HATEOAS links in their headers.

Links:

• https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Link

• https://datatracker.ietf.org/doc/html/rfc8288#section-3

get_next_url(response)

Override this method to extract a HATEOAS link from the response.

Parameters:

response (requests.Response) – API response object.

Returns:

A HATEOAS link parsed from the response headers.

Return type:

str | None