Module pagers (2.17.0)

API documentation for monitoring_dashboard_v1.services.dashboards_service.pagers module.

Classes

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, typing.Union[str, bytes]]] = ()
)

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.

ListDashboardsPager

ListDashboardsPager(
    method: typing.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,
    *,
    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_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.