def test_publish(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.PublishRequest() # Mock the actual call within the gRPC stub, and fake the request. with mock.patch.object(type(client._transport.publish), '__call__') as call: # Designate an appropriate return value for the call. call.return_value = pubsub.PublishResponse( message_ids=['message_ids_value'], ) response = client.publish(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.PublishResponse) assert response.message_ids == ['message_ids_value']
def test_publish_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.publish( pubsub.PublishRequest(), topic='topic_value', messages=[pubsub.PubsubMessage(data=b'data_blob')], )
async def publish( self, request: pubsub.PublishRequest = None, *, topic: str = None, messages: Sequence[pubsub.PubsubMessage] = None, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pubsub.PublishResponse: r"""Adds one or more messages to the topic. Returns ``NOT_FOUND`` if the topic does not exist. Args: request (:class:`google.pubsub_v1.types.PublishRequest`): The request object. Request for the Publish method. topic (:class:`str`): Required. The messages in the request will be published on this topic. 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. messages (:class:`Sequence[google.pubsub_v1.types.PubsubMessage]`): Required. The messages to publish. This corresponds to the ``messages`` 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.types.PublishResponse: Response for the Publish 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. has_flattened_params = any([topic, messages]) 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.PublishRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if topic is not None: request.topic = topic if messages: request.messages.extend(messages) # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = gapic_v1.method_async.wrap_method( self._client._transport.publish, default_retry=retries.Retry( initial=0.1, maximum=60.0, multiplier=1.3, predicate=retries.if_exception_type( exceptions.Aborted, exceptions.Cancelled, exceptions.DeadlineExceeded, exceptions.InternalServerError, exceptions.ResourceExhausted, 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, ) # Done; return the response. return response
def publish( self, request: pubsub.PublishRequest = None, *, topic: str = None, messages: Sequence[pubsub.PubsubMessage] = None, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pubsub.PublishResponse: r"""Adds one or more messages to the topic. Returns ``NOT_FOUND`` if the topic does not exist. Args: request (:class:`~.pubsub.PublishRequest`): The request object. Request for the Publish method. topic (:class:`str`): Required. The messages in the request will be published on this topic. 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. messages (:class:`Sequence[~.pubsub.PubsubMessage]`): Required. The messages to publish. This corresponds to the ``messages`` 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.PublishResponse: Response for the ``Publish`` 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, messages]): raise ValueError('If the `request` argument is set, then none of ' 'the individual field arguments should be set.') request = pubsub.PublishRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if topic is not None: request.topic = topic if messages is not None: request.messages = messages # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = gapic_v1.method.wrap_method( self._transport.publish, default_timeout=None, client_info=_client_info, ) # Send the request. response = rpc( request, retry=retry, timeout=timeout, metadata=metadata, ) # Done; return the response. return response
def publish( self, request: pubsub.PublishRequest = None, *, topic: str = None, messages: Sequence[pubsub.PubsubMessage] = None, retry: retries.Retry = gapic_v1.method.DEFAULT, timeout: float = None, metadata: Sequence[Tuple[str, str]] = (), ) -> pubsub.PublishResponse: r"""Adds one or more messages to the topic. Returns ``NOT_FOUND`` if the topic does not exist. Args: request (:class:`~.pubsub.PublishRequest`): The request object. Request for the Publish method. topic (:class:`str`): Required. The messages in the request will be published on this topic. 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. messages (:class:`Sequence[~.pubsub.PubsubMessage]`): Required. The messages to publish. This corresponds to the ``messages`` 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.PublishResponse: Response for the ``Publish`` 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. has_flattened_params = any([topic, messages]) 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.PublishRequest. # There's no risk of modifying the input as we've already verified # there are no flattened fields. if not isinstance(request, pubsub.PublishRequest): request = pubsub.PublishRequest(request) # If we have keyword arguments corresponding to fields on the # request, apply these. if topic is not None: request.topic = topic if messages is not None: request.messages = messages # Wrap the RPC method; this adds retry and timeout information, # and friendly error handling. rpc = self._transport._wrapped_methods[self._transport.publish] # 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