def test_list_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.ListBlurbsRequest() # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object( type(client._transport.list_blurbs), '__call__') as call: # Designate an appropriate return value for the call. call.return_value = messaging.ListBlurbsResponse( next_page_token='next_page_token_value', ) response = client.list_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, pagers.ListBlurbsPager) assert response.next_page_token == 'next_page_token_value'
def test_list_blurbs_field_headers(): client = MessagingClient( 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 = messaging.ListBlurbsRequest( parent='parent/value', ) # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object( type(client._transport.list_blurbs), '__call__') as call: call.return_value = messaging.ListBlurbsResponse() response = client.list_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 field header was sent. _, _, kw = call.mock_calls[0] assert ( 'x-goog-request-params', 'parent=parent/value', ) in kw['metadata']
def test_list_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.list_blurbs( messaging.ListBlurbsRequest(), parent='parent_value', )
def list_blurbs( self, request: messaging.ListBlurbsRequest = None, *, parent: str = None, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListBlurbsPager: r"""Lists blurbs for a specific chat room or user profile depending on the parent resource name. Args: request (:class:`~.messaging.ListBlurbsRequest`): The request object. The request message for the google.showcase.v1beta1.Messaging\ListBlurbs method. parent (:class:`str`): The resource name of the requested room or profile whos blurbs to list. This corresponds to the ``parent`` 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.ListBlurbsPager: The response message for the google.showcase.v1beta1.Messaging\ListBlurbs 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. if request is not None and any([parent]): 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.ListBlurbsRequest(request) if parent is not None: request.parent = parent # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = gapic_v1.method.wrap_method( self._transport.list_blurbs, 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( (('parent', request.parent), )), ) # 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.ListBlurbsPager( method=rpc, request=request, response=response, ) # Done; return the response. return response