From 533a68158dd92d083aba9e13493e4d66cd3d85df Mon Sep 17 00:00:00 2001 From: Praful Makani Date: Mon, 28 Sep 2020 21:11:45 +0530 Subject: [PATCH] docs(samples): add disable transfer config (#384) * docs(samples): add disable transfer config * docs(samples): update test case name --- .../DisableTransferConfig.java | 55 +++++++++++++ .../DisableTransferConfigIT.java | 81 +++++++++++++++++++ .../UpdateTransferConfigIT.java | 2 +- 3 files changed, 137 insertions(+), 1 deletion(-) create mode 100644 samples/snippets/src/main/java/com/example/bigquerydatatransfer/DisableTransferConfig.java create mode 100644 samples/snippets/src/test/java/com/example/bigquerydatatransfer/DisableTransferConfigIT.java diff --git a/samples/snippets/src/main/java/com/example/bigquerydatatransfer/DisableTransferConfig.java b/samples/snippets/src/main/java/com/example/bigquerydatatransfer/DisableTransferConfig.java new file mode 100644 index 00000000..5b88cee0 --- /dev/null +++ b/samples/snippets/src/main/java/com/example/bigquerydatatransfer/DisableTransferConfig.java @@ -0,0 +1,55 @@ +/* + * 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.bigquerydatatransfer; + +// [START bigquerydatatransfer_disable_transfer] +import com.google.api.gax.rpc.ApiException; +import com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient; +import com.google.cloud.bigquery.datatransfer.v1.TransferConfig; +import com.google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest; +import com.google.protobuf.FieldMask; +import com.google.protobuf.util.FieldMaskUtil; +import java.io.IOException; + +// Sample to disable transfer config. +public class DisableTransferConfig { + + public static void main(String[] args) throws IOException { + // TODO(developer): Replace these variables before running the sample. + String configId = "MY_CONFIG_ID"; + TransferConfig transferConfig = + TransferConfig.newBuilder().setName(configId).setDisabled(true).build(); + FieldMask updateMask = FieldMaskUtil.fromString("disabled"); + disableTransferConfig(transferConfig, updateMask); + } + + public static void disableTransferConfig(TransferConfig transferConfig, FieldMask updateMask) + throws IOException { + try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { + UpdateTransferConfigRequest request = + UpdateTransferConfigRequest.newBuilder() + .setTransferConfig(transferConfig) + .setUpdateMask(updateMask) + .build(); + TransferConfig updateConfig = dataTransferServiceClient.updateTransferConfig(request); + System.out.println("Transfer config disabled successfully :" + updateConfig.getDisplayName()); + } catch (ApiException ex) { + System.out.print("Transfer config was not disabled." + ex.toString()); + } + } +} +// [END bigquerydatatransfer_disable_transfer] diff --git a/samples/snippets/src/test/java/com/example/bigquerydatatransfer/DisableTransferConfigIT.java b/samples/snippets/src/test/java/com/example/bigquerydatatransfer/DisableTransferConfigIT.java new file mode 100644 index 00000000..5934d1e5 --- /dev/null +++ b/samples/snippets/src/test/java/com/example/bigquerydatatransfer/DisableTransferConfigIT.java @@ -0,0 +1,81 @@ +/* + * 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.bigquerydatatransfer; + +import static com.google.common.truth.Truth.assertThat; +import static junit.framework.TestCase.assertNotNull; + +import com.google.cloud.bigquery.datatransfer.v1.TransferConfig; +import com.google.protobuf.FieldMask; +import com.google.protobuf.util.FieldMaskUtil; +import java.io.ByteArrayOutputStream; +import java.io.IOException; +import java.io.PrintStream; +import java.util.logging.Level; +import java.util.logging.Logger; +import org.junit.After; +import org.junit.Before; +import org.junit.BeforeClass; +import org.junit.Test; + +public class DisableTransferConfigIT { + + private static final Logger LOG = Logger.getLogger(DisableTransferConfigIT.class.getName()); + private ByteArrayOutputStream bout; + private PrintStream out; + private PrintStream originalPrintStream; + + private static final String CONFIG_NAME = requireEnvVar("DTS_TRANSFER_CONFIG_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("DTS_TRANSFER_CONFIG_NAME"); + } + + @Before + public void setUp() { + bout = new ByteArrayOutputStream(); + out = new PrintStream(bout); + originalPrintStream = System.out; + System.setOut(out); + } + + @After + public void tearDown() { + // restores print statements in the original method + System.out.flush(); + System.setOut(originalPrintStream); + LOG.log(Level.INFO, bout.toString()); + } + + @Test + public void testDisableTransferConfig() throws IOException { + TransferConfig transferConfig = + TransferConfig.newBuilder().setName(CONFIG_NAME).setDisabled(true).build(); + FieldMask updateMask = FieldMaskUtil.fromString("disabled"); + DisableTransferConfig.disableTransferConfig(transferConfig, updateMask); + assertThat(bout.toString()).contains("Transfer config disabled successfully"); + } +} diff --git a/samples/snippets/src/test/java/com/example/bigquerydatatransfer/UpdateTransferConfigIT.java b/samples/snippets/src/test/java/com/example/bigquerydatatransfer/UpdateTransferConfigIT.java index 320c5ebe..4da497a9 100644 --- a/samples/snippets/src/test/java/com/example/bigquerydatatransfer/UpdateTransferConfigIT.java +++ b/samples/snippets/src/test/java/com/example/bigquerydatatransfer/UpdateTransferConfigIT.java @@ -34,7 +34,7 @@ public class UpdateTransferConfigIT { - private static final Logger LOG = Logger.getLogger(DeleteScheduledQueryIT.class.getName()); + private static final Logger LOG = Logger.getLogger(UpdateTransferConfigIT.class.getName()); private ByteArrayOutputStream bout; private PrintStream out; private PrintStream originalPrintStream;