Class ListSynonymSetsPager (0.1.0)

ListSynonymSetsPager(
    method: Callable[
        [...],
        google.cloud.contentwarehouse_v1.types.synonymset_service_request.ListSynonymSetsResponse,
    ],
    request: google.cloud.contentwarehouse_v1.types.synonymset_service_request.ListSynonymSetsRequest,
    response: google.cloud.contentwarehouse_v1.types.synonymset_service_request.ListSynonymSetsResponse,
    *,
    metadata: Sequence[Tuple[str, str]] = ()
)

A pager for iterating through list_synonym_sets requests.

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

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

All the usual ListSynonymSetsResponse 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 > ListSynonymSetsPager

Methods

ListSynonymSetsPager

ListSynonymSetsPager(
    method: Callable[
        [...],
        google.cloud.contentwarehouse_v1.types.synonymset_service_request.ListSynonymSetsResponse,
    ],
    request: google.cloud.contentwarehouse_v1.types.synonymset_service_request.ListSynonymSetsRequest,
    response: google.cloud.contentwarehouse_v1.types.synonymset_service_request.ListSynonymSetsResponse,
    *,
    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.contentwarehouse_v1.types.ListSynonymSetsRequest

The initial request object.

response google.cloud.contentwarehouse_v1.types.ListSynonymSetsResponse

The initial response object.

metadata Sequence[Tuple[str, str]]

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