As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Source code for google.cloud.dialogflowcx_v3.services.intents.pagers

# -*- coding: utf-8 -*-
# Copyright 2020 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
from typing import (
    Any,
    AsyncIterator,
    Awaitable,
    Callable,
    Sequence,
    Tuple,
    Optional,
    Iterator,
)

from google.cloud.dialogflowcx_v3.types import intent


[docs]class ListIntentsPager: """A pager for iterating through ``list_intents`` requests. This class thinly wraps an initial :class:`google.cloud.dialogflowcx_v3.types.ListIntentsResponse` object, and provides an ``__iter__`` method to iterate through its ``intents`` field. If there are more pages, the ``__iter__`` method will make additional ``ListIntents`` requests and continue to iterate through the ``intents`` field on the corresponding responses. All the usual :class:`google.cloud.dialogflowcx_v3.types.ListIntentsResponse` attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup. """ def __init__( self, method: Callable[..., intent.ListIntentsResponse], request: intent.ListIntentsRequest, response: intent.ListIntentsResponse, *, metadata: Sequence[Tuple[str, str]] = () ): """Instantiate the pager. Args: method (Callable): The method that was originally called, and which instantiated this pager. request (google.cloud.dialogflowcx_v3.types.ListIntentsRequest): The initial request object. response (google.cloud.dialogflowcx_v3.types.ListIntentsResponse): The initial response object. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. """ self._method = method self._request = intent.ListIntentsRequest(request) self._response = response self._metadata = metadata def __getattr__(self, name: str) -> Any: return getattr(self._response, name) @property def pages(self) -> Iterator[intent.ListIntentsResponse]: yield self._response while self._response.next_page_token: self._request.page_token = self._response.next_page_token self._response = self._method(self._request, metadata=self._metadata) yield self._response def __iter__(self) -> Iterator[intent.Intent]: for page in self.pages: yield from page.intents def __repr__(self) -> str: return "{0}<{1!r}>".format(self.__class__.__name__, self._response)
[docs]class ListIntentsAsyncPager: """A pager for iterating through ``list_intents`` requests. This class thinly wraps an initial :class:`google.cloud.dialogflowcx_v3.types.ListIntentsResponse` object, and provides an ``__aiter__`` method to iterate through its ``intents`` field. If there are more pages, the ``__aiter__`` method will make additional ``ListIntents`` requests and continue to iterate through the ``intents`` field on the corresponding responses. All the usual :class:`google.cloud.dialogflowcx_v3.types.ListIntentsResponse` attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup. """ def __init__( self, method: Callable[..., Awaitable[intent.ListIntentsResponse]], request: intent.ListIntentsRequest, response: intent.ListIntentsResponse, *, metadata: Sequence[Tuple[str, str]] = () ): """Instantiates the pager. Args: method (Callable): The method that was originally called, and which instantiated this pager. request (google.cloud.dialogflowcx_v3.types.ListIntentsRequest): The initial request object. response (google.cloud.dialogflowcx_v3.types.ListIntentsResponse): The initial response object. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. """ self._method = method self._request = intent.ListIntentsRequest(request) self._response = response self._metadata = metadata def __getattr__(self, name: str) -> Any: return getattr(self._response, name) @property async def pages(self) -> AsyncIterator[intent.ListIntentsResponse]: yield self._response while self._response.next_page_token: self._request.page_token = self._response.next_page_token self._response = await self._method(self._request, metadata=self._metadata) yield self._response def __aiter__(self) -> AsyncIterator[intent.Intent]: async def async_generator(): async for page in self.pages: for response in page.intents: yield response return async_generator() def __repr__(self) -> str: return "{0}<{1!r}>".format(self.__class__.__name__, self._response)