Module pagers (0.13.5)

Version latest

• 0.13.5 (latest)
• 0.13.4
• 0.12.3
• 0.11.14
• 0.10.0
• 0.9.1
• 0.8.1
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.1
• 0.2.1
• 0.1.1

API documentation for discoveryengine_v1.services.control_service.pagers module.

Classes

ListControlsAsyncPager

ListControlsAsyncPager(
    method: typing.Callable[
        [...],
        typing.Awaitable[
            google.cloud.discoveryengine_v1.types.control_service.ListControlsResponse
        ],
    ],
    request: google.cloud.discoveryengine_v1.types.control_service.ListControlsRequest,
    response: google.cloud.discoveryengine_v1.types.control_service.ListControlsResponse,
    *,
    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_controls requests.

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

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

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

ListControlsPager

ListControlsPager(
    method: typing.Callable[
        [...],
        google.cloud.discoveryengine_v1.types.control_service.ListControlsResponse,
    ],
    request: google.cloud.discoveryengine_v1.types.control_service.ListControlsRequest,
    response: google.cloud.discoveryengine_v1.types.control_service.ListControlsResponse,
    *,
    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_controls requests.

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

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

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