Server : LiteSpeed System : Linux in-mum-web1949.main-hosting.eu 5.14.0-503.40.1.el9_5.x86_64 #1 SMP PREEMPT_DYNAMIC Mon May 5 06:06:04 EDT 2025 x86_64 User : u595547767 ( 595547767) PHP Version : 7.4.33 Disable Function : NONE Directory : /opt/alt/python311/lib/python3.11/site-packages/google/pubsub_v1/services/publisher/ |
# -*- coding: utf-8 -*-
# Copyright 2025 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 google.api_core import gapic_v1
from google.api_core import retry as retries
from google.api_core import retry_async as retries_async
from typing import (
Any,
AsyncIterator,
Awaitable,
Callable,
Sequence,
Tuple,
Optional,
Iterator,
Union,
)
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.pubsub_v1.types import pubsub
class ListTopicsPager:
"""A pager for iterating through ``list_topics`` requests.
This class thinly wraps an initial
:class:`google.pubsub_v1.types.ListTopicsResponse` object, and
provides an ``__iter__`` method to iterate through its
``topics`` field.
If there are more pages, the ``__iter__`` method will make additional
``ListTopics`` requests and continue to iterate
through the ``topics`` field on the
corresponding responses.
All the usual :class:`google.pubsub_v1.types.ListTopicsResponse`
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[..., pubsub.ListTopicsResponse],
request: pubsub.ListTopicsRequest,
response: pubsub.ListTopicsResponse,
*,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()
):
"""Instantiate the pager.
Args:
method (Callable): The method that was originally called, and
which instantiated this pager.
request (google.pubsub_v1.types.ListTopicsRequest):
The initial request object.
response (google.pubsub_v1.types.ListTopicsResponse):
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`.
"""
self._method = method
self._request = pubsub.ListTopicsRequest(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[pubsub.ListTopicsResponse]:
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[pubsub.Topic]:
for page in self.pages:
yield from page.topics
def __repr__(self) -> str:
return "{0}<{1!r}>".format(self.__class__.__name__, self._response)
class ListTopicsAsyncPager:
"""A pager for iterating through ``list_topics`` requests.
This class thinly wraps an initial
:class:`google.pubsub_v1.types.ListTopicsResponse` object, and
provides an ``__aiter__`` method to iterate through its
``topics`` field.
If there are more pages, the ``__aiter__`` method will make additional
``ListTopics`` requests and continue to iterate
through the ``topics`` field on the
corresponding responses.
All the usual :class:`google.pubsub_v1.types.ListTopicsResponse`
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[pubsub.ListTopicsResponse]],
request: pubsub.ListTopicsRequest,
response: pubsub.ListTopicsResponse,
*,
retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()
):
"""Instantiates the pager.
Args:
method (Callable): The method that was originally called, and
which instantiated this pager.
request (google.pubsub_v1.types.ListTopicsRequest):
The initial request object.
response (google.pubsub_v1.types.ListTopicsResponse):
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, 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`.
"""
self._method = method
self._request = pubsub.ListTopicsRequest(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[pubsub.ListTopicsResponse]:
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[pubsub.Topic]:
async def async_generator():
async for page in self.pages:
for response in page.topics:
yield response
return async_generator()
def __repr__(self) -> str:
return "{0}<{1!r}>".format(self.__class__.__name__, self._response)
class ListTopicSubscriptionsPager:
"""A pager for iterating through ``list_topic_subscriptions`` requests.
This class thinly wraps an initial
:class:`google.pubsub_v1.types.ListTopicSubscriptionsResponse` object, and
provides an ``__iter__`` method to iterate through its
``subscriptions`` field.
If there are more pages, the ``__iter__`` method will make additional
``ListTopicSubscriptions`` requests and continue to iterate
through the ``subscriptions`` field on the
corresponding responses.
All the usual :class:`google.pubsub_v1.types.ListTopicSubscriptionsResponse`
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[..., pubsub.ListTopicSubscriptionsResponse],
request: pubsub.ListTopicSubscriptionsRequest,
response: pubsub.ListTopicSubscriptionsResponse,
*,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()
):
"""Instantiate the pager.
Args:
method (Callable): The method that was originally called, and
which instantiated this pager.
request (google.pubsub_v1.types.ListTopicSubscriptionsRequest):
The initial request object.
response (google.pubsub_v1.types.ListTopicSubscriptionsResponse):
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`.
"""
self._method = method
self._request = pubsub.ListTopicSubscriptionsRequest(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[pubsub.ListTopicSubscriptionsResponse]:
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[str]:
for page in self.pages:
yield from page.subscriptions
def __repr__(self) -> str:
return "{0}<{1!r}>".format(self.__class__.__name__, self._response)
class ListTopicSubscriptionsAsyncPager:
"""A pager for iterating through ``list_topic_subscriptions`` requests.
This class thinly wraps an initial
:class:`google.pubsub_v1.types.ListTopicSubscriptionsResponse` object, and
provides an ``__aiter__`` method to iterate through its
``subscriptions`` field.
If there are more pages, the ``__aiter__`` method will make additional
``ListTopicSubscriptions`` requests and continue to iterate
through the ``subscriptions`` field on the
corresponding responses.
All the usual :class:`google.pubsub_v1.types.ListTopicSubscriptionsResponse`
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[pubsub.ListTopicSubscriptionsResponse]],
request: pubsub.ListTopicSubscriptionsRequest,
response: pubsub.ListTopicSubscriptionsResponse,
*,
retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()
):
"""Instantiates the pager.
Args:
method (Callable): The method that was originally called, and
which instantiated this pager.
request (google.pubsub_v1.types.ListTopicSubscriptionsRequest):
The initial request object.
response (google.pubsub_v1.types.ListTopicSubscriptionsResponse):
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, 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`.
"""
self._method = method
self._request = pubsub.ListTopicSubscriptionsRequest(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[pubsub.ListTopicSubscriptionsResponse]:
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[str]:
async def async_generator():
async for page in self.pages:
for response in page.subscriptions:
yield response
return async_generator()
def __repr__(self) -> str:
return "{0}<{1!r}>".format(self.__class__.__name__, self._response)
class ListTopicSnapshotsPager:
"""A pager for iterating through ``list_topic_snapshots`` requests.
This class thinly wraps an initial
:class:`google.pubsub_v1.types.ListTopicSnapshotsResponse` object, and
provides an ``__iter__`` method to iterate through its
``snapshots`` field.
If there are more pages, the ``__iter__`` method will make additional
``ListTopicSnapshots`` requests and continue to iterate
through the ``snapshots`` field on the
corresponding responses.
All the usual :class:`google.pubsub_v1.types.ListTopicSnapshotsResponse`
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[..., pubsub.ListTopicSnapshotsResponse],
request: pubsub.ListTopicSnapshotsRequest,
response: pubsub.ListTopicSnapshotsResponse,
*,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()
):
"""Instantiate the pager.
Args:
method (Callable): The method that was originally called, and
which instantiated this pager.
request (google.pubsub_v1.types.ListTopicSnapshotsRequest):
The initial request object.
response (google.pubsub_v1.types.ListTopicSnapshotsResponse):
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`.
"""
self._method = method
self._request = pubsub.ListTopicSnapshotsRequest(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[pubsub.ListTopicSnapshotsResponse]:
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[str]:
for page in self.pages:
yield from page.snapshots
def __repr__(self) -> str:
return "{0}<{1!r}>".format(self.__class__.__name__, self._response)
class ListTopicSnapshotsAsyncPager:
"""A pager for iterating through ``list_topic_snapshots`` requests.
This class thinly wraps an initial
:class:`google.pubsub_v1.types.ListTopicSnapshotsResponse` object, and
provides an ``__aiter__`` method to iterate through its
``snapshots`` field.
If there are more pages, the ``__aiter__`` method will make additional
``ListTopicSnapshots`` requests and continue to iterate
through the ``snapshots`` field on the
corresponding responses.
All the usual :class:`google.pubsub_v1.types.ListTopicSnapshotsResponse`
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[pubsub.ListTopicSnapshotsResponse]],
request: pubsub.ListTopicSnapshotsRequest,
response: pubsub.ListTopicSnapshotsResponse,
*,
retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT,
timeout: Union[float, object] = gapic_v1.method.DEFAULT,
metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()
):
"""Instantiates the pager.
Args:
method (Callable): The method that was originally called, and
which instantiated this pager.
request (google.pubsub_v1.types.ListTopicSnapshotsRequest):
The initial request object.
response (google.pubsub_v1.types.ListTopicSnapshotsResponse):
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, 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`.
"""
self._method = method
self._request = pubsub.ListTopicSnapshotsRequest(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[pubsub.ListTopicSnapshotsResponse]:
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[str]:
async def async_generator():
async for page in self.pages:
for response in page.snapshots:
yield response
return async_generator()
def __repr__(self) -> str:
return "{0}<{1!r}>".format(self.__class__.__name__, self._response)