samples: create BigQuery subscription

README.md

@@ -19,7 +19,7 @@ If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file
     <dependency>
       <groupId>com.google.cloud</groupId>
       <artifactId>libraries-bom</artifactId>
-      <version>25.3.0</version>
+      <version>25.4.0</version>
       <type>pom</type>
       <scope>import</scope>
     </dependency>
@@ -243,6 +243,7 @@ Samples are in the [`samples/`](https://github.com/googleapis/java-pubsub/tree/m
 | Native Image Pub Sub Sample | [source code](https://github.com/googleapis/java-pubsub/blob/main/samples/native-image-sample/src/main/java/pubsub/NativeImagePubSubSample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-pubsub&page=editor&open_in_editor=samples/native-image-sample/src/main/java/pubsub/NativeImagePubSubSample.java) |
 | Publish Operations | [source code](https://github.com/googleapis/java-pubsub/blob/main/samples/native-image-sample/src/main/java/utilities/PublishOperations.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-pubsub&page=editor&open_in_editor=samples/native-image-sample/src/main/java/utilities/PublishOperations.java) |
 | Create Avro Schema Example | [source code](https://github.com/googleapis/java-pubsub/blob/main/samples/snippets/src/main/java/pubsub/CreateAvroSchemaExample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-pubsub&page=editor&open_in_editor=samples/snippets/src/main/java/pubsub/CreateAvroSchemaExample.java) |
+| Create Big Query Subscription Example | [source code](https://github.com/googleapis/java-pubsub/blob/main/samples/snippets/src/main/java/pubsub/CreateBigQuerySubscriptionExample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-pubsub&page=editor&open_in_editor=samples/snippets/src/main/java/pubsub/CreateBigQuerySubscriptionExample.java) |
 | Create Proto Schema Example | [source code](https://github.com/googleapis/java-pubsub/blob/main/samples/snippets/src/main/java/pubsub/CreateProtoSchemaExample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-pubsub&page=editor&open_in_editor=samples/snippets/src/main/java/pubsub/CreateProtoSchemaExample.java) |
 | Create Pull Subscription Example | [source code](https://github.com/googleapis/java-pubsub/blob/main/samples/snippets/src/main/java/pubsub/CreatePullSubscriptionExample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-pubsub&page=editor&open_in_editor=samples/snippets/src/main/java/pubsub/CreatePullSubscriptionExample.java) |
 | Create Push Subscription Example | [source code](https://github.com/googleapis/java-pubsub/blob/main/samples/snippets/src/main/java/pubsub/CreatePushSubscriptionExample.java) | [![Open in Cloud Shell][shell_img]](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/java-pubsub&page=editor&open_in_editor=samples/snippets/src/main/java/pubsub/CreatePushSubscriptionExample.java) |

samples/install-without-bom/pom.xml

@@ -83,6 +83,11 @@
       <version>2.7.1</version>
       <classifier>tests</classifier>
     </dependency>
+    <dependency>
+      <groupId>com.google.cloud</groupId>
+      <artifactId>google-cloud-bigquery</artifactId>
+      <version>2.13.3</version>
+    </dependency>
   </dependencies>
 
   <!-- compile and run all snippet tests -->

samples/snapshot/pom.xml

@@ -82,6 +82,11 @@
       <version>2.7.1</version>
       <classifier>tests</classifier>
     </dependency>
+    <dependency>
+      <groupId>com.google.cloud</groupId>
+      <artifactId>google-cloud-bigquery</artifactId>
+      <version>2.13.3</version>
+    </dependency>
   </dependencies>
 
   <!-- compile and run all snippet tests -->

samples/snippets/pom.xml

@@ -45,7 +45,7 @@
       <dependency>
         <groupId>com.google.cloud</groupId>
         <artifactId>libraries-bom</artifactId>
-        <version>25.3.0</version>
+        <version>25.4.0</version>
         <type>pom</type>
         <scope>import</scope>
       </dependency>
@@ -57,8 +57,12 @@
       <groupId>com.google.cloud</groupId>
       <artifactId>google-cloud-pubsub</artifactId>
     </dependency>
-    
+
     <!-- [START_EXCLUDE] -->
+    <dependency>
+      <groupId>com.google.cloud</groupId>
+      <artifactId>google-cloud-bigquery</artifactId>
+    </dependency>
     <dependency>
       <groupId>org.apache.avro</groupId>
       <artifactId>avro</artifactId>

samples/snippets/src/main/java/pubsub/CreateBigQuerySubscriptionExample.java

@@ -0,0 +1,62 @@
+/*
+ * Copyright 2022 Google LLC
+ *
+ * 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 pubsub;
+
+// [START pubsub_create_bigquery_subscription]
+import com.google.cloud.pubsub.v1.SubscriptionAdminClient;
+import com.google.pubsub.v1.BigQueryConfig;
+import com.google.pubsub.v1.ProjectSubscriptionName;
+import com.google.pubsub.v1.ProjectTopicName;
+import com.google.pubsub.v1.Subscription;
+import java.io.IOException;
+
+public class CreateBigQuerySubscriptionExample {
+  public static void main(String... args) throws Exception {
+    // TODO(developer): Replace these variables before running the sample.
+    String projectId = "your-project-id";
+    String topicId = "your-topic-id";
+    String subscriptionId = "your-subscription-id";
+    String bigqueryTableId = "your-project.your-dataset.your-table";
+
+    createBigQuerySubscription(projectId, topicId, subscriptionId, bigqueryTableId);
+  }
+
+  public static void createBigQuerySubscription(
+      String projectId, String topicId, String subscriptionId, String bigqueryTableId)
+      throws IOException {
+    try (SubscriptionAdminClient subscriptionAdminClient = SubscriptionAdminClient.create()) {
+
+      ProjectTopicName topicName = ProjectTopicName.of(projectId, topicId);
+      ProjectSubscriptionName subscriptionName =
+          ProjectSubscriptionName.of(projectId, subscriptionId);
+
+      BigQueryConfig bigqueryConfig =
+          BigQueryConfig.newBuilder().setTable(bigqueryTableId).setWriteMetadata(true).build();
+
+      Subscription subscription =
+          subscriptionAdminClient.createSubscription(
+              Subscription.newBuilder()
+                  .setName(subscriptionName.toString())
+                  .setTopic(topicName.toString())
+                  .setBigqueryConfig(bigqueryConfig)
+                  .build());
+
+      System.out.println("Created a BigQuery subscription: " + subscription.getAllFields());
+    }
+  }
+}
+// [END pubsub_create_bigquery_subscription]

samples/snippets/src/test/java/pubsub/AdminIT.java

@@ -20,6 +20,17 @@
 import static junit.framework.TestCase.assertNotNull;
 
 import com.google.api.gax.rpc.NotFoundException;
+import com.google.cloud.bigquery.BigQuery;
+import com.google.cloud.bigquery.BigQueryOptions;
+import com.google.cloud.bigquery.DatasetId;
+import com.google.cloud.bigquery.DatasetInfo;
+import com.google.cloud.bigquery.Field;
+import com.google.cloud.bigquery.Schema;
+import com.google.cloud.bigquery.StandardSQLTypeName;
+import com.google.cloud.bigquery.StandardTableDefinition;
+import com.google.cloud.bigquery.TableDefinition;
+import com.google.cloud.bigquery.TableId;
+import com.google.cloud.bigquery.TableInfo;
 import com.google.cloud.pubsub.v1.SubscriptionAdminClient;
 import com.google.cloud.pubsub.v1.TopicAdminClient;
 import com.google.pubsub.v1.SubscriptionName;
@@ -48,6 +59,10 @@ public class AdminIT {
   private static final String exactlyOnceSubscriptionId =
       "iam-exactly-once-subscription-" + _suffix;
   private static final String pushEndpoint = "https://my-test-project.appspot.com/push";
+  private static final String bigqueryDatasetId =
+      "java_samples_data_set" + _suffix.replace("-", "_");
+  private static final String bigquerySubscriptionId = "iam-bigquery-subscription-" + _suffix;
+  private static final String bigqueryTableId = "java_samples_table_" + _suffix;
 
   private static final TopicName topicName = TopicName.of(projectId, topicId);
   private static final SubscriptionName pullSubscriptionName =
@@ -79,6 +94,9 @@ public void setUp() throws Exception {
     bout = new ByteArrayOutputStream();
     out = new PrintStream(bout);
     System.setOut(out);
+
+    // Create table for BigQuery subscription.
+    createBigQueryTable();
   }
 
   @After
@@ -102,9 +120,39 @@ public void tearDown() throws Exception {
     } catch (NotFoundException ignored) {
       // ignore this as resources may not have been created
     }
+
+    // Delete BigQuery table.
+    deleteBigQueryTable();
+
     System.setOut(null);
   }
 
+  private void createBigQueryTable() throws Exception {
+    BigQuery bigquery = BigQueryOptions.getDefaultInstance().getService();
+    DatasetInfo datasetInfo = DatasetInfo.newBuilder(projectId, bigqueryDatasetId).build();
+    bigquery.create(datasetInfo);
+
+    Schema schema =
+        Schema.of(
+            Field.of("data", StandardSQLTypeName.STRING),
+            Field.of("message_id", StandardSQLTypeName.STRING),
+            Field.of("attributes", StandardSQLTypeName.STRING),
+            Field.of("subscription_name", StandardSQLTypeName.STRING),
+            Field.of("publish_time", StandardSQLTypeName.TIMESTAMP));
+
+    TableId tableId = TableId.of(projectId, bigqueryDatasetId, bigqueryTableId);
+    TableDefinition tableDefinition = StandardTableDefinition.of(schema);
+    TableInfo tableInfo = TableInfo.newBuilder(tableId, tableDefinition).build();
+
+    bigquery.create(tableInfo);
+  }
+
+  private void deleteBigQueryTable() throws Exception {
+    BigQuery bigquery = BigQueryOptions.getDefaultInstance().getService();
+    DatasetId datasetId = DatasetId.of(projectId, bigqueryDatasetId);
+    bigquery.delete(datasetId, BigQuery.DatasetDeleteOption.deleteContents());
+  }
+
   @Test
   public void testAdmin() throws Exception {
     // Test create topic.
@@ -208,12 +256,21 @@ public void testAdmin() throws Exception {
         .contains("Created a subscription with exactly once delivery enabled:");
     assertThat(bout.toString()).contains("enable_exactly_once_delivery=true");
 
+    bout.reset();
+    // Test create a BigQuery subscription
+    String bigqueryTablePath = String.join(".", projectId, bigqueryDatasetId, bigqueryTableId);
+    CreateBigQuerySubscriptionExample.createBigQuerySubscription(
+        projectId, topicId, bigquerySubscriptionId, bigqueryTablePath);
+    assertThat(bout.toString()).contains("Created a BigQuery subscription:");
+    assertThat(bout.toString()).contains(bigqueryTablePath);
+
     bout.reset();
     // Test delete subscription.
     DeleteSubscriptionExample.deleteSubscriptionExample(projectId, pullSubscriptionId);
     DeleteSubscriptionExample.deleteSubscriptionExample(projectId, pushSubscriptionId);
     DeleteSubscriptionExample.deleteSubscriptionExample(projectId, orderedSubscriptionId);
     DeleteSubscriptionExample.deleteSubscriptionExample(projectId, exactlyOnceSubscriptionId);
+    DeleteSubscriptionExample.deleteSubscriptionExample(projectId, bigquerySubscriptionId);
     assertThat(bout.toString()).contains("Deleted subscription.");
 
     bout.reset();