docs(samples): add schedule backfill (#390)

Author: Praful Makani

samples/snippets/src/main/java/com/example/bigquerydatatransfer/ScheduleBackFill.java

@@ -0,0 +1,78 @@
+/*
+ * 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_schedule_backfill]
+import com.google.api.gax.rpc.ApiException;
+import com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient;
+import com.google.cloud.bigquery.datatransfer.v1.ScheduleOptions;
+import com.google.cloud.bigquery.datatransfer.v1.TransferConfig;
+import com.google.cloud.bigquery.datatransfer.v1.UpdateTransferConfigRequest;
+import com.google.common.collect.ImmutableList;
+import com.google.protobuf.FieldMask;
+import com.google.protobuf.Timestamp;
+import com.google.protobuf.util.FieldMaskUtil;
+import java.io.IOException;
+import org.threeten.bp.Clock;
+import org.threeten.bp.Instant;
+import org.threeten.bp.temporal.ChronoUnit;
+
+// Sample to update schedule back fill for transfer config
+public class ScheduleBackFill {
+
+  public static void main(String[] args) throws IOException {
+    // TODO(developer): Replace these variables before running the sample.
+    String configId = "MY_CONFIG_ID";
+    Clock clock = Clock.systemDefaultZone();
+    Instant instant = clock.instant();
+    Timestamp startDate =
+        Timestamp.newBuilder()
+            .setSeconds(instant.getEpochSecond())
+            .setNanos(instant.getNano())
+            .build();
+    Timestamp endDate =
+        Timestamp.newBuilder()
+            .setSeconds(instant.plus(10, ChronoUnit.DAYS).getEpochSecond())
+            .setNanos(instant.plus(10, ChronoUnit.DAYS).getNano())
+            .build();
+    TransferConfig transferConfig =
+        TransferConfig.newBuilder()
+            .setName(configId)
+            .setScheduleOptions(
+                ScheduleOptions.newBuilder().setStartTime(startDate).setEndTime(endDate).build())
+            .build();
+    FieldMask updateMask = FieldMaskUtil.fromStringList(ImmutableList.of("start_time", "end_time"));
+    scheduleBackFill(transferConfig, updateMask);
+  }
+
+  public static void scheduleBackFill(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(
+          "Schedule backfill updated successfully :" + updateConfig.getDisplayName());
+    } catch (ApiException ex) {
+      System.out.print("Schedule backfill was not updated." + ex.toString());
+    }
+  }
+}
+// [END bigquerydatatransfer_schedule_backfill]

samples/snippets/src/test/java/com/example/bigquerydatatransfer/ScheduleBackFillIT.java

@@ -0,0 +1,103 @@
+/*
+ * 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.ScheduleOptions;
+import com.google.cloud.bigquery.datatransfer.v1.TransferConfig;
+import com.google.common.collect.ImmutableList;
+import com.google.protobuf.FieldMask;
+import com.google.protobuf.Timestamp;
+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;
+import org.threeten.bp.Clock;
+import org.threeten.bp.Instant;
+import org.threeten.bp.temporal.ChronoUnit;
+
+public class ScheduleBackFillIT {
+
+  private static final Logger LOG = Logger.getLogger(ScheduleBackFillIT.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 testScheduleBackFill() throws IOException {
+    Clock clock = Clock.systemDefaultZone();
+    Instant instant = clock.instant();
+    Timestamp startDate =
+        Timestamp.newBuilder()
+            .setSeconds(instant.getEpochSecond())
+            .setNanos(instant.getNano())
+            .build();
+    Timestamp endDate =
+        Timestamp.newBuilder()
+            .setSeconds(instant.plus(10, ChronoUnit.DAYS).getEpochSecond())
+            .setNanos(instant.plus(10, ChronoUnit.DAYS).getNano())
+            .build();
+    TransferConfig transferConfig =
+        TransferConfig.newBuilder()
+            .setName(CONFIG_NAME)
+            .setScheduleOptions(
+                ScheduleOptions.newBuilder().setStartTime(startDate).setEndTime(endDate).build())
+            .build();
+    FieldMask updateMask = FieldMaskUtil.fromStringList(ImmutableList.of("start_time", "end_time"));
+    ScheduleBackFill.scheduleBackFill(transferConfig, updateMask);
+    assertThat(bout.toString()).contains("Schedule backfill updated successfully :");
+  }
+}