Class ListUserEventsPager (0.8.1)

ListUserEventsPager(
    method: Callable[
        [...],
        google.cloud.recommendationengine_v1beta1.types.user_event_service.ListUserEventsResponse,
    ],
    request: google.cloud.recommendationengine_v1beta1.types.user_event_service.ListUserEventsRequest,
    response: google.cloud.recommendationengine_v1beta1.types.user_event_service.ListUserEventsResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through list_user_events requests.

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

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

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

Inheritance

builtins.object > ListUserEventsPager

Methods

ListUserEventsPager

ListUserEventsPager(
    method: Callable[
        [...],
        google.cloud.recommendationengine_v1beta1.types.user_event_service.ListUserEventsResponse,
    ],
    request: google.cloud.recommendationengine_v1beta1.types.user_event_service.ListUserEventsRequest,
    response: google.cloud.recommendationengine_v1beta1.types.user_event_service.ListUserEventsResponse,
    *,
    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.recommendationengine_v1beta1.types.ListUserEventsRequest

The initial request object.

response google.cloud.recommendationengine_v1beta1.types.ListUserEventsResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

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