From 31cc9375c78156643b03374fddeb7aab4b26b4f3 Mon Sep 17 00:00:00 2001 From: Praful Makani Date: Thu, 30 Jul 2020 12:03:21 +0530 Subject: [PATCH] docs(samples): add update table cmek (#619) --- .../com/example/bigquery/UpdateTableCMEK.java | 57 ++++++++++++ .../example/bigquery/UpdateTableCMEKIT.java | 91 +++++++++++++++++++ 2 files changed, 148 insertions(+) create mode 100644 samples/snippets/src/main/java/com/example/bigquery/UpdateTableCMEK.java create mode 100644 samples/snippets/src/test/java/com/example/bigquery/UpdateTableCMEKIT.java diff --git a/samples/snippets/src/main/java/com/example/bigquery/UpdateTableCMEK.java b/samples/snippets/src/main/java/com/example/bigquery/UpdateTableCMEK.java new file mode 100644 index 000000000..c0431c8f7 --- /dev/null +++ b/samples/snippets/src/main/java/com/example/bigquery/UpdateTableCMEK.java @@ -0,0 +1,57 @@ +/* + * 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_update_table_cmek] +import com.google.cloud.bigquery.BigQuery; +import com.google.cloud.bigquery.BigQueryException; +import com.google.cloud.bigquery.BigQueryOptions; +import com.google.cloud.bigquery.EncryptionConfiguration; +import com.google.cloud.bigquery.Table; +import com.google.cloud.bigquery.TableId; + +// Sample to update a cmek table +public class UpdateTableCMEK { + + public static void runUpdateTableCMEK() { + // TODO(developer): Replace these variables before running the sample. + String datasetName = "MY_DATASET_NAME"; + String tableName = "MY_TABLE_NAME"; + String kmsKeyName = "MY_KEY_NAME"; + // Set a new encryption key to use for the destination. + // i.e. projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{cryptoKey} + EncryptionConfiguration encryption = + EncryptionConfiguration.newBuilder().setKmsKeyName(kmsKeyName).build(); + updateTableCMEK(datasetName, tableName, encryption); + } + + public static void updateTableCMEK( + String datasetName, String tableName, EncryptionConfiguration encryption) { + 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(); + + Table table = bigquery.getTable(TableId.of(datasetName, tableName)); + bigquery.update(table.toBuilder().setEncryptionConfiguration(encryption).build()); + System.out.println("Table cmek updated successfully"); + } catch (BigQueryException e) { + System.out.println("Table cmek was not updated. \n" + e.toString()); + } + } +} +// [END bigquery_update_table_cmek] diff --git a/samples/snippets/src/test/java/com/example/bigquery/UpdateTableCMEKIT.java b/samples/snippets/src/test/java/com/example/bigquery/UpdateTableCMEKIT.java new file mode 100644 index 000000000..6ec7de63a --- /dev/null +++ b/samples/snippets/src/test/java/com/example/bigquery/UpdateTableCMEKIT.java @@ -0,0 +1,91 @@ +/* + * 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 com.google.cloud.bigquery.EncryptionConfiguration; +import com.google.cloud.bigquery.Field; +import com.google.cloud.bigquery.Schema; +import com.google.cloud.bigquery.StandardSQLTypeName; +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 UpdateTableCMEKIT { + + private String tableName; + private ByteArrayOutputStream bout; + private PrintStream out; + + private static final String BIGQUERY_DATASET_NAME = requireEnvVar("BIGQUERY_DATASET_NAME"); + private static final String BIGQUERY_KMS_KEY_NAME = requireEnvVar("BIGQUERY_KMS_KEY_NAME"); + + 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("BIGQUERY_DATASET_NAME"); + requireEnvVar("BIGQUERY_KMS_KEY_NAME"); + } + + @Before + public void setUp() { + bout = new ByteArrayOutputStream(); + out = new PrintStream(bout); + System.setOut(out); + // create a test table. + tableName = "MY_UPDATE_TABLE_CMEK_TEST" + UUID.randomUUID().toString().substring(0, 8); + Schema schema = + Schema.of( + Field.of("stringField", StandardSQLTypeName.STRING), + Field.of("booleanField", StandardSQLTypeName.BOOL)); + EncryptionConfiguration encryption = + EncryptionConfiguration.newBuilder().setKmsKeyName(BIGQUERY_KMS_KEY_NAME).build(); + CreateTableCMEK.createTableCMEK(BIGQUERY_DATASET_NAME, tableName, schema, encryption); + + bout = new ByteArrayOutputStream(); + out = new PrintStream(bout); + System.setOut(out); + } + + @After + public void tearDown() { + // Clean up + DeleteTable.deleteTable(BIGQUERY_DATASET_NAME, tableName); + System.setOut(null); + } + + @Test + public void testUpdateTableCMEK() { + EncryptionConfiguration encryption = + EncryptionConfiguration.newBuilder().setKmsKeyName(BIGQUERY_KMS_KEY_NAME).build(); + UpdateTableCMEK.updateTableCMEK(BIGQUERY_DATASET_NAME, tableName, encryption); + assertThat(bout.toString()).contains("Table cmek updated successfully"); + } +}