Class QueryTimeSeriesAsyncPager (2.24.0)

QueryTimeSeriesAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.monitoring_v3.types.metric_service.QueryTimeSeriesResponse
        ],
    ],
    request: google.cloud.monitoring_v3.types.metric_service.QueryTimeSeriesRequest,
    response: google.cloud.monitoring_v3.types.metric_service.QueryTimeSeriesResponse,
    *,
    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 query_time_series requests.

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

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

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

QueryTimeSeriesAsyncPager

QueryTimeSeriesAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.monitoring_v3.types.metric_service.QueryTimeSeriesResponse
        ],
    ],
    request: google.cloud.monitoring_v3.types.metric_service.QueryTimeSeriesRequest,
    response: google.cloud.monitoring_v3.types.metric_service.QueryTimeSeriesResponse,
    *,
    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_v3.types.QueryTimeSeriesRequest

The initial request object.

response google.cloud.monitoring_v3.types.QueryTimeSeriesResponse

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.