Module pagers (0.1.0)

API documentation for chronicle_v1.services.entity_service.pagers module.

Classes

ListWatchlistsAsyncPager

ListWatchlistsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[google.cloud.chronicle_v1.types.entity.ListWatchlistsResponse],
    ],
    request: google.cloud.chronicle_v1.types.entity.ListWatchlistsRequest,
    response: google.cloud.chronicle_v1.types.entity.ListWatchlistsResponse,
    *,
    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_watchlists requests.

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

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

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

ListWatchlistsPager

ListWatchlistsPager(
    method: typing.Callable[
        [...], google.cloud.chronicle_v1.types.entity.ListWatchlistsResponse
    ],
    request: google.cloud.chronicle_v1.types.entity.ListWatchlistsRequest,
    response: google.cloud.chronicle_v1.types.entity.ListWatchlistsResponse,
    *,
    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_watchlists requests.

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

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

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