docs(samples): add get dataset labels (#539)

Praful Makani · web-flow · commit 563157cc4072 · 2020-07-13T14:53:31.000-04:00
* docs(samples): add get dataset labels

* docs(samples): run formatter
diff --git a/samples/snippets/src/main/java/com/example/bigquery/GetDatasetLabels.java b/samples/snippets/src/main/java/com/example/bigquery/GetDatasetLabels.java
@@ -0,0 +1,49 @@
+/*
+ * Copyright 2020 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.bigquery;
+
+// [START bigquery_get_dataset_labels]
+import com.google.cloud.bigquery.BigQuery;
+import com.google.cloud.bigquery.BigQueryException;
+import com.google.cloud.bigquery.BigQueryOptions;
+import com.google.cloud.bigquery.Dataset;
+
+// Sample to get dataset labels
+public class GetDatasetLabels {
+
+  public static void runGetDatasetLabels() {
+    // TODO(developer): Replace these variables before running the sample.
+    String datasetName = "MY_DATASET_NAME";
+    getDatasetLabels(datasetName);
+  }
+
+  public static void getDatasetLabels(String datasetName) {
+    try {
+      // Initialize client that will be used to send requests. This client only needs to be created
+      // once, and can be reused for multiple requests.
+      BigQuery bigquery = BigQueryOptions.getDefaultInstance().getService();
+
+      Dataset dataset = bigquery.getDataset(datasetName);
+      dataset
+          .getLabels()
+          .forEach((key, value) -> System.out.println("Retrieved labels successfully"));
+    } catch (BigQueryException e) {
+      System.out.println("Label was not found. \n" + e.toString());
+    }
+  }
+}
+// [END bigquery_get_dataset_labels]
diff --git a/samples/snippets/src/test/java/com/example/bigquery/GetDatasetLabelsIT.java b/samples/snippets/src/test/java/com/example/bigquery/GetDatasetLabelsIT.java
@@ -0,0 +1,79 @@
+/*
+ * Copyright 2020 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.bigquery;
+
+import static com.google.common.truth.Truth.assertThat;
+import static junit.framework.TestCase.assertNotNull;
+
+import java.io.ByteArrayOutputStream;
+import java.io.PrintStream;
+import java.util.UUID;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.BeforeClass;
+import org.junit.Test;
+
+public class GetDatasetLabelsIT {
+
+  private String datasetName;
+  private ByteArrayOutputStream bout;
+  private PrintStream out;
+
+  private static final String PROJECT_ID = requireEnvVar("GOOGLE_CLOUD_PROJECT");
+
+  private static String requireEnvVar(String varName) {
+    String value = System.getenv(varName);
+    assertNotNull(
+        "Environment variable " + varName + " is required to perform these tests.",
+        System.getenv(varName));
+    return value;
+  }
+
+  @BeforeClass
+  public static void checkRequirements() {
+    requireEnvVar("GOOGLE_CLOUD_PROJECT");
+  }
+
+  @Before
+  public void setUp() {
+    bout = new ByteArrayOutputStream();
+    out = new PrintStream(bout);
+    System.setOut(out);
+    // create a temporary dataset
+    datasetName = "MY_DATASET_TEST_" + UUID.randomUUID().toString().substring(0, 8);
+    CreateDataset.createDataset(datasetName);
+    // add a label on dataset
+    LabelDataset.labelDataset(datasetName);
+
+    bout = new ByteArrayOutputStream();
+    out = new PrintStream(bout);
+    System.setOut(out);
+  }
+
+  @After
+  public void tearDown() {
+    // delete a temporary dataset
+    DeleteDataset.deleteDataset(PROJECT_ID, datasetName);
+    System.setOut(null);
+  }
+
+  @Test
+  public void testGetDatasetLabels() {
+    GetDatasetLabels.getDatasetLabels(datasetName);
+    assertThat(bout.toString()).contains("Retrieved labels successfully");
+  }
+}
