DefaultPaginator
Default pagination implementation to request pages of results with a fixed size until the pagination strategy no longer returns a next_page_token.
- type:
object - required:
["type","pagination_strategy"]
type
- Required: Yes
- type:
string - enum:
["DefaultPaginator"]
pagination_strategy
Strategy defining how records are paginated.
-
Required: Yes
-
anyOf:
- Allowed type:
PageIncrement
- Allowed type:
-
anyOf:
- Allowed type:
OffsetIncrement
- Allowed type:
-
anyOf:
- Allowed type:
CursorPagination
- Allowed type:
-
anyOf:
- Allowed type:
CustomPaginationStrategy
- Allowed type:
page_size_option
- Required: No
- Allowed type:
RequestOption
page_token_option
Inject the page token into the outgoing HTTP requests by inserting it into either the request URL path or a field on the request.
-
Required: No
-
anyOf:
- Allowed type:
RequestOption
- Allowed type:
-
anyOf:
- Allowed type:
RequestPath
- Allowed type:
$parameters
- Required: No
- type:
object