cleaning up PubSubExample

adding snippet for creating a subscription with a push endpoint

Author: jabubake

google-cloud-examples/src/main/java/com/google/cloud/examples/pubsub/PubSubExample.java

@@ -48,8 +48,6 @@
  *  pull sync <subscription> <maxMessages>
  *  publish <topic> <message>+
  *  replace-push-config <subscription> <endpoint>?
- *  ack <subscription> <ackId>+
- *  nack <subscription> <ackId>+
  *  create topic <topic>
  *  create subscription <topic> <subscription> <endpoint>?
  *  list subscriptions <topic>?
@@ -488,22 +486,6 @@ public String params() {
         }
     }
 
-    private abstract static class MessagesAction extends PubSubAction<Tuple<SubscriptionName, List<String>>> {
-        @Override
-        Tuple<SubscriptionName, List<String>> parse(String... args) throws Exception {
-            if (args.length < 2) {
-                throw new IllegalArgumentException("Missing required subscription and ack IDs");
-            }
-            SubscriptionName subscriptionName = SubscriptionName.create(projectId, args[0]);
-            return Tuple.of(subscriptionName, Arrays.asList(Arrays.copyOfRange(args, 1, args.length)));
-        }
-
-        @Override
-        public String params() {
-            return "<subscription> <ackId>+";
-        }
-    }
-
     /**
      * This class demonstrates how to asynchronously pull messages from a Pub/Sub pull subscription.
      * Messages are pulled until a timeout is reached.

google-cloud-examples/src/main/java/com/google/cloud/examples/pubsub/snippets/SubscriptionAdminClientSnippets.java

@@ -53,12 +53,15 @@ public String getProjectId() {
   }
 
   /** Example of creating a pull subscription for a topic. */
-  public Subscription createSubscription(String topic, String subscriptionId) throws Exception {
+  public Subscription createSubscription(String topicId, String subscriptionId) throws Exception {
     try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
       // [START createSubscription]
-      TopicName topicName = TopicName.create(projectId, topic);
+      // eg. projectId = "my-test-project", topicId = "my-test-topic"
+      TopicName topicName = TopicName.create(projectId, topicId);
+      // eg. subscriptionId = "my-test-subscription"
       SubscriptionName subscriptionName =
           SubscriptionName.create(projectId, subscriptionId);
+      // create a pull subscription with default acknowledgement deadline
       Subscription subscription =
           subscriptionAdminClient.createSubscription(
               subscriptionName, topicName, PushConfig.getDefaultInstance(), 0);
@@ -67,6 +70,29 @@ public Subscription createSubscription(String topic, String subscriptionId) thro
     }
   }
 
+  /** Example of creating a subscription with a push endpoint. */
+  public Subscription createSubscriptionWithPushEndpoint(String topicId, String subscriptionId, String endpoint)
+          throws Exception {
+    try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
+      // [START createSubscriptionWithPushEndpoint]
+      TopicName topicName = TopicName.create(projectId, topicId);
+      SubscriptionName subscriptionName =
+              SubscriptionName.create(projectId, subscriptionId);
+
+      // eg. endpoint = "https://my-test-project.appspot.com/push"
+      PushConfig pushConfig = PushConfig.newBuilder().setPushEndpoint(endpoint).build();
+
+      // acknowledgement deadline in seconds for the message received over the push endpoint
+      int ackDeadlineInSeconds = 10;
+
+      Subscription subscription =
+              subscriptionAdminClient.createSubscription(
+                      subscriptionName, topicName, pushConfig, ackDeadlineInSeconds);
+      // [END createSubscriptionWithPushEndpoint]
+      return subscription;
+    }
+  }
+
   /** Example of replacing the push configuration of a subscription, setting the push endpoint. */
   public void replacePushConfig(String subscriptionId, String endpoint) throws Exception {
     try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {

google-cloud-examples/src/test/java/com/google/cloud/examples/pubsub/snippets/ITSubscriptionAdminClientSnippets.java

@@ -82,16 +82,19 @@ public void setUp() throws Exception {
     Cleanup.deleteTestTopicsAndSubscriptions(projectId, topics, subscriptions);
   }
 
-  private Subscription createSubscription(String topicName, String subscriptionName)
-      throws Exception {
+  @Test
+  public void createSubscriptionWithPushIsSuccessful() throws Exception {
+    String topicName = topics[0];
+    String subscriptionName = subscriptions[0];
     createTopic(topicName);
+    String endpoint = "https://" + projectId + ".appspot.com/push";
     Subscription subscription =
-        subscriptionAdminClientSnippets.createSubscription(topicName, subscriptionName);
+        subscriptionAdminClientSnippets.createSubscriptionWithPushEndpoint(topicName, subscriptionName, endpoint);
     assertNotNull(subscription);
     Subscription retrievedSubscription = subscriptionAdminClientSnippets.getSubscription(subscriptionName);
     assertNotNull(retrievedSubscription);
     assertEquals(subscription.getName(), retrievedSubscription.getName());
-    return subscription;
+    assertEquals(subscription.getPushConfig().getPushEndpoint(), endpoint);
   }
 
   @Test
@@ -168,17 +171,16 @@ private void createTopic(String name) throws Exception {
     }
   }
 
-  private Set<String> publishMessages(String topicName, int numMessages) throws Exception {
-    Set<String> messages = new HashSet<>();
-    Publisher publisher = Publisher.defaultBuilder(TopicName.create(projectId, topicName)).build();
-    for (int i = 1; i<= numMessages; i++) {
-      String message = formatForTest("message-" + i);
-      PubsubMessage pubsubMessage = PubsubMessage.newBuilder().setData(
-          ByteString.copyFromUtf8(message)).build();
-      publisher.publish(pubsubMessage);
-      messages.add(message);
-    }
-    return messages;
+  private Subscription createSubscription(String topicName, String subscriptionName)
+          throws Exception {
+    createTopic(topicName);
+    Subscription subscription =
+        subscriptionAdminClientSnippets.createSubscription(topicName, subscriptionName);
+    assertNotNull(subscription);
+    Subscription retrievedSubscription = subscriptionAdminClientSnippets.getSubscription(subscriptionName);
+    assertNotNull(retrievedSubscription);
+    assertEquals(subscription.getName(), retrievedSubscription.getName());
+    return subscription;
   }
 
   @After