From 18b3a2f77816b55cf605447b382a2f1bd42e0880 Mon Sep 17 00:00:00 2001
From: dpcollins-google <40498610+dpcollins-google@users.noreply.github.com>
Date: Thu, 21 Jan 2021 14:23:14 -0500
Subject: [PATCH] docs: Document potentially unexpected blocking behavior of
 publish() method (#370)

* docs: Document potentially unexpected blocking behavior of publish() method.

* docs: Run mvn fmt:format
---
 .../src/main/java/com/google/cloud/pubsub/v1/Publisher.java    | 3 +++
 .../java/com/google/cloud/pubsub/v1/PublisherInterface.java    | 2 ++
 2 files changed, 5 insertions(+)

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
index 07a550496..aa140d7b9 100644
--- 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
index 80a465053..2a9d25b92 100644
--- 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