Class ListDatabasesPager (3.43.0)

ListDatabasesPager(
    method: typing.Callable[
        [...],
        google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabasesResponse,
    ],
    request: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabasesRequest,
    response: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabasesResponse,
    *,
    metadata: typing.Sequence[typing.Tuple[str, str]] = ()
)

A pager for iterating through list_databases requests.

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

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

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

Methods

ListDatabasesPager

ListDatabasesPager(
    method: typing.Callable[
        [...],
        google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabasesResponse,
    ],
    request: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabasesRequest,
    response: google.cloud.spanner_admin_database_v1.types.spanner_database_admin.ListDatabasesResponse,
    *,
    metadata: typing.Sequence[typing.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_admin_database_v1.types.ListDatabasesRequest

The initial request object.

response google.cloud.spanner_admin_database_v1.types.ListDatabasesResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

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