Class ListApisPager (1.2.2)

ListApisPager(
    method: Callable[
        [...], google.cloud.apigateway_v1.types.apigateway.ListApisResponse
    ],
    request: google.cloud.apigateway_v1.types.apigateway.ListApisRequest,
    response: google.cloud.apigateway_v1.types.apigateway.ListApisResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through list_apis requests.

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

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

All the usual ListApisResponse 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 > ListApisPager

Methods

ListApisPager

ListApisPager(
    method: Callable[
        [...], google.cloud.apigateway_v1.types.apigateway.ListApisResponse
    ],
    request: google.cloud.apigateway_v1.types.apigateway.ListApisRequest,
    response: google.cloud.apigateway_v1.types.apigateway.ListApisResponse,
    *,
    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.apigateway_v1.types.ListApisRequest

The initial request object.

response google.cloud.apigateway_v1.types.ListApisResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

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