Add Data Catalog createEntry samples and tests.

datacatalog/cloud-client/build.gradle

@@ -19,7 +19,7 @@ repositories {
 }
 
 dependencies {
-    compile group: 'com.google.cloud', name: 'google-cloud-datacatalog', version:'0.4.0-alpha'
+    compile group: 'com.google.cloud', name: 'google-cloud-datacatalog', version:'0.28.0-alpha'
 
     testCompile group: 'com.google.truth', name: 'truth', version:'0.42'
     testCompile group: 'junit', name: 'junit', version:'4.13-beta-2'

datacatalog/cloud-client/pom.xml

@@ -39,7 +39,7 @@
         <dependency>
             <groupId>com.google.cloud</groupId>
             <artifactId>google-cloud-datacatalog</artifactId>
-            <version>0.14.0-alpha</version>
+            <version>0.28.0-alpha</version>
         </dependency>
 
         <!-- Test dependencies -->

datacatalog/cloud-client/src/main/java/com/example/datacatalog/CreateFilesetEntry.java

@@ -0,0 +1,137 @@
+/*
+ * Copyright 2019 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.datacatalog;
+
+// [START create_fileset_entry]
+
+import com.google.cloud.datacatalog.ColumnSchema;
+import com.google.cloud.datacatalog.CreateEntryGroupRequest;
+import com.google.cloud.datacatalog.CreateEntryRequest;
+import com.google.cloud.datacatalog.Entry;
+import com.google.cloud.datacatalog.EntryGroup;
+import com.google.cloud.datacatalog.EntryGroupName;
+import com.google.cloud.datacatalog.EntryName;
+import com.google.cloud.datacatalog.EntryType;
+import com.google.cloud.datacatalog.GcsFilesetSpec;
+import com.google.cloud.datacatalog.LocationName;
+import com.google.cloud.datacatalog.Schema;
+
+import com.google.cloud.datacatalog.v1beta1.DataCatalogClient;
+
+public class CreateFilesetEntry {
+
+  /**
+   * Create Fileset Entry
+   *
+   * @param projectId    The project ID to which the fileset belongs, e.g. 'my-project'
+   * @param entryGroupId The Entry Group ID to which the fileset belongs,
+   *                     e.g. 'fileset_entry_group'
+   * @param entryId      The Entry ID for the fileset, e.g. 'fileset_entry_id'
+   */
+  public static void createEntry(String projectId, String entryGroupId, String entryId) {
+
+    // -------------------------------
+    // Currently, Data Catalog stores metadata in the
+    // us-central1 region.
+    // -------------------------------
+    String location = "us-central1";
+
+    // Initialize client that will be used to send requests. This client only needs to be created
+    // once, and can be reused for multiple requests. After completing all of your requests, call
+    // the "close" method on the client to safely clean up any remaining background resources.
+    try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+
+      // -------------------------------
+      // 1. Environment cleanup: delete pre-existing data.
+      // -------------------------------
+      // Delete any pre-existing Entry with the same name
+      // that will be used in step 3.
+      try {
+        dataCatalogClient.deleteEntry(
+                EntryName.of(projectId, location, entryGroupId, entryId).toString());
+      } catch (Exception e) {
+        System.out.println("Entry does not exist.");
+      }
+
+      // Delete any pre-existing Entry Group with the same name
+      // that will be used in step 2.
+      try {
+        dataCatalogClient.deleteEntryGroup(
+                EntryGroupName.of(projectId, location, entryGroupId).toString());
+      } catch (Exception e) {
+        System.out.println("Entry Group does not exist.");
+      }
+
+      // -------------------------------
+      // 2. Create an Entry Group.
+      // -------------------------------
+      // Construct the EntryGroup for the EntryGroup request.
+      EntryGroup entryGroup = EntryGroup.newBuilder().build();
+
+      // Construct the EntryGroup request to be sent by the client.
+      CreateEntryGroupRequest entryGroupRequest = CreateEntryGroupRequest.newBuilder()
+              .setParent(LocationName.of(projectId, location).toString())
+              .setEntryGroupId(entryGroupId)
+              .setEntryGroup(entryGroup)
+              .build();
+
+      // Use the client to send the API request.
+      EntryGroup entryGroupResponse = dataCatalogClient.createEntryGroup(entryGroupRequest);
+
+      System.out.printf("\nEntry Group created with name: %s\n", entryGroupResponse.getName());
+
+      // -------------------------------
+      // 3. Create a Fileset Entry.
+      // -------------------------------
+      // Construct the Entry for the Entry request.
+      Entry entry = Entry.newBuilder()
+              .setDisplayName("My Fileset")
+              .setDescription("This fileset consists of ....")
+              .setGcsFilesetSpec(GcsFilesetSpec.newBuilder().addFilePatterns("gs://my_bucket/*")
+                      .build())
+              .setSchema(Schema.newBuilder()
+                      .addColumns(ColumnSchema.newBuilder()
+                              .setColumn("first_column")
+                              .setType("STRING")
+                              .setDescription("This columns consists of ....").build())
+                      .addColumns(ColumnSchema.newBuilder()
+                              .setColumn("second_column")
+                              .setType("STRING")
+                              .setDescription("This columns consists of ....").build())
+                      .build())
+              .setType(EntryType.FILESET)
+              .build();
+
+      // Construct the Entry request to be sent by the client.
+      CreateEntryRequest entryRequest = CreateEntryRequest.newBuilder()
+              .setParent(entryGroupResponse.getName())
+              .setEntryId(entryId)
+              .setEntry(entry)
+              .build();
+
+      // Use the client to send the API request.
+      Entry entryResponse = dataCatalogClient.createEntry(entryRequest);
+
+      System.out.printf("\nEntry created with name: %s\n", entryResponse.getName());
+
+
+    } catch (Exception e) {
+      System.out.println("Error in create entry process:\n" + e.toString());
+    }
+  }
+}
+// [END create_fileset_entry]

datacatalog/cloud-client/src/test/java/com/example/datacatalog/CreateFilesetEntryTests.java

@@ -0,0 +1,87 @@
+/*
+ * Copyright 2019 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 com.example.datacatalog;
+
+import static org.junit.Assert.assertThat;
+
+import com.google.cloud.datacatalog.EntryGroupName;
+import com.google.cloud.datacatalog.EntryName;
+import com.google.cloud.datacatalog.v1beta1.DataCatalogClient;
+
+import java.io.ByteArrayOutputStream;
+import java.io.PrintStream;
+
+import org.hamcrest.CoreMatchers;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+
+/**
+ * Integration (system) tests for {@link CreateFilesetEntry}.
+ */
+@RunWith(JUnit4.class)
+@SuppressWarnings("checkstyle:abbreviationaswordinname")
+public class CreateFilesetEntryTests {
+
+  private ByteArrayOutputStream bout;
+
+  private static String PROJECT_ID = System.getenv().get("GOOGLE_CLOUD_PROJECT");
+  private static String LOCATION = "us-central1";
+  private static String ENTRY_GROUP_ID = "fileset_entry_group";
+  private static String ENTRY_ID = "fileset_entry_id";
+
+  @Before
+  public void setUp() {
+    bout = new ByteArrayOutputStream();
+    System.setOut(new PrintStream(bout));
+  }
+
+  @After
+  public void tearDown() {
+    System.setOut(null);
+    bout.reset();
+
+    try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {
+      dataCatalogClient.deleteEntry(
+              EntryName.of(PROJECT_ID, LOCATION, ENTRY_GROUP_ID, ENTRY_ID).toString());
+      dataCatalogClient.deleteEntryGroup(
+              EntryGroupName.of(PROJECT_ID, LOCATION, ENTRY_GROUP_ID).toString());
+    } catch (Exception e) {
+      System.out.println("Error in cleaning up test data:\n" + e.toString());
+    }
+
+  }
+
+  @Test
+  public void testCreateFilesetEntry() {
+    CreateFilesetEntry.createEntry(PROJECT_ID, "fileset_entry_group", "fileset_entry_id");
+
+    String output = bout.toString();
+
+    String entryGroupTemplate =
+            "Entry Group created with name: projects/%s/locations/us-central1/entryGroups/%s";
+    assertThat(output, CoreMatchers.containsString(
+            String.format(entryGroupTemplate, PROJECT_ID, ENTRY_GROUP_ID)));
+
+    String entryTemplate =
+            "Entry created with name: projects/%s/locations/us-central1/entryGroups/%s/entries/%s";
+    assertThat(output, CoreMatchers.containsString(
+            String.format(entryTemplate, PROJECT_ID, ENTRY_GROUP_ID, ENTRY_ID)));
+  }
+}