def test_list_topic_snapshots(transport: str = 'grpc'):
client = PublisherClient(
credentials=credentials.AnonymousCredentials(),
transport=transport,
)
# Everything is optional in proto3 as far as the runtime is concerned,
# and we are mocking out the actual API, so just send an empty request.
request = pubsub.ListTopicSnapshotsRequest()
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.list_topic_snapshots),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = pubsub.ListTopicSnapshotsResponse(
snapshots=['snapshots_value'],
next_page_token='next_page_token_value',
)
response = client.list_topic_snapshots(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == request
# Establish that the response is the type that we expect.
assert isinstance(response, pubsub.ListTopicSnapshotsResponse)
assert response.snapshots == ['snapshots_value']
assert response.next_page_token == 'next_page_token_value'
def test_list_topic_snapshots_flattened_error():
client = PublisherClient(credentials=credentials.AnonymousCredentials(), )
# Attempting to call a method with both a request object and flattened
# fields is an error.
with pytest.raises(ValueError):
client.list_topic_snapshots(
pubsub.ListTopicSnapshotsRequest(),
topic='topic_value',
)
def __init__(self,
method: Callable[..., pubsub.ListTopicSnapshotsResponse],
request: pubsub.ListTopicSnapshotsRequest,
response: pubsub.ListTopicSnapshotsResponse,
*,
metadata: Sequence[Tuple[str, str]] = ()):
"""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.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
"""
self._method = method
self._request = pubsub.ListTopicSnapshotsRequest(request)
self._response = response
self._metadata = metadata
def test_list_topic_snapshots_field_headers():
client = PublisherClient(credentials=credentials.AnonymousCredentials(), )
# Any value that is part of the HTTP/1.1 URI should be sent as
# a field header. Set these to a non-empty value.
request = pubsub.ListTopicSnapshotsRequest(topic='topic/value', )
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.list_topic_snapshots),
'__call__') as call:
call.return_value = pubsub.ListTopicSnapshotsResponse()
client.list_topic_snapshots(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == request
# Establish that the field header was sent.
_, _, kw = call.mock_calls[0]
assert (
'x-goog-request-params',
'topic=topic/value',
) in kw['metadata']
async def list_topic_snapshots(
self,
request: pubsub.ListTopicSnapshotsRequest = None,
*,
topic: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListTopicSnapshotsAsyncPager:
r"""Lists the names of the snapshots on this topic. Snapshots are
used in
`Seek <https://cloud.google.com/pubsub/docs/replay-overview>`__
operations, which allow you to manage message acknowledgments in
bulk. That is, you can set the acknowledgment state of messages
in an existing subscription to the state captured by a snapshot.
Args:
request (:class:`google.pubsub_v1.types.ListTopicSnapshotsRequest`):
The request object. Request for the `ListTopicSnapshots`
method.
topic (:class:`str`):
Required. The name of the topic that snapshots are
attached to. Format is
``projects/{project}/topics/{topic}``.
This corresponds to the ``topic`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
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.
Returns:
google.pubsub_v1.services.publisher.pagers.ListTopicSnapshotsAsyncPager:
Response for the ListTopicSnapshots method.
Iterating over this object will yield results and
resolve additional pages automatically.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([topic])
if request is not None and has_flattened_params:
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
request = pubsub.ListTopicSnapshotsRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if topic is not None:
request.topic = topic
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.list_topic_snapshots,
default_retry=retries.Retry(
initial=0.1,
maximum=60.0,
multiplier=1.3,
predicate=retries.if_exception_type(
exceptions.Aborted,
exceptions.ServiceUnavailable,
exceptions.Unknown,
),
deadline=60.0,
),
default_timeout=60.0,
client_info=DEFAULT_CLIENT_INFO,
)
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("topic", request.topic), )), )
# Send the request.
response = await rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# This method is paged; wrap the response in a pager, which provides
# an `__aiter__` convenience method.
response = pagers.ListTopicSnapshotsAsyncPager(
method=rpc,
request=request,
response=response,
metadata=metadata,
)
# Done; return the response.
return response
def list_topic_snapshots(
self,
request: pubsub.ListTopicSnapshotsRequest = None,
*,
topic: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pubsub.ListTopicSnapshotsResponse:
r"""Lists the names of the snapshots on this topic.
Snapshots are used in <a
href="https://cloud.google.com/pubsub/docs/replay-
overview">Seek</a> operations, which allow
you to manage message acknowledgments in bulk. That is,
you can set the acknowledgment state of messages in an
existing subscription to the state captured by a
snapshot.
Args:
request (:class:`~.pubsub.ListTopicSnapshotsRequest`):
The request object. Request for the `ListTopicSnapshots`
method.
topic (:class:`str`):
Required. The name of the topic that snapshots are
attached to. Format is
``projects/{project}/topics/{topic}``.
This corresponds to the ``topic`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
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.
Returns:
~.pubsub.ListTopicSnapshotsResponse:
Response for the ``ListTopicSnapshots`` method.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
if request is not None and any([topic]):
raise ValueError('If the `request` argument is set, then none of '
'the individual field arguments should be set.')
request = pubsub.ListTopicSnapshotsRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if topic is not None:
request.topic = topic
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method.wrap_method(
self._transport.list_topic_snapshots,
default_timeout=None,
client_info=_client_info,
)
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(('topic', request.topic), )), )
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
def list_topic_snapshots(
self,
request: pubsub.ListTopicSnapshotsRequest = None,
*,
topic: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListTopicSnapshotsPager:
r"""Lists the names of the snapshots on this topic. Snapshots are
used in
`Seek <https://cloud.google.com/pubsub/docs/replay-overview>`__
operations, which allow you to manage message acknowledgments in
bulk. That is, you can set the acknowledgment state of messages
in an existing subscription to the state captured by a snapshot.
Args:
request (:class:`~.pubsub.ListTopicSnapshotsRequest`):
The request object. Request for the `ListTopicSnapshots`
method.
topic (:class:`str`):
Required. The name of the topic that snapshots are
attached to. Format is
``projects/{project}/topics/{topic}``.
This corresponds to the ``topic`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
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.
Returns:
~.pagers.ListTopicSnapshotsPager:
Response for the ``ListTopicSnapshots`` method.
Iterating over this object will yield results and
resolve additional pages automatically.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([topic])
if request is not None and has_flattened_params:
raise ValueError("If the `request` argument is set, then none of "
"the individual field arguments should be set.")
# Minor optimization to avoid making a copy if the user passes
# in a pubsub.ListTopicSnapshotsRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request, pubsub.ListTopicSnapshotsRequest):
request = pubsub.ListTopicSnapshotsRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if topic is not None:
request.topic = topic
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[
self._transport.list_topic_snapshots]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("topic", request.topic), )), )
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# This method is paged; wrap the response in a pager, which provides
# an `__iter__` convenience method.
response = pagers.ListTopicSnapshotsPager(
method=rpc,
request=request,
response=response,
metadata=metadata,
)
# Done; return the response.
return response
