From 53c34935449e36977b23cf376bf379e651c2f287 Mon Sep 17 00:00:00 2001 From: Daniel Collins Date: Wed, 30 Sep 2020 09:45:57 -0400 Subject: [PATCH 1/2] docs: Document potentially unexpected blocking behavior of publish() method. --- .../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..142c793c8 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. * + * This method blocks in the downcall if using LimitExceededBehavior.Block in the flow control + * settings. + * *

Example of publishing a message. * *

{@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..6ac263c1f 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.
    *
+   * Some implementations of this method may block in the downcall until allowed by flow control.
+   *
    * 

Example of publishing a message. * *

{@code

From f655d0fe7ee19227b56cc885039e6b073df22896 Mon Sep 17 00:00:00 2001
From: Daniel Collins 
Date: Wed, 30 Sep 2020 09:56:28 -0400
Subject: [PATCH 2/2] docs: Run mvn fmt:format

---
 .../src/main/java/com/google/cloud/pubsub/v1/Publisher.java     | 2 +-
 .../java/com/google/cloud/pubsub/v1/PublisherInterface.java     | 2 +-
 2 files changed, 2 insertions(+), 2 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
index 142c793c8..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,7 +206,7 @@ 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.
    *
-   * This method blocks in the downcall if using LimitExceededBehavior.Block in the flow control
+   * 

This method blocks in the downcall if using LimitExceededBehavior.Block in the flow control * settings. * *

Example of publishing a message. 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 6ac263c1f..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,7 +28,7 @@ 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. * - * Some implementations of this method may block in the downcall until allowed by flow control. + *

Some implementations of this method may block in the downcall until allowed by flow control. * *

Example of publishing a message. *