feat: new sample - Models: List model resources contained in a dataset (#125)

* feat: new sample - Models: List Models * update to use hamcrest truth * update base on comments * update base on comment * nit * nit * nit update * nit update

Author: stephaniewang526

samples/src/main/java/com/example/bigquery/ListDatasets.java

@@ -39,9 +39,14 @@ public static void listDatasets(String projectId) {
  BigQuery bigquery = BigQueryOptions.getDefaultInstance().getService();
 
  Page<Dataset> datasets = bigquery.listDatasets(projectId, DatasetListOption.pageSize(100));
- for (Dataset dataset : datasets.iterateAll()) {
- System.out.println(dataset.getDatasetId() + " dataset in project listed successfully");
+ if (datasets == null) {
+ System.out.println("Dataset does not contain any models");
+ return;
  }
+ datasets
+ .iterateAll()
+ .forEach(
+ dataset -> System.out.printf("Success! Dataset ID: %s ", dataset.getDatasetId()));
  } catch (BigQueryException e) {
  System.out.println("Project does not contain any datasets \n" + e.toString());
  }

samples/src/main/java/com/example/bigquery/ListModels.java

@@ -0,0 +1,54 @@
+/*
+ * 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 com.google.api.gax.paging.Page;
+import com.google.cloud.bigquery.BigQuery;
+import com.google.cloud.bigquery.BigQuery.ModelListOption;
+import com.google.cloud.bigquery.BigQueryException;
+import com.google.cloud.bigquery.BigQueryOptions;
+import com.google.cloud.bigquery.Model;
+
+// [START bigquery_list_models]
+public class ListModels {
+
+ public static void runListModels() {
+ // TODO(developer): Replace these variables before running the sample.
+ String datasetName = "MY_DATASET_NAME";
+ listModels(datasetName);
+ }
+
+ public static void listModels(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();
+
+ Page<Model> models = bigquery.listModels(datasetName, ModelListOption.pageSize(100));
+ if (models == null) {
+ System.out.println("Dataset does not contain any models.");
+ return;
+ }
+ models
+ .iterateAll()
+ .forEach(model -> System.out.printf("Success! Model ID: %s", model.getModelId()));
+ } catch (BigQueryException e) {
+ System.out.println("Models not listed in dataset due to error: \n" + e.toString());
+ }
+ }
+}
+// [END bigquery_list_models]

samples/src/test/java/com/example/bigquery/ListDatasetsIT.java

@@ -44,6 +44,6 @@ public void tearDown() {
  public void listDatasets() {
  // List datasets in bigquery-public-data project
  ListDatasets.listDatasets("bigquery-public-data");
- assertThat(bout.toString()).contains("dataset in project listed successfully");
+ assertThat(bout.toString()).contains("Success! Dataset ID");
  }
 }

samples/src/test/java/com/example/bigquery/ListModelsIT.java

@@ -0,0 +1,63 @@
+/*
+ * 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 junit.framework.TestCase.assertNotNull;
+
+import com.google.common.truth.Truth;
+import java.io.ByteArrayOutputStream;
+import java.io.PrintStream;
+import org.junit.After;
+import org.junit.Before;
+import org.junit.BeforeClass;
+import org.junit.Test;
+
+public class ListModelsIT {
+ private ByteArrayOutputStream bout;
+ private PrintStream out;
+
+ private static final String BIGQUERY_DATASET_NAME = System.getenv("BIGQUERY_DATASET_NAME");
+
+ private static void requireEnvVar(String varName) {
+ assertNotNull(
+ "Environment variable " + varName + " is required to perform these tests.",
+ System.getenv(varName));
+ }
+
+ @BeforeClass
+ public static void checkRequirements() {
+ requireEnvVar("BIGQUERY_DATASET_NAME");
+ }
+
+ @Before
+ public void setUp() {
+ bout = new ByteArrayOutputStream();
+ out = new PrintStream(bout);
+ System.setOut(out);
+ }
+
+ @After
+ public void tearDown() {
+ System.setOut(null);
+ }
+
+ @Test
+ public void testListModels() {
+ ListModels.listModels(BIGQUERY_DATASET_NAME);
+ Truth.assertThat(bout.toString()).contains("Success! Model ID");
+ }
+}