def test_search_blurbs(transport: str = 'grpc'):
client = MessagingClient(
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 = messaging.SearchBlurbsRequest()
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(
type(client._transport.search_blurbs),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = operations_pb2.Operation(name='operations/spam')
response = client.search_blurbs(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, future.Future)
def test_search_blurbs_flattened_error():
client = MessagingClient(credentials=credentials.AnonymousCredentials(), )
# Attempting to call a method with both a request object and flattened
# fields is an error.
with pytest.raises(ValueError):
client.search_blurbs(
messaging.SearchBlurbsRequest(),
query='query_value',
)
def search_blurbs(
self,
request: messaging.SearchBlurbsRequest = None,
*,
query: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> operation.Operation:
r"""This method searches through all blurbs across all
rooms and profiles for blurbs containing to words found
in the query. Only posts that contain an exact match of
a queried word will be returned.
Args:
request (:class:`~.messaging.SearchBlurbsRequest`):
The request object. The request message for the
google.showcase.v1beta1.Messaging\SearchBlurbs method.
query (:class:`str`):
The query used to search for blurbs
containing to words of this string. Only
posts that contain an exact match of a
queried word will be returned.
This corresponds to the ``query`` 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:
~.operation.Operation:
An object representing a long-running operation.
The result type for the operation will be
:class:``~.messaging.SearchBlurbsResponse``: The
operation response message for the
google.showcase.v1beta1.Messaging\\SearchBlurbs 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([query]):
raise ValueError('If the `request` argument is set, then none of '
'the individual field arguments should be set.')
# If we have keyword arguments corresponding to fields on the
# request, apply these.
request = messaging.SearchBlurbsRequest(request)
if query is not None:
request.query = query
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method.wrap_method(
self._transport.search_blurbs,
default_timeout=None,
client_info=_client_info,
)
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Wrap the response in an operation future.
response = operation.from_gapic(
response,
self._transport.operations_client,
messaging.SearchBlurbsResponse,
metadata_type=messaging.SearchBlurbsMetadata,
)
# Done; return the response.
return response