Module pagers (1.10.1)

API documentation for apigateway_v1.services.api_gateway_service.pagers module.

Classes

ListApiConfigsAsyncPager

ListApiConfigsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.apigateway_v1.types.apigateway.ListApiConfigsResponse
        ],
    ],
    request: google.cloud.apigateway_v1.types.apigateway.ListApiConfigsRequest,
    response: google.cloud.apigateway_v1.types.apigateway.ListApiConfigsResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

A pager for iterating through list_api_configs requests.

This class thinly wraps an initial ListApiConfigsResponse object, and provides an __aiter__ method to iterate through its api_configs field.

If there are more pages, the __aiter__ method will make additional ListApiConfigs requests and continue to iterate through the api_configs field on the corresponding responses.

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

ListApiConfigsPager

ListApiConfigsPager(
    method: typing.Callable[
        [...], google.cloud.apigateway_v1.types.apigateway.ListApiConfigsResponse
    ],
    request: google.cloud.apigateway_v1.types.apigateway.ListApiConfigsRequest,
    response: google.cloud.apigateway_v1.types.apigateway.ListApiConfigsResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

A pager for iterating through list_api_configs requests.

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

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

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

ListApisAsyncPager

ListApisAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[google.cloud.apigateway_v1.types.apigateway.ListApisResponse],
    ],
    request: google.cloud.apigateway_v1.types.apigateway.ListApisRequest,
    response: google.cloud.apigateway_v1.types.apigateway.ListApisResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

A pager for iterating through list_apis requests.

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

If there are more pages, the __aiter__ 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.

ListApisPager

ListApisPager(
    method: typing.Callable[
        [...], google.cloud.apigateway_v1.types.apigateway.ListApisResponse
    ],
    request: google.cloud.apigateway_v1.types.apigateway.ListApisRequest,
    response: google.cloud.apigateway_v1.types.apigateway.ListApisResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.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.

ListGatewaysAsyncPager

ListGatewaysAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.apigateway_v1.types.apigateway.ListGatewaysResponse
        ],
    ],
    request: google.cloud.apigateway_v1.types.apigateway.ListGatewaysRequest,
    response: google.cloud.apigateway_v1.types.apigateway.ListGatewaysResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

A pager for iterating through list_gateways requests.

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

If there are more pages, the __aiter__ 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.

ListGatewaysPager

ListGatewaysPager(
    method: typing.Callable[
        [...], google.cloud.apigateway_v1.types.apigateway.ListGatewaysResponse
    ],
    request: google.cloud.apigateway_v1.types.apigateway.ListGatewaysRequest,
    response: google.cloud.apigateway_v1.types.apigateway.ListGatewaysResponse,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.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.