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.area120.tables_v1alpha1.services.tables_service.pagers

# -*- coding: utf-8 -*-
# Copyright 2024 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,
    Iterator,
    Optional,
    Sequence,
    Tuple,
    Union,
)

from google.api_core import gapic_v1
from google.api_core import retry as retries
from google.api_core import retry_async as retries_async

try:
    OptionalRetry = Union[retries.Retry, gapic_v1.method._MethodDefault, None]
    OptionalAsyncRetry = Union[
        retries_async.AsyncRetry, gapic_v1.method._MethodDefault, None
    ]
except AttributeError:  # pragma: NO COVER
    OptionalRetry = Union[retries.Retry, object, None]  # type: ignore
    OptionalAsyncRetry = Union[retries_async.AsyncRetry, object, None]  # type: ignore

from google.area120.tables_v1alpha1.types import tables


[docs]class ListTablesPager: """A pager for iterating through ``list_tables`` requests. This class thinly wraps an initial :class:`google.area120.tables_v1alpha1.types.ListTablesResponse` object, and provides an ``__iter__`` method to iterate through its ``tables`` field. If there are more pages, the ``__iter__`` method will make additional ``ListTables`` requests and continue to iterate through the ``tables`` field on the corresponding responses. All the usual :class:`google.area120.tables_v1alpha1.types.ListTablesResponse` 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[..., tables.ListTablesResponse], request: tables.ListTablesRequest, response: tables.ListTablesResponse, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = () ): """Instantiate the pager. Args: method (Callable): The method that was originally called, and which instantiated this pager. request (google.area120.tables_v1alpha1.types.ListTablesRequest): The initial request object. response (google.area120.tables_v1alpha1.types.ListTablesResponse): 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, str]]): Strings which should be sent along with the request as metadata. """ self._method = method self._request = tables.ListTablesRequest(request) self._response = response self._retry = retry self._timeout = timeout self._metadata = metadata def __getattr__(self, name: str) -> Any: return getattr(self._response, name) @property def pages(self) -> Iterator[tables.ListTablesResponse]: yield self._response while self._response.next_page_token: self._request.page_token = self._response.next_page_token self._response = self._method( self._request, retry=self._retry, timeout=self._timeout, metadata=self._metadata, ) yield self._response def __iter__(self) -> Iterator[tables.Table]: for page in self.pages: yield from page.tables def __repr__(self) -> str: return "{0}<{1!r}>".format(self.__class__.__name__, self._response)
[docs]class ListTablesAsyncPager: """A pager for iterating through ``list_tables`` requests. This class thinly wraps an initial :class:`google.area120.tables_v1alpha1.types.ListTablesResponse` object, and provides an ``__aiter__`` method to iterate through its ``tables`` field. If there are more pages, the ``__aiter__`` method will make additional ``ListTables`` requests and continue to iterate through the ``tables`` field on the corresponding responses. All the usual :class:`google.area120.tables_v1alpha1.types.ListTablesResponse` 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[tables.ListTablesResponse]], request: tables.ListTablesRequest, response: tables.ListTablesResponse, *, retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = () ): """Instantiates the pager. Args: method (Callable): The method that was originally called, and which instantiated this pager. request (google.area120.tables_v1alpha1.types.ListTablesRequest): The initial request object. response (google.area120.tables_v1alpha1.types.ListTablesResponse): The initial response object. retry (google.api_core.retry.AsyncRetry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. """ self._method = method self._request = tables.ListTablesRequest(request) self._response = response self._retry = retry self._timeout = timeout self._metadata = metadata def __getattr__(self, name: str) -> Any: return getattr(self._response, name) @property async def pages(self) -> AsyncIterator[tables.ListTablesResponse]: 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, retry=self._retry, timeout=self._timeout, metadata=self._metadata, ) yield self._response def __aiter__(self) -> AsyncIterator[tables.Table]: async def async_generator(): async for page in self.pages: for response in page.tables: yield response return async_generator() def __repr__(self) -> str: return "{0}<{1!r}>".format(self.__class__.__name__, self._response)
[docs]class ListWorkspacesPager: """A pager for iterating through ``list_workspaces`` requests. This class thinly wraps an initial :class:`google.area120.tables_v1alpha1.types.ListWorkspacesResponse` object, and provides an ``__iter__`` method to iterate through its ``workspaces`` field. If there are more pages, the ``__iter__`` method will make additional ``ListWorkspaces`` requests and continue to iterate through the ``workspaces`` field on the corresponding responses. All the usual :class:`google.area120.tables_v1alpha1.types.ListWorkspacesResponse` 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[..., tables.ListWorkspacesResponse], request: tables.ListWorkspacesRequest, response: tables.ListWorkspacesResponse, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = () ): """Instantiate the pager. Args: method (Callable): The method that was originally called, and which instantiated this pager. request (google.area120.tables_v1alpha1.types.ListWorkspacesRequest): The initial request object. response (google.area120.tables_v1alpha1.types.ListWorkspacesResponse): 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, str]]): Strings which should be sent along with the request as metadata. """ self._method = method self._request = tables.ListWorkspacesRequest(request) self._response = response self._retry = retry self._timeout = timeout self._metadata = metadata def __getattr__(self, name: str) -> Any: return getattr(self._response, name) @property def pages(self) -> Iterator[tables.ListWorkspacesResponse]: yield self._response while self._response.next_page_token: self._request.page_token = self._response.next_page_token self._response = self._method( self._request, retry=self._retry, timeout=self._timeout, metadata=self._metadata, ) yield self._response def __iter__(self) -> Iterator[tables.Workspace]: for page in self.pages: yield from page.workspaces def __repr__(self) -> str: return "{0}<{1!r}>".format(self.__class__.__name__, self._response)
[docs]class ListWorkspacesAsyncPager: """A pager for iterating through ``list_workspaces`` requests. This class thinly wraps an initial :class:`google.area120.tables_v1alpha1.types.ListWorkspacesResponse` object, and provides an ``__aiter__`` method to iterate through its ``workspaces`` field. If there are more pages, the ``__aiter__`` method will make additional ``ListWorkspaces`` requests and continue to iterate through the ``workspaces`` field on the corresponding responses. All the usual :class:`google.area120.tables_v1alpha1.types.ListWorkspacesResponse` 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[tables.ListWorkspacesResponse]], request: tables.ListWorkspacesRequest, response: tables.ListWorkspacesResponse, *, retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = () ): """Instantiates the pager. Args: method (Callable): The method that was originally called, and which instantiated this pager. request (google.area120.tables_v1alpha1.types.ListWorkspacesRequest): The initial request object. response (google.area120.tables_v1alpha1.types.ListWorkspacesResponse): The initial response object. retry (google.api_core.retry.AsyncRetry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. """ self._method = method self._request = tables.ListWorkspacesRequest(request) self._response = response self._retry = retry self._timeout = timeout self._metadata = metadata def __getattr__(self, name: str) -> Any: return getattr(self._response, name) @property async def pages(self) -> AsyncIterator[tables.ListWorkspacesResponse]: 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, retry=self._retry, timeout=self._timeout, metadata=self._metadata, ) yield self._response def __aiter__(self) -> AsyncIterator[tables.Workspace]: async def async_generator(): async for page in self.pages: for response in page.workspaces: yield response return async_generator() def __repr__(self) -> str: return "{0}<{1!r}>".format(self.__class__.__name__, self._response)
[docs]class ListRowsPager: """A pager for iterating through ``list_rows`` requests. This class thinly wraps an initial :class:`google.area120.tables_v1alpha1.types.ListRowsResponse` object, and provides an ``__iter__`` method to iterate through its ``rows`` field. If there are more pages, the ``__iter__`` method will make additional ``ListRows`` requests and continue to iterate through the ``rows`` field on the corresponding responses. All the usual :class:`google.area120.tables_v1alpha1.types.ListRowsResponse` 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[..., tables.ListRowsResponse], request: tables.ListRowsRequest, response: tables.ListRowsResponse, *, retry: OptionalRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = () ): """Instantiate the pager. Args: method (Callable): The method that was originally called, and which instantiated this pager. request (google.area120.tables_v1alpha1.types.ListRowsRequest): The initial request object. response (google.area120.tables_v1alpha1.types.ListRowsResponse): 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, str]]): Strings which should be sent along with the request as metadata. """ self._method = method self._request = tables.ListRowsRequest(request) self._response = response self._retry = retry self._timeout = timeout self._metadata = metadata def __getattr__(self, name: str) -> Any: return getattr(self._response, name) @property def pages(self) -> Iterator[tables.ListRowsResponse]: yield self._response while self._response.next_page_token: self._request.page_token = self._response.next_page_token self._response = self._method( self._request, retry=self._retry, timeout=self._timeout, metadata=self._metadata, ) yield self._response def __iter__(self) -> Iterator[tables.Row]: for page in self.pages: yield from page.rows def __repr__(self) -> str: return "{0}<{1!r}>".format(self.__class__.__name__, self._response)
[docs]class ListRowsAsyncPager: """A pager for iterating through ``list_rows`` requests. This class thinly wraps an initial :class:`google.area120.tables_v1alpha1.types.ListRowsResponse` object, and provides an ``__aiter__`` method to iterate through its ``rows`` field. If there are more pages, the ``__aiter__`` method will make additional ``ListRows`` requests and continue to iterate through the ``rows`` field on the corresponding responses. All the usual :class:`google.area120.tables_v1alpha1.types.ListRowsResponse` 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[tables.ListRowsResponse]], request: tables.ListRowsRequest, response: tables.ListRowsResponse, *, retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT, timeout: Union[float, object] = gapic_v1.method.DEFAULT, metadata: Sequence[Tuple[str, str]] = () ): """Instantiates the pager. Args: method (Callable): The method that was originally called, and which instantiated this pager. request (google.area120.tables_v1alpha1.types.ListRowsRequest): The initial request object. response (google.area120.tables_v1alpha1.types.ListRowsResponse): The initial response object. retry (google.api_core.retry.AsyncRetry): Designation of what errors, if any, should be retried. timeout (float): The timeout for this request. metadata (Sequence[Tuple[str, str]]): Strings which should be sent along with the request as metadata. """ self._method = method self._request = tables.ListRowsRequest(request) self._response = response self._retry = retry self._timeout = timeout self._metadata = metadata def __getattr__(self, name: str) -> Any: return getattr(self._response, name) @property async def pages(self) -> AsyncIterator[tables.ListRowsResponse]: 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, retry=self._retry, timeout=self._timeout, metadata=self._metadata, ) yield self._response def __aiter__(self) -> AsyncIterator[tables.Row]: async def async_generator(): async for page in self.pages: for response in page.rows: yield response return async_generator() def __repr__(self) -> str: return "{0}<{1!r}>".format(self.__class__.__name__, self._response)