Class ListNodesPager (1.3.4)

ListNodesPager(
    method: Callable[
        [...], google.cloud.tpu_v2alpha1.types.cloud_tpu.ListNodesResponse
    ],
    request: google.cloud.tpu_v2alpha1.types.cloud_tpu.ListNodesRequest,
    response: google.cloud.tpu_v2alpha1.types.cloud_tpu.ListNodesResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through list_nodes requests.

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

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

All the usual ListNodesResponse 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 > ListNodesPager

Methods

ListNodesPager

ListNodesPager(
    method: Callable[
        [...], google.cloud.tpu_v2alpha1.types.cloud_tpu.ListNodesResponse
    ],
    request: google.cloud.tpu_v2alpha1.types.cloud_tpu.ListNodesRequest,
    response: google.cloud.tpu_v2alpha1.types.cloud_tpu.ListNodesResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

Instantiate the pager.

Parameters
NameDescription
method Callable

The method that was originally called, and which instantiated this pager.

request google.cloud.tpu_v2alpha1.types.ListNodesRequest

The initial request object.

response google.cloud.tpu_v2alpha1.types.ListNodesResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

Strings which should be sent along with the request as metadata.