pagination¶

Contents¶

Request parameters for page-based pagination.

Field	Type	Description
page_number	int64	Page number is the page number to return based on the size.
page_size	int64	Page size is the maximum number of records to include per page.

Metadata related to page based pagination for paginated API responses.

Field	Type	Description
total_records	int64	Total records without pagination available in the dataset.
current_page	int64	Current page number for this paginated response.
page_size	int64	Page size used for pagination.
total_pages	int64	Total pages based on the page_size provided in the request.
next_page	int64	Next page if available in the dataset, -1 if unavailable.
prev_page	int64	Previous page if available in the dataset, -1 if unavailable.

.proto Type	Notes	C++ Type	Java Type	Python Type
double		double	double	float
float		float	float	float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int32	int	int
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int64	long	int/long
uint32	Uses variable-length encoding.	uint32	int	int/long
uint64	Uses variable-length encoding.	uint64	long	int/long
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int32	int	int
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int64	long	int/long
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	uint32	int	int
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	uint64	long	int/long
sfixed32	Always four bytes.	int32	int	int
sfixed64	Always eight bytes.	int64	long	int/long
bool		bool	boolean	boolean
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	string	String	str/unicode
bytes	May contain any arbitrary sequence of bytes.	string	ByteString	str