From 6416ff630d66210c2b82ba25dde12247d2e81c22 Mon Sep 17 00:00:00 2001
From: Michael Darakananda <pongad@google.com>
Date: Sun, 22 Jan 2017 16:08:12 +1100
Subject: [PATCH] small doc and naming fixes

---
 .../cloud/pubsub/spi/v1/MessageReceiver.java     | 16 ++++++++++++----
 .../google/cloud/pubsub/spi/v1/Publisher.java    |  6 +++---
 .../google/cloud/pubsub/spi/v1/Subscriber.java   |  3 +++
 3 files changed, 18 insertions(+), 7 deletions(-)

diff --git a/google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/spi/v1/MessageReceiver.java b/google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/spi/v1/MessageReceiver.java
index 90006b0ad01b..d43591ba7686 100644
--- a/google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/spi/v1/MessageReceiver.java
+++ b/google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/spi/v1/MessageReceiver.java
@@ -19,14 +19,22 @@
 import com.google.common.util.concurrent.ListenableFuture;
 import com.google.pubsub.v1.PubsubMessage;
 
-/** Users of the {@link Subscriber} must implement this interface to receive messages. */
+/** This interface can be implemented by users of {@link Subscriber} to receive messages. */
 public interface MessageReceiver {
-   enum AckReply {
-    /** To be used for acking a message. */
+  /** A reply to a message, to be sent back to the service. */
+  enum AckReply {
+    /**
+     * Acknowledges that the message has been successfully processed. The service will not send the
+     * message again.
+     */
     ACK,
-    /** To be used for nacking a message. */
+    /**
+     * Signals that the message has not been successfully processed. The service will resend the
+     * message.
+     */
     NACK
   }
+  
   /**
    * Called when a message is received by the subscriber.
    *
diff --git a/google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/spi/v1/Publisher.java b/google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/spi/v1/Publisher.java
index ad1d7af7c5bc..954436c4c3e1 100644
--- a/google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/spi/v1/Publisher.java
+++ b/google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/spi/v1/Publisher.java
@@ -109,12 +109,12 @@
  */
 public class Publisher {
   /** The maximum number of messages in one request. Defined by the API. */
-  public static long getApiMaxBundleMessages() {
+  public static long getApiMaxRequestElementCount() {
     return 1000L;
   }
 
   /** The maximum size of one request. Defined by the API. */
-  public static long getApiMaxBundleBytes() {
+  public static long getApiMaxRequestBytes() {
     return 10L * 1000L * 1000L; // 10 megabytes (https://en.wikipedia.org/wiki/Megabyte)
   }
 
@@ -193,7 +193,7 @@ private Publisher(Builder builder) throws IOException {
     messagesWaiter = new MessagesWaiter();
   }
 
-  /** Topic to which the publisher publishes to. */
+  /** Topic which the publisher publishes to. */
   public String getTopic() {
     return topic;
   }
diff --git a/google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/spi/v1/Subscriber.java b/google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/spi/v1/Subscriber.java
index 13d1931ce151..1d937ca677ea 100644
--- a/google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/spi/v1/Subscriber.java
+++ b/google-cloud-pubsub/src/main/java/com/google/cloud/pubsub/spi/v1/Subscriber.java
@@ -361,14 +361,17 @@ public SubscriberStats getStats() {
     return null;
   }
 
+  /** Subscription which the subscriber is subscribed to. */
   public String getSubscription() {
     return subscription;
   }
 
+  /** Acknowledgement expiration padding. See {@link Builder.setAckExpirationPadding}. */
   public Duration getAckExpirationPadding() {
     return ackExpirationPadding;
   }
 
+  /** The flow control settings the Subscriber is configured with. */
   public FlowController.Settings getFlowControlSettings() {
     return flowControlSettings;
   }