Class ListSynonymSetsPager (0.7.12)

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

Methods

ListSynonymSetsPager

ListSynonymSetsPager(
    method: typing.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,
    *,
    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]]] = ()
)

Instantiate the pager.

Parameters
Name	Description
`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.
`retry`	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.