Class ListDashboardsPager (2.6.1)

ListDashboardsPager(
    method: Callable[
        [...],
        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,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through list_dashboards requests.

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

If there are more pages, the __iter__ 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

ListDashboardsPager

ListDashboardsPager(
    method: Callable[
        [...],
        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,
    *,
    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.monitoring_dashboard_v1.types.ListDashboardsRequest

The initial request object.

response google.cloud.monitoring_dashboard_v1.types.ListDashboardsResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

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