Reference for hub_sdk/base/paginated_list.py
Note
This file is available at https://github.com/ultralytics/hub-sdk/blob/main/hub_sdk/base/paginated_list.py. If you spot a problem please help fix it by contributing a Pull Request 🛠️. Thank you 🙏!
hub_sdk.base.paginated_list.PaginatedList
Bases: APIClient
Source code in hub_sdk/base/paginated_list.py
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 |
|
__init__(base_endpoint, name, page_size=None, public=None, headers=None)
Initialize a PaginatedList instance.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
base_endpoint |
str
|
The base API endpoint for the paginated resource. |
required |
name |
str
|
A descriptive name for the paginated resource. |
required |
page_size |
int
|
The number of items per page. |
None
|
headers |
dict
|
Additional headers to include in API requests. |
None
|
Source code in hub_sdk/base/paginated_list.py
__update_data(resp)
Update the internal data with the response from the API.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
resp |
Response
|
API response data. |
required |
Source code in hub_sdk/base/paginated_list.py
list(page_size=10, last_record=None, query=None)
Retrieve a list of items from the API.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
page_size |
int
|
The number of items per page. |
10
|
last_record |
str
|
ID of the last record from the previous page. |
None
|
query |
dict
|
Additional query parameters for the API request. |
None
|
Returns:
Type | Description |
---|---|
Optional[Response]
|
Response object from the list request, or None if it fails. |
Source code in hub_sdk/base/paginated_list.py
next()
Move to the next page of results if available.
Source code in hub_sdk/base/paginated_list.py
previous()
Move to the previous page of results if available.