|
| 1 | +/* |
| 2 | + * Copyright 2026 Google LLC |
| 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 | +package com.google.cloud.bigquery; |
| 17 | + |
| 18 | +import javax.annotation.Nullable; |
| 19 | + |
| 20 | +/** |
| 21 | + * Maps to <a |
| 22 | + * href="https://docs.cloud.google.com/bigquery/docs/reference/rest/v2/JobCreationReason">JobCreationReason</a> |
| 23 | + * when used with {@link |
| 24 | + * com.google.cloud.bigquery.QueryJobConfiguration.JobCreationMode#JOB_CREATION_OPTIONAL}. |
| 25 | + * |
| 26 | + * <p>The code indicates the high level reason why a job was created. The default is `UNKNOWN` if |
| 27 | + * there is no mapping found between the server response and the client library. |
| 28 | + */ |
| 29 | +public class JobCreationReason { |
| 30 | + |
| 31 | + public enum Code { |
| 32 | + REQUESTED("REQUESTED"), |
| 33 | + LONG_RUNNING("LONG_RUNNING"), |
| 34 | + LARGE_RESULTS("LARGE_RESULTS"), |
| 35 | + OTHER("OTHER"), |
| 36 | + UNKNOWN("UNKNOWN"); |
| 37 | + |
| 38 | + private final String reason; |
| 39 | + |
| 40 | + Code(String reason) { |
| 41 | + this.reason = reason; |
| 42 | + } |
| 43 | + |
| 44 | + /** |
| 45 | + * Maps the server code to BQ code. Returns {@link Code#UNKNOWN} if the mapping does not exist. |
| 46 | + */ |
| 47 | + static Code fromValue(@Nullable String reason) { |
| 48 | + for (JobCreationReason.Code code : Code.values()) { |
| 49 | + if (code.reason.equals(reason)) { |
| 50 | + return code; |
| 51 | + } |
| 52 | + } |
| 53 | + return UNKNOWN; |
| 54 | + } |
| 55 | + } |
| 56 | + |
| 57 | + @Nullable private final Code code; |
| 58 | + |
| 59 | + JobCreationReason(Code code) { |
| 60 | + this.code = code; |
| 61 | + } |
| 62 | + |
| 63 | + static JobCreationReason fromPb( |
| 64 | + com.google.api.services.bigquery.model.JobCreationReason jobCreationReason) { |
| 65 | + // JobCreationReason may be null if the JobCreationMode is specified to be Optional |
| 66 | + // Note: JobCreationMode.Optional may also end up creating a job depending on the |
| 67 | + // query complexity and other factors. |
| 68 | + if (jobCreationReason == null) { |
| 69 | + return null; |
| 70 | + } |
| 71 | + return new JobCreationReason(Code.fromValue(jobCreationReason.getCode())); |
| 72 | + } |
| 73 | + |
| 74 | + /** |
| 75 | + * @return JobCreationReason code or {@link Code#UNKNOWN} if mapping does not exist. |
| 76 | + */ |
| 77 | + public Code getCode() { |
| 78 | + return code; |
| 79 | + } |
| 80 | +} |
0 commit comments