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.automl_v1beta1.services.auto_ml.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.cloud.automl_v1beta1.types import (
    column_spec,
    dataset,
    model,
    model_evaluation,
    service,
    table_spec,
)


[docs]class ListDatasetsPager: """A pager for iterating through ``list_datasets`` requests. This class thinly wraps an initial :class:`google.cloud.automl_v1beta1.types.ListDatasetsResponse` object, and provides an ``__iter__`` method to iterate through its ``datasets`` field. If there are more pages, the ``__iter__`` method will make additional ``ListDatasets`` requests and continue to iterate through the ``datasets`` field on the corresponding responses. All the usual :class:`google.cloud.automl_v1beta1.types.ListDatasetsResponse` 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[..., service.ListDatasetsResponse], request: service.ListDatasetsRequest, response: service.ListDatasetsResponse, *, 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.cloud.automl_v1beta1.types.ListDatasetsRequest): The initial request object. response (google.cloud.automl_v1beta1.types.ListDatasetsResponse): 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 = service.ListDatasetsRequest(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[service.ListDatasetsResponse]: 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[dataset.Dataset]: for page in self.pages: yield from page.datasets def __repr__(self) -> str: return "{0}<{1!r}>".format(self.__class__.__name__, self._response)
[docs]class ListDatasetsAsyncPager: """A pager for iterating through ``list_datasets`` requests. This class thinly wraps an initial :class:`google.cloud.automl_v1beta1.types.ListDatasetsResponse` object, and provides an ``__aiter__`` method to iterate through its ``datasets`` field. If there are more pages, the ``__aiter__`` method will make additional ``ListDatasets`` requests and continue to iterate through the ``datasets`` field on the corresponding responses. All the usual :class:`google.cloud.automl_v1beta1.types.ListDatasetsResponse` 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[service.ListDatasetsResponse]], request: service.ListDatasetsRequest, response: service.ListDatasetsResponse, *, 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.cloud.automl_v1beta1.types.ListDatasetsRequest): The initial request object. response (google.cloud.automl_v1beta1.types.ListDatasetsResponse): 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 = service.ListDatasetsRequest(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[service.ListDatasetsResponse]: 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[dataset.Dataset]: async def async_generator(): async for page in self.pages: for response in page.datasets: yield response return async_generator() def __repr__(self) -> str: return "{0}<{1!r}>".format(self.__class__.__name__, self._response)
[docs]class ListTableSpecsPager: """A pager for iterating through ``list_table_specs`` requests. This class thinly wraps an initial :class:`google.cloud.automl_v1beta1.types.ListTableSpecsResponse` object, and provides an ``__iter__`` method to iterate through its ``table_specs`` field. If there are more pages, the ``__iter__`` method will make additional ``ListTableSpecs`` requests and continue to iterate through the ``table_specs`` field on the corresponding responses. All the usual :class:`google.cloud.automl_v1beta1.types.ListTableSpecsResponse` 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[..., service.ListTableSpecsResponse], request: service.ListTableSpecsRequest, response: service.ListTableSpecsResponse, *, 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.cloud.automl_v1beta1.types.ListTableSpecsRequest): The initial request object. response (google.cloud.automl_v1beta1.types.ListTableSpecsResponse): 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 = service.ListTableSpecsRequest(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[service.ListTableSpecsResponse]: 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[table_spec.TableSpec]: for page in self.pages: yield from page.table_specs def __repr__(self) -> str: return "{0}<{1!r}>".format(self.__class__.__name__, self._response)
[docs]class ListTableSpecsAsyncPager: """A pager for iterating through ``list_table_specs`` requests. This class thinly wraps an initial :class:`google.cloud.automl_v1beta1.types.ListTableSpecsResponse` object, and provides an ``__aiter__`` method to iterate through its ``table_specs`` field. If there are more pages, the ``__aiter__`` method will make additional ``ListTableSpecs`` requests and continue to iterate through the ``table_specs`` field on the corresponding responses. All the usual :class:`google.cloud.automl_v1beta1.types.ListTableSpecsResponse` 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[service.ListTableSpecsResponse]], request: service.ListTableSpecsRequest, response: service.ListTableSpecsResponse, *, 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.cloud.automl_v1beta1.types.ListTableSpecsRequest): The initial request object. response (google.cloud.automl_v1beta1.types.ListTableSpecsResponse): 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 = service.ListTableSpecsRequest(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[service.ListTableSpecsResponse]: 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[table_spec.TableSpec]: async def async_generator(): async for page in self.pages: for response in page.table_specs: yield response return async_generator() def __repr__(self) -> str: return "{0}<{1!r}>".format(self.__class__.__name__, self._response)
[docs]class ListColumnSpecsPager: """A pager for iterating through ``list_column_specs`` requests. This class thinly wraps an initial :class:`google.cloud.automl_v1beta1.types.ListColumnSpecsResponse` object, and provides an ``__iter__`` method to iterate through its ``column_specs`` field. If there are more pages, the ``__iter__`` method will make additional ``ListColumnSpecs`` requests and continue to iterate through the ``column_specs`` field on the corresponding responses. All the usual :class:`google.cloud.automl_v1beta1.types.ListColumnSpecsResponse` 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[..., service.ListColumnSpecsResponse], request: service.ListColumnSpecsRequest, response: service.ListColumnSpecsResponse, *, 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.cloud.automl_v1beta1.types.ListColumnSpecsRequest): The initial request object. response (google.cloud.automl_v1beta1.types.ListColumnSpecsResponse): 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 = service.ListColumnSpecsRequest(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[service.ListColumnSpecsResponse]: 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[column_spec.ColumnSpec]: for page in self.pages: yield from page.column_specs def __repr__(self) -> str: return "{0}<{1!r}>".format(self.__class__.__name__, self._response)
[docs]class ListColumnSpecsAsyncPager: """A pager for iterating through ``list_column_specs`` requests. This class thinly wraps an initial :class:`google.cloud.automl_v1beta1.types.ListColumnSpecsResponse` object, and provides an ``__aiter__`` method to iterate through its ``column_specs`` field. If there are more pages, the ``__aiter__`` method will make additional ``ListColumnSpecs`` requests and continue to iterate through the ``column_specs`` field on the corresponding responses. All the usual :class:`google.cloud.automl_v1beta1.types.ListColumnSpecsResponse` 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[service.ListColumnSpecsResponse]], request: service.ListColumnSpecsRequest, response: service.ListColumnSpecsResponse, *, 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.cloud.automl_v1beta1.types.ListColumnSpecsRequest): The initial request object. response (google.cloud.automl_v1beta1.types.ListColumnSpecsResponse): 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 = service.ListColumnSpecsRequest(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[service.ListColumnSpecsResponse]: 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[column_spec.ColumnSpec]: async def async_generator(): async for page in self.pages: for response in page.column_specs: yield response return async_generator() def __repr__(self) -> str: return "{0}<{1!r}>".format(self.__class__.__name__, self._response)
[docs]class ListModelsPager: """A pager for iterating through ``list_models`` requests. This class thinly wraps an initial :class:`google.cloud.automl_v1beta1.types.ListModelsResponse` object, and provides an ``__iter__`` method to iterate through its ``model`` field. If there are more pages, the ``__iter__`` method will make additional ``ListModels`` requests and continue to iterate through the ``model`` field on the corresponding responses. All the usual :class:`google.cloud.automl_v1beta1.types.ListModelsResponse` 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[..., service.ListModelsResponse], request: service.ListModelsRequest, response: service.ListModelsResponse, *, 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.cloud.automl_v1beta1.types.ListModelsRequest): The initial request object. response (google.cloud.automl_v1beta1.types.ListModelsResponse): 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 = service.ListModelsRequest(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[service.ListModelsResponse]: 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[model.Model]: for page in self.pages: yield from page.model def __repr__(self) -> str: return "{0}<{1!r}>".format(self.__class__.__name__, self._response)
[docs]class ListModelsAsyncPager: """A pager for iterating through ``list_models`` requests. This class thinly wraps an initial :class:`google.cloud.automl_v1beta1.types.ListModelsResponse` object, and provides an ``__aiter__`` method to iterate through its ``model`` field. If there are more pages, the ``__aiter__`` method will make additional ``ListModels`` requests and continue to iterate through the ``model`` field on the corresponding responses. All the usual :class:`google.cloud.automl_v1beta1.types.ListModelsResponse` 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[service.ListModelsResponse]], request: service.ListModelsRequest, response: service.ListModelsResponse, *, 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.cloud.automl_v1beta1.types.ListModelsRequest): The initial request object. response (google.cloud.automl_v1beta1.types.ListModelsResponse): 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 = service.ListModelsRequest(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[service.ListModelsResponse]: 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[model.Model]: async def async_generator(): async for page in self.pages: for response in page.model: yield response return async_generator() def __repr__(self) -> str: return "{0}<{1!r}>".format(self.__class__.__name__, self._response)
[docs]class ListModelEvaluationsPager: """A pager for iterating through ``list_model_evaluations`` requests. This class thinly wraps an initial :class:`google.cloud.automl_v1beta1.types.ListModelEvaluationsResponse` object, and provides an ``__iter__`` method to iterate through its ``model_evaluation`` field. If there are more pages, the ``__iter__`` method will make additional ``ListModelEvaluations`` requests and continue to iterate through the ``model_evaluation`` field on the corresponding responses. All the usual :class:`google.cloud.automl_v1beta1.types.ListModelEvaluationsResponse` 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[..., service.ListModelEvaluationsResponse], request: service.ListModelEvaluationsRequest, response: service.ListModelEvaluationsResponse, *, 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.cloud.automl_v1beta1.types.ListModelEvaluationsRequest): The initial request object. response (google.cloud.automl_v1beta1.types.ListModelEvaluationsResponse): 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 = service.ListModelEvaluationsRequest(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[service.ListModelEvaluationsResponse]: 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[model_evaluation.ModelEvaluation]: for page in self.pages: yield from page.model_evaluation def __repr__(self) -> str: return "{0}<{1!r}>".format(self.__class__.__name__, self._response)
[docs]class ListModelEvaluationsAsyncPager: """A pager for iterating through ``list_model_evaluations`` requests. This class thinly wraps an initial :class:`google.cloud.automl_v1beta1.types.ListModelEvaluationsResponse` object, and provides an ``__aiter__`` method to iterate through its ``model_evaluation`` field. If there are more pages, the ``__aiter__`` method will make additional ``ListModelEvaluations`` requests and continue to iterate through the ``model_evaluation`` field on the corresponding responses. All the usual :class:`google.cloud.automl_v1beta1.types.ListModelEvaluationsResponse` 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[service.ListModelEvaluationsResponse]], request: service.ListModelEvaluationsRequest, response: service.ListModelEvaluationsResponse, *, 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.cloud.automl_v1beta1.types.ListModelEvaluationsRequest): The initial request object. response (google.cloud.automl_v1beta1.types.ListModelEvaluationsResponse): 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 = service.ListModelEvaluationsRequest(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[service.ListModelEvaluationsResponse]: 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[model_evaluation.ModelEvaluation]: async def async_generator(): async for page in self.pages: for response in page.model_evaluation: yield response return async_generator() def __repr__(self) -> str: return "{0}<{1!r}>".format(self.__class__.__name__, self._response)