Paged Class

A container for paged REST responses.

Inheritance
Paged

Constructor

Paged(command, classes, raw_headers=None, **kwargs)

Parameters

response
<xref:ClientResponse>
Required

server response object.

command
callable
Required

Function to retrieve the next page of items.

classes
dict
Required

A dictionary of class dependencies for deserialization.

raw_headers
dict
Required

A dict of raw headers to add if "raw" is called

Methods

advance_page

Force moving the cursor to the next azure call.

This method is for advanced usage, iterator protocol is prefered.

get

Get an arbitrary page.

This resets the iterator and then fully consumes it to return the specific page only.

next

Iterate through responses.

reset

Reset iterator to first page.

advance_page

Force moving the cursor to the next azure call.

This method is for advanced usage, iterator protocol is prefered.

advance_page()

Returns

The current page list

Return type

get

Get an arbitrary page.

This resets the iterator and then fully consumes it to return the specific page only.

get(url)

Parameters

url
str
Required

URL to arbitrary page results.

next

Iterate through responses.

next()

reset

Reset iterator to first page.

reset()

Attributes

raw

Get current page as ClientRawResponse.

Return type

<xref:ClientRawResponse>