Class ListGatewaysPager (1.3.2)

ListGatewaysPager(
    method: Callable[
        [...], google.cloud.apigateway_v1.types.apigateway.ListGatewaysResponse
    ],
    request: google.cloud.apigateway_v1.types.apigateway.ListGatewaysRequest,
    response: google.cloud.apigateway_v1.types.apigateway.ListGatewaysResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through list_gateways requests.

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

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

All the usual ListGatewaysResponse 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 > ListGatewaysPager

Methods

ListGatewaysPager

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

The initial request object.

response google.cloud.apigateway_v1.types.ListGatewaysResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

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