def test_list_topics(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.ListTopicsRequest() # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object(type(client._transport.list_topics), '__call__') as call: # Designate an appropriate return value for the call. call.return_value = pubsub.ListTopicsResponse( next_page_token='next_page_token_value', ) response = client.list_topics(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.ListTopicsPager) assert response.next_page_token == 'next_page_token_value'
def test_list_topics_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_topics( pubsub.ListTopicsRequest(), project='project_value', )
def __init__(self, method: Callable[[pubsub.ListTopicsRequest], pubsub.ListTopicsResponse], request: pubsub.ListTopicsRequest, response: pubsub.ListTopicsResponse): """Instantiate the pager. Args: method (Callable): The method that was originally called, and which instantiated this pager. request (:class:`~.pubsub.ListTopicsRequest`): The initial request object. response (:class:`~.pubsub.ListTopicsResponse`): The initial response object. """ self._method = method self._request = pubsub.ListTopicsRequest(request) self._response = response
def __init__(self, method: Callable[..., pubsub.ListTopicsResponse], request: pubsub.ListTopicsRequest, response: pubsub.ListTopicsResponse, *, 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.ListTopicsRequest): The initial request object. response (google.pubsub_v1.types.ListTopicsResponse): 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.ListTopicsRequest(request) self._response = response self._metadata = metadata
def test_list_topics_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.ListTopicsRequest(project='project/value', ) # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object(type(client._transport.list_topics), '__call__') as call: call.return_value = pubsub.ListTopicsResponse() client.list_topics(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', 'project=project/value', ) in kw['metadata']
async def list_topics( self, request: pubsub.ListTopicsRequest = None, *, project: str = None, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListTopicsAsyncPager: r"""Lists matching topics. Args: request (:class:`google.pubsub_v1.types.ListTopicsRequest`): The request object. Request for the `ListTopics` method. project (:class:`str`): Required. The name of the project in which to list topics. Format is ``projects/{project-id}``. This corresponds to the ``project`` 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.ListTopicsAsyncPager: Response for the ListTopics 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([project]) 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.ListTopicsRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if project is not None: request.project = project # 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_topics, 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( (("project", request.project), )), ) # 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.ListTopicsAsyncPager( method=rpc, request=request, response=response, metadata=metadata, ) # Done; return the response. return response
def list_topics( self, request: pubsub.ListTopicsRequest = None, *, project: str = None, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pagers.ListTopicsPager: r"""Lists matching topics. Args: request (:class:`~.pubsub.ListTopicsRequest`): The request object. Request for the `ListTopics` method. project (:class:`str`): Required. The name of the project in which to list topics. Format is ``projects/{project-id}``. This corresponds to the ``project`` 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.ListTopicsPager: Response for the ``ListTopics`` 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([project]): raise ValueError('If the `request` argument is set, then none of ' 'the individual field arguments should be set.') request = pubsub.ListTopicsRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if project is not None: request.project = project # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = gapic_v1.method.wrap_method( self._transport.list_topics, 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( (('project', request.project), )), ) # 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.ListTopicsPager( method=rpc, request=request, response=response, ) # Done; return the response. return response