docs: Document potentially unexpected blocking behavior of publish() …

…method (#370) * docs: Document potentially unexpected blocking behavior of publish() method. * docs: Run mvn fmt:format
googleapis · Jan 21, 2021 · 18b3a2f · 18b3a2f
1 parent 573a5e0
commit 18b3a2f
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/Publisher.java b/google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/Publisher.java
@@ -206,6 +206,9 @@ public String getTopicNameString() {
    * Schedules the publishing of a message. The publishing of the message may occur immediately or
    * be delayed based on the publisher batching options.
    *
+   * <p>This method blocks in the downcall if using LimitExceededBehavior.Block in the flow control
+   * settings.
+   *
    * <p>Example of publishing a message.
    *
    * <pre>{@code

diff --git a/google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/PublisherInterface.java b/google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/v1/PublisherInterface.java
@@ -28,6 +28,8 @@ public interface PublisherInterface {
    * Schedules the publishing of a message. The future will be returned with the message ID on
    * success or an exception on failure.
    *
+   * <p>Some implementations of this method may block in the downcall until allowed by flow control.
+   *
    * <p>Example of publishing a message.
    *
    * <pre>{@code