Class ListSessionsPager (3.18.0)

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

Inheritance

builtins.object > ListSessionsPager

Methods

ListSessionsPager

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

The initial request object.

response google.cloud.spanner_v1.types.ListSessionsResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

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