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.

Pagers

class google.pubsub_v1.services.subscriber.pagers.ListSnapshotsAsyncPager(method: Callable[[...], Awaitable[google.cloud.pubsub_v1.types.ListSnapshotsResponse]], request: google.cloud.pubsub_v1.types.ListSnapshotsRequest, response: google.cloud.pubsub_v1.types.ListSnapshotsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_snapshots requests.

This class thinly wraps an initial google.pubsub_v1.types.ListSnapshotsResponse object, and provides an __aiter__ method to iterate through its snapshots field.

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

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

Instantiates the pager.

Parameters

  • method (Callable) – The method that was originally called, and which instantiated this pager.

  • request (google.pubsub_v1.types.ListSnapshotsRequest) – The initial request object.

  • response (google.pubsub_v1.types.ListSnapshotsResponse) – 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.

class google.pubsub_v1.services.subscriber.pagers.ListSnapshotsPager(method: Callable[[...], google.cloud.pubsub_v1.types.ListSnapshotsResponse], request: google.cloud.pubsub_v1.types.ListSnapshotsRequest, response: google.cloud.pubsub_v1.types.ListSnapshotsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_snapshots requests.

This class thinly wraps an initial google.pubsub_v1.types.ListSnapshotsResponse object, and provides an __iter__ method to iterate through its snapshots field.

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

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

Instantiate the pager.

Parameters

  • method (Callable) – The method that was originally called, and which instantiated this pager.

  • request (google.pubsub_v1.types.ListSnapshotsRequest) – The initial request object.

  • response (google.pubsub_v1.types.ListSnapshotsResponse) – 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.

class google.pubsub_v1.services.subscriber.pagers.ListSubscriptionsAsyncPager(method: Callable[[...], Awaitable[google.cloud.pubsub_v1.types.ListSubscriptionsResponse]], request: google.cloud.pubsub_v1.types.ListSubscriptionsRequest, response: google.cloud.pubsub_v1.types.ListSubscriptionsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary_async.AsyncRetry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_subscriptions requests.

This class thinly wraps an initial google.pubsub_v1.types.ListSubscriptionsResponse object, and provides an __aiter__ method to iterate through its subscriptions field.

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

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

Instantiates the pager.

Parameters

  • method (Callable) – The method that was originally called, and which instantiated this pager.

  • request (google.pubsub_v1.types.ListSubscriptionsRequest) – The initial request object.

  • response (google.pubsub_v1.types.ListSubscriptionsResponse) – 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.

class google.pubsub_v1.services.subscriber.pagers.ListSubscriptionsPager(method: Callable[[...], google.cloud.pubsub_v1.types.ListSubscriptionsResponse], request: google.cloud.pubsub_v1.types.ListSubscriptionsRequest, response: google.cloud.pubsub_v1.types.ListSubscriptionsResponse, *, retry: Optional[Union[google.api_core.retry.retry_unary.Retry, google.api_core.gapic_v1.method._MethodDefault]] = _MethodDefault._DEFAULT_VALUE, timeout: Union[float, object] = _MethodDefault._DEFAULT_VALUE, metadata: Sequence[Tuple[str, str]] = ())[source]

A pager for iterating through list_subscriptions requests.

This class thinly wraps an initial google.pubsub_v1.types.ListSubscriptionsResponse object, and provides an __iter__ method to iterate through its subscriptions field.

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

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

Instantiate the pager.

Parameters

  • method (Callable) – The method that was originally called, and which instantiated this pager.

  • request (google.pubsub_v1.types.ListSubscriptionsRequest) – The initial request object.

  • response (google.pubsub_v1.types.ListSubscriptionsResponse) – 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.