Class ListDashboardsAsyncPager (2.15.3)

ListDashboardsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.monitoring_dashboard_v1.types.dashboards_service.ListDashboardsResponse
        ],
    ],
    request: google.cloud.monitoring_dashboard_v1.types.dashboards_service.ListDashboardsRequest,
    response: google.cloud.monitoring_dashboard_v1.types.dashboards_service.ListDashboardsResponse,
    *,
    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_dashboards requests.

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

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

All the usual ListDashboardsResponse 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

ListDashboardsAsyncPager

ListDashboardsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.monitoring_dashboard_v1.types.dashboards_service.ListDashboardsResponse
        ],
    ],
    request: google.cloud.monitoring_dashboard_v1.types.dashboards_service.ListDashboardsRequest,
    response: google.cloud.monitoring_dashboard_v1.types.dashboards_service.ListDashboardsResponse,
    *,
    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]] = ()
)

Instantiates the pager.

Parameters
Name Description
method Callable

The method that was originally called, and which instantiated this pager.

request google.cloud.monitoring_dashboard_v1.types.ListDashboardsRequest

The initial request object.

response google.cloud.monitoring_dashboard_v1.types.ListDashboardsResponse

The initial response object.

retry google.api_core.retry.AsyncRetry

Designation of what errors, if any, should be retried.

timeout float

The timeout for this request.

metadata Sequence[Tuple[str, str]]

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