Skip to content
Permalink
Browse files
docs(samples): add run details (#334)
* docs(samples): add run details

* docs(samples): address feedback

* docs(samples): add envvar
  • Loading branch information
Praful Makani committed Sep 17, 2020
1 parent 2b86803 commit 8824cc55cb3f5cb2ca88f2505e6c580e58cf575a
@@ -0,0 +1,48 @@
/*
* 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_get_run_details]
import com.google.api.gax.rpc.ApiException;
import com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient;
import com.google.cloud.bigquery.datatransfer.v1.GetTransferRunRequest;
import com.google.cloud.bigquery.datatransfer.v1.TransferRun;
import java.io.IOException;

// Sample to get run details from transfer config.
public class RunDetails {

public static void main(String[] args) throws IOException {
// TODO(developer): Replace these variables before running the sample.
// runId examples:
// `projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}` or
// `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}/runs/{run_id}`
String runId = "MY_RUN_ID";
runDetails(runId);
}

public static void runDetails(String runId) throws IOException {
try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) {
GetTransferRunRequest request = GetTransferRunRequest.newBuilder().setName(runId).build();
TransferRun run = dataTransferServiceClient.getTransferRun(request);
System.out.print("Run details retrieved successfully :" + run.getName() + "\n");
} catch (ApiException ex) {
System.out.print("Run details not found." + ex.toString());
}
}
}
// [END bigquerydatatransfer_get_run_details]
@@ -0,0 +1,80 @@
/*
* 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.DataTransferServiceClient;
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 RunDetailsIT {

private static final Logger LOG = Logger.getLogger(GetTransferConfigInfoIT.class.getName());
private ByteArrayOutputStream bout;
private String runName;
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() throws IOException {
bout = new ByteArrayOutputStream();
out = new PrintStream(bout);
originalPrintStream = System.out;
System.setOut(out);
try (DataTransferServiceClient client = DataTransferServiceClient.create()) {
client.listTransferRuns(CONFIG_NAME).iterateAll().forEach(run -> runName = run.getName());
}
}

@After
public void tearDown() throws IOException {
// restores print statements in the original method
System.out.flush();
System.setOut(originalPrintStream);
LOG.log(Level.INFO, bout.toString());
}

@Test
public void testRunDetails() throws IOException {
RunDetails.runDetails(runName);
assertThat(bout.toString()).contains("Run details retrieved successfully :");
}
}

0 comments on commit 8824cc5

Please sign in to comment.