Class ListDevicesPager (2.6.1)

Version 2.6.1

• 2.9.2 (latest)
• 2.9.1
• 2.8.1
• 2.7.0
• 2.6.4
• 2.5.1
• 2.4.1
• 2.3.0
• 2.2.1
• 2.1.0
• 2.0.2
• 1.0.2
• 0.3.3

ListDevicesPager(
    method: Callable[
        [...], google.cloud.iot_v1.types.device_manager.ListDevicesResponse
    ],
    request: google.cloud.iot_v1.types.device_manager.ListDevicesRequest,
    response: google.cloud.iot_v1.types.device_manager.ListDevicesResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through list_devices requests.

This class thinly wraps an initial ListDevicesResponse object, and provides an __iter__ method to iterate through its devices field.

If there are more pages, the __iter__ method will make additional ListDevices requests and continue to iterate through the devices field on the corresponding responses.

All the usual ListDevicesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Inheritance

builtins.object > ListDevicesPager

Methods

ListDevicesPager

ListDevicesPager(
    method: Callable[
        [...], google.cloud.iot_v1.types.device_manager.ListDevicesResponse
    ],
    request: google.cloud.iot_v1.types.device_manager.ListDevicesRequest,
    response: google.cloud.iot_v1.types.device_manager.ListDevicesResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

Instantiate the pager.

Parameters

Name	Description
method	Callable The method that was originally called, and which instantiated this pager.
request	google.cloud.iot_v1.types.ListDevicesRequest The initial request object.
response	google.cloud.iot_v1.types.ListDevicesResponse The initial response object.
metadata	Sequence[Tuple[str, str]] Strings which should be sent along with the request as metadata.