Class ListConnectionsPager (1.3.1)

ListConnectionsPager(
    method: Callable[
        [...], google.cloud.apigeeconnect_v1.types.connection.ListConnectionsResponse
    ],
    request: google.cloud.apigeeconnect_v1.types.connection.ListConnectionsRequest,
    response: google.cloud.apigeeconnect_v1.types.connection.ListConnectionsResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through list_connections requests.

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

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

All the usual ListConnectionsResponse 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 > ListConnectionsPager

Methods

ListConnectionsPager

ListConnectionsPager(
    method: Callable[
        [...], google.cloud.apigeeconnect_v1.types.connection.ListConnectionsResponse
    ],
    request: google.cloud.apigeeconnect_v1.types.connection.ListConnectionsRequest,
    response: google.cloud.apigeeconnect_v1.types.connection.ListConnectionsResponse,
    *,
    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.apigeeconnect_v1.types.ListConnectionsRequest

The initial request object.

response google.cloud.apigeeconnect_v1.types.ListConnectionsResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

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