|
| 1 | +/* |
| 2 | + * Copyright 2016 Google Inc. All Rights Reserved. |
| 3 | + * |
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | + * you may not use this file except in compliance with the License. |
| 6 | + * You may obtain a copy of the License at |
| 7 | + * |
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | + * |
| 10 | + * Unless required by applicable law or agreed to in writing, software |
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | + * See the License for the specific language governing permissions and |
| 14 | + * limitations under the License. |
| 15 | + */ |
| 16 | + |
| 17 | +/* |
| 18 | + * EDITING INSTRUCTIONS |
| 19 | + * This file is referenced in Job's javadoc. Any change to this file should be reflected in |
| 20 | + * Job's javadoc. |
| 21 | + */ |
| 22 | + |
| 23 | +package com.google.cloud.examples.bigquery.snippets; |
| 24 | + |
| 25 | +import com.google.cloud.WaitForOption; |
| 26 | +import com.google.cloud.bigquery.BigQuery; |
| 27 | +import com.google.cloud.bigquery.Job; |
| 28 | +import com.google.cloud.bigquery.JobStatus; |
| 29 | + |
| 30 | +import java.util.concurrent.TimeUnit; |
| 31 | +import java.util.concurrent.TimeoutException; |
| 32 | + |
| 33 | +public class JobSnippets { |
| 34 | + |
| 35 | + private Job job; |
| 36 | + |
| 37 | + public JobSnippets(Job job) { |
| 38 | + this.job = job; |
| 39 | + } |
| 40 | + |
| 41 | + /** |
| 42 | + * Example of checking that a job exists. |
| 43 | + */ |
| 44 | + // [TARGET exists()] |
| 45 | + public boolean exists() throws InterruptedException { |
| 46 | + // [START exists] |
| 47 | + if (!job.exists()) { |
| 48 | + // job doesn't exist |
| 49 | + } |
| 50 | + // [END exists] |
| 51 | + return job.exists(); |
| 52 | + } |
| 53 | + |
| 54 | + /** |
| 55 | + * Example of waiting for a job until it reports that it is done. |
| 56 | + */ |
| 57 | + // [TARGET isDone()] |
| 58 | + public void isDone() throws InterruptedException { |
| 59 | + // [START isDone] |
| 60 | + while (!job.isDone()) { |
| 61 | + Thread.sleep(1000L); |
| 62 | + } |
| 63 | + // [END isDone] |
| 64 | + } |
| 65 | + |
| 66 | + /** |
| 67 | + * Example usage of {@code waitFor()}. |
| 68 | + */ |
| 69 | + // [TARGET waitFor(WaitForOption...)] |
| 70 | + public boolean waitFor() throws InterruptedException { |
| 71 | + try { |
| 72 | + // [START waitFor] |
| 73 | + Job completedJob = job.waitFor(); |
| 74 | + if (completedJob == null) { |
| 75 | + // job no longer exists |
| 76 | + } else if (completedJob.status().error() != null) { |
| 77 | + // job failed, handle error |
| 78 | + } else { |
| 79 | + // job completed successfully |
| 80 | + } |
| 81 | + // [END waitFor] |
| 82 | + } catch (TimeoutException e) { |
| 83 | + // Timeouts shouldn't happen without a timeout option. |
| 84 | + return false; |
| 85 | + } |
| 86 | + return true; |
| 87 | + } |
| 88 | + |
| 89 | + /** |
| 90 | + * Example usage of {@code waitFor()} with checking period and timeout. |
| 91 | + */ |
| 92 | + // [TARGET waitFor(WaitForOption...)] |
| 93 | + public boolean waitForWithOptions() throws InterruptedException { |
| 94 | + try { |
| 95 | + // [START waitForWithOptions] |
| 96 | + Job completedJob = |
| 97 | + job.waitFor( |
| 98 | + WaitForOption.checkEvery(1, TimeUnit.SECONDS), |
| 99 | + WaitForOption.timeout(60, TimeUnit.SECONDS)); |
| 100 | + if (completedJob == null) { |
| 101 | + // job no longer exists |
| 102 | + } else if (completedJob.status().error() != null) { |
| 103 | + // job failed, handle error |
| 104 | + } else { |
| 105 | + // job completed successfully |
| 106 | + } |
| 107 | + // [END waitForWithOptions] |
| 108 | + } catch (TimeoutException e) { |
| 109 | + return true; |
| 110 | + } |
| 111 | + return true; |
| 112 | + } |
| 113 | + |
| 114 | + /** |
| 115 | + * Example of reloading all fields until job status is DONE. |
| 116 | + */ |
| 117 | + // [TARGET reload(JobOption...)] |
| 118 | + public JobStatus.State reload() throws InterruptedException { |
| 119 | + // [START reload] |
| 120 | + while (job.status().state() != JobStatus.State.DONE) { |
| 121 | + Thread.sleep(1000L); |
| 122 | + job = job.reload(); |
| 123 | + } |
| 124 | + // [END reload] |
| 125 | + return job.status().state(); |
| 126 | + } |
| 127 | + |
| 128 | + /** |
| 129 | + * Example of reloading status field until job status is DONE. |
| 130 | + */ |
| 131 | + // [TARGET reload(JobOption...)] |
| 132 | + public JobStatus.State reloadStatus() throws InterruptedException { |
| 133 | + // [START reloadStatus] |
| 134 | + while (job.status().state() != JobStatus.State.DONE) { |
| 135 | + Thread.sleep(1000L); |
| 136 | + job = job.reload(BigQuery.JobOption.fields(BigQuery.JobField.STATUS)); |
| 137 | + } |
| 138 | + // [END reloadStatus] |
| 139 | + return job.status().state(); |
| 140 | + } |
| 141 | + |
| 142 | + /** |
| 143 | + * Example of cancelling a job. |
| 144 | + */ |
| 145 | + // [TARGET cancel()] |
| 146 | + public boolean cancel() { |
| 147 | + // [START cancel] |
| 148 | + if (job.cancel()) { |
| 149 | + return true; // job successfully cancelled |
| 150 | + } else { |
| 151 | + // job not found |
| 152 | + } |
| 153 | + // [END cancel] |
| 154 | + return false; |
| 155 | + } |
| 156 | +} |
0 commit comments