Module pagers (0.1.1)

API documentation for sqladmin_v1.services.sql_instances_service.pagers module.

Classes

ListAsyncPager

ListAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.sqladmin_v1.types.cloud_sql_instances.InstancesListResponse
        ],
    ],
    request: google.cloud.sqladmin_v1.types.cloud_sql_instances.SqlInstancesListRequest,
    response: google.cloud.sqladmin_v1.types.cloud_sql_instances.InstancesListResponse,
    *,
    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, typing.Union[str, bytes]]] = ()
)

A pager for iterating through list requests.

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

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

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

ListPager

ListPager(
    method: typing.Callable[
        [...], google.cloud.sqladmin_v1.types.cloud_sql_instances.InstancesListResponse
    ],
    request: google.cloud.sqladmin_v1.types.cloud_sql_instances.SqlInstancesListRequest,
    response: google.cloud.sqladmin_v1.types.cloud_sql_instances.InstancesListResponse,
    *,
    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, typing.Union[str, bytes]]] = ()
)

A pager for iterating through list requests.

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

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

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