small doc and naming fixes (#1556)

pongad · web-flow · commit 51a9a804df74 · 2017-01-24T09:52:25.000+11:00
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
@@ -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
@@ -110,12 +110,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)
   }
 
@@ -194,7 +194,7 @@ public void close() 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
@@ -370,14 +370,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;
   }

Original file line number	Diff line number	Diff line change
`@@ -110,12 +110,12 @@`
`110`	`110`	`*/`
`111`	`111`	`public class Publisher {`
`112`	`112`	`/** The maximum number of messages in one request. Defined by the API. */`
`113`		`- public static long getApiMaxBundleMessages() {`
	`113`	`+ public static long getApiMaxRequestElementCount() {`
`114`	`114`	`return 1000L;`
`115`	`115`	`}`
`116`	`116`
`117`	`117`	`/** The maximum size of one request. Defined by the API. */`
`118`		`- public static long getApiMaxBundleBytes() {`
	`118`	`+ public static long getApiMaxRequestBytes() {`
`119`	`119`	`return 10L * 1000L * 1000L; // 10 megabytes (https://en.wikipedia.org/wiki/Megabyte)`
`120`	`120`	`}`
`121`	`121`
`@@ -194,7 +194,7 @@ public void close() throws IOException {`
`194`	`194`	`messagesWaiter = new MessagesWaiter();`
`195`	`195`	`}`
`196`	`196`
`197`		`- /** Topic to which the publisher publishes to. */`
	`197`	`+ /** Topic which the publisher publishes to. */`
`198`	`198`	`public String getTopic() {`
`199`	`199`	`return topic;`
`200`	`200`	`}`
Original file line number	Diff line number	Diff line change
`@@ -370,14 +370,17 @@ public SubscriberStats getStats() {`
`370`	`370`	`return null;`
`371`	`371`	`}`
`372`	`372`
	`373`	`+ /** Subscription which the subscriber is subscribed to. */`
`373`	`374`	`public String getSubscription() {`
`374`	`375`	`return subscription;`
`375`	`376`	`}`
`376`	`377`
	`378`	`+ /** Acknowledgement expiration padding. See {@link Builder.setAckExpirationPadding}. */`
`377`	`379`	`public Duration getAckExpirationPadding() {`
`378`	`380`	`return ackExpirationPadding;`
`379`	`381`	`}`
`380`	`382`
	`383`	`+ /** The flow control settings the Subscriber is configured with. */`
`381`	`384`	`public FlowController.Settings getFlowControlSettings() {`
`382`	`385`	`return flowControlSettings;`
`383`	`386`	`}`