Pubsub getting started

pubsub/cloud-client/README.md

@@ -14,24 +14,40 @@ For more samples, see the samples in
 ## Quickstart
 
 #### Setup
-- Install [Maven](http://maven.apache.org/) <p>
-- Install the [Google Cloud SDK](https://cloud.google.com/sdk/) and run :
-
-
-      gcloud config set project [YOUR PROJECT ID]
-
+- Install [Maven](http://maven.apache.org/).
+- [Enable](https://console.cloud.google.com/apis/api/pubsub.googleapis.com/overview) Pub/Sub API.
+- Set up [authentication](https://cloud.google.com/docs/authentication/getting-started).
 
+#### Build
 - Build your project with:
-
-
-	  mvn clean package -DskipTests
+```
+  mvn clean package -DskipTests
+```
+
+#### Create a new topic
+```
+  mvn exec:java -Dexec.mainClass=com.example.pubsub.CreateTopicExample -Dexec.args=my-topic
+```
+
+#### Create a subscription
+```
+  mvn exec:java -Dexec.mainClass=com.example.pubsub.CreatePullSubscriptionExample -Dexec.args="my-topic-id my-sub"
+```
+
+#### Publish messages
+```
+  mvn exec:java -Dexec.mainClass=com.example.pubsub.PublisherExample -Dexec.args=my-topic
+```
+Publishes 5 messages to the topic `my-topic`.
+
+#### Receive messages
+```
+   mvn exec:java -Dexec.mainClass=com.example.pubsub.SubscriberExample -Dexec.args=my-sub
+```
+Subscriber will continue to listen on the topic for 5 minutes and print out message id and data as messages are received.
 
 #### Testing
-
-Run the tests with Maven.
-
-    mvn clean verify
-
-#### Creating a new topic (using the quickstart sample)
-
-    mvn exec:java -Dexec.mainClass=com.example.pubsub.QuickstartSample
+Run the test with Maven.
+```
+  mvn verify
+```

pubsub/cloud-client/pom.xml

@@ -31,27 +31,16 @@
     <maven.compiler.target>1.8</maven.compiler.target>
     <maven.compiler.source>1.8</maven.compiler.source>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-    <pubsub.version>0.21.1-beta</pubsub.version>
   </properties>
 
   <dependencies>
     <dependency>
       <groupId>com.google.cloud</groupId>
       <artifactId>google-cloud-pubsub</artifactId>
-      <version>${pubsub.version}</version>
+      <version>0.21.0-beta</version>
     </dependency>
 
     <!-- Test dependencies -->
-    <dependency>
-      <groupId>com.google.guava</groupId>
-      <artifactId>guava</artifactId>
-      <version>20.0</version>
-    </dependency>
-    <dependency>
-      <groupId>com.google.auth</groupId>
-      <artifactId>google-auth-library-oauth2-http</artifactId>
-      <version>0.7.1</version>
-    </dependency>
     <dependency>
       <groupId>junit</groupId>
       <artifactId>junit</artifactId>

pubsub/cloud-client/src/main/java/com/example/pubsub/CreatePullSubscriptionExample.java

@@ -0,0 +1,62 @@
+/*
+  Copyright 2017, Google, Inc.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+*/
+
+package com.example.pubsub;
+
+// [START pubsub_quickstart_create_subscription]
+import com.google.cloud.ServiceOptions;
+import com.google.cloud.pubsub.v1.SubscriptionAdminClient;
+import com.google.pubsub.v1.PushConfig;
+import com.google.pubsub.v1.Subscription;
+import com.google.pubsub.v1.SubscriptionName;
+import com.google.pubsub.v1.TopicName;
+
+public class CreatePullSubscriptionExample {
+
+  /**
+   * Create a pull subscription.
+   *
+   * @param args topic subscriptionId
+   * @throws Exception exception thrown if operation is unsuccessful
+   */
+  public static void main(String... args) throws Exception {
+
+    // Your Google Cloud Platform project ID
+    String projectId = ServiceOptions.getDefaultProjectId();
+
+    // Your topic ID, eg. "my-topic"
+    String topicId = args[0];
+
+    // Your subscription ID eg. "my-sub"
+    String subscriptionId = args[1];
+
+    TopicName topicName = TopicName.create(projectId, topicId);
+
+    // Create a new subscription
+    SubscriptionName subscriptionName = SubscriptionName.create(projectId, subscriptionId);
+    try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
+      // create a pull subscription with default acknowledgement deadline (= 10 seconds)
+      Subscription subscription =
+          subscriptionAdminClient.createSubscription(
+              subscriptionName, topicName, PushConfig.getDefaultInstance(), 0);
+    }
+
+    System.out.printf(
+        "Subscription %s:%s created.\n",
+        subscriptionName.getProject(), subscriptionName.getSubscription());
+  }
+}
+// [END pubsub_quickstart_create_subscription]

pubsub/cloud-client/src/main/java/com/example/pubsub/QuickstartSample.java → pubsub/cloud-client/src/main/java/com/example/pubsub/CreateTopicExample.java

@@ -16,22 +16,27 @@
 
 package com.example.pubsub;
 
-// [START pubsub_quickstart]
+// [START pubsub_quickstart_create_topic]
 // Imports the Google Cloud client library
-
 import com.google.cloud.ServiceOptions;
 import com.google.cloud.pubsub.v1.TopicAdminClient;
 import com.google.pubsub.v1.TopicName;
 
-public class QuickstartSample {
+public class CreateTopicExample {
 
+  /**
+   * Create a topic.
+   *
+   * @param args topicId
+   * @throws Exception exception thrown if operation is unsuccessful
+   */
   public static void main(String... args) throws Exception {
 
     // Your Google Cloud Platform project ID
     String projectId = ServiceOptions.getDefaultProjectId();
 
-    // Your topic ID
-    String topicId = "my-new-topic";
+    // Your topic ID, eg. "my-topic"
+    String topicId = args[0];
 
     // Create a new topic
     TopicName topic = TopicName.create(projectId, topicId);
@@ -42,4 +47,4 @@ public static void main(String... args) throws Exception {
     System.out.printf("Topic %s:%s created.\n", topic.getProject(), topic.getTopic());
   }
 }
-// [END pubsub_quickstart]
+// [END pubsub_quickstart_create_topic]

pubsub/cloud-client/src/main/java/com/example/pubsub/PublisherExample.java

@@ -0,0 +1,74 @@
+/*
+ * Copyright 2017 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.example.pubsub;
+// [START pubsub_quickstart_publisher]
+
+import com.google.api.core.ApiFuture;
+import com.google.api.core.ApiFutures;
+import com.google.cloud.ServiceOptions;
+import com.google.cloud.pubsub.v1.Publisher;
+import com.google.protobuf.ByteString;
+import com.google.pubsub.v1.PubsubMessage;
+import com.google.pubsub.v1.TopicName;
+import java.util.ArrayList;
+import java.util.List;
+
+public class PublisherExample {
+
+  static final int MESSAGE_COUNT = 5;
+
+  // use the default project id
+  private static final String PROJECT_ID = ServiceOptions.getDefaultProjectId();
+
+  //schedule a message to be published, messages are automatically batched
+  private static ApiFuture<String> publishMessage(Publisher publisher, String message)
+      throws Exception {
+    // convert message to bytes
+    ByteString data = ByteString.copyFromUtf8(message);
+    PubsubMessage pubsubMessage = PubsubMessage.newBuilder().setData(data).build();
+    return publisher.publish(pubsubMessage);
+  }
+
+  /** Publish messages to a topic. */
+  public static void main(String... args) throws Exception {
+    // topic id, eg. "my-topic"
+    String topicId = args[0];
+    TopicName topicName = TopicName.create(PROJECT_ID, topicId);
+    Publisher publisher = null;
+    List<ApiFuture<String>> apiFutures = new ArrayList<>();
+    try {
+      // Create a publisher instance with default settings bound to the topic
+      publisher = Publisher.defaultBuilder(topicName).build();
+      for (int i = 0; i < MESSAGE_COUNT; i++) {
+        String message = "message-" + i;
+        ApiFuture<String> messageId = publishMessage(publisher, message);
+        apiFutures.add(messageId);
+      }
+    } finally {
+      // Once published, returns server-assigned message ids (unique within the topic)
+      List<String> messageIds = ApiFutures.allAsList(apiFutures).get();
+      for (String messageId : messageIds) {
+        System.out.println(messageId);
+      }
+      if (publisher != null) {
+        // When finished with the publisher, shutdown to free up resources.
+        publisher.shutdown();
+      }
+    }
+  }
+}
+// [END pubsub_quickstart_quickstart]

pubsub/cloud-client/src/main/java/com/example/pubsub/SubscriberExample.java

@@ -0,0 +1,70 @@
+/*
+ * Copyright 2017 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *       http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.example.pubsub;
+
+// [START pubsub_quickstart_subscriber]
+
+import com.google.cloud.ServiceOptions;
+import com.google.cloud.pubsub.v1.AckReplyConsumer;
+import com.google.cloud.pubsub.v1.MessageReceiver;
+import com.google.cloud.pubsub.v1.Subscriber;
+import com.google.pubsub.v1.PubsubMessage;
+import com.google.pubsub.v1.SubscriptionName;
+import java.util.concurrent.BlockingQueue;
+import java.util.concurrent.LinkedBlockingDeque;
+
+public class SubscriberExample {
+
+  // use the default project id
+  private static final String PROJECT_ID = ServiceOptions.getDefaultProjectId();
+
+  private static final BlockingQueue<PubsubMessage> messages = new LinkedBlockingDeque<>();
+
+  static class MessageReceiverExample implements MessageReceiver {
+
+    @Override
+    public void receiveMessage(PubsubMessage message, AckReplyConsumer consumer) {
+      messages.offer(message);
+      consumer.ack();
+    }
+  }
+
+  /** Receive messages over a subscription. */
+  public static void main(String... args) throws Exception {
+    // set subscriber id, eg. my-sub
+    String subscriptionId = args[0];
+    SubscriptionName subscriptionName = SubscriptionName.create(PROJECT_ID, subscriptionId);
+    Subscriber subscriber = null;
+    try {
+      // create a subscriber bound to the asynchronous message receiver
+      subscriber =
+          Subscriber.defaultBuilder(subscriptionName, new MessageReceiverExample()).build();
+      subscriber.startAsync().awaitRunning();
+      // Continue to listen to messages
+      while (true) {
+        PubsubMessage message = messages.take();
+        System.out.println("Message Id: " + message.getMessageId());
+        System.out.println("Data: " + message.getData().toStringUtf8());
+      }
+    } finally {
+      if (subscriber != null) {
+        subscriber.stopAsync();
+      }
+    }
+  }
+}
+// [END pubsub_quickstart_subscriber]