This repository has been archived by the owner on Sep 27, 2023. It is now read-only.
docs(samples): add run details #334
Merged
Merged
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
48 changes: 48 additions & 0 deletions
48
samples/snippets/src/main/java/com/example/bigquerydatatransfer/RunDetails.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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] |
137 changes: 137 additions & 0 deletions
137
samples/snippets/src/test/java/com/example/bigquerydatatransfer/RunDetailsIT.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,137 @@ | ||
/* | ||
* 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.BigQuery; | ||
import com.google.cloud.bigquery.BigQueryOptions; | ||
import com.google.cloud.bigquery.DatasetInfo; | ||
import com.google.cloud.bigquery.datatransfer.v1.CreateTransferConfigRequest; | ||
import com.google.cloud.bigquery.datatransfer.v1.DataTransferServiceClient; | ||
import com.google.cloud.bigquery.datatransfer.v1.ProjectName; | ||
import com.google.cloud.bigquery.datatransfer.v1.TransferConfig; | ||
import com.google.protobuf.Struct; | ||
import com.google.protobuf.Value; | ||
import java.io.ByteArrayOutputStream; | ||
import java.io.IOException; | ||
import java.io.PrintStream; | ||
import java.util.HashMap; | ||
import java.util.Map; | ||
import java.util.UUID; | ||
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 static final String ID = UUID.randomUUID().toString().substring(0, 8); | ||
private BigQuery bigquery; | ||
private ByteArrayOutputStream bout; | ||
private String name; | ||
private String runName; | ||
private String displayName; | ||
private String datasetName; | ||
private PrintStream out; | ||
private PrintStream originalPrintStream; | ||
|
||
private static final String PROJECT_ID = requireEnvVar("GOOGLE_CLOUD_PROJECT"); | ||
|
||
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("GOOGLE_CLOUD_PROJECT"); | ||
} | ||
|
||
@Before | ||
public void setUp() throws IOException { | ||
bout = new ByteArrayOutputStream(); | ||
out = new PrintStream(bout); | ||
originalPrintStream = System.out; | ||
System.setOut(out); | ||
|
||
displayName = "MY_SCHEDULE_NAME_TEST_" + ID; | ||
datasetName = "MY_DATASET_NAME_TEST_" + ID; | ||
// create a temporary dataset | ||
bigquery = BigQueryOptions.getDefaultInstance().getService(); | ||
bigquery.create(DatasetInfo.of(datasetName)); | ||
// create a scheduled query | ||
String query = | ||
"SELECT CURRENT_TIMESTAMP() as current_time, @run_time as intended_run_time, " | ||
+ "@run_date as intended_run_date, 17 as some_integer"; | ||
String destinationTableName = "MY_DESTINATION_TABLE_" + ID + "_{run_date}"; | ||
Map<String, Value> params = new HashMap<>(); | ||
params.put("query", Value.newBuilder().setStringValue(query).build()); | ||
params.put( | ||
"destination_table_name_template", | ||
Value.newBuilder().setStringValue(destinationTableName).build()); | ||
params.put("write_disposition", Value.newBuilder().setStringValue("WRITE_TRUNCATE").build()); | ||
params.put("partitioning_field", Value.newBuilder().setStringValue("").build()); | ||
TransferConfig transferConfig = | ||
TransferConfig.newBuilder() | ||
.setDestinationDatasetId(datasetName) | ||
.setDisplayName(displayName) | ||
.setDataSourceId("scheduled_query") | ||
.setParams(Struct.newBuilder().putAllFields(params).build()) | ||
.setSchedule("every 24 hours") | ||
.build(); | ||
try (DataTransferServiceClient dataTransferServiceClient = DataTransferServiceClient.create()) { | ||
ProjectName parent = ProjectName.of(PROJECT_ID); | ||
CreateTransferConfigRequest request = | ||
CreateTransferConfigRequest.newBuilder() | ||
.setParent(parent.toString()) | ||
.setTransferConfig(transferConfig) | ||
.build(); | ||
name = dataTransferServiceClient.createTransferConfig(request).getName(); | ||
System.out.println("Scheduled query created successfully :" + name); | ||
} | ||
try (DataTransferServiceClient client = DataTransferServiceClient.create()) { | ||
client.listTransferRuns(name).iterateAll().forEach(run -> runName = run.getName()); | ||
} | ||
} | ||
|
||
@After | ||
public void tearDown() throws IOException { | ||
// delete scheduled query that was just created | ||
DeleteScheduledQuery.deleteScheduledQuery(name); | ||
// delete a temporary dataset | ||
bigquery.delete(datasetName, BigQuery.DatasetDeleteOption.deleteContents()); | ||
|
||
// 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 :"); | ||
} | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, but we prefer (Sample Format guide) that exceptions not be caught if you aren't going to actually do something with them.