Module pagers (3.51.0)

API documentation for spanner_v1.services.spanner.pagers module.

Classes

ListSessionsAsyncPager

ListSessionsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[google.cloud.spanner_v1.types.spanner.ListSessionsResponse],
    ],
    request: google.cloud.spanner_v1.types.spanner.ListSessionsRequest,
    response: google.cloud.spanner_v1.types.spanner.ListSessionsResponse,
    *,
    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_sessions requests.

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

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

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

ListSessionsPager

ListSessionsPager(
    method: typing.Callable[
        [...], google.cloud.spanner_v1.types.spanner.ListSessionsResponse
    ],
    request: google.cloud.spanner_v1.types.spanner.ListSessionsRequest,
    response: google.cloud.spanner_v1.types.spanner.ListSessionsResponse,
    *,
    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_sessions requests.

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

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

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