Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b6971b0405ba59d905b84fa5fc8e27e12d29b70c / . / docs / dyn / bigquery_v2.jobs.html
blob: 66a790984424713968e5610a479b2de9e2d6c995 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="bigquery_v2.html">BigQuery API</a> . <a href="bigquery_v2.jobs.html">jobs</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]78 <code><a href="#cancel">cancel(projectId, jobId, location=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]79<p class="firstline">Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]80<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]81 <code><a href="#close">close()</a></code></p>
82<p class="firstline">Close httplib2 connections.</p>
83<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]84 <code><a href="#get">get(projectId, jobId, location=None)</a></code></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]85<p class="firstline">Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]86<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]87 <code><a href="#getQueryResults">getQueryResults(projectId, jobId, maxResults=None, startIndex=None, pageToken=None, location=None, timeoutMs=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]88<p class="firstline">Retrieves the results of a query job.</p>
89<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]90 <code><a href="#getQueryResults_next">getQueryResults_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]93 <code><a href="#insert">insert(projectId, body=None, media_body=None, media_mime_type=None)</a></code></p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]94<p class="firstline">Starts a new asynchronous job. Requires the Can View project role.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]95<p class="toc_element">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]96 <code><a href="#list">list(projectId, minCreationTime=None, pageToken=None, maxCreationTime=None, parentJobId=None, allUsers=None, projection=None, stateFilter=None, maxResults=None)</a></code></p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]97<p class="firstline">Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]102 <code><a href="#query">query(projectId, body=None)</a></code></p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]103<p class="firstline">Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.</p>
104<h3>Method Details</h3>
105<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106 <code class="details" id="cancel">cancel(projectId, jobId, location=None)</code>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]107 <pre>Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]108
109Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]110 projectId: string, [Required] Project ID of the job to cancel (required)
111 jobId: string, [Required] Job ID of the job to cancel (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]112 location: string, The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]113
114Returns:
115 An object of the form:
116
117 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]118 &quot;kind&quot;: &quot;bigquery#jobCancelResponse&quot;, # The resource type of the response.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]119 &quot;job&quot;: { # The final state of the job.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]120 &quot;id&quot;: &quot;A String&quot;, # [Output-only] Opaque ID field of the job
121 &quot;selfLink&quot;: &quot;A String&quot;, # [Output-only] A URL that can be used to access this resource again.
122 &quot;kind&quot;: &quot;bigquery#job&quot;, # [Output-only] The type of the resource.
123 &quot;etag&quot;: &quot;A String&quot;, # [Output-only] A hash of this resource.
124 &quot;status&quot;: { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
125 &quot;state&quot;: &quot;A String&quot;, # [Output-only] Running state of the job.
126 &quot;errors&quot;: [ # [Output-only] The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
127 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]128 &quot;reason&quot;: &quot;A String&quot;, # A short error code that summarizes the error.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]129 &quot;debugInfo&quot;: &quot;A String&quot;, # Debugging information. This property is internal to Google and should not be used.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]130 &quot;location&quot;: &quot;A String&quot;, # Specifies where the error occurred, if present.
131 &quot;message&quot;: &quot;A String&quot;, # A human-readable description of the error.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]132 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]133 ],
134 &quot;errorResult&quot;: { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
135 &quot;reason&quot;: &quot;A String&quot;, # A short error code that summarizes the error.
136 &quot;debugInfo&quot;: &quot;A String&quot;, # Debugging information. This property is internal to Google and should not be used.
137 &quot;location&quot;: &quot;A String&quot;, # Specifies where the error occurred, if present.
138 &quot;message&quot;: &quot;A String&quot;, # A human-readable description of the error.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]139 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]140 },
141 &quot;statistics&quot;: { # [Output-only] Information about the job, including starting time and ending time of the job.
142 &quot;startTime&quot;: &quot;A String&quot;, # [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
143 &quot;completionRatio&quot;: 3.14, # [TrustedTester] [Output-only] Job progress (0.0 -&gt; 1.0) for LOAD and EXTRACT jobs.
144 &quot;rowLevelSecurityStatistics&quot;: { # [Output-only] [Preview] Statistics for row-level security. Present only for query and extract jobs.
145 &quot;rowLevelSecurityApplied&quot;: True or False, # [Output-only] [Preview] Whether any accessed data was protected by row access policies.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]146 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]147 &quot;numChildJobs&quot;: &quot;A String&quot;, # [Output-only] Number of child jobs executed.
148 &quot;extract&quot;: { # [Output-only] Statistics for an extract job.
149 &quot;inputBytes&quot;: &quot;A String&quot;, # [Output-only] Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.
150 &quot;destinationUriFileCounts&quot;: [ # [Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the &#x27;destinationUris&#x27; field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]151 &quot;A String&quot;,
152 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]153 },
154 &quot;transactionInfoTemplate&quot;: { # [Output-only] [Alpha] Information of the multi-statement transaction if this job is part of one.
155 &quot;transactionId&quot;: &quot;A String&quot;, # [Output-only] // [Alpha] Id of the transaction.
156 },
157 &quot;reservationUsage&quot;: [ # [Output-only] Job resource usage breakdown by reservation.
158 {
159 &quot;slotMs&quot;: &quot;A String&quot;, # [Output-only] Slot-milliseconds the job spent in the given reservation.
160 &quot;name&quot;: &quot;A String&quot;, # [Output-only] Reservation name or &quot;unreserved&quot; for on-demand resources usage.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]161 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]162 ],
163 &quot;creationTime&quot;: &quot;A String&quot;, # [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
164 &quot;totalBytesProcessed&quot;: &quot;A String&quot;, # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
165 &quot;reservation_id&quot;: &quot;A String&quot;, # [Output-only] Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.
166 &quot;endTime&quot;: &quot;A String&quot;, # [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
167 &quot;query&quot;: { # [Output-only] Statistics for a query job.
168 &quot;undeclaredQueryParameters&quot;: [ # Standard SQL only: list of undeclared query parameters detected during a dry run validation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]169 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]170 &quot;parameterValue&quot;: { # [Required] The value of this parameter.
171 &quot;arrayValues&quot;: [ # [Optional] The array values, if this is an array type.
172 # Object with schema name: QueryParameterValue
173 ],
174 &quot;value&quot;: &quot;A String&quot;, # [Optional] The value of this value, if a simple scalar type.
175 &quot;structValues&quot;: { # [Optional] The struct field values, in order of the struct type&#x27;s declaration.
176 &quot;a_key&quot;: # Object with schema name: QueryParameterValue
177 },
178 },
179 &quot;name&quot;: &quot;A String&quot;, # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
180 &quot;parameterType&quot;: { # [Required] The type of this parameter.
181 &quot;arrayType&quot;: # Object with schema name: QueryParameterType # [Optional] The type of the array&#x27;s elements, if this is an array.
182 &quot;structTypes&quot;: [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
183 {
184 &quot;type&quot;: # Object with schema name: QueryParameterType # [Required] The type of this field.
185 &quot;description&quot;: &quot;A String&quot;, # [Optional] Human-oriented description of the field.
186 &quot;name&quot;: &quot;A String&quot;, # [Optional] The name of this field.
187 },
188 ],
189 &quot;type&quot;: &quot;A String&quot;, # [Required] The top level type of this field.
190 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]191 },
192 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]193 &quot;ddlOperationPerformed&quot;: &quot;A String&quot;, # The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): &quot;CREATE&quot;: The query created the DDL target. &quot;SKIP&quot;: No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. &quot;REPLACE&quot;: The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. &quot;DROP&quot;: The query deleted the DDL target.
194 &quot;schema&quot;: { # [Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
195 &quot;fields&quot;: [ # Describes the fields in a table.
196 {
197 &quot;type&quot;: &quot;A String&quot;, # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
198 &quot;categories&quot;: { # [Optional] The categories attached to this field, used for field-level access control.
199 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/taxonomies/2/categories/3&quot;. At most 5 categories are allowed.
200 &quot;A String&quot;,
201 ],
202 },
203 &quot;fields&quot;: [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
204 # Object with schema name: TableFieldSchema
205 ],
206 &quot;name&quot;: &quot;A String&quot;, # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
207 &quot;description&quot;: &quot;A String&quot;, # [Optional] The field description. The maximum length is 1,024 characters.
208 &quot;policyTags&quot;: {
209 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/location/eu/taxonomies/2/policyTags/3&quot;. At most 1 policy tag is allowed.
210 &quot;A String&quot;,
211 ],
212 },
213 &quot;mode&quot;: &quot;A String&quot;, # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
214 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]215 ],
216 },
217 &quot;totalSlotMs&quot;: &quot;A String&quot;, # [Output-only] Slot-milliseconds for the job.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]218 &quot;modelTrainingCurrentIteration&quot;: 42, # [Output-only, Beta] Deprecated; do not use.
219 &quot;billingTier&quot;: 42, # [Output-only] Billing tier for the job.
220 &quot;estimatedBytesProcessed&quot;: &quot;A String&quot;, # [Output-only] The original estimate of bytes processed for the job.
221 &quot;totalBytesProcessed&quot;: &quot;A String&quot;, # [Output-only] Total bytes processed for the job.
222 &quot;statementType&quot;: &quot;A String&quot;, # The type of query statement, if valid. Possible values (new values might be added in the future): &quot;SELECT&quot;: SELECT query. &quot;INSERT&quot;: INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. &quot;UPDATE&quot;: UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. &quot;DELETE&quot;: DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. &quot;MERGE&quot;: MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. &quot;ALTER_TABLE&quot;: ALTER TABLE query. &quot;ALTER_VIEW&quot;: ALTER VIEW query. &quot;ASSERT&quot;: ASSERT condition AS &#x27;description&#x27;. &quot;CREATE_FUNCTION&quot;: CREATE FUNCTION query. &quot;CREATE_MODEL&quot;: CREATE [OR REPLACE] MODEL ... AS SELECT ... . &quot;CREATE_PROCEDURE&quot;: CREATE PROCEDURE query. &quot;CREATE_TABLE&quot;: CREATE [OR REPLACE] TABLE without AS SELECT. &quot;CREATE_TABLE_AS_SELECT&quot;: CREATE [OR REPLACE] TABLE ... AS SELECT ... . &quot;CREATE_VIEW&quot;: CREATE [OR REPLACE] VIEW ... AS SELECT ... . &quot;DROP_FUNCTION&quot; : DROP FUNCTION query. &quot;DROP_PROCEDURE&quot;: DROP PROCEDURE query. &quot;DROP_TABLE&quot;: DROP TABLE query. &quot;DROP_VIEW&quot;: DROP VIEW query.
223 &quot;ddlAffectedRowAccessPolicyCount&quot;: &quot;A String&quot;, # [Output-only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
224 &quot;referencedTables&quot;: [ # [Output-only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
225 {
226 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
227 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
228 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
229 },
230 ],
231 &quot;totalPartitionsProcessed&quot;: &quot;A String&quot;, # [Output-only] Total number of partitions processed from all partitioned tables referenced in the job.
232 &quot;ddlTargetTable&quot;: { # [Output-only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
233 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
234 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
235 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]236 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]237 &quot;referencedRoutines&quot;: [ # [Output-only] Referenced routines (persistent user-defined functions and stored procedures) for the job.
238 {
239 &quot;routineId&quot;: &quot;A String&quot;, # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
240 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this routine.
241 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this routine.
242 },
243 ],
244 &quot;timeline&quot;: [ # [Output-only] [Beta] Describes a timeline of job execution.
245 {
246 &quot;activeUnits&quot;: &quot;A String&quot;, # Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
247 &quot;completedUnits&quot;: &quot;A String&quot;, # Total parallel units of work completed by this query.
248 &quot;pendingUnits&quot;: &quot;A String&quot;, # Total parallel units of work remaining for the active stages.
249 &quot;totalSlotMs&quot;: &quot;A String&quot;, # Cumulative slot-ms consumed by the query.
250 &quot;elapsedMs&quot;: &quot;A String&quot;, # Milliseconds elapsed since the start of query execution.
251 },
252 ],
253 &quot;totalBytesBilled&quot;: &quot;A String&quot;, # [Output-only] Total bytes billed for the job.
254 &quot;modelTraining&quot;: { # [Output-only, Beta] Information about create model query job progress.
255 &quot;expectedTotalIterations&quot;: &quot;A String&quot;, # [Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.
256 &quot;currentIteration&quot;: 42, # [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]257 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]258 &quot;numDmlAffectedRows&quot;: &quot;A String&quot;, # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
259 &quot;queryPlan&quot;: [ # [Output-only] Describes execution plan for the query.
260 {
261 &quot;computeRatioAvg&quot;: 3.14, # Relative amount of time the average shard spent on CPU-bound tasks.
262 &quot;waitMsMax&quot;: &quot;A String&quot;, # Milliseconds the slowest shard spent waiting to be scheduled.
263 &quot;shuffleOutputBytes&quot;: &quot;A String&quot;, # Total number of bytes written to shuffle.
264 &quot;computeMsAvg&quot;: &quot;A String&quot;, # Milliseconds the average shard spent on CPU-bound tasks.
265 &quot;writeMsMax&quot;: &quot;A String&quot;, # Milliseconds the slowest shard spent on writing output.
266 &quot;waitMsAvg&quot;: &quot;A String&quot;, # Milliseconds the average shard spent waiting to be scheduled.
267 &quot;computeRatioMax&quot;: 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks.
268 &quot;writeMsAvg&quot;: &quot;A String&quot;, # Milliseconds the average shard spent on writing output.
269 &quot;slotMs&quot;: &quot;A String&quot;, # Slot-milliseconds used by the stage.
270 &quot;readMsAvg&quot;: &quot;A String&quot;, # Milliseconds the average shard spent reading input.
271 &quot;waitRatioMax&quot;: 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled.
272 &quot;shuffleOutputBytesSpilled&quot;: &quot;A String&quot;, # Total number of bytes written to shuffle and spilled to disk.
273 &quot;startMs&quot;: &quot;A String&quot;, # Stage start time represented as milliseconds since epoch.
274 &quot;completedParallelInputs&quot;: &quot;A String&quot;, # Number of parallel input segments completed.
275 &quot;recordsRead&quot;: &quot;A String&quot;, # Number of records read into the stage.
276 &quot;inputStages&quot;: [ # IDs for stages that are inputs to this stage.
277 &quot;A String&quot;,
278 ],
279 &quot;computeMsMax&quot;: &quot;A String&quot;, # Milliseconds the slowest shard spent on CPU-bound tasks.
280 &quot;id&quot;: &quot;A String&quot;, # Unique ID for stage within plan.
281 &quot;readRatioMax&quot;: 3.14, # Relative amount of time the slowest shard spent reading input.
282 &quot;writeRatioMax&quot;: 3.14, # Relative amount of time the slowest shard spent on writing output.
283 &quot;readMsMax&quot;: &quot;A String&quot;, # Milliseconds the slowest shard spent reading input.
284 &quot;readRatioAvg&quot;: 3.14, # Relative amount of time the average shard spent reading input.
285 &quot;status&quot;: &quot;A String&quot;, # Current status for the stage.
286 &quot;waitRatioAvg&quot;: 3.14, # Relative amount of time the average shard spent waiting to be scheduled.
287 &quot;name&quot;: &quot;A String&quot;, # Human-readable name for stage.
288 &quot;endMs&quot;: &quot;A String&quot;, # Stage end time represented as milliseconds since epoch.
289 &quot;parallelInputs&quot;: &quot;A String&quot;, # Number of parallel input segments to be processed.
290 &quot;recordsWritten&quot;: &quot;A String&quot;, # Number of records written by the stage.
291 &quot;steps&quot;: [ # List of operations within the stage in dependency order (approximately chronological).
292 {
293 &quot;kind&quot;: &quot;A String&quot;, # Machine-readable operation type.
294 &quot;substeps&quot;: [ # Human-readable stage descriptions.
295 &quot;A String&quot;,
296 ],
297 },
298 ],
299 &quot;writeRatioAvg&quot;: 3.14, # Relative amount of time the average shard spent on writing output.
300 },
301 ],
302 &quot;totalBytesProcessedAccuracy&quot;: &quot;A String&quot;, # [Output-only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
303 &quot;cacheHit&quot;: True or False, # [Output-only] Whether the query result was fetched from the query cache.
304 &quot;modelTrainingExpectedTotalIteration&quot;: &quot;A String&quot;, # [Output-only, Beta] Deprecated; do not use.
305 &quot;ddlTargetRowAccessPolicy&quot;: { # [Output-only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
306 &quot;policyId&quot;: &quot;A String&quot;, # [Required] The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
307 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this row access policy.
308 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table containing this row access policy.
309 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this row access policy.
310 },
311 &quot;reservationUsage&quot;: [ # [Output-only] Job resource usage breakdown by reservation.
312 {
313 &quot;slotMs&quot;: &quot;A String&quot;, # [Output-only] Slot-milliseconds the job spent in the given reservation.
314 &quot;name&quot;: &quot;A String&quot;, # [Output-only] Reservation name or &quot;unreserved&quot; for on-demand resources usage.
315 },
316 ],
317 &quot;ddlTargetRoutine&quot;: { # The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
318 &quot;routineId&quot;: &quot;A String&quot;, # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
319 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this routine.
320 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this routine.
321 },
322 },
323 &quot;quotaDeferments&quot;: [ # [Output-only] Quotas which delayed this job&#x27;s start time.
324 &quot;A String&quot;,
325 ],
326 &quot;scriptStatistics&quot;: { # [Output-only] Statistics for a child job of a script.
327 &quot;stackFrames&quot;: [ # Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty.
328 {
329 &quot;procedureId&quot;: &quot;A String&quot;, # [Output-only] Name of the active procedure, empty if in a top-level script.
330 &quot;startColumn&quot;: 42, # [Output-only] One-based start column.
331 &quot;startLine&quot;: 42, # [Output-only] One-based start line.
332 &quot;endColumn&quot;: 42, # [Output-only] One-based end column.
333 &quot;endLine&quot;: 42, # [Output-only] One-based end line.
334 &quot;text&quot;: &quot;A String&quot;, # [Output-only] Text of the current statement/expression.
335 },
336 ],
337 &quot;evaluationKind&quot;: &quot;A String&quot;, # [Output-only] Whether this child job was a statement or expression.
338 },
339 &quot;parentJobId&quot;: &quot;A String&quot;, # [Output-only] If this is a child job, the id of the parent.
340 &quot;totalSlotMs&quot;: &quot;A String&quot;, # [Output-only] Slot-milliseconds for the job.
341 &quot;load&quot;: { # [Output-only] Statistics for a load job.
342 &quot;outputRows&quot;: &quot;A String&quot;, # [Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
343 &quot;inputFileBytes&quot;: &quot;A String&quot;, # [Output-only] Number of bytes of source data in a load job.
344 &quot;badRecords&quot;: &quot;A String&quot;, # [Output-only] The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.
345 &quot;outputBytes&quot;: &quot;A String&quot;, # [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
346 &quot;inputFiles&quot;: &quot;A String&quot;, # [Output-only] Number of source files in a load job.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]347 },
348 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]349 &quot;user_email&quot;: &quot;A String&quot;, # [Output-only] Email address of the user who ran the job.
350 &quot;jobReference&quot;: { # [Optional] Reference describing the unique-per-user name of the job.
351 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this job.
352 &quot;location&quot;: &quot;A String&quot;, # The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
353 &quot;jobId&quot;: &quot;A String&quot;, # [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
354 },
355 &quot;configuration&quot;: { # [Required] Describes the job configuration.
356 &quot;extract&quot;: { # [Pick one] Configures an extract job.
357 &quot;compression&quot;: &quot;A String&quot;, # [Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
358 &quot;destinationUris&quot;: [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
359 &quot;A String&quot;,
360 ],
361 &quot;useAvroLogicalTypes&quot;: True or False, # [Optional] If destinationFormat is set to &quot;AVRO&quot;, this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
362 &quot;destinationFormat&quot;: &quot;A String&quot;, # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
363 &quot;sourceTable&quot;: { # A reference to the table being exported.
364 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
365 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
366 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
367 },
368 &quot;destinationUri&quot;: &quot;A String&quot;, # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
369 &quot;fieldDelimiter&quot;: &quot;A String&quot;, # [Optional] Delimiter to use between fields in the exported data. Default is &#x27;,&#x27;. Not applicable when extracting models.
370 &quot;printHeader&quot;: true, # [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
371 &quot;sourceModel&quot;: { # A reference to the model being exported.
372 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this model.
373 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this model.
374 &quot;modelId&quot;: &quot;A String&quot;, # [Required] The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
375 },
376 },
377 &quot;dryRun&quot;: True or False, # [Optional] If set, don&#x27;t actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn&#x27;t a dry run. Behavior of non-query jobs is undefined.
378 &quot;load&quot;: { # [Pick one] Configures a load job.
379 &quot;allowQuotedNewlines&quot;: True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
380 &quot;schema&quot;: { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you&#x27;re loading data from Google Cloud Datastore.
381 &quot;fields&quot;: [ # Describes the fields in a table.
382 {
383 &quot;type&quot;: &quot;A String&quot;, # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
384 &quot;categories&quot;: { # [Optional] The categories attached to this field, used for field-level access control.
385 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/taxonomies/2/categories/3&quot;. At most 5 categories are allowed.
386 &quot;A String&quot;,
387 ],
388 },
389 &quot;fields&quot;: [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
390 # Object with schema name: TableFieldSchema
391 ],
392 &quot;name&quot;: &quot;A String&quot;, # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
393 &quot;description&quot;: &quot;A String&quot;, # [Optional] The field description. The maximum length is 1,024 characters.
394 &quot;policyTags&quot;: {
395 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/location/eu/taxonomies/2/policyTags/3&quot;. At most 1 policy tag is allowed.
396 &quot;A String&quot;,
397 ],
398 },
399 &quot;mode&quot;: &quot;A String&quot;, # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
400 },
401 ],
402 },
403 &quot;decimalTargetTypes&quot;: [ # [Trusted Tester] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. For example: suppose decimal_target_type = [&quot;NUMERIC&quot;, &quot;BIGNUMERIC&quot;]. Then if (precision,scale) is: * (38,9) -&gt; NUMERIC; * (39,9) -&gt; BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -&gt; BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -&gt; BIGNUMERIC; * (77,38) -&gt; BIGNUMERIC (error if value exeeds supported range). For duplicated types in this field, only one will be considered and the rest will be ignored. The order of the types in this field is ignored. For example, [&quot;BIGNUMERIC&quot;, &quot;NUMERIC&quot;] is the same as [&quot;NUMERIC&quot;, &quot;BIGNUMERIC&quot;] and NUMERIC always takes precedence over BIGNUMERIC.
404 &quot;A String&quot;,
405 ],
406 &quot;skipLeadingRows&quot;: 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
407 &quot;timePartitioning&quot;: { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
408 &quot;requirePartitionFilter&quot;: True or False,
409 &quot;type&quot;: &quot;A String&quot;, # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.
410 &quot;expirationMs&quot;: &quot;A String&quot;, # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
411 &quot;field&quot;: &quot;A String&quot;, # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either &#x27;_PARTITIONTIME&#x27; as TIMESTAMP type, or &#x27;_PARTITIONDATE&#x27; as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
412 },
413 &quot;destinationEncryptionConfiguration&quot;: { # Custom encryption configuration (e.g., Cloud KMS keys).
414 &quot;kmsKeyName&quot;: &quot;A String&quot;, # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
415 },
416 &quot;schemaUpdateOptions&quot;: [ # Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
417 &quot;A String&quot;,
418 ],
419 &quot;destinationTable&quot;: { # [Required] The destination table to load the data into.
420 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
421 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
422 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
423 },
424 &quot;schemaInline&quot;: &quot;A String&quot;, # [Deprecated] The inline schema. For CSV schemas, specify as &quot;Field1:Type1[,Field2:Type2]*&quot;. For example, &quot;foo:STRING, bar:INTEGER, baz:FLOAT&quot;.
425 &quot;projectionFields&quot;: [ # If sourceFormat is set to &quot;DATASTORE_BACKUP&quot;, indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn&#x27;t found in the Cloud Datastore backup, an invalid error is returned in the job result.
426 &quot;A String&quot;,
427 ],
428 &quot;maxBadRecords&quot;: 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
429 &quot;allowJaggedRows&quot;: True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
430 &quot;schemaInlineFormat&quot;: &quot;A String&quot;, # [Deprecated] The format of the schemaInline property.
431 &quot;autodetect&quot;: True or False, # [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
432 &quot;encoding&quot;: &quot;A String&quot;, # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
433 &quot;destinationTableProperties&quot;: { # [Beta] [Optional] Properties with which to create the destination table if it is new.
434 &quot;labels&quot;: { # [Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
435 &quot;a_key&quot;: &quot;A String&quot;,
436 },
437 &quot;description&quot;: &quot;A String&quot;, # [Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
438 &quot;friendlyName&quot;: &quot;A String&quot;, # [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
439 },
440 &quot;createDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a &#x27;notFound&#x27; error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
441 &quot;sourceUris&quot;: [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one &#x27;*&#x27; wildcard character and it must come after the &#x27;bucket&#x27; name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the &#x27;*&#x27; wildcard character is not allowed.
442 &quot;A String&quot;,
443 ],
444 &quot;rangePartitioning&quot;: { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
445 &quot;field&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
446 &quot;range&quot;: { # [TrustedTester] [Required] Defines the ranges for range partitioning.
447 &quot;interval&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The width of each interval.
448 &quot;end&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The end of range partitioning, exclusive.
449 &quot;start&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The start of range partitioning, inclusive.
450 },
451 },
452 &quot;useAvroLogicalTypes&quot;: True or False, # [Optional] If sourceFormat is set to &quot;AVRO&quot;, indicates whether to enable interpreting logical types into their corresponding types (ie. TIMESTAMP), instead of only using their raw types (ie. INTEGER).
453 &quot;ignoreUnknownValues&quot;: True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don&#x27;t match any column names
454 &quot;sourceFormat&quot;: &quot;A String&quot;, # [Optional] The format of the data files. For CSV files, specify &quot;CSV&quot;. For datastore backups, specify &quot;DATASTORE_BACKUP&quot;. For newline-delimited JSON, specify &quot;NEWLINE_DELIMITED_JSON&quot;. For Avro, specify &quot;AVRO&quot;. For parquet, specify &quot;PARQUET&quot;. For orc, specify &quot;ORC&quot;. The default value is CSV.
455 &quot;fieldDelimiter&quot;: &quot;A String&quot;, # [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence &quot;\t&quot; to specify a tab separator. The default value is a comma (&#x27;,&#x27;).
456 &quot;clustering&quot;: { # [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
457 &quot;fields&quot;: [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
458 &quot;A String&quot;,
459 ],
460 },
461 &quot;nullMarker&quot;: &quot;A String&quot;, # [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify &quot;\N&quot;, BigQuery interprets &quot;\N&quot; as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
462 &quot;quote&quot;: &quot;&quot;&quot;, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote (&#x27;&quot;&#x27;). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
463 &quot;hivePartitioningOptions&quot;: { # [Optional, Trusted Tester] Options to configure hive partitioning support.
464 &quot;requirePartitionFilter&quot;: True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
465 &quot;mode&quot;: &quot;A String&quot;, # [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
466 &quot;sourceUriPrefix&quot;: &quot;A String&quot;, # [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
467 },
468 &quot;writeDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a &#x27;duplicate&#x27; error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
469 },
470 &quot;jobType&quot;: &quot;A String&quot;, # [Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
471 &quot;query&quot;: { # [Pick one] Configures a query job.
472 &quot;query&quot;: &quot;A String&quot;, # [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.
473 &quot;flattenResults&quot;: true, # [Optional] If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened.
474 &quot;rangePartitioning&quot;: { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
475 &quot;field&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
476 &quot;range&quot;: { # [TrustedTester] [Required] Defines the ranges for range partitioning.
477 &quot;interval&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The width of each interval.
478 &quot;end&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The end of range partitioning, exclusive.
479 &quot;start&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The start of range partitioning, inclusive.
480 },
481 },
482 &quot;maximumBillingTier&quot;: 1, # [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.
483 &quot;priority&quot;: &quot;A String&quot;, # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
484 &quot;destinationTable&quot;: { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size.
485 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
486 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
487 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
488 },
489 &quot;tableDefinitions&quot;: { # [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
490 &quot;a_key&quot;: {
491 &quot;hivePartitioningOptions&quot;: { # [Optional, Trusted Tester] Options to configure hive partitioning support.
492 &quot;requirePartitionFilter&quot;: True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
493 &quot;mode&quot;: &quot;A String&quot;, # [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
494 &quot;sourceUriPrefix&quot;: &quot;A String&quot;, # [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
495 },
496 &quot;schema&quot;: { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
497 &quot;fields&quot;: [ # Describes the fields in a table.
498 {
499 &quot;type&quot;: &quot;A String&quot;, # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
500 &quot;categories&quot;: { # [Optional] The categories attached to this field, used for field-level access control.
501 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/taxonomies/2/categories/3&quot;. At most 5 categories are allowed.
502 &quot;A String&quot;,
503 ],
504 },
505 &quot;fields&quot;: [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
506 # Object with schema name: TableFieldSchema
507 ],
508 &quot;name&quot;: &quot;A String&quot;, # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
509 &quot;description&quot;: &quot;A String&quot;, # [Optional] The field description. The maximum length is 1,024 characters.
510 &quot;policyTags&quot;: {
511 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/location/eu/taxonomies/2/policyTags/3&quot;. At most 1 policy tag is allowed.
512 &quot;A String&quot;,
513 ],
514 },
515 &quot;mode&quot;: &quot;A String&quot;, # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
516 },
517 ],
518 },
519 &quot;maxBadRecords&quot;: 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
520 &quot;bigtableOptions&quot;: { # [Optional] Additional options if sourceFormat is set to BIGTABLE.
521 &quot;readRowkeyAsString&quot;: True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
522 &quot;ignoreUnspecifiedColumnFamilies&quot;: True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
523 &quot;columnFamilies&quot;: [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the &#x27;type&#x27; field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
524 {
525 &quot;encoding&quot;: &quot;A String&quot;, # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in &#x27;columns&#x27; and specifying an encoding for it.
526 &quot;onlyReadLatest&quot;: True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in &#x27;columns&#x27; and specifying a different setting for that column.
527 &quot;familyId&quot;: &quot;A String&quot;, # Identifier of the column family.
528 &quot;columns&quot;: [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.
529 {
530 &quot;fieldName&quot;: &quot;A String&quot;, # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
531 &quot;encoding&quot;: &quot;A String&quot;, # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. &#x27;encoding&#x27; can also be set at the column family level. However, the setting at this level takes precedence if &#x27;encoding&#x27; is set at both levels.
532 &quot;type&quot;: &quot;A String&quot;, # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. &#x27;type&#x27; can also be set at the column family level. However, the setting at this level takes precedence if &#x27;type&#x27; is set at both levels.
533 &quot;qualifierString&quot;: &quot;A String&quot;,
534 &quot;qualifierEncoded&quot;: &quot;A String&quot;, # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.
535 &quot;onlyReadLatest&quot;: True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. &#x27;onlyReadLatest&#x27; can also be set at the column family level. However, the setting at this level takes precedence if &#x27;onlyReadLatest&#x27; is set at both levels.
536 },
537 ],
538 &quot;type&quot;: &quot;A String&quot;, # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in &#x27;columns&#x27; and specifying a type for it.
539 },
540 ],
541 },
542 &quot;autodetect&quot;: True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.
543 &quot;sourceFormat&quot;: &quot;A String&quot;, # [Required] The data format. For CSV files, specify &quot;CSV&quot;. For Google sheets, specify &quot;GOOGLE_SHEETS&quot;. For newline-delimited JSON, specify &quot;NEWLINE_DELIMITED_JSON&quot;. For Avro files, specify &quot;AVRO&quot;. For Google Cloud Datastore backups, specify &quot;DATASTORE_BACKUP&quot;. [Beta] For Google Cloud Bigtable, specify &quot;BIGTABLE&quot;.
544 &quot;connectionId&quot;: &quot;A String&quot;, # [Optional, Trusted Tester] Connection for external data source.
545 &quot;ignoreUnknownValues&quot;: True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don&#x27;t match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
546 &quot;csvOptions&quot;: { # Additional properties to set if sourceFormat is set to CSV.
547 &quot;encoding&quot;: &quot;A String&quot;, # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
548 &quot;allowJaggedRows&quot;: True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
549 &quot;fieldDelimiter&quot;: &quot;A String&quot;, # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence &quot;\t&quot; to specify a tab separator. The default value is a comma (&#x27;,&#x27;).
550 &quot;quote&quot;: &quot;&quot;&quot;, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote (&#x27;&quot;&#x27;). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
551 &quot;skipLeadingRows&quot;: &quot;A String&quot;, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N &gt; 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
552 &quot;allowQuotedNewlines&quot;: True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
553 },
554 &quot;compression&quot;: &quot;A String&quot;, # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
555 &quot;googleSheetsOptions&quot;: { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
556 &quot;skipLeadingRows&quot;: &quot;A String&quot;, # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N &gt; 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
557 &quot;range&quot;: &quot;A String&quot;, # [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20
558 },
559 &quot;sourceUris&quot;: [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one &#x27;*&#x27; wildcard character and it must come after the &#x27;bucket&#x27; name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the &#x27;*&#x27; wildcard character is not allowed.
560 &quot;A String&quot;,
561 ],
562 },
563 },
564 &quot;queryParameters&quot;: [ # Query parameters for standard SQL queries.
565 {
566 &quot;parameterValue&quot;: { # [Required] The value of this parameter.
567 &quot;arrayValues&quot;: [ # [Optional] The array values, if this is an array type.
568 # Object with schema name: QueryParameterValue
569 ],
570 &quot;value&quot;: &quot;A String&quot;, # [Optional] The value of this value, if a simple scalar type.
571 &quot;structValues&quot;: { # [Optional] The struct field values, in order of the struct type&#x27;s declaration.
572 &quot;a_key&quot;: # Object with schema name: QueryParameterValue
573 },
574 },
575 &quot;name&quot;: &quot;A String&quot;, # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
576 &quot;parameterType&quot;: { # [Required] The type of this parameter.
577 &quot;arrayType&quot;: # Object with schema name: QueryParameterType # [Optional] The type of the array&#x27;s elements, if this is an array.
578 &quot;structTypes&quot;: [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
579 {
580 &quot;type&quot;: # Object with schema name: QueryParameterType # [Required] The type of this field.
581 &quot;description&quot;: &quot;A String&quot;, # [Optional] Human-oriented description of the field.
582 &quot;name&quot;: &quot;A String&quot;, # [Optional] The name of this field.
583 },
584 ],
585 &quot;type&quot;: &quot;A String&quot;, # [Required] The top level type of this field.
586 },
587 },
588 ],
589 &quot;allowLargeResults&quot;: false, # [Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size.
590 &quot;maximumBytesBilled&quot;: &quot;A String&quot;, # [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.
591 &quot;destinationEncryptionConfiguration&quot;: { # Custom encryption configuration (e.g., Cloud KMS keys).
592 &quot;kmsKeyName&quot;: &quot;A String&quot;, # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
593 },
594 &quot;useLegacySql&quot;: true, # Specifies whether to use BigQuery&#x27;s legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery&#x27;s standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.
595 &quot;parameterMode&quot;: &quot;A String&quot;, # Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
596 &quot;connectionProperties&quot;: [ # Connection properties.
597 {
598 &quot;key&quot;: &quot;A String&quot;, # [Required] Name of the connection property to set.
599 &quot;value&quot;: &quot;A String&quot;, # [Required] Value of the connection property.
600 },
601 ],
602 &quot;timePartitioning&quot;: { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
603 &quot;requirePartitionFilter&quot;: True or False,
604 &quot;type&quot;: &quot;A String&quot;, # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.
605 &quot;expirationMs&quot;: &quot;A String&quot;, # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
606 &quot;field&quot;: &quot;A String&quot;, # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either &#x27;_PARTITIONTIME&#x27; as TIMESTAMP type, or &#x27;_PARTITIONDATE&#x27; as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
607 },
608 &quot;schemaUpdateOptions&quot;: [ # Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
609 &quot;A String&quot;,
610 ],
611 &quot;preserveNulls&quot;: True or False, # [Deprecated] This property is deprecated.
612 &quot;userDefinedFunctionResources&quot;: [ # Describes user-defined function resources used in the query.
613 { # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions
614 &quot;inlineCode&quot;: &quot;A String&quot;, # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
615 &quot;resourceUri&quot;: &quot;A String&quot;, # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
616 },
617 ],
618 &quot;defaultDataset&quot;: { # [Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names.
619 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
620 &quot;projectId&quot;: &quot;A String&quot;, # [Optional] The ID of the project containing this dataset.
621 },
622 &quot;useQueryCache&quot;: true, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.
623 &quot;clustering&quot;: { # [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
624 &quot;fields&quot;: [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
625 &quot;A String&quot;,
626 ],
627 },
628 &quot;createDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a &#x27;notFound&#x27; error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
629 &quot;writeDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a &#x27;duplicate&#x27; error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
630 },
631 &quot;labels&quot;: { # The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
632 &quot;a_key&quot;: &quot;A String&quot;,
633 },
634 &quot;jobTimeoutMs&quot;: &quot;A String&quot;, # [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
635 &quot;copy&quot;: { # [Pick one] Copies a table.
636 &quot;sourceTable&quot;: { # [Pick one] Source table to copy.
637 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
638 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
639 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
640 },
641 &quot;destinationEncryptionConfiguration&quot;: { # Custom encryption configuration (e.g., Cloud KMS keys).
642 &quot;kmsKeyName&quot;: &quot;A String&quot;, # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
643 },
644 &quot;destinationTable&quot;: { # [Required] The destination table
645 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
646 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
647 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
648 },
649 &quot;operationType&quot;: &quot;A String&quot;, # [Optional] Supported operation types in table copy job.
650 &quot;writeDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a &#x27;duplicate&#x27; error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
651 &quot;destinationExpirationTime&quot;: &quot;&quot;, # [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
652 &quot;sourceTables&quot;: [ # [Pick one] Source tables to copy.
653 {
654 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
655 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
656 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
657 },
658 ],
659 &quot;createDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a &#x27;notFound&#x27; error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
660 },
661 },
662 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]663 }</pre>
664</div>
665
666<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]667 <code class="details" id="close">close()</code>
668 <pre>Close httplib2 connections.</pre>
669</div>
670
671<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]672 <code class="details" id="get">get(projectId, jobId, location=None)</code>
673 <pre>Returns information about a specific job. Job information is available for a six month period after creation. Requires that you&#x27;re the person who ran the job, or have the Is Owner project role.
674
675Args:
676 projectId: string, [Required] Project ID of the requested job (required)
677 jobId: string, [Required] Job ID of the requested job (required)
678 location: string, The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
679
680Returns:
681 An object of the form:
682
683 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]684 &quot;id&quot;: &quot;A String&quot;, # [Output-only] Opaque ID field of the job
685 &quot;selfLink&quot;: &quot;A String&quot;, # [Output-only] A URL that can be used to access this resource again.
686 &quot;kind&quot;: &quot;bigquery#job&quot;, # [Output-only] The type of the resource.
687 &quot;etag&quot;: &quot;A String&quot;, # [Output-only] A hash of this resource.
688 &quot;status&quot;: { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
689 &quot;state&quot;: &quot;A String&quot;, # [Output-only] Running state of the job.
690 &quot;errors&quot;: [ # [Output-only] The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
691 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]692 &quot;reason&quot;: &quot;A String&quot;, # A short error code that summarizes the error.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]693 &quot;debugInfo&quot;: &quot;A String&quot;, # Debugging information. This property is internal to Google and should not be used.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]694 &quot;location&quot;: &quot;A String&quot;, # Specifies where the error occurred, if present.
695 &quot;message&quot;: &quot;A String&quot;, # A human-readable description of the error.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]696 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]697 ],
698 &quot;errorResult&quot;: { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
699 &quot;reason&quot;: &quot;A String&quot;, # A short error code that summarizes the error.
700 &quot;debugInfo&quot;: &quot;A String&quot;, # Debugging information. This property is internal to Google and should not be used.
701 &quot;location&quot;: &quot;A String&quot;, # Specifies where the error occurred, if present.
702 &quot;message&quot;: &quot;A String&quot;, # A human-readable description of the error.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]703 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]704 },
705 &quot;statistics&quot;: { # [Output-only] Information about the job, including starting time and ending time of the job.
706 &quot;startTime&quot;: &quot;A String&quot;, # [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
707 &quot;completionRatio&quot;: 3.14, # [TrustedTester] [Output-only] Job progress (0.0 -&gt; 1.0) for LOAD and EXTRACT jobs.
708 &quot;rowLevelSecurityStatistics&quot;: { # [Output-only] [Preview] Statistics for row-level security. Present only for query and extract jobs.
709 &quot;rowLevelSecurityApplied&quot;: True or False, # [Output-only] [Preview] Whether any accessed data was protected by row access policies.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]710 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]711 &quot;numChildJobs&quot;: &quot;A String&quot;, # [Output-only] Number of child jobs executed.
712 &quot;extract&quot;: { # [Output-only] Statistics for an extract job.
713 &quot;inputBytes&quot;: &quot;A String&quot;, # [Output-only] Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.
714 &quot;destinationUriFileCounts&quot;: [ # [Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the &#x27;destinationUris&#x27; field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]715 &quot;A String&quot;,
716 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]717 },
718 &quot;transactionInfoTemplate&quot;: { # [Output-only] [Alpha] Information of the multi-statement transaction if this job is part of one.
719 &quot;transactionId&quot;: &quot;A String&quot;, # [Output-only] // [Alpha] Id of the transaction.
720 },
721 &quot;reservationUsage&quot;: [ # [Output-only] Job resource usage breakdown by reservation.
722 {
723 &quot;slotMs&quot;: &quot;A String&quot;, # [Output-only] Slot-milliseconds the job spent in the given reservation.
724 &quot;name&quot;: &quot;A String&quot;, # [Output-only] Reservation name or &quot;unreserved&quot; for on-demand resources usage.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]725 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]726 ],
727 &quot;creationTime&quot;: &quot;A String&quot;, # [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
728 &quot;totalBytesProcessed&quot;: &quot;A String&quot;, # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
729 &quot;reservation_id&quot;: &quot;A String&quot;, # [Output-only] Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.
730 &quot;endTime&quot;: &quot;A String&quot;, # [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
731 &quot;query&quot;: { # [Output-only] Statistics for a query job.
732 &quot;undeclaredQueryParameters&quot;: [ # Standard SQL only: list of undeclared query parameters detected during a dry run validation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]733 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]734 &quot;parameterValue&quot;: { # [Required] The value of this parameter.
735 &quot;arrayValues&quot;: [ # [Optional] The array values, if this is an array type.
736 # Object with schema name: QueryParameterValue
737 ],
738 &quot;value&quot;: &quot;A String&quot;, # [Optional] The value of this value, if a simple scalar type.
739 &quot;structValues&quot;: { # [Optional] The struct field values, in order of the struct type&#x27;s declaration.
740 &quot;a_key&quot;: # Object with schema name: QueryParameterValue
741 },
742 },
743 &quot;name&quot;: &quot;A String&quot;, # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
744 &quot;parameterType&quot;: { # [Required] The type of this parameter.
745 &quot;arrayType&quot;: # Object with schema name: QueryParameterType # [Optional] The type of the array&#x27;s elements, if this is an array.
746 &quot;structTypes&quot;: [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
747 {
748 &quot;type&quot;: # Object with schema name: QueryParameterType # [Required] The type of this field.
749 &quot;description&quot;: &quot;A String&quot;, # [Optional] Human-oriented description of the field.
750 &quot;name&quot;: &quot;A String&quot;, # [Optional] The name of this field.
751 },
752 ],
753 &quot;type&quot;: &quot;A String&quot;, # [Required] The top level type of this field.
754 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]755 },
756 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]757 &quot;ddlOperationPerformed&quot;: &quot;A String&quot;, # The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): &quot;CREATE&quot;: The query created the DDL target. &quot;SKIP&quot;: No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. &quot;REPLACE&quot;: The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. &quot;DROP&quot;: The query deleted the DDL target.
758 &quot;schema&quot;: { # [Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
759 &quot;fields&quot;: [ # Describes the fields in a table.
760 {
761 &quot;type&quot;: &quot;A String&quot;, # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
762 &quot;categories&quot;: { # [Optional] The categories attached to this field, used for field-level access control.
763 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/taxonomies/2/categories/3&quot;. At most 5 categories are allowed.
764 &quot;A String&quot;,
765 ],
766 },
767 &quot;fields&quot;: [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
768 # Object with schema name: TableFieldSchema
769 ],
770 &quot;name&quot;: &quot;A String&quot;, # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
771 &quot;description&quot;: &quot;A String&quot;, # [Optional] The field description. The maximum length is 1,024 characters.
772 &quot;policyTags&quot;: {
773 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/location/eu/taxonomies/2/policyTags/3&quot;. At most 1 policy tag is allowed.
774 &quot;A String&quot;,
775 ],
776 },
777 &quot;mode&quot;: &quot;A String&quot;, # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
778 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]779 ],
780 },
781 &quot;totalSlotMs&quot;: &quot;A String&quot;, # [Output-only] Slot-milliseconds for the job.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]782 &quot;modelTrainingCurrentIteration&quot;: 42, # [Output-only, Beta] Deprecated; do not use.
783 &quot;billingTier&quot;: 42, # [Output-only] Billing tier for the job.
784 &quot;estimatedBytesProcessed&quot;: &quot;A String&quot;, # [Output-only] The original estimate of bytes processed for the job.
785 &quot;totalBytesProcessed&quot;: &quot;A String&quot;, # [Output-only] Total bytes processed for the job.
786 &quot;statementType&quot;: &quot;A String&quot;, # The type of query statement, if valid. Possible values (new values might be added in the future): &quot;SELECT&quot;: SELECT query. &quot;INSERT&quot;: INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. &quot;UPDATE&quot;: UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. &quot;DELETE&quot;: DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. &quot;MERGE&quot;: MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. &quot;ALTER_TABLE&quot;: ALTER TABLE query. &quot;ALTER_VIEW&quot;: ALTER VIEW query. &quot;ASSERT&quot;: ASSERT condition AS &#x27;description&#x27;. &quot;CREATE_FUNCTION&quot;: CREATE FUNCTION query. &quot;CREATE_MODEL&quot;: CREATE [OR REPLACE] MODEL ... AS SELECT ... . &quot;CREATE_PROCEDURE&quot;: CREATE PROCEDURE query. &quot;CREATE_TABLE&quot;: CREATE [OR REPLACE] TABLE without AS SELECT. &quot;CREATE_TABLE_AS_SELECT&quot;: CREATE [OR REPLACE] TABLE ... AS SELECT ... . &quot;CREATE_VIEW&quot;: CREATE [OR REPLACE] VIEW ... AS SELECT ... . &quot;DROP_FUNCTION&quot; : DROP FUNCTION query. &quot;DROP_PROCEDURE&quot;: DROP PROCEDURE query. &quot;DROP_TABLE&quot;: DROP TABLE query. &quot;DROP_VIEW&quot;: DROP VIEW query.
787 &quot;ddlAffectedRowAccessPolicyCount&quot;: &quot;A String&quot;, # [Output-only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
788 &quot;referencedTables&quot;: [ # [Output-only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
789 {
790 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
791 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
792 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
793 },
794 ],
795 &quot;totalPartitionsProcessed&quot;: &quot;A String&quot;, # [Output-only] Total number of partitions processed from all partitioned tables referenced in the job.
796 &quot;ddlTargetTable&quot;: { # [Output-only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
797 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
798 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
799 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
800 },
801 &quot;referencedRoutines&quot;: [ # [Output-only] Referenced routines (persistent user-defined functions and stored procedures) for the job.
802 {
803 &quot;routineId&quot;: &quot;A String&quot;, # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
804 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this routine.
805 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this routine.
806 },
807 ],
808 &quot;timeline&quot;: [ # [Output-only] [Beta] Describes a timeline of job execution.
809 {
810 &quot;activeUnits&quot;: &quot;A String&quot;, # Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
811 &quot;completedUnits&quot;: &quot;A String&quot;, # Total parallel units of work completed by this query.
812 &quot;pendingUnits&quot;: &quot;A String&quot;, # Total parallel units of work remaining for the active stages.
813 &quot;totalSlotMs&quot;: &quot;A String&quot;, # Cumulative slot-ms consumed by the query.
814 &quot;elapsedMs&quot;: &quot;A String&quot;, # Milliseconds elapsed since the start of query execution.
815 },
816 ],
817 &quot;totalBytesBilled&quot;: &quot;A String&quot;, # [Output-only] Total bytes billed for the job.
818 &quot;modelTraining&quot;: { # [Output-only, Beta] Information about create model query job progress.
819 &quot;expectedTotalIterations&quot;: &quot;A String&quot;, # [Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.
820 &quot;currentIteration&quot;: 42, # [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.
821 },
822 &quot;numDmlAffectedRows&quot;: &quot;A String&quot;, # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
823 &quot;queryPlan&quot;: [ # [Output-only] Describes execution plan for the query.
824 {
825 &quot;computeRatioAvg&quot;: 3.14, # Relative amount of time the average shard spent on CPU-bound tasks.
826 &quot;waitMsMax&quot;: &quot;A String&quot;, # Milliseconds the slowest shard spent waiting to be scheduled.
827 &quot;shuffleOutputBytes&quot;: &quot;A String&quot;, # Total number of bytes written to shuffle.
828 &quot;computeMsAvg&quot;: &quot;A String&quot;, # Milliseconds the average shard spent on CPU-bound tasks.
829 &quot;writeMsMax&quot;: &quot;A String&quot;, # Milliseconds the slowest shard spent on writing output.
830 &quot;waitMsAvg&quot;: &quot;A String&quot;, # Milliseconds the average shard spent waiting to be scheduled.
831 &quot;computeRatioMax&quot;: 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks.
832 &quot;writeMsAvg&quot;: &quot;A String&quot;, # Milliseconds the average shard spent on writing output.
833 &quot;slotMs&quot;: &quot;A String&quot;, # Slot-milliseconds used by the stage.
834 &quot;readMsAvg&quot;: &quot;A String&quot;, # Milliseconds the average shard spent reading input.
835 &quot;waitRatioMax&quot;: 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled.
836 &quot;shuffleOutputBytesSpilled&quot;: &quot;A String&quot;, # Total number of bytes written to shuffle and spilled to disk.
837 &quot;startMs&quot;: &quot;A String&quot;, # Stage start time represented as milliseconds since epoch.
838 &quot;completedParallelInputs&quot;: &quot;A String&quot;, # Number of parallel input segments completed.
839 &quot;recordsRead&quot;: &quot;A String&quot;, # Number of records read into the stage.
840 &quot;inputStages&quot;: [ # IDs for stages that are inputs to this stage.
841 &quot;A String&quot;,
842 ],
843 &quot;computeMsMax&quot;: &quot;A String&quot;, # Milliseconds the slowest shard spent on CPU-bound tasks.
844 &quot;id&quot;: &quot;A String&quot;, # Unique ID for stage within plan.
845 &quot;readRatioMax&quot;: 3.14, # Relative amount of time the slowest shard spent reading input.
846 &quot;writeRatioMax&quot;: 3.14, # Relative amount of time the slowest shard spent on writing output.
847 &quot;readMsMax&quot;: &quot;A String&quot;, # Milliseconds the slowest shard spent reading input.
848 &quot;readRatioAvg&quot;: 3.14, # Relative amount of time the average shard spent reading input.
849 &quot;status&quot;: &quot;A String&quot;, # Current status for the stage.
850 &quot;waitRatioAvg&quot;: 3.14, # Relative amount of time the average shard spent waiting to be scheduled.
851 &quot;name&quot;: &quot;A String&quot;, # Human-readable name for stage.
852 &quot;endMs&quot;: &quot;A String&quot;, # Stage end time represented as milliseconds since epoch.
853 &quot;parallelInputs&quot;: &quot;A String&quot;, # Number of parallel input segments to be processed.
854 &quot;recordsWritten&quot;: &quot;A String&quot;, # Number of records written by the stage.
855 &quot;steps&quot;: [ # List of operations within the stage in dependency order (approximately chronological).
856 {
857 &quot;kind&quot;: &quot;A String&quot;, # Machine-readable operation type.
858 &quot;substeps&quot;: [ # Human-readable stage descriptions.
859 &quot;A String&quot;,
860 ],
861 },
862 ],
863 &quot;writeRatioAvg&quot;: 3.14, # Relative amount of time the average shard spent on writing output.
864 },
865 ],
866 &quot;totalBytesProcessedAccuracy&quot;: &quot;A String&quot;, # [Output-only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
867 &quot;cacheHit&quot;: True or False, # [Output-only] Whether the query result was fetched from the query cache.
868 &quot;modelTrainingExpectedTotalIteration&quot;: &quot;A String&quot;, # [Output-only, Beta] Deprecated; do not use.
869 &quot;ddlTargetRowAccessPolicy&quot;: { # [Output-only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
870 &quot;policyId&quot;: &quot;A String&quot;, # [Required] The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
871 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this row access policy.
872 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table containing this row access policy.
873 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this row access policy.
874 },
875 &quot;reservationUsage&quot;: [ # [Output-only] Job resource usage breakdown by reservation.
876 {
877 &quot;slotMs&quot;: &quot;A String&quot;, # [Output-only] Slot-milliseconds the job spent in the given reservation.
878 &quot;name&quot;: &quot;A String&quot;, # [Output-only] Reservation name or &quot;unreserved&quot; for on-demand resources usage.
879 },
880 ],
881 &quot;ddlTargetRoutine&quot;: { # The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
882 &quot;routineId&quot;: &quot;A String&quot;, # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
883 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this routine.
884 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this routine.
885 },
886 },
887 &quot;quotaDeferments&quot;: [ # [Output-only] Quotas which delayed this job&#x27;s start time.
888 &quot;A String&quot;,
889 ],
890 &quot;scriptStatistics&quot;: { # [Output-only] Statistics for a child job of a script.
891 &quot;stackFrames&quot;: [ # Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty.
892 {
893 &quot;procedureId&quot;: &quot;A String&quot;, # [Output-only] Name of the active procedure, empty if in a top-level script.
894 &quot;startColumn&quot;: 42, # [Output-only] One-based start column.
895 &quot;startLine&quot;: 42, # [Output-only] One-based start line.
896 &quot;endColumn&quot;: 42, # [Output-only] One-based end column.
897 &quot;endLine&quot;: 42, # [Output-only] One-based end line.
898 &quot;text&quot;: &quot;A String&quot;, # [Output-only] Text of the current statement/expression.
899 },
900 ],
901 &quot;evaluationKind&quot;: &quot;A String&quot;, # [Output-only] Whether this child job was a statement or expression.
902 },
903 &quot;parentJobId&quot;: &quot;A String&quot;, # [Output-only] If this is a child job, the id of the parent.
904 &quot;totalSlotMs&quot;: &quot;A String&quot;, # [Output-only] Slot-milliseconds for the job.
905 &quot;load&quot;: { # [Output-only] Statistics for a load job.
906 &quot;outputRows&quot;: &quot;A String&quot;, # [Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
907 &quot;inputFileBytes&quot;: &quot;A String&quot;, # [Output-only] Number of bytes of source data in a load job.
908 &quot;badRecords&quot;: &quot;A String&quot;, # [Output-only] The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.
909 &quot;outputBytes&quot;: &quot;A String&quot;, # [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
910 &quot;inputFiles&quot;: &quot;A String&quot;, # [Output-only] Number of source files in a load job.
911 },
912 },
913 &quot;user_email&quot;: &quot;A String&quot;, # [Output-only] Email address of the user who ran the job.
914 &quot;jobReference&quot;: { # [Optional] Reference describing the unique-per-user name of the job.
915 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this job.
916 &quot;location&quot;: &quot;A String&quot;, # The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
917 &quot;jobId&quot;: &quot;A String&quot;, # [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
918 },
919 &quot;configuration&quot;: { # [Required] Describes the job configuration.
920 &quot;extract&quot;: { # [Pick one] Configures an extract job.
921 &quot;compression&quot;: &quot;A String&quot;, # [Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
922 &quot;destinationUris&quot;: [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
923 &quot;A String&quot;,
924 ],
925 &quot;useAvroLogicalTypes&quot;: True or False, # [Optional] If destinationFormat is set to &quot;AVRO&quot;, this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
926 &quot;destinationFormat&quot;: &quot;A String&quot;, # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
927 &quot;sourceTable&quot;: { # A reference to the table being exported.
928 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
929 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
930 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
931 },
932 &quot;destinationUri&quot;: &quot;A String&quot;, # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
933 &quot;fieldDelimiter&quot;: &quot;A String&quot;, # [Optional] Delimiter to use between fields in the exported data. Default is &#x27;,&#x27;. Not applicable when extracting models.
934 &quot;printHeader&quot;: true, # [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
935 &quot;sourceModel&quot;: { # A reference to the model being exported.
936 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this model.
937 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this model.
938 &quot;modelId&quot;: &quot;A String&quot;, # [Required] The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
939 },
940 },
941 &quot;dryRun&quot;: True or False, # [Optional] If set, don&#x27;t actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn&#x27;t a dry run. Behavior of non-query jobs is undefined.
942 &quot;load&quot;: { # [Pick one] Configures a load job.
943 &quot;allowQuotedNewlines&quot;: True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
944 &quot;schema&quot;: { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you&#x27;re loading data from Google Cloud Datastore.
945 &quot;fields&quot;: [ # Describes the fields in a table.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]946 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]947 &quot;type&quot;: &quot;A String&quot;, # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
948 &quot;categories&quot;: { # [Optional] The categories attached to this field, used for field-level access control.
949 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/taxonomies/2/categories/3&quot;. At most 5 categories are allowed.
950 &quot;A String&quot;,
951 ],
952 },
953 &quot;fields&quot;: [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
954 # Object with schema name: TableFieldSchema
955 ],
956 &quot;name&quot;: &quot;A String&quot;, # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
957 &quot;description&quot;: &quot;A String&quot;, # [Optional] The field description. The maximum length is 1,024 characters.
958 &quot;policyTags&quot;: {
959 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/location/eu/taxonomies/2/policyTags/3&quot;. At most 1 policy tag is allowed.
960 &quot;A String&quot;,
961 ],
962 },
963 &quot;mode&quot;: &quot;A String&quot;, # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]964 },
965 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]966 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]967 &quot;decimalTargetTypes&quot;: [ # [Trusted Tester] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. For example: suppose decimal_target_type = [&quot;NUMERIC&quot;, &quot;BIGNUMERIC&quot;]. Then if (precision,scale) is: * (38,9) -&gt; NUMERIC; * (39,9) -&gt; BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -&gt; BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -&gt; BIGNUMERIC; * (77,38) -&gt; BIGNUMERIC (error if value exeeds supported range). For duplicated types in this field, only one will be considered and the rest will be ignored. The order of the types in this field is ignored. For example, [&quot;BIGNUMERIC&quot;, &quot;NUMERIC&quot;] is the same as [&quot;NUMERIC&quot;, &quot;BIGNUMERIC&quot;] and NUMERIC always takes precedence over BIGNUMERIC.
968 &quot;A String&quot;,
969 ],
970 &quot;skipLeadingRows&quot;: 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
971 &quot;timePartitioning&quot;: { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
972 &quot;requirePartitionFilter&quot;: True or False,
973 &quot;type&quot;: &quot;A String&quot;, # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.
974 &quot;expirationMs&quot;: &quot;A String&quot;, # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
975 &quot;field&quot;: &quot;A String&quot;, # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either &#x27;_PARTITIONTIME&#x27; as TIMESTAMP type, or &#x27;_PARTITIONDATE&#x27; as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]976 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]977 &quot;destinationEncryptionConfiguration&quot;: { # Custom encryption configuration (e.g., Cloud KMS keys).
978 &quot;kmsKeyName&quot;: &quot;A String&quot;, # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
979 },
980 &quot;schemaUpdateOptions&quot;: [ # Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
981 &quot;A String&quot;,
982 ],
983 &quot;destinationTable&quot;: { # [Required] The destination table to load the data into.
984 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
985 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
986 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
987 },
988 &quot;schemaInline&quot;: &quot;A String&quot;, # [Deprecated] The inline schema. For CSV schemas, specify as &quot;Field1:Type1[,Field2:Type2]*&quot;. For example, &quot;foo:STRING, bar:INTEGER, baz:FLOAT&quot;.
989 &quot;projectionFields&quot;: [ # If sourceFormat is set to &quot;DATASTORE_BACKUP&quot;, indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn&#x27;t found in the Cloud Datastore backup, an invalid error is returned in the job result.
990 &quot;A String&quot;,
991 ],
992 &quot;maxBadRecords&quot;: 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
993 &quot;allowJaggedRows&quot;: True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
994 &quot;schemaInlineFormat&quot;: &quot;A String&quot;, # [Deprecated] The format of the schemaInline property.
995 &quot;autodetect&quot;: True or False, # [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
996 &quot;encoding&quot;: &quot;A String&quot;, # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
997 &quot;destinationTableProperties&quot;: { # [Beta] [Optional] Properties with which to create the destination table if it is new.
998 &quot;labels&quot;: { # [Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
999 &quot;a_key&quot;: &quot;A String&quot;,
1000 },
1001 &quot;description&quot;: &quot;A String&quot;, # [Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
1002 &quot;friendlyName&quot;: &quot;A String&quot;, # [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
1003 },
1004 &quot;createDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a &#x27;notFound&#x27; error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
1005 &quot;sourceUris&quot;: [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one &#x27;*&#x27; wildcard character and it must come after the &#x27;bucket&#x27; name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the &#x27;*&#x27; wildcard character is not allowed.
1006 &quot;A String&quot;,
1007 ],
1008 &quot;rangePartitioning&quot;: { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
1009 &quot;field&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
1010 &quot;range&quot;: { # [TrustedTester] [Required] Defines the ranges for range partitioning.
1011 &quot;interval&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The width of each interval.
1012 &quot;end&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The end of range partitioning, exclusive.
1013 &quot;start&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The start of range partitioning, inclusive.
1014 },
1015 },
1016 &quot;useAvroLogicalTypes&quot;: True or False, # [Optional] If sourceFormat is set to &quot;AVRO&quot;, indicates whether to enable interpreting logical types into their corresponding types (ie. TIMESTAMP), instead of only using their raw types (ie. INTEGER).
1017 &quot;ignoreUnknownValues&quot;: True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don&#x27;t match any column names
1018 &quot;sourceFormat&quot;: &quot;A String&quot;, # [Optional] The format of the data files. For CSV files, specify &quot;CSV&quot;. For datastore backups, specify &quot;DATASTORE_BACKUP&quot;. For newline-delimited JSON, specify &quot;NEWLINE_DELIMITED_JSON&quot;. For Avro, specify &quot;AVRO&quot;. For parquet, specify &quot;PARQUET&quot;. For orc, specify &quot;ORC&quot;. The default value is CSV.
1019 &quot;fieldDelimiter&quot;: &quot;A String&quot;, # [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence &quot;\t&quot; to specify a tab separator. The default value is a comma (&#x27;,&#x27;).
1020 &quot;clustering&quot;: { # [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
1021 &quot;fields&quot;: [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
1022 &quot;A String&quot;,
1023 ],
1024 },
1025 &quot;nullMarker&quot;: &quot;A String&quot;, # [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify &quot;\N&quot;, BigQuery interprets &quot;\N&quot; as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
1026 &quot;quote&quot;: &quot;&quot;&quot;, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote (&#x27;&quot;&#x27;). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
1027 &quot;hivePartitioningOptions&quot;: { # [Optional, Trusted Tester] Options to configure hive partitioning support.
1028 &quot;requirePartitionFilter&quot;: True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
1029 &quot;mode&quot;: &quot;A String&quot;, # [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
1030 &quot;sourceUriPrefix&quot;: &quot;A String&quot;, # [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
1031 },
1032 &quot;writeDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a &#x27;duplicate&#x27; error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1033 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1034 &quot;jobType&quot;: &quot;A String&quot;, # [Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
1035 &quot;query&quot;: { # [Pick one] Configures a query job.
1036 &quot;query&quot;: &quot;A String&quot;, # [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.
1037 &quot;flattenResults&quot;: true, # [Optional] If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened.
1038 &quot;rangePartitioning&quot;: { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
1039 &quot;field&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
1040 &quot;range&quot;: { # [TrustedTester] [Required] Defines the ranges for range partitioning.
1041 &quot;interval&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The width of each interval.
1042 &quot;end&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The end of range partitioning, exclusive.
1043 &quot;start&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The start of range partitioning, inclusive.
1044 },
1045 },
1046 &quot;maximumBillingTier&quot;: 1, # [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.
1047 &quot;priority&quot;: &quot;A String&quot;, # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
1048 &quot;destinationTable&quot;: { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size.
1049 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
1050 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
1051 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
1052 },
1053 &quot;tableDefinitions&quot;: { # [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
1054 &quot;a_key&quot;: {
1055 &quot;hivePartitioningOptions&quot;: { # [Optional, Trusted Tester] Options to configure hive partitioning support.
1056 &quot;requirePartitionFilter&quot;: True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
1057 &quot;mode&quot;: &quot;A String&quot;, # [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
1058 &quot;sourceUriPrefix&quot;: &quot;A String&quot;, # [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
1059 },
1060 &quot;schema&quot;: { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
1061 &quot;fields&quot;: [ # Describes the fields in a table.
1062 {
1063 &quot;type&quot;: &quot;A String&quot;, # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
1064 &quot;categories&quot;: { # [Optional] The categories attached to this field, used for field-level access control.
1065 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/taxonomies/2/categories/3&quot;. At most 5 categories are allowed.
1066 &quot;A String&quot;,
1067 ],
1068 },
1069 &quot;fields&quot;: [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
1070 # Object with schema name: TableFieldSchema
1071 ],
1072 &quot;name&quot;: &quot;A String&quot;, # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
1073 &quot;description&quot;: &quot;A String&quot;, # [Optional] The field description. The maximum length is 1,024 characters.
1074 &quot;policyTags&quot;: {
1075 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/location/eu/taxonomies/2/policyTags/3&quot;. At most 1 policy tag is allowed.
1076 &quot;A String&quot;,
1077 ],
1078 },
1079 &quot;mode&quot;: &quot;A String&quot;, # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
1080 },
1081 ],
1082 },
1083 &quot;maxBadRecords&quot;: 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
1084 &quot;bigtableOptions&quot;: { # [Optional] Additional options if sourceFormat is set to BIGTABLE.
1085 &quot;readRowkeyAsString&quot;: True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
1086 &quot;ignoreUnspecifiedColumnFamilies&quot;: True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
1087 &quot;columnFamilies&quot;: [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the &#x27;type&#x27; field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
1088 {
1089 &quot;encoding&quot;: &quot;A String&quot;, # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in &#x27;columns&#x27; and specifying an encoding for it.
1090 &quot;onlyReadLatest&quot;: True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in &#x27;columns&#x27; and specifying a different setting for that column.
1091 &quot;familyId&quot;: &quot;A String&quot;, # Identifier of the column family.
1092 &quot;columns&quot;: [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.
1093 {
1094 &quot;fieldName&quot;: &quot;A String&quot;, # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
1095 &quot;encoding&quot;: &quot;A String&quot;, # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. &#x27;encoding&#x27; can also be set at the column family level. However, the setting at this level takes precedence if &#x27;encoding&#x27; is set at both levels.
1096 &quot;type&quot;: &quot;A String&quot;, # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. &#x27;type&#x27; can also be set at the column family level. However, the setting at this level takes precedence if &#x27;type&#x27; is set at both levels.
1097 &quot;qualifierString&quot;: &quot;A String&quot;,
1098 &quot;qualifierEncoded&quot;: &quot;A String&quot;, # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.
1099 &quot;onlyReadLatest&quot;: True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. &#x27;onlyReadLatest&#x27; can also be set at the column family level. However, the setting at this level takes precedence if &#x27;onlyReadLatest&#x27; is set at both levels.
1100 },
1101 ],
1102 &quot;type&quot;: &quot;A String&quot;, # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in &#x27;columns&#x27; and specifying a type for it.
1103 },
1104 ],
1105 },
1106 &quot;autodetect&quot;: True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.
1107 &quot;sourceFormat&quot;: &quot;A String&quot;, # [Required] The data format. For CSV files, specify &quot;CSV&quot;. For Google sheets, specify &quot;GOOGLE_SHEETS&quot;. For newline-delimited JSON, specify &quot;NEWLINE_DELIMITED_JSON&quot;. For Avro files, specify &quot;AVRO&quot;. For Google Cloud Datastore backups, specify &quot;DATASTORE_BACKUP&quot;. [Beta] For Google Cloud Bigtable, specify &quot;BIGTABLE&quot;.
1108 &quot;connectionId&quot;: &quot;A String&quot;, # [Optional, Trusted Tester] Connection for external data source.
1109 &quot;ignoreUnknownValues&quot;: True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don&#x27;t match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
1110 &quot;csvOptions&quot;: { # Additional properties to set if sourceFormat is set to CSV.
1111 &quot;encoding&quot;: &quot;A String&quot;, # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
1112 &quot;allowJaggedRows&quot;: True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
1113 &quot;fieldDelimiter&quot;: &quot;A String&quot;, # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence &quot;\t&quot; to specify a tab separator. The default value is a comma (&#x27;,&#x27;).
1114 &quot;quote&quot;: &quot;&quot;&quot;, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote (&#x27;&quot;&#x27;). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
1115 &quot;skipLeadingRows&quot;: &quot;A String&quot;, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N &gt; 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
1116 &quot;allowQuotedNewlines&quot;: True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
1117 },
1118 &quot;compression&quot;: &quot;A String&quot;, # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
1119 &quot;googleSheetsOptions&quot;: { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
1120 &quot;skipLeadingRows&quot;: &quot;A String&quot;, # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N &gt; 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
1121 &quot;range&quot;: &quot;A String&quot;, # [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20
1122 },
1123 &quot;sourceUris&quot;: [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one &#x27;*&#x27; wildcard character and it must come after the &#x27;bucket&#x27; name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the &#x27;*&#x27; wildcard character is not allowed.
1124 &quot;A String&quot;,
1125 ],
1126 },
1127 },
1128 &quot;queryParameters&quot;: [ # Query parameters for standard SQL queries.
1129 {
1130 &quot;parameterValue&quot;: { # [Required] The value of this parameter.
1131 &quot;arrayValues&quot;: [ # [Optional] The array values, if this is an array type.
1132 # Object with schema name: QueryParameterValue
1133 ],
1134 &quot;value&quot;: &quot;A String&quot;, # [Optional] The value of this value, if a simple scalar type.
1135 &quot;structValues&quot;: { # [Optional] The struct field values, in order of the struct type&#x27;s declaration.
1136 &quot;a_key&quot;: # Object with schema name: QueryParameterValue
1137 },
1138 },
1139 &quot;name&quot;: &quot;A String&quot;, # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
1140 &quot;parameterType&quot;: { # [Required] The type of this parameter.
1141 &quot;arrayType&quot;: # Object with schema name: QueryParameterType # [Optional] The type of the array&#x27;s elements, if this is an array.
1142 &quot;structTypes&quot;: [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
1143 {
1144 &quot;type&quot;: # Object with schema name: QueryParameterType # [Required] The type of this field.
1145 &quot;description&quot;: &quot;A String&quot;, # [Optional] Human-oriented description of the field.
1146 &quot;name&quot;: &quot;A String&quot;, # [Optional] The name of this field.
1147 },
1148 ],
1149 &quot;type&quot;: &quot;A String&quot;, # [Required] The top level type of this field.
1150 },
1151 },
1152 ],
1153 &quot;allowLargeResults&quot;: false, # [Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size.
1154 &quot;maximumBytesBilled&quot;: &quot;A String&quot;, # [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.
1155 &quot;destinationEncryptionConfiguration&quot;: { # Custom encryption configuration (e.g., Cloud KMS keys).
1156 &quot;kmsKeyName&quot;: &quot;A String&quot;, # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
1157 },
1158 &quot;useLegacySql&quot;: true, # Specifies whether to use BigQuery&#x27;s legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery&#x27;s standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.
1159 &quot;parameterMode&quot;: &quot;A String&quot;, # Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
1160 &quot;connectionProperties&quot;: [ # Connection properties.
1161 {
1162 &quot;key&quot;: &quot;A String&quot;, # [Required] Name of the connection property to set.
1163 &quot;value&quot;: &quot;A String&quot;, # [Required] Value of the connection property.
1164 },
1165 ],
1166 &quot;timePartitioning&quot;: { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
1167 &quot;requirePartitionFilter&quot;: True or False,
1168 &quot;type&quot;: &quot;A String&quot;, # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.
1169 &quot;expirationMs&quot;: &quot;A String&quot;, # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
1170 &quot;field&quot;: &quot;A String&quot;, # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either &#x27;_PARTITIONTIME&#x27; as TIMESTAMP type, or &#x27;_PARTITIONDATE&#x27; as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
1171 },
1172 &quot;schemaUpdateOptions&quot;: [ # Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
1173 &quot;A String&quot;,
1174 ],
1175 &quot;preserveNulls&quot;: True or False, # [Deprecated] This property is deprecated.
1176 &quot;userDefinedFunctionResources&quot;: [ # Describes user-defined function resources used in the query.
1177 { # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions
1178 &quot;inlineCode&quot;: &quot;A String&quot;, # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
1179 &quot;resourceUri&quot;: &quot;A String&quot;, # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
1180 },
1181 ],
1182 &quot;defaultDataset&quot;: { # [Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names.
1183 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
1184 &quot;projectId&quot;: &quot;A String&quot;, # [Optional] The ID of the project containing this dataset.
1185 },
1186 &quot;useQueryCache&quot;: true, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.
1187 &quot;clustering&quot;: { # [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
1188 &quot;fields&quot;: [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
1189 &quot;A String&quot;,
1190 ],
1191 },
1192 &quot;createDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a &#x27;notFound&#x27; error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
1193 &quot;writeDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a &#x27;duplicate&#x27; error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
1194 },
1195 &quot;labels&quot;: { # The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
1196 &quot;a_key&quot;: &quot;A String&quot;,
1197 },
1198 &quot;jobTimeoutMs&quot;: &quot;A String&quot;, # [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
1199 &quot;copy&quot;: { # [Pick one] Copies a table.
1200 &quot;sourceTable&quot;: { # [Pick one] Source table to copy.
1201 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
1202 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
1203 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
1204 },
1205 &quot;destinationEncryptionConfiguration&quot;: { # Custom encryption configuration (e.g., Cloud KMS keys).
1206 &quot;kmsKeyName&quot;: &quot;A String&quot;, # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
1207 },
1208 &quot;destinationTable&quot;: { # [Required] The destination table
1209 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
1210 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
1211 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
1212 },
1213 &quot;operationType&quot;: &quot;A String&quot;, # [Optional] Supported operation types in table copy job.
1214 &quot;writeDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a &#x27;duplicate&#x27; error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
1215 &quot;destinationExpirationTime&quot;: &quot;&quot;, # [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
1216 &quot;sourceTables&quot;: [ # [Pick one] Source tables to copy.
1217 {
1218 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
1219 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
1220 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
1221 },
1222 ],
1223 &quot;createDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a &#x27;notFound&#x27; error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
1224 },
1225 },
1226 }</pre>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1227</div>
1228
1229<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1230 <code class="details" id="getQueryResults">getQueryResults(projectId, jobId, maxResults=None, startIndex=None, pageToken=None, location=None, timeoutMs=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1231 <pre>Retrieves the results of a query job.
1232
1233Args:
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1234 projectId: string, [Required] Project ID of the query job (required)
1235 jobId: string, [Required] Job ID of the query job (required)
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1236 maxResults: integer, Maximum number of results to read
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1237 startIndex: string, Zero-based index of the starting row
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1238 pageToken: string, Page token, returned by a previous call, to request the next page of results
1239 location: string, The geographic location where the job should run. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1240 timeoutMs: integer, How long to wait for the query to complete, in milliseconds, before returning. Default is 10 seconds. If the timeout passes before the job completes, the &#x27;jobComplete&#x27; field in the response will be false
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1241
1242Returns:
1243 An object of the form:
1244
1245 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1246 &quot;numDmlAffectedRows&quot;: &quot;A String&quot;, # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
1247 &quot;totalBytesProcessed&quot;: &quot;A String&quot;, # The total number of bytes processed for this query.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1248 &quot;schema&quot;: { # The schema of the results. Present only when the query completes successfully.
1249 &quot;fields&quot;: [ # Describes the fields in a table.
1250 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1251 &quot;type&quot;: &quot;A String&quot;, # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
1252 &quot;categories&quot;: { # [Optional] The categories attached to this field, used for field-level access control.
1253 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/taxonomies/2/categories/3&quot;. At most 5 categories are allowed.
1254 &quot;A String&quot;,
1255 ],
1256 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1257 &quot;fields&quot;: [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
1258 # Object with schema name: TableFieldSchema
1259 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1260 &quot;name&quot;: &quot;A String&quot;, # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1261 &quot;description&quot;: &quot;A String&quot;, # [Optional] The field description. The maximum length is 1,024 characters.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1262 &quot;policyTags&quot;: {
1263 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/location/eu/taxonomies/2/policyTags/3&quot;. At most 1 policy tag is allowed.
1264 &quot;A String&quot;,
1265 ],
1266 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1267 &quot;mode&quot;: &quot;A String&quot;, # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1268 },
1269 ],
1270 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1271 &quot;jobComplete&quot;: True or False, # Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1272 &quot;errors&quot;: [ # [Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
1273 {
1274 &quot;reason&quot;: &quot;A String&quot;, # A short error code that summarizes the error.
1275 &quot;debugInfo&quot;: &quot;A String&quot;, # Debugging information. This property is internal to Google and should not be used.
1276 &quot;location&quot;: &quot;A String&quot;, # Specifies where the error occurred, if present.
1277 &quot;message&quot;: &quot;A String&quot;, # A human-readable description of the error.
1278 },
1279 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1280 &quot;jobReference&quot;: { # Reference to the BigQuery Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).
1281 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this job.
1282 &quot;location&quot;: &quot;A String&quot;, # The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
1283 &quot;jobId&quot;: &quot;A String&quot;, # [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
1284 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1285 &quot;kind&quot;: &quot;bigquery#getQueryResultsResponse&quot;, # The resource type of the response.
1286 &quot;etag&quot;: &quot;A String&quot;, # A hash of this response.
1287 &quot;totalRows&quot;: &quot;A String&quot;, # The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. Present only when the query completes successfully.
1288 &quot;cacheHit&quot;: True or False, # Whether the query result was fetched from the query cache.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1289 &quot;pageToken&quot;: &quot;A String&quot;, # A token used for paging results.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1290 &quot;rows&quot;: [ # An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Present only when the query completes successfully.
1291 {
1292 &quot;f&quot;: [ # Represents a single row in the result set, consisting of one or more fields.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1293 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1294 &quot;v&quot;: &quot;&quot;,
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1295 },
1296 ],
1297 },
1298 ],
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1299 }</pre>
1300</div>
1301
1302<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1303 <code class="details" id="getQueryResults_next">getQueryResults_next(previous_request, previous_response)</code>
1304 <pre>Retrieves the next page of results.
1305
1306Args:
1307 previous_request: The request for the previous page. (required)
1308 previous_response: The response from the request for the previous page. (required)
1309
1310Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]1311 A request object that you can call &#x27;execute()&#x27; on to request the next
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1312 page. Returns None if there are no more items in the collection.
1313 </pre>
1314</div>
1315
1316<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1317 <code class="details" id="insert">insert(projectId, body=None, media_body=None, media_mime_type=None)</code>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1318 <pre>Starts a new asynchronous job. Requires the Can View project role.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]1319
1320Args:
1321 projectId: string, Project ID of the project that will be billed for the job (required)
1322 body: object, The request body.
1323 The object takes the form of:
1324
1325{
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1326 &quot;id&quot;: &quot;A String&quot;, # [Output-only] Opaque ID field of the job
1327 &quot;selfLink&quot;: &quot;A String&quot;, # [Output-only] A URL that can be used to access this resource again.
1328 &quot;kind&quot;: &quot;bigquery#job&quot;, # [Output-only] The type of the resource.
1329 &quot;etag&quot;: &quot;A String&quot;, # [Output-only] A hash of this resource.
1330 &quot;status&quot;: { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
1331 &quot;state&quot;: &quot;A String&quot;, # [Output-only] Running state of the job.
1332 &quot;errors&quot;: [ # [Output-only] The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
1333 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1334 &quot;reason&quot;: &quot;A String&quot;, # A short error code that summarizes the error.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]1335 &quot;debugInfo&quot;: &quot;A String&quot;, # Debugging information. This property is internal to Google and should not be used.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1336 &quot;location&quot;: &quot;A String&quot;, # Specifies where the error occurred, if present.
1337 &quot;message&quot;: &quot;A String&quot;, # A human-readable description of the error.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]1338 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1339 ],
1340 &quot;errorResult&quot;: { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
1341 &quot;reason&quot;: &quot;A String&quot;, # A short error code that summarizes the error.
1342 &quot;debugInfo&quot;: &quot;A String&quot;, # Debugging information. This property is internal to Google and should not be used.
1343 &quot;location&quot;: &quot;A String&quot;, # Specifies where the error occurred, if present.
1344 &quot;message&quot;: &quot;A String&quot;, # A human-readable description of the error.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]1345 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1346 },
1347 &quot;statistics&quot;: { # [Output-only] Information about the job, including starting time and ending time of the job.
1348 &quot;startTime&quot;: &quot;A String&quot;, # [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
1349 &quot;completionRatio&quot;: 3.14, # [TrustedTester] [Output-only] Job progress (0.0 -&gt; 1.0) for LOAD and EXTRACT jobs.
1350 &quot;rowLevelSecurityStatistics&quot;: { # [Output-only] [Preview] Statistics for row-level security. Present only for query and extract jobs.
1351 &quot;rowLevelSecurityApplied&quot;: True or False, # [Output-only] [Preview] Whether any accessed data was protected by row access policies.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1352 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1353 &quot;numChildJobs&quot;: &quot;A String&quot;, # [Output-only] Number of child jobs executed.
1354 &quot;extract&quot;: { # [Output-only] Statistics for an extract job.
1355 &quot;inputBytes&quot;: &quot;A String&quot;, # [Output-only] Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.
1356 &quot;destinationUriFileCounts&quot;: [ # [Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the &#x27;destinationUris&#x27; field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1357 &quot;A String&quot;,
1358 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1359 },
1360 &quot;transactionInfoTemplate&quot;: { # [Output-only] [Alpha] Information of the multi-statement transaction if this job is part of one.
1361 &quot;transactionId&quot;: &quot;A String&quot;, # [Output-only] // [Alpha] Id of the transaction.
1362 },
1363 &quot;reservationUsage&quot;: [ # [Output-only] Job resource usage breakdown by reservation.
1364 {
1365 &quot;slotMs&quot;: &quot;A String&quot;, # [Output-only] Slot-milliseconds the job spent in the given reservation.
1366 &quot;name&quot;: &quot;A String&quot;, # [Output-only] Reservation name or &quot;unreserved&quot; for on-demand resources usage.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1367 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1368 ],
1369 &quot;creationTime&quot;: &quot;A String&quot;, # [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
1370 &quot;totalBytesProcessed&quot;: &quot;A String&quot;, # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
1371 &quot;reservation_id&quot;: &quot;A String&quot;, # [Output-only] Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.
1372 &quot;endTime&quot;: &quot;A String&quot;, # [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
1373 &quot;query&quot;: { # [Output-only] Statistics for a query job.
1374 &quot;undeclaredQueryParameters&quot;: [ # Standard SQL only: list of undeclared query parameters detected during a dry run validation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1375 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1376 &quot;parameterValue&quot;: { # [Required] The value of this parameter.
1377 &quot;arrayValues&quot;: [ # [Optional] The array values, if this is an array type.
1378 # Object with schema name: QueryParameterValue
1379 ],
1380 &quot;value&quot;: &quot;A String&quot;, # [Optional] The value of this value, if a simple scalar type.
1381 &quot;structValues&quot;: { # [Optional] The struct field values, in order of the struct type&#x27;s declaration.
1382 &quot;a_key&quot;: # Object with schema name: QueryParameterValue
1383 },
1384 },
1385 &quot;name&quot;: &quot;A String&quot;, # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
1386 &quot;parameterType&quot;: { # [Required] The type of this parameter.
1387 &quot;arrayType&quot;: # Object with schema name: QueryParameterType # [Optional] The type of the array&#x27;s elements, if this is an array.
1388 &quot;structTypes&quot;: [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
1389 {
1390 &quot;type&quot;: # Object with schema name: QueryParameterType # [Required] The type of this field.
1391 &quot;description&quot;: &quot;A String&quot;, # [Optional] Human-oriented description of the field.
1392 &quot;name&quot;: &quot;A String&quot;, # [Optional] The name of this field.
1393 },
1394 ],
1395 &quot;type&quot;: &quot;A String&quot;, # [Required] The top level type of this field.
1396 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1397 },
1398 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1399 &quot;ddlOperationPerformed&quot;: &quot;A String&quot;, # The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): &quot;CREATE&quot;: The query created the DDL target. &quot;SKIP&quot;: No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. &quot;REPLACE&quot;: The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. &quot;DROP&quot;: The query deleted the DDL target.
1400 &quot;schema&quot;: { # [Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
1401 &quot;fields&quot;: [ # Describes the fields in a table.
1402 {
1403 &quot;type&quot;: &quot;A String&quot;, # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
1404 &quot;categories&quot;: { # [Optional] The categories attached to this field, used for field-level access control.
1405 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/taxonomies/2/categories/3&quot;. At most 5 categories are allowed.
1406 &quot;A String&quot;,
1407 ],
1408 },
1409 &quot;fields&quot;: [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
1410 # Object with schema name: TableFieldSchema
1411 ],
1412 &quot;name&quot;: &quot;A String&quot;, # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
1413 &quot;description&quot;: &quot;A String&quot;, # [Optional] The field description. The maximum length is 1,024 characters.
1414 &quot;policyTags&quot;: {
1415 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/location/eu/taxonomies/2/policyTags/3&quot;. At most 1 policy tag is allowed.
1416 &quot;A String&quot;,
1417 ],
1418 },
1419 &quot;mode&quot;: &quot;A String&quot;, # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
1420 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1421 ],
1422 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1423 &quot;totalSlotMs&quot;: &quot;A String&quot;, # [Output-only] Slot-milliseconds for the job.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1424 &quot;modelTrainingCurrentIteration&quot;: 42, # [Output-only, Beta] Deprecated; do not use.
1425 &quot;billingTier&quot;: 42, # [Output-only] Billing tier for the job.
1426 &quot;estimatedBytesProcessed&quot;: &quot;A String&quot;, # [Output-only] The original estimate of bytes processed for the job.
1427 &quot;totalBytesProcessed&quot;: &quot;A String&quot;, # [Output-only] Total bytes processed for the job.
1428 &quot;statementType&quot;: &quot;A String&quot;, # The type of query statement, if valid. Possible values (new values might be added in the future): &quot;SELECT&quot;: SELECT query. &quot;INSERT&quot;: INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. &quot;UPDATE&quot;: UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. &quot;DELETE&quot;: DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. &quot;MERGE&quot;: MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. &quot;ALTER_TABLE&quot;: ALTER TABLE query. &quot;ALTER_VIEW&quot;: ALTER VIEW query. &quot;ASSERT&quot;: ASSERT condition AS &#x27;description&#x27;. &quot;CREATE_FUNCTION&quot;: CREATE FUNCTION query. &quot;CREATE_MODEL&quot;: CREATE [OR REPLACE] MODEL ... AS SELECT ... . &quot;CREATE_PROCEDURE&quot;: CREATE PROCEDURE query. &quot;CREATE_TABLE&quot;: CREATE [OR REPLACE] TABLE without AS SELECT. &quot;CREATE_TABLE_AS_SELECT&quot;: CREATE [OR REPLACE] TABLE ... AS SELECT ... . &quot;CREATE_VIEW&quot;: CREATE [OR REPLACE] VIEW ... AS SELECT ... . &quot;DROP_FUNCTION&quot; : DROP FUNCTION query. &quot;DROP_PROCEDURE&quot;: DROP PROCEDURE query. &quot;DROP_TABLE&quot;: DROP TABLE query. &quot;DROP_VIEW&quot;: DROP VIEW query.
1429 &quot;ddlAffectedRowAccessPolicyCount&quot;: &quot;A String&quot;, # [Output-only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
1430 &quot;referencedTables&quot;: [ # [Output-only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
1431 {
1432 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
1433 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
1434 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
1435 },
1436 ],
1437 &quot;totalPartitionsProcessed&quot;: &quot;A String&quot;, # [Output-only] Total number of partitions processed from all partitioned tables referenced in the job.
1438 &quot;ddlTargetTable&quot;: { # [Output-only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
1439 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
1440 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
1441 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
1442 },
1443 &quot;referencedRoutines&quot;: [ # [Output-only] Referenced routines (persistent user-defined functions and stored procedures) for the job.
1444 {
1445 &quot;routineId&quot;: &quot;A String&quot;, # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
1446 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this routine.
1447 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this routine.
1448 },
1449 ],
1450 &quot;timeline&quot;: [ # [Output-only] [Beta] Describes a timeline of job execution.
1451 {
1452 &quot;activeUnits&quot;: &quot;A String&quot;, # Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
1453 &quot;completedUnits&quot;: &quot;A String&quot;, # Total parallel units of work completed by this query.
1454 &quot;pendingUnits&quot;: &quot;A String&quot;, # Total parallel units of work remaining for the active stages.
1455 &quot;totalSlotMs&quot;: &quot;A String&quot;, # Cumulative slot-ms consumed by the query.
1456 &quot;elapsedMs&quot;: &quot;A String&quot;, # Milliseconds elapsed since the start of query execution.
1457 },
1458 ],
1459 &quot;totalBytesBilled&quot;: &quot;A String&quot;, # [Output-only] Total bytes billed for the job.
1460 &quot;modelTraining&quot;: { # [Output-only, Beta] Information about create model query job progress.
1461 &quot;expectedTotalIterations&quot;: &quot;A String&quot;, # [Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.
1462 &quot;currentIteration&quot;: 42, # [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.
1463 },
1464 &quot;numDmlAffectedRows&quot;: &quot;A String&quot;, # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
1465 &quot;queryPlan&quot;: [ # [Output-only] Describes execution plan for the query.
1466 {
1467 &quot;computeRatioAvg&quot;: 3.14, # Relative amount of time the average shard spent on CPU-bound tasks.
1468 &quot;waitMsMax&quot;: &quot;A String&quot;, # Milliseconds the slowest shard spent waiting to be scheduled.
1469 &quot;shuffleOutputBytes&quot;: &quot;A String&quot;, # Total number of bytes written to shuffle.
1470 &quot;computeMsAvg&quot;: &quot;A String&quot;, # Milliseconds the average shard spent on CPU-bound tasks.
1471 &quot;writeMsMax&quot;: &quot;A String&quot;, # Milliseconds the slowest shard spent on writing output.
1472 &quot;waitMsAvg&quot;: &quot;A String&quot;, # Milliseconds the average shard spent waiting to be scheduled.
1473 &quot;computeRatioMax&quot;: 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks.
1474 &quot;writeMsAvg&quot;: &quot;A String&quot;, # Milliseconds the average shard spent on writing output.
1475 &quot;slotMs&quot;: &quot;A String&quot;, # Slot-milliseconds used by the stage.
1476 &quot;readMsAvg&quot;: &quot;A String&quot;, # Milliseconds the average shard spent reading input.
1477 &quot;waitRatioMax&quot;: 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled.
1478 &quot;shuffleOutputBytesSpilled&quot;: &quot;A String&quot;, # Total number of bytes written to shuffle and spilled to disk.
1479 &quot;startMs&quot;: &quot;A String&quot;, # Stage start time represented as milliseconds since epoch.
1480 &quot;completedParallelInputs&quot;: &quot;A String&quot;, # Number of parallel input segments completed.
1481 &quot;recordsRead&quot;: &quot;A String&quot;, # Number of records read into the stage.
1482 &quot;inputStages&quot;: [ # IDs for stages that are inputs to this stage.
1483 &quot;A String&quot;,
1484 ],
1485 &quot;computeMsMax&quot;: &quot;A String&quot;, # Milliseconds the slowest shard spent on CPU-bound tasks.
1486 &quot;id&quot;: &quot;A String&quot;, # Unique ID for stage within plan.
1487 &quot;readRatioMax&quot;: 3.14, # Relative amount of time the slowest shard spent reading input.
1488 &quot;writeRatioMax&quot;: 3.14, # Relative amount of time the slowest shard spent on writing output.
1489 &quot;readMsMax&quot;: &quot;A String&quot;, # Milliseconds the slowest shard spent reading input.
1490 &quot;readRatioAvg&quot;: 3.14, # Relative amount of time the average shard spent reading input.
1491 &quot;status&quot;: &quot;A String&quot;, # Current status for the stage.
1492 &quot;waitRatioAvg&quot;: 3.14, # Relative amount of time the average shard spent waiting to be scheduled.
1493 &quot;name&quot;: &quot;A String&quot;, # Human-readable name for stage.
1494 &quot;endMs&quot;: &quot;A String&quot;, # Stage end time represented as milliseconds since epoch.
1495 &quot;parallelInputs&quot;: &quot;A String&quot;, # Number of parallel input segments to be processed.
1496 &quot;recordsWritten&quot;: &quot;A String&quot;, # Number of records written by the stage.
1497 &quot;steps&quot;: [ # List of operations within the stage in dependency order (approximately chronological).
1498 {
1499 &quot;kind&quot;: &quot;A String&quot;, # Machine-readable operation type.
1500 &quot;substeps&quot;: [ # Human-readable stage descriptions.
1501 &quot;A String&quot;,
1502 ],
1503 },
1504 ],
1505 &quot;writeRatioAvg&quot;: 3.14, # Relative amount of time the average shard spent on writing output.
1506 },
1507 ],
1508 &quot;totalBytesProcessedAccuracy&quot;: &quot;A String&quot;, # [Output-only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
1509 &quot;cacheHit&quot;: True or False, # [Output-only] Whether the query result was fetched from the query cache.
1510 &quot;modelTrainingExpectedTotalIteration&quot;: &quot;A String&quot;, # [Output-only, Beta] Deprecated; do not use.
1511 &quot;ddlTargetRowAccessPolicy&quot;: { # [Output-only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
1512 &quot;policyId&quot;: &quot;A String&quot;, # [Required] The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
1513 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this row access policy.
1514 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table containing this row access policy.
1515 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this row access policy.
1516 },
1517 &quot;reservationUsage&quot;: [ # [Output-only] Job resource usage breakdown by reservation.
1518 {
1519 &quot;slotMs&quot;: &quot;A String&quot;, # [Output-only] Slot-milliseconds the job spent in the given reservation.
1520 &quot;name&quot;: &quot;A String&quot;, # [Output-only] Reservation name or &quot;unreserved&quot; for on-demand resources usage.
1521 },
1522 ],
1523 &quot;ddlTargetRoutine&quot;: { # The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
1524 &quot;routineId&quot;: &quot;A String&quot;, # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
1525 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this routine.
1526 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this routine.
1527 },
1528 },
1529 &quot;quotaDeferments&quot;: [ # [Output-only] Quotas which delayed this job&#x27;s start time.
1530 &quot;A String&quot;,
1531 ],
1532 &quot;scriptStatistics&quot;: { # [Output-only] Statistics for a child job of a script.
1533 &quot;stackFrames&quot;: [ # Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty.
1534 {
1535 &quot;procedureId&quot;: &quot;A String&quot;, # [Output-only] Name of the active procedure, empty if in a top-level script.
1536 &quot;startColumn&quot;: 42, # [Output-only] One-based start column.
1537 &quot;startLine&quot;: 42, # [Output-only] One-based start line.
1538 &quot;endColumn&quot;: 42, # [Output-only] One-based end column.
1539 &quot;endLine&quot;: 42, # [Output-only] One-based end line.
1540 &quot;text&quot;: &quot;A String&quot;, # [Output-only] Text of the current statement/expression.
1541 },
1542 ],
1543 &quot;evaluationKind&quot;: &quot;A String&quot;, # [Output-only] Whether this child job was a statement or expression.
1544 },
1545 &quot;parentJobId&quot;: &quot;A String&quot;, # [Output-only] If this is a child job, the id of the parent.
1546 &quot;totalSlotMs&quot;: &quot;A String&quot;, # [Output-only] Slot-milliseconds for the job.
1547 &quot;load&quot;: { # [Output-only] Statistics for a load job.
1548 &quot;outputRows&quot;: &quot;A String&quot;, # [Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
1549 &quot;inputFileBytes&quot;: &quot;A String&quot;, # [Output-only] Number of bytes of source data in a load job.
1550 &quot;badRecords&quot;: &quot;A String&quot;, # [Output-only] The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.
1551 &quot;outputBytes&quot;: &quot;A String&quot;, # [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
1552 &quot;inputFiles&quot;: &quot;A String&quot;, # [Output-only] Number of source files in a load job.
1553 },
1554 },
1555 &quot;user_email&quot;: &quot;A String&quot;, # [Output-only] Email address of the user who ran the job.
1556 &quot;jobReference&quot;: { # [Optional] Reference describing the unique-per-user name of the job.
1557 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this job.
1558 &quot;location&quot;: &quot;A String&quot;, # The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
1559 &quot;jobId&quot;: &quot;A String&quot;, # [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
1560 },
1561 &quot;configuration&quot;: { # [Required] Describes the job configuration.
1562 &quot;extract&quot;: { # [Pick one] Configures an extract job.
1563 &quot;compression&quot;: &quot;A String&quot;, # [Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
1564 &quot;destinationUris&quot;: [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
1565 &quot;A String&quot;,
1566 ],
1567 &quot;useAvroLogicalTypes&quot;: True or False, # [Optional] If destinationFormat is set to &quot;AVRO&quot;, this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
1568 &quot;destinationFormat&quot;: &quot;A String&quot;, # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
1569 &quot;sourceTable&quot;: { # A reference to the table being exported.
1570 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
1571 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
1572 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
1573 },
1574 &quot;destinationUri&quot;: &quot;A String&quot;, # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
1575 &quot;fieldDelimiter&quot;: &quot;A String&quot;, # [Optional] Delimiter to use between fields in the exported data. Default is &#x27;,&#x27;. Not applicable when extracting models.
1576 &quot;printHeader&quot;: true, # [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
1577 &quot;sourceModel&quot;: { # A reference to the model being exported.
1578 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this model.
1579 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this model.
1580 &quot;modelId&quot;: &quot;A String&quot;, # [Required] The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
1581 },
1582 },
1583 &quot;dryRun&quot;: True or False, # [Optional] If set, don&#x27;t actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn&#x27;t a dry run. Behavior of non-query jobs is undefined.
1584 &quot;load&quot;: { # [Pick one] Configures a load job.
1585 &quot;allowQuotedNewlines&quot;: True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
1586 &quot;schema&quot;: { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you&#x27;re loading data from Google Cloud Datastore.
1587 &quot;fields&quot;: [ # Describes the fields in a table.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1588 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1589 &quot;type&quot;: &quot;A String&quot;, # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
1590 &quot;categories&quot;: { # [Optional] The categories attached to this field, used for field-level access control.
1591 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/taxonomies/2/categories/3&quot;. At most 5 categories are allowed.
1592 &quot;A String&quot;,
1593 ],
1594 },
1595 &quot;fields&quot;: [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
1596 # Object with schema name: TableFieldSchema
1597 ],
1598 &quot;name&quot;: &quot;A String&quot;, # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
1599 &quot;description&quot;: &quot;A String&quot;, # [Optional] The field description. The maximum length is 1,024 characters.
1600 &quot;policyTags&quot;: {
1601 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/location/eu/taxonomies/2/policyTags/3&quot;. At most 1 policy tag is allowed.
1602 &quot;A String&quot;,
1603 ],
1604 },
1605 &quot;mode&quot;: &quot;A String&quot;, # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1606 },
1607 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1608 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1609 &quot;decimalTargetTypes&quot;: [ # [Trusted Tester] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. For example: suppose decimal_target_type = [&quot;NUMERIC&quot;, &quot;BIGNUMERIC&quot;]. Then if (precision,scale) is: * (38,9) -&gt; NUMERIC; * (39,9) -&gt; BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -&gt; BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -&gt; BIGNUMERIC; * (77,38) -&gt; BIGNUMERIC (error if value exeeds supported range). For duplicated types in this field, only one will be considered and the rest will be ignored. The order of the types in this field is ignored. For example, [&quot;BIGNUMERIC&quot;, &quot;NUMERIC&quot;] is the same as [&quot;NUMERIC&quot;, &quot;BIGNUMERIC&quot;] and NUMERIC always takes precedence over BIGNUMERIC.
1610 &quot;A String&quot;,
1611 ],
1612 &quot;skipLeadingRows&quot;: 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
1613 &quot;timePartitioning&quot;: { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
1614 &quot;requirePartitionFilter&quot;: True or False,
1615 &quot;type&quot;: &quot;A String&quot;, # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.
1616 &quot;expirationMs&quot;: &quot;A String&quot;, # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
1617 &quot;field&quot;: &quot;A String&quot;, # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either &#x27;_PARTITIONTIME&#x27; as TIMESTAMP type, or &#x27;_PARTITIONDATE&#x27; as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1618 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1619 &quot;destinationEncryptionConfiguration&quot;: { # Custom encryption configuration (e.g., Cloud KMS keys).
1620 &quot;kmsKeyName&quot;: &quot;A String&quot;, # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
1621 },
1622 &quot;schemaUpdateOptions&quot;: [ # Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
1623 &quot;A String&quot;,
1624 ],
1625 &quot;destinationTable&quot;: { # [Required] The destination table to load the data into.
1626 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
1627 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
1628 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
1629 },
1630 &quot;schemaInline&quot;: &quot;A String&quot;, # [Deprecated] The inline schema. For CSV schemas, specify as &quot;Field1:Type1[,Field2:Type2]*&quot;. For example, &quot;foo:STRING, bar:INTEGER, baz:FLOAT&quot;.
1631 &quot;projectionFields&quot;: [ # If sourceFormat is set to &quot;DATASTORE_BACKUP&quot;, indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn&#x27;t found in the Cloud Datastore backup, an invalid error is returned in the job result.
1632 &quot;A String&quot;,
1633 ],
1634 &quot;maxBadRecords&quot;: 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
1635 &quot;allowJaggedRows&quot;: True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
1636 &quot;schemaInlineFormat&quot;: &quot;A String&quot;, # [Deprecated] The format of the schemaInline property.
1637 &quot;autodetect&quot;: True or False, # [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
1638 &quot;encoding&quot;: &quot;A String&quot;, # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
1639 &quot;destinationTableProperties&quot;: { # [Beta] [Optional] Properties with which to create the destination table if it is new.
1640 &quot;labels&quot;: { # [Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
1641 &quot;a_key&quot;: &quot;A String&quot;,
1642 },
1643 &quot;description&quot;: &quot;A String&quot;, # [Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
1644 &quot;friendlyName&quot;: &quot;A String&quot;, # [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
1645 },
1646 &quot;createDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a &#x27;notFound&#x27; error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
1647 &quot;sourceUris&quot;: [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one &#x27;*&#x27; wildcard character and it must come after the &#x27;bucket&#x27; name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the &#x27;*&#x27; wildcard character is not allowed.
1648 &quot;A String&quot;,
1649 ],
1650 &quot;rangePartitioning&quot;: { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
1651 &quot;field&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
1652 &quot;range&quot;: { # [TrustedTester] [Required] Defines the ranges for range partitioning.
1653 &quot;interval&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The width of each interval.
1654 &quot;end&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The end of range partitioning, exclusive.
1655 &quot;start&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The start of range partitioning, inclusive.
1656 },
1657 },
1658 &quot;useAvroLogicalTypes&quot;: True or False, # [Optional] If sourceFormat is set to &quot;AVRO&quot;, indicates whether to enable interpreting logical types into their corresponding types (ie. TIMESTAMP), instead of only using their raw types (ie. INTEGER).
1659 &quot;ignoreUnknownValues&quot;: True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don&#x27;t match any column names
1660 &quot;sourceFormat&quot;: &quot;A String&quot;, # [Optional] The format of the data files. For CSV files, specify &quot;CSV&quot;. For datastore backups, specify &quot;DATASTORE_BACKUP&quot;. For newline-delimited JSON, specify &quot;NEWLINE_DELIMITED_JSON&quot;. For Avro, specify &quot;AVRO&quot;. For parquet, specify &quot;PARQUET&quot;. For orc, specify &quot;ORC&quot;. The default value is CSV.
1661 &quot;fieldDelimiter&quot;: &quot;A String&quot;, # [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence &quot;\t&quot; to specify a tab separator. The default value is a comma (&#x27;,&#x27;).
1662 &quot;clustering&quot;: { # [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
1663 &quot;fields&quot;: [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
1664 &quot;A String&quot;,
1665 ],
1666 },
1667 &quot;nullMarker&quot;: &quot;A String&quot;, # [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify &quot;\N&quot;, BigQuery interprets &quot;\N&quot; as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
1668 &quot;quote&quot;: &quot;&quot;&quot;, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote (&#x27;&quot;&#x27;). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
1669 &quot;hivePartitioningOptions&quot;: { # [Optional, Trusted Tester] Options to configure hive partitioning support.
1670 &quot;requirePartitionFilter&quot;: True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
1671 &quot;mode&quot;: &quot;A String&quot;, # [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
1672 &quot;sourceUriPrefix&quot;: &quot;A String&quot;, # [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
1673 },
1674 &quot;writeDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a &#x27;duplicate&#x27; error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1675 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1676 &quot;jobType&quot;: &quot;A String&quot;, # [Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
1677 &quot;query&quot;: { # [Pick one] Configures a query job.
1678 &quot;query&quot;: &quot;A String&quot;, # [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.
1679 &quot;flattenResults&quot;: true, # [Optional] If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened.
1680 &quot;rangePartitioning&quot;: { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
1681 &quot;field&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
1682 &quot;range&quot;: { # [TrustedTester] [Required] Defines the ranges for range partitioning.
1683 &quot;interval&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The width of each interval.
1684 &quot;end&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The end of range partitioning, exclusive.
1685 &quot;start&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The start of range partitioning, inclusive.
1686 },
1687 },
1688 &quot;maximumBillingTier&quot;: 1, # [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.
1689 &quot;priority&quot;: &quot;A String&quot;, # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
1690 &quot;destinationTable&quot;: { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size.
1691 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
1692 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
1693 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
1694 },
1695 &quot;tableDefinitions&quot;: { # [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
1696 &quot;a_key&quot;: {
1697 &quot;hivePartitioningOptions&quot;: { # [Optional, Trusted Tester] Options to configure hive partitioning support.
1698 &quot;requirePartitionFilter&quot;: True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
1699 &quot;mode&quot;: &quot;A String&quot;, # [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
1700 &quot;sourceUriPrefix&quot;: &quot;A String&quot;, # [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
1701 },
1702 &quot;schema&quot;: { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
1703 &quot;fields&quot;: [ # Describes the fields in a table.
1704 {
1705 &quot;type&quot;: &quot;A String&quot;, # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
1706 &quot;categories&quot;: { # [Optional] The categories attached to this field, used for field-level access control.
1707 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/taxonomies/2/categories/3&quot;. At most 5 categories are allowed.
1708 &quot;A String&quot;,
1709 ],
1710 },
1711 &quot;fields&quot;: [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
1712 # Object with schema name: TableFieldSchema
1713 ],
1714 &quot;name&quot;: &quot;A String&quot;, # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
1715 &quot;description&quot;: &quot;A String&quot;, # [Optional] The field description. The maximum length is 1,024 characters.
1716 &quot;policyTags&quot;: {
1717 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/location/eu/taxonomies/2/policyTags/3&quot;. At most 1 policy tag is allowed.
1718 &quot;A String&quot;,
1719 ],
1720 },
1721 &quot;mode&quot;: &quot;A String&quot;, # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
1722 },
1723 ],
1724 },
1725 &quot;maxBadRecords&quot;: 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
1726 &quot;bigtableOptions&quot;: { # [Optional] Additional options if sourceFormat is set to BIGTABLE.
1727 &quot;readRowkeyAsString&quot;: True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
1728 &quot;ignoreUnspecifiedColumnFamilies&quot;: True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
1729 &quot;columnFamilies&quot;: [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the &#x27;type&#x27; field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
1730 {
1731 &quot;encoding&quot;: &quot;A String&quot;, # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in &#x27;columns&#x27; and specifying an encoding for it.
1732 &quot;onlyReadLatest&quot;: True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in &#x27;columns&#x27; and specifying a different setting for that column.
1733 &quot;familyId&quot;: &quot;A String&quot;, # Identifier of the column family.
1734 &quot;columns&quot;: [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.
1735 {
1736 &quot;fieldName&quot;: &quot;A String&quot;, # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
1737 &quot;encoding&quot;: &quot;A String&quot;, # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. &#x27;encoding&#x27; can also be set at the column family level. However, the setting at this level takes precedence if &#x27;encoding&#x27; is set at both levels.
1738 &quot;type&quot;: &quot;A String&quot;, # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. &#x27;type&#x27; can also be set at the column family level. However, the setting at this level takes precedence if &#x27;type&#x27; is set at both levels.
1739 &quot;qualifierString&quot;: &quot;A String&quot;,
1740 &quot;qualifierEncoded&quot;: &quot;A String&quot;, # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.
1741 &quot;onlyReadLatest&quot;: True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. &#x27;onlyReadLatest&#x27; can also be set at the column family level. However, the setting at this level takes precedence if &#x27;onlyReadLatest&#x27; is set at both levels.
1742 },
1743 ],
1744 &quot;type&quot;: &quot;A String&quot;, # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in &#x27;columns&#x27; and specifying a type for it.
1745 },
1746 ],
1747 },
1748 &quot;autodetect&quot;: True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.
1749 &quot;sourceFormat&quot;: &quot;A String&quot;, # [Required] The data format. For CSV files, specify &quot;CSV&quot;. For Google sheets, specify &quot;GOOGLE_SHEETS&quot;. For newline-delimited JSON, specify &quot;NEWLINE_DELIMITED_JSON&quot;. For Avro files, specify &quot;AVRO&quot;. For Google Cloud Datastore backups, specify &quot;DATASTORE_BACKUP&quot;. [Beta] For Google Cloud Bigtable, specify &quot;BIGTABLE&quot;.
1750 &quot;connectionId&quot;: &quot;A String&quot;, # [Optional, Trusted Tester] Connection for external data source.
1751 &quot;ignoreUnknownValues&quot;: True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don&#x27;t match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
1752 &quot;csvOptions&quot;: { # Additional properties to set if sourceFormat is set to CSV.
1753 &quot;encoding&quot;: &quot;A String&quot;, # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
1754 &quot;allowJaggedRows&quot;: True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
1755 &quot;fieldDelimiter&quot;: &quot;A String&quot;, # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence &quot;\t&quot; to specify a tab separator. The default value is a comma (&#x27;,&#x27;).
1756 &quot;quote&quot;: &quot;&quot;&quot;, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote (&#x27;&quot;&#x27;). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
1757 &quot;skipLeadingRows&quot;: &quot;A String&quot;, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N &gt; 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
1758 &quot;allowQuotedNewlines&quot;: True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
1759 },
1760 &quot;compression&quot;: &quot;A String&quot;, # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
1761 &quot;googleSheetsOptions&quot;: { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
1762 &quot;skipLeadingRows&quot;: &quot;A String&quot;, # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N &gt; 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
1763 &quot;range&quot;: &quot;A String&quot;, # [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20
1764 },
1765 &quot;sourceUris&quot;: [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one &#x27;*&#x27; wildcard character and it must come after the &#x27;bucket&#x27; name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the &#x27;*&#x27; wildcard character is not allowed.
1766 &quot;A String&quot;,
1767 ],
1768 },
1769 },
1770 &quot;queryParameters&quot;: [ # Query parameters for standard SQL queries.
1771 {
1772 &quot;parameterValue&quot;: { # [Required] The value of this parameter.
1773 &quot;arrayValues&quot;: [ # [Optional] The array values, if this is an array type.
1774 # Object with schema name: QueryParameterValue
1775 ],
1776 &quot;value&quot;: &quot;A String&quot;, # [Optional] The value of this value, if a simple scalar type.
1777 &quot;structValues&quot;: { # [Optional] The struct field values, in order of the struct type&#x27;s declaration.
1778 &quot;a_key&quot;: # Object with schema name: QueryParameterValue
1779 },
1780 },
1781 &quot;name&quot;: &quot;A String&quot;, # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
1782 &quot;parameterType&quot;: { # [Required] The type of this parameter.
1783 &quot;arrayType&quot;: # Object with schema name: QueryParameterType # [Optional] The type of the array&#x27;s elements, if this is an array.
1784 &quot;structTypes&quot;: [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
1785 {
1786 &quot;type&quot;: # Object with schema name: QueryParameterType # [Required] The type of this field.
1787 &quot;description&quot;: &quot;A String&quot;, # [Optional] Human-oriented description of the field.
1788 &quot;name&quot;: &quot;A String&quot;, # [Optional] The name of this field.
1789 },
1790 ],
1791 &quot;type&quot;: &quot;A String&quot;, # [Required] The top level type of this field.
1792 },
1793 },
1794 ],
1795 &quot;allowLargeResults&quot;: false, # [Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size.
1796 &quot;maximumBytesBilled&quot;: &quot;A String&quot;, # [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.
1797 &quot;destinationEncryptionConfiguration&quot;: { # Custom encryption configuration (e.g., Cloud KMS keys).
1798 &quot;kmsKeyName&quot;: &quot;A String&quot;, # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
1799 },
1800 &quot;useLegacySql&quot;: true, # Specifies whether to use BigQuery&#x27;s legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery&#x27;s standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.
1801 &quot;parameterMode&quot;: &quot;A String&quot;, # Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
1802 &quot;connectionProperties&quot;: [ # Connection properties.
1803 {
1804 &quot;key&quot;: &quot;A String&quot;, # [Required] Name of the connection property to set.
1805 &quot;value&quot;: &quot;A String&quot;, # [Required] Value of the connection property.
1806 },
1807 ],
1808 &quot;timePartitioning&quot;: { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
1809 &quot;requirePartitionFilter&quot;: True or False,
1810 &quot;type&quot;: &quot;A String&quot;, # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.
1811 &quot;expirationMs&quot;: &quot;A String&quot;, # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
1812 &quot;field&quot;: &quot;A String&quot;, # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either &#x27;_PARTITIONTIME&#x27; as TIMESTAMP type, or &#x27;_PARTITIONDATE&#x27; as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
1813 },
1814 &quot;schemaUpdateOptions&quot;: [ # Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
1815 &quot;A String&quot;,
1816 ],
1817 &quot;preserveNulls&quot;: True or False, # [Deprecated] This property is deprecated.
1818 &quot;userDefinedFunctionResources&quot;: [ # Describes user-defined function resources used in the query.
1819 { # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions
1820 &quot;inlineCode&quot;: &quot;A String&quot;, # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
1821 &quot;resourceUri&quot;: &quot;A String&quot;, # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
1822 },
1823 ],
1824 &quot;defaultDataset&quot;: { # [Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names.
1825 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
1826 &quot;projectId&quot;: &quot;A String&quot;, # [Optional] The ID of the project containing this dataset.
1827 },
1828 &quot;useQueryCache&quot;: true, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.
1829 &quot;clustering&quot;: { # [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
1830 &quot;fields&quot;: [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
1831 &quot;A String&quot;,
1832 ],
1833 },
1834 &quot;createDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a &#x27;notFound&#x27; error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
1835 &quot;writeDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a &#x27;duplicate&#x27; error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
1836 },
1837 &quot;labels&quot;: { # The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
1838 &quot;a_key&quot;: &quot;A String&quot;,
1839 },
1840 &quot;jobTimeoutMs&quot;: &quot;A String&quot;, # [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
1841 &quot;copy&quot;: { # [Pick one] Copies a table.
1842 &quot;sourceTable&quot;: { # [Pick one] Source table to copy.
1843 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
1844 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
1845 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
1846 },
1847 &quot;destinationEncryptionConfiguration&quot;: { # Custom encryption configuration (e.g., Cloud KMS keys).
1848 &quot;kmsKeyName&quot;: &quot;A String&quot;, # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
1849 },
1850 &quot;destinationTable&quot;: { # [Required] The destination table
1851 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
1852 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
1853 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
1854 },
1855 &quot;operationType&quot;: &quot;A String&quot;, # [Optional] Supported operation types in table copy job.
1856 &quot;writeDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a &#x27;duplicate&#x27; error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
1857 &quot;destinationExpirationTime&quot;: &quot;&quot;, # [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
1858 &quot;sourceTables&quot;: [ # [Pick one] Source tables to copy.
1859 {
1860 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
1861 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
1862 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
1863 },
1864 ],
1865 &quot;createDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a &#x27;notFound&#x27; error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
1866 },
1867 },
1868}
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1869
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1870 media_body: string, The filename of the media request body, or an instance of a MediaUpload object.
1871 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1872
1873Returns:
1874 An object of the form:
1875
1876 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1877 &quot;id&quot;: &quot;A String&quot;, # [Output-only] Opaque ID field of the job
1878 &quot;selfLink&quot;: &quot;A String&quot;, # [Output-only] A URL that can be used to access this resource again.
1879 &quot;kind&quot;: &quot;bigquery#job&quot;, # [Output-only] The type of the resource.
1880 &quot;etag&quot;: &quot;A String&quot;, # [Output-only] A hash of this resource.
1881 &quot;status&quot;: { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
1882 &quot;state&quot;: &quot;A String&quot;, # [Output-only] Running state of the job.
1883 &quot;errors&quot;: [ # [Output-only] The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
1884 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1885 &quot;reason&quot;: &quot;A String&quot;, # A short error code that summarizes the error.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]1886 &quot;debugInfo&quot;: &quot;A String&quot;, # Debugging information. This property is internal to Google and should not be used.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1887 &quot;location&quot;: &quot;A String&quot;, # Specifies where the error occurred, if present.
1888 &quot;message&quot;: &quot;A String&quot;, # A human-readable description of the error.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1889 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1890 ],
1891 &quot;errorResult&quot;: { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
1892 &quot;reason&quot;: &quot;A String&quot;, # A short error code that summarizes the error.
1893 &quot;debugInfo&quot;: &quot;A String&quot;, # Debugging information. This property is internal to Google and should not be used.
1894 &quot;location&quot;: &quot;A String&quot;, # Specifies where the error occurred, if present.
1895 &quot;message&quot;: &quot;A String&quot;, # A human-readable description of the error.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1896 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1897 },
1898 &quot;statistics&quot;: { # [Output-only] Information about the job, including starting time and ending time of the job.
1899 &quot;startTime&quot;: &quot;A String&quot;, # [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
1900 &quot;completionRatio&quot;: 3.14, # [TrustedTester] [Output-only] Job progress (0.0 -&gt; 1.0) for LOAD and EXTRACT jobs.
1901 &quot;rowLevelSecurityStatistics&quot;: { # [Output-only] [Preview] Statistics for row-level security. Present only for query and extract jobs.
1902 &quot;rowLevelSecurityApplied&quot;: True or False, # [Output-only] [Preview] Whether any accessed data was protected by row access policies.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1903 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1904 &quot;numChildJobs&quot;: &quot;A String&quot;, # [Output-only] Number of child jobs executed.
1905 &quot;extract&quot;: { # [Output-only] Statistics for an extract job.
1906 &quot;inputBytes&quot;: &quot;A String&quot;, # [Output-only] Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.
1907 &quot;destinationUriFileCounts&quot;: [ # [Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the &#x27;destinationUris&#x27; field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1908 &quot;A String&quot;,
1909 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1910 },
1911 &quot;transactionInfoTemplate&quot;: { # [Output-only] [Alpha] Information of the multi-statement transaction if this job is part of one.
1912 &quot;transactionId&quot;: &quot;A String&quot;, # [Output-only] // [Alpha] Id of the transaction.
1913 },
1914 &quot;reservationUsage&quot;: [ # [Output-only] Job resource usage breakdown by reservation.
1915 {
1916 &quot;slotMs&quot;: &quot;A String&quot;, # [Output-only] Slot-milliseconds the job spent in the given reservation.
1917 &quot;name&quot;: &quot;A String&quot;, # [Output-only] Reservation name or &quot;unreserved&quot; for on-demand resources usage.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1918 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1919 ],
1920 &quot;creationTime&quot;: &quot;A String&quot;, # [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
1921 &quot;totalBytesProcessed&quot;: &quot;A String&quot;, # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
1922 &quot;reservation_id&quot;: &quot;A String&quot;, # [Output-only] Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.
1923 &quot;endTime&quot;: &quot;A String&quot;, # [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
1924 &quot;query&quot;: { # [Output-only] Statistics for a query job.
1925 &quot;undeclaredQueryParameters&quot;: [ # Standard SQL only: list of undeclared query parameters detected during a dry run validation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1926 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1927 &quot;parameterValue&quot;: { # [Required] The value of this parameter.
1928 &quot;arrayValues&quot;: [ # [Optional] The array values, if this is an array type.
1929 # Object with schema name: QueryParameterValue
1930 ],
1931 &quot;value&quot;: &quot;A String&quot;, # [Optional] The value of this value, if a simple scalar type.
1932 &quot;structValues&quot;: { # [Optional] The struct field values, in order of the struct type&#x27;s declaration.
1933 &quot;a_key&quot;: # Object with schema name: QueryParameterValue
1934 },
1935 },
1936 &quot;name&quot;: &quot;A String&quot;, # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
1937 &quot;parameterType&quot;: { # [Required] The type of this parameter.
1938 &quot;arrayType&quot;: # Object with schema name: QueryParameterType # [Optional] The type of the array&#x27;s elements, if this is an array.
1939 &quot;structTypes&quot;: [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
1940 {
1941 &quot;type&quot;: # Object with schema name: QueryParameterType # [Required] The type of this field.
1942 &quot;description&quot;: &quot;A String&quot;, # [Optional] Human-oriented description of the field.
1943 &quot;name&quot;: &quot;A String&quot;, # [Optional] The name of this field.
1944 },
1945 ],
1946 &quot;type&quot;: &quot;A String&quot;, # [Required] The top level type of this field.
1947 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]1948 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1949 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1950 &quot;ddlOperationPerformed&quot;: &quot;A String&quot;, # The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): &quot;CREATE&quot;: The query created the DDL target. &quot;SKIP&quot;: No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. &quot;REPLACE&quot;: The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. &quot;DROP&quot;: The query deleted the DDL target.
1951 &quot;schema&quot;: { # [Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
1952 &quot;fields&quot;: [ # Describes the fields in a table.
1953 {
1954 &quot;type&quot;: &quot;A String&quot;, # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
1955 &quot;categories&quot;: { # [Optional] The categories attached to this field, used for field-level access control.
1956 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/taxonomies/2/categories/3&quot;. At most 5 categories are allowed.
1957 &quot;A String&quot;,
1958 ],
1959 },
1960 &quot;fields&quot;: [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
1961 # Object with schema name: TableFieldSchema
1962 ],
1963 &quot;name&quot;: &quot;A String&quot;, # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
1964 &quot;description&quot;: &quot;A String&quot;, # [Optional] The field description. The maximum length is 1,024 characters.
1965 &quot;policyTags&quot;: {
1966 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/location/eu/taxonomies/2/policyTags/3&quot;. At most 1 policy tag is allowed.
1967 &quot;A String&quot;,
1968 ],
1969 },
1970 &quot;mode&quot;: &quot;A String&quot;, # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
1971 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]1972 ],
1973 },
1974 &quot;totalSlotMs&quot;: &quot;A String&quot;, # [Output-only] Slot-milliseconds for the job.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]1975 &quot;modelTrainingCurrentIteration&quot;: 42, # [Output-only, Beta] Deprecated; do not use.
1976 &quot;billingTier&quot;: 42, # [Output-only] Billing tier for the job.
1977 &quot;estimatedBytesProcessed&quot;: &quot;A String&quot;, # [Output-only] The original estimate of bytes processed for the job.
1978 &quot;totalBytesProcessed&quot;: &quot;A String&quot;, # [Output-only] Total bytes processed for the job.
1979 &quot;statementType&quot;: &quot;A String&quot;, # The type of query statement, if valid. Possible values (new values might be added in the future): &quot;SELECT&quot;: SELECT query. &quot;INSERT&quot;: INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. &quot;UPDATE&quot;: UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. &quot;DELETE&quot;: DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. &quot;MERGE&quot;: MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. &quot;ALTER_TABLE&quot;: ALTER TABLE query. &quot;ALTER_VIEW&quot;: ALTER VIEW query. &quot;ASSERT&quot;: ASSERT condition AS &#x27;description&#x27;. &quot;CREATE_FUNCTION&quot;: CREATE FUNCTION query. &quot;CREATE_MODEL&quot;: CREATE [OR REPLACE] MODEL ... AS SELECT ... . &quot;CREATE_PROCEDURE&quot;: CREATE PROCEDURE query. &quot;CREATE_TABLE&quot;: CREATE [OR REPLACE] TABLE without AS SELECT. &quot;CREATE_TABLE_AS_SELECT&quot;: CREATE [OR REPLACE] TABLE ... AS SELECT ... . &quot;CREATE_VIEW&quot;: CREATE [OR REPLACE] VIEW ... AS SELECT ... . &quot;DROP_FUNCTION&quot; : DROP FUNCTION query. &quot;DROP_PROCEDURE&quot;: DROP PROCEDURE query. &quot;DROP_TABLE&quot;: DROP TABLE query. &quot;DROP_VIEW&quot;: DROP VIEW query.
1980 &quot;ddlAffectedRowAccessPolicyCount&quot;: &quot;A String&quot;, # [Output-only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
1981 &quot;referencedTables&quot;: [ # [Output-only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
1982 {
1983 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
1984 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
1985 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
1986 },
1987 ],
1988 &quot;totalPartitionsProcessed&quot;: &quot;A String&quot;, # [Output-only] Total number of partitions processed from all partitioned tables referenced in the job.
1989 &quot;ddlTargetTable&quot;: { # [Output-only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
1990 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
1991 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
1992 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
1993 },
1994 &quot;referencedRoutines&quot;: [ # [Output-only] Referenced routines (persistent user-defined functions and stored procedures) for the job.
1995 {
1996 &quot;routineId&quot;: &quot;A String&quot;, # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
1997 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this routine.
1998 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this routine.
1999 },
2000 ],
2001 &quot;timeline&quot;: [ # [Output-only] [Beta] Describes a timeline of job execution.
2002 {
2003 &quot;activeUnits&quot;: &quot;A String&quot;, # Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
2004 &quot;completedUnits&quot;: &quot;A String&quot;, # Total parallel units of work completed by this query.
2005 &quot;pendingUnits&quot;: &quot;A String&quot;, # Total parallel units of work remaining for the active stages.
2006 &quot;totalSlotMs&quot;: &quot;A String&quot;, # Cumulative slot-ms consumed by the query.
2007 &quot;elapsedMs&quot;: &quot;A String&quot;, # Milliseconds elapsed since the start of query execution.
2008 },
2009 ],
2010 &quot;totalBytesBilled&quot;: &quot;A String&quot;, # [Output-only] Total bytes billed for the job.
2011 &quot;modelTraining&quot;: { # [Output-only, Beta] Information about create model query job progress.
2012 &quot;expectedTotalIterations&quot;: &quot;A String&quot;, # [Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.
2013 &quot;currentIteration&quot;: 42, # [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.
2014 },
2015 &quot;numDmlAffectedRows&quot;: &quot;A String&quot;, # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
2016 &quot;queryPlan&quot;: [ # [Output-only] Describes execution plan for the query.
2017 {
2018 &quot;computeRatioAvg&quot;: 3.14, # Relative amount of time the average shard spent on CPU-bound tasks.
2019 &quot;waitMsMax&quot;: &quot;A String&quot;, # Milliseconds the slowest shard spent waiting to be scheduled.
2020 &quot;shuffleOutputBytes&quot;: &quot;A String&quot;, # Total number of bytes written to shuffle.
2021 &quot;computeMsAvg&quot;: &quot;A String&quot;, # Milliseconds the average shard spent on CPU-bound tasks.
2022 &quot;writeMsMax&quot;: &quot;A String&quot;, # Milliseconds the slowest shard spent on writing output.
2023 &quot;waitMsAvg&quot;: &quot;A String&quot;, # Milliseconds the average shard spent waiting to be scheduled.
2024 &quot;computeRatioMax&quot;: 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks.
2025 &quot;writeMsAvg&quot;: &quot;A String&quot;, # Milliseconds the average shard spent on writing output.
2026 &quot;slotMs&quot;: &quot;A String&quot;, # Slot-milliseconds used by the stage.
2027 &quot;readMsAvg&quot;: &quot;A String&quot;, # Milliseconds the average shard spent reading input.
2028 &quot;waitRatioMax&quot;: 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled.
2029 &quot;shuffleOutputBytesSpilled&quot;: &quot;A String&quot;, # Total number of bytes written to shuffle and spilled to disk.
2030 &quot;startMs&quot;: &quot;A String&quot;, # Stage start time represented as milliseconds since epoch.
2031 &quot;completedParallelInputs&quot;: &quot;A String&quot;, # Number of parallel input segments completed.
2032 &quot;recordsRead&quot;: &quot;A String&quot;, # Number of records read into the stage.
2033 &quot;inputStages&quot;: [ # IDs for stages that are inputs to this stage.
2034 &quot;A String&quot;,
2035 ],
2036 &quot;computeMsMax&quot;: &quot;A String&quot;, # Milliseconds the slowest shard spent on CPU-bound tasks.
2037 &quot;id&quot;: &quot;A String&quot;, # Unique ID for stage within plan.
2038 &quot;readRatioMax&quot;: 3.14, # Relative amount of time the slowest shard spent reading input.
2039 &quot;writeRatioMax&quot;: 3.14, # Relative amount of time the slowest shard spent on writing output.
2040 &quot;readMsMax&quot;: &quot;A String&quot;, # Milliseconds the slowest shard spent reading input.
2041 &quot;readRatioAvg&quot;: 3.14, # Relative amount of time the average shard spent reading input.
2042 &quot;status&quot;: &quot;A String&quot;, # Current status for the stage.
2043 &quot;waitRatioAvg&quot;: 3.14, # Relative amount of time the average shard spent waiting to be scheduled.
2044 &quot;name&quot;: &quot;A String&quot;, # Human-readable name for stage.
2045 &quot;endMs&quot;: &quot;A String&quot;, # Stage end time represented as milliseconds since epoch.
2046 &quot;parallelInputs&quot;: &quot;A String&quot;, # Number of parallel input segments to be processed.
2047 &quot;recordsWritten&quot;: &quot;A String&quot;, # Number of records written by the stage.
2048 &quot;steps&quot;: [ # List of operations within the stage in dependency order (approximately chronological).
2049 {
2050 &quot;kind&quot;: &quot;A String&quot;, # Machine-readable operation type.
2051 &quot;substeps&quot;: [ # Human-readable stage descriptions.
2052 &quot;A String&quot;,
2053 ],
2054 },
2055 ],
2056 &quot;writeRatioAvg&quot;: 3.14, # Relative amount of time the average shard spent on writing output.
2057 },
2058 ],
2059 &quot;totalBytesProcessedAccuracy&quot;: &quot;A String&quot;, # [Output-only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
2060 &quot;cacheHit&quot;: True or False, # [Output-only] Whether the query result was fetched from the query cache.
2061 &quot;modelTrainingExpectedTotalIteration&quot;: &quot;A String&quot;, # [Output-only, Beta] Deprecated; do not use.
2062 &quot;ddlTargetRowAccessPolicy&quot;: { # [Output-only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
2063 &quot;policyId&quot;: &quot;A String&quot;, # [Required] The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
2064 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this row access policy.
2065 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table containing this row access policy.
2066 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this row access policy.
2067 },
2068 &quot;reservationUsage&quot;: [ # [Output-only] Job resource usage breakdown by reservation.
2069 {
2070 &quot;slotMs&quot;: &quot;A String&quot;, # [Output-only] Slot-milliseconds the job spent in the given reservation.
2071 &quot;name&quot;: &quot;A String&quot;, # [Output-only] Reservation name or &quot;unreserved&quot; for on-demand resources usage.
2072 },
2073 ],
2074 &quot;ddlTargetRoutine&quot;: { # The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
2075 &quot;routineId&quot;: &quot;A String&quot;, # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
2076 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this routine.
2077 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this routine.
2078 },
2079 },
2080 &quot;quotaDeferments&quot;: [ # [Output-only] Quotas which delayed this job&#x27;s start time.
2081 &quot;A String&quot;,
2082 ],
2083 &quot;scriptStatistics&quot;: { # [Output-only] Statistics for a child job of a script.
2084 &quot;stackFrames&quot;: [ # Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty.
2085 {
2086 &quot;procedureId&quot;: &quot;A String&quot;, # [Output-only] Name of the active procedure, empty if in a top-level script.
2087 &quot;startColumn&quot;: 42, # [Output-only] One-based start column.
2088 &quot;startLine&quot;: 42, # [Output-only] One-based start line.
2089 &quot;endColumn&quot;: 42, # [Output-only] One-based end column.
2090 &quot;endLine&quot;: 42, # [Output-only] One-based end line.
2091 &quot;text&quot;: &quot;A String&quot;, # [Output-only] Text of the current statement/expression.
2092 },
2093 ],
2094 &quot;evaluationKind&quot;: &quot;A String&quot;, # [Output-only] Whether this child job was a statement or expression.
2095 },
2096 &quot;parentJobId&quot;: &quot;A String&quot;, # [Output-only] If this is a child job, the id of the parent.
2097 &quot;totalSlotMs&quot;: &quot;A String&quot;, # [Output-only] Slot-milliseconds for the job.
2098 &quot;load&quot;: { # [Output-only] Statistics for a load job.
2099 &quot;outputRows&quot;: &quot;A String&quot;, # [Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
2100 &quot;inputFileBytes&quot;: &quot;A String&quot;, # [Output-only] Number of bytes of source data in a load job.
2101 &quot;badRecords&quot;: &quot;A String&quot;, # [Output-only] The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.
2102 &quot;outputBytes&quot;: &quot;A String&quot;, # [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
2103 &quot;inputFiles&quot;: &quot;A String&quot;, # [Output-only] Number of source files in a load job.
2104 },
2105 },
2106 &quot;user_email&quot;: &quot;A String&quot;, # [Output-only] Email address of the user who ran the job.
2107 &quot;jobReference&quot;: { # [Optional] Reference describing the unique-per-user name of the job.
2108 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this job.
2109 &quot;location&quot;: &quot;A String&quot;, # The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
2110 &quot;jobId&quot;: &quot;A String&quot;, # [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
2111 },
2112 &quot;configuration&quot;: { # [Required] Describes the job configuration.
2113 &quot;extract&quot;: { # [Pick one] Configures an extract job.
2114 &quot;compression&quot;: &quot;A String&quot;, # [Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
2115 &quot;destinationUris&quot;: [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
2116 &quot;A String&quot;,
2117 ],
2118 &quot;useAvroLogicalTypes&quot;: True or False, # [Optional] If destinationFormat is set to &quot;AVRO&quot;, this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
2119 &quot;destinationFormat&quot;: &quot;A String&quot;, # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
2120 &quot;sourceTable&quot;: { # A reference to the table being exported.
2121 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
2122 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
2123 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
2124 },
2125 &quot;destinationUri&quot;: &quot;A String&quot;, # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
2126 &quot;fieldDelimiter&quot;: &quot;A String&quot;, # [Optional] Delimiter to use between fields in the exported data. Default is &#x27;,&#x27;. Not applicable when extracting models.
2127 &quot;printHeader&quot;: true, # [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
2128 &quot;sourceModel&quot;: { # A reference to the model being exported.
2129 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this model.
2130 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this model.
2131 &quot;modelId&quot;: &quot;A String&quot;, # [Required] The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
2132 },
2133 },
2134 &quot;dryRun&quot;: True or False, # [Optional] If set, don&#x27;t actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn&#x27;t a dry run. Behavior of non-query jobs is undefined.
2135 &quot;load&quot;: { # [Pick one] Configures a load job.
2136 &quot;allowQuotedNewlines&quot;: True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
2137 &quot;schema&quot;: { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you&#x27;re loading data from Google Cloud Datastore.
2138 &quot;fields&quot;: [ # Describes the fields in a table.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2139 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2140 &quot;type&quot;: &quot;A String&quot;, # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
2141 &quot;categories&quot;: { # [Optional] The categories attached to this field, used for field-level access control.
2142 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/taxonomies/2/categories/3&quot;. At most 5 categories are allowed.
2143 &quot;A String&quot;,
2144 ],
2145 },
2146 &quot;fields&quot;: [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
2147 # Object with schema name: TableFieldSchema
2148 ],
2149 &quot;name&quot;: &quot;A String&quot;, # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
2150 &quot;description&quot;: &quot;A String&quot;, # [Optional] The field description. The maximum length is 1,024 characters.
2151 &quot;policyTags&quot;: {
2152 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/location/eu/taxonomies/2/policyTags/3&quot;. At most 1 policy tag is allowed.
2153 &quot;A String&quot;,
2154 ],
2155 },
2156 &quot;mode&quot;: &quot;A String&quot;, # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2157 },
2158 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2159 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2160 &quot;decimalTargetTypes&quot;: [ # [Trusted Tester] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. For example: suppose decimal_target_type = [&quot;NUMERIC&quot;, &quot;BIGNUMERIC&quot;]. Then if (precision,scale) is: * (38,9) -&gt; NUMERIC; * (39,9) -&gt; BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -&gt; BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -&gt; BIGNUMERIC; * (77,38) -&gt; BIGNUMERIC (error if value exeeds supported range). For duplicated types in this field, only one will be considered and the rest will be ignored. The order of the types in this field is ignored. For example, [&quot;BIGNUMERIC&quot;, &quot;NUMERIC&quot;] is the same as [&quot;NUMERIC&quot;, &quot;BIGNUMERIC&quot;] and NUMERIC always takes precedence over BIGNUMERIC.
2161 &quot;A String&quot;,
2162 ],
2163 &quot;skipLeadingRows&quot;: 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
2164 &quot;timePartitioning&quot;: { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
2165 &quot;requirePartitionFilter&quot;: True or False,
2166 &quot;type&quot;: &quot;A String&quot;, # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.
2167 &quot;expirationMs&quot;: &quot;A String&quot;, # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
2168 &quot;field&quot;: &quot;A String&quot;, # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either &#x27;_PARTITIONTIME&#x27; as TIMESTAMP type, or &#x27;_PARTITIONDATE&#x27; as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2169 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2170 &quot;destinationEncryptionConfiguration&quot;: { # Custom encryption configuration (e.g., Cloud KMS keys).
2171 &quot;kmsKeyName&quot;: &quot;A String&quot;, # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
2172 },
2173 &quot;schemaUpdateOptions&quot;: [ # Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
2174 &quot;A String&quot;,
2175 ],
2176 &quot;destinationTable&quot;: { # [Required] The destination table to load the data into.
2177 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
2178 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
2179 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
2180 },
2181 &quot;schemaInline&quot;: &quot;A String&quot;, # [Deprecated] The inline schema. For CSV schemas, specify as &quot;Field1:Type1[,Field2:Type2]*&quot;. For example, &quot;foo:STRING, bar:INTEGER, baz:FLOAT&quot;.
2182 &quot;projectionFields&quot;: [ # If sourceFormat is set to &quot;DATASTORE_BACKUP&quot;, indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn&#x27;t found in the Cloud Datastore backup, an invalid error is returned in the job result.
2183 &quot;A String&quot;,
2184 ],
2185 &quot;maxBadRecords&quot;: 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
2186 &quot;allowJaggedRows&quot;: True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
2187 &quot;schemaInlineFormat&quot;: &quot;A String&quot;, # [Deprecated] The format of the schemaInline property.
2188 &quot;autodetect&quot;: True or False, # [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
2189 &quot;encoding&quot;: &quot;A String&quot;, # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
2190 &quot;destinationTableProperties&quot;: { # [Beta] [Optional] Properties with which to create the destination table if it is new.
2191 &quot;labels&quot;: { # [Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
2192 &quot;a_key&quot;: &quot;A String&quot;,
2193 },
2194 &quot;description&quot;: &quot;A String&quot;, # [Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
2195 &quot;friendlyName&quot;: &quot;A String&quot;, # [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
2196 },
2197 &quot;createDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a &#x27;notFound&#x27; error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
2198 &quot;sourceUris&quot;: [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one &#x27;*&#x27; wildcard character and it must come after the &#x27;bucket&#x27; name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the &#x27;*&#x27; wildcard character is not allowed.
2199 &quot;A String&quot;,
2200 ],
2201 &quot;rangePartitioning&quot;: { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
2202 &quot;field&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
2203 &quot;range&quot;: { # [TrustedTester] [Required] Defines the ranges for range partitioning.
2204 &quot;interval&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The width of each interval.
2205 &quot;end&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The end of range partitioning, exclusive.
2206 &quot;start&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The start of range partitioning, inclusive.
2207 },
2208 },
2209 &quot;useAvroLogicalTypes&quot;: True or False, # [Optional] If sourceFormat is set to &quot;AVRO&quot;, indicates whether to enable interpreting logical types into their corresponding types (ie. TIMESTAMP), instead of only using their raw types (ie. INTEGER).
2210 &quot;ignoreUnknownValues&quot;: True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don&#x27;t match any column names
2211 &quot;sourceFormat&quot;: &quot;A String&quot;, # [Optional] The format of the data files. For CSV files, specify &quot;CSV&quot;. For datastore backups, specify &quot;DATASTORE_BACKUP&quot;. For newline-delimited JSON, specify &quot;NEWLINE_DELIMITED_JSON&quot;. For Avro, specify &quot;AVRO&quot;. For parquet, specify &quot;PARQUET&quot;. For orc, specify &quot;ORC&quot;. The default value is CSV.
2212 &quot;fieldDelimiter&quot;: &quot;A String&quot;, # [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence &quot;\t&quot; to specify a tab separator. The default value is a comma (&#x27;,&#x27;).
2213 &quot;clustering&quot;: { # [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
2214 &quot;fields&quot;: [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
2215 &quot;A String&quot;,
2216 ],
2217 },
2218 &quot;nullMarker&quot;: &quot;A String&quot;, # [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify &quot;\N&quot;, BigQuery interprets &quot;\N&quot; as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
2219 &quot;quote&quot;: &quot;&quot;&quot;, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote (&#x27;&quot;&#x27;). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
2220 &quot;hivePartitioningOptions&quot;: { # [Optional, Trusted Tester] Options to configure hive partitioning support.
2221 &quot;requirePartitionFilter&quot;: True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
2222 &quot;mode&quot;: &quot;A String&quot;, # [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
2223 &quot;sourceUriPrefix&quot;: &quot;A String&quot;, # [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
2224 },
2225 &quot;writeDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a &#x27;duplicate&#x27; error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2226 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2227 &quot;jobType&quot;: &quot;A String&quot;, # [Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
2228 &quot;query&quot;: { # [Pick one] Configures a query job.
2229 &quot;query&quot;: &quot;A String&quot;, # [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.
2230 &quot;flattenResults&quot;: true, # [Optional] If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened.
2231 &quot;rangePartitioning&quot;: { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
2232 &quot;field&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
2233 &quot;range&quot;: { # [TrustedTester] [Required] Defines the ranges for range partitioning.
2234 &quot;interval&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The width of each interval.
2235 &quot;end&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The end of range partitioning, exclusive.
2236 &quot;start&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The start of range partitioning, inclusive.
2237 },
2238 },
2239 &quot;maximumBillingTier&quot;: 1, # [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.
2240 &quot;priority&quot;: &quot;A String&quot;, # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
2241 &quot;destinationTable&quot;: { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size.
2242 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
2243 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
2244 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
2245 },
2246 &quot;tableDefinitions&quot;: { # [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
2247 &quot;a_key&quot;: {
2248 &quot;hivePartitioningOptions&quot;: { # [Optional, Trusted Tester] Options to configure hive partitioning support.
2249 &quot;requirePartitionFilter&quot;: True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
2250 &quot;mode&quot;: &quot;A String&quot;, # [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
2251 &quot;sourceUriPrefix&quot;: &quot;A String&quot;, # [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
2252 },
2253 &quot;schema&quot;: { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
2254 &quot;fields&quot;: [ # Describes the fields in a table.
2255 {
2256 &quot;type&quot;: &quot;A String&quot;, # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
2257 &quot;categories&quot;: { # [Optional] The categories attached to this field, used for field-level access control.
2258 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/taxonomies/2/categories/3&quot;. At most 5 categories are allowed.
2259 &quot;A String&quot;,
2260 ],
2261 },
2262 &quot;fields&quot;: [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
2263 # Object with schema name: TableFieldSchema
2264 ],
2265 &quot;name&quot;: &quot;A String&quot;, # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
2266 &quot;description&quot;: &quot;A String&quot;, # [Optional] The field description. The maximum length is 1,024 characters.
2267 &quot;policyTags&quot;: {
2268 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/location/eu/taxonomies/2/policyTags/3&quot;. At most 1 policy tag is allowed.
2269 &quot;A String&quot;,
2270 ],
2271 },
2272 &quot;mode&quot;: &quot;A String&quot;, # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
2273 },
2274 ],
2275 },
2276 &quot;maxBadRecords&quot;: 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
2277 &quot;bigtableOptions&quot;: { # [Optional] Additional options if sourceFormat is set to BIGTABLE.
2278 &quot;readRowkeyAsString&quot;: True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
2279 &quot;ignoreUnspecifiedColumnFamilies&quot;: True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
2280 &quot;columnFamilies&quot;: [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the &#x27;type&#x27; field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
2281 {
2282 &quot;encoding&quot;: &quot;A String&quot;, # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in &#x27;columns&#x27; and specifying an encoding for it.
2283 &quot;onlyReadLatest&quot;: True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in &#x27;columns&#x27; and specifying a different setting for that column.
2284 &quot;familyId&quot;: &quot;A String&quot;, # Identifier of the column family.
2285 &quot;columns&quot;: [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.
2286 {
2287 &quot;fieldName&quot;: &quot;A String&quot;, # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
2288 &quot;encoding&quot;: &quot;A String&quot;, # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. &#x27;encoding&#x27; can also be set at the column family level. However, the setting at this level takes precedence if &#x27;encoding&#x27; is set at both levels.
2289 &quot;type&quot;: &quot;A String&quot;, # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. &#x27;type&#x27; can also be set at the column family level. However, the setting at this level takes precedence if &#x27;type&#x27; is set at both levels.
2290 &quot;qualifierString&quot;: &quot;A String&quot;,
2291 &quot;qualifierEncoded&quot;: &quot;A String&quot;, # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.
2292 &quot;onlyReadLatest&quot;: True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. &#x27;onlyReadLatest&#x27; can also be set at the column family level. However, the setting at this level takes precedence if &#x27;onlyReadLatest&#x27; is set at both levels.
2293 },
2294 ],
2295 &quot;type&quot;: &quot;A String&quot;, # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in &#x27;columns&#x27; and specifying a type for it.
2296 },
2297 ],
2298 },
2299 &quot;autodetect&quot;: True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.
2300 &quot;sourceFormat&quot;: &quot;A String&quot;, # [Required] The data format. For CSV files, specify &quot;CSV&quot;. For Google sheets, specify &quot;GOOGLE_SHEETS&quot;. For newline-delimited JSON, specify &quot;NEWLINE_DELIMITED_JSON&quot;. For Avro files, specify &quot;AVRO&quot;. For Google Cloud Datastore backups, specify &quot;DATASTORE_BACKUP&quot;. [Beta] For Google Cloud Bigtable, specify &quot;BIGTABLE&quot;.
2301 &quot;connectionId&quot;: &quot;A String&quot;, # [Optional, Trusted Tester] Connection for external data source.
2302 &quot;ignoreUnknownValues&quot;: True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don&#x27;t match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
2303 &quot;csvOptions&quot;: { # Additional properties to set if sourceFormat is set to CSV.
2304 &quot;encoding&quot;: &quot;A String&quot;, # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
2305 &quot;allowJaggedRows&quot;: True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
2306 &quot;fieldDelimiter&quot;: &quot;A String&quot;, # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence &quot;\t&quot; to specify a tab separator. The default value is a comma (&#x27;,&#x27;).
2307 &quot;quote&quot;: &quot;&quot;&quot;, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote (&#x27;&quot;&#x27;). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
2308 &quot;skipLeadingRows&quot;: &quot;A String&quot;, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N &gt; 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
2309 &quot;allowQuotedNewlines&quot;: True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
2310 },
2311 &quot;compression&quot;: &quot;A String&quot;, # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
2312 &quot;googleSheetsOptions&quot;: { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
2313 &quot;skipLeadingRows&quot;: &quot;A String&quot;, # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N &gt; 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
2314 &quot;range&quot;: &quot;A String&quot;, # [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20
2315 },
2316 &quot;sourceUris&quot;: [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one &#x27;*&#x27; wildcard character and it must come after the &#x27;bucket&#x27; name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the &#x27;*&#x27; wildcard character is not allowed.
2317 &quot;A String&quot;,
2318 ],
2319 },
2320 },
2321 &quot;queryParameters&quot;: [ # Query parameters for standard SQL queries.
2322 {
2323 &quot;parameterValue&quot;: { # [Required] The value of this parameter.
2324 &quot;arrayValues&quot;: [ # [Optional] The array values, if this is an array type.
2325 # Object with schema name: QueryParameterValue
2326 ],
2327 &quot;value&quot;: &quot;A String&quot;, # [Optional] The value of this value, if a simple scalar type.
2328 &quot;structValues&quot;: { # [Optional] The struct field values, in order of the struct type&#x27;s declaration.
2329 &quot;a_key&quot;: # Object with schema name: QueryParameterValue
2330 },
2331 },
2332 &quot;name&quot;: &quot;A String&quot;, # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
2333 &quot;parameterType&quot;: { # [Required] The type of this parameter.
2334 &quot;arrayType&quot;: # Object with schema name: QueryParameterType # [Optional] The type of the array&#x27;s elements, if this is an array.
2335 &quot;structTypes&quot;: [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
2336 {
2337 &quot;type&quot;: # Object with schema name: QueryParameterType # [Required] The type of this field.
2338 &quot;description&quot;: &quot;A String&quot;, # [Optional] Human-oriented description of the field.
2339 &quot;name&quot;: &quot;A String&quot;, # [Optional] The name of this field.
2340 },
2341 ],
2342 &quot;type&quot;: &quot;A String&quot;, # [Required] The top level type of this field.
2343 },
2344 },
2345 ],
2346 &quot;allowLargeResults&quot;: false, # [Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size.
2347 &quot;maximumBytesBilled&quot;: &quot;A String&quot;, # [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.
2348 &quot;destinationEncryptionConfiguration&quot;: { # Custom encryption configuration (e.g., Cloud KMS keys).
2349 &quot;kmsKeyName&quot;: &quot;A String&quot;, # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
2350 },
2351 &quot;useLegacySql&quot;: true, # Specifies whether to use BigQuery&#x27;s legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery&#x27;s standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.
2352 &quot;parameterMode&quot;: &quot;A String&quot;, # Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
2353 &quot;connectionProperties&quot;: [ # Connection properties.
2354 {
2355 &quot;key&quot;: &quot;A String&quot;, # [Required] Name of the connection property to set.
2356 &quot;value&quot;: &quot;A String&quot;, # [Required] Value of the connection property.
2357 },
2358 ],
2359 &quot;timePartitioning&quot;: { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
2360 &quot;requirePartitionFilter&quot;: True or False,
2361 &quot;type&quot;: &quot;A String&quot;, # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.
2362 &quot;expirationMs&quot;: &quot;A String&quot;, # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
2363 &quot;field&quot;: &quot;A String&quot;, # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either &#x27;_PARTITIONTIME&#x27; as TIMESTAMP type, or &#x27;_PARTITIONDATE&#x27; as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
2364 },
2365 &quot;schemaUpdateOptions&quot;: [ # Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
2366 &quot;A String&quot;,
2367 ],
2368 &quot;preserveNulls&quot;: True or False, # [Deprecated] This property is deprecated.
2369 &quot;userDefinedFunctionResources&quot;: [ # Describes user-defined function resources used in the query.
2370 { # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions
2371 &quot;inlineCode&quot;: &quot;A String&quot;, # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
2372 &quot;resourceUri&quot;: &quot;A String&quot;, # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
2373 },
2374 ],
2375 &quot;defaultDataset&quot;: { # [Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names.
2376 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
2377 &quot;projectId&quot;: &quot;A String&quot;, # [Optional] The ID of the project containing this dataset.
2378 },
2379 &quot;useQueryCache&quot;: true, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.
2380 &quot;clustering&quot;: { # [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
2381 &quot;fields&quot;: [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
2382 &quot;A String&quot;,
2383 ],
2384 },
2385 &quot;createDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a &#x27;notFound&#x27; error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
2386 &quot;writeDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a &#x27;duplicate&#x27; error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
2387 },
2388 &quot;labels&quot;: { # The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
2389 &quot;a_key&quot;: &quot;A String&quot;,
2390 },
2391 &quot;jobTimeoutMs&quot;: &quot;A String&quot;, # [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
2392 &quot;copy&quot;: { # [Pick one] Copies a table.
2393 &quot;sourceTable&quot;: { # [Pick one] Source table to copy.
2394 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
2395 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
2396 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
2397 },
2398 &quot;destinationEncryptionConfiguration&quot;: { # Custom encryption configuration (e.g., Cloud KMS keys).
2399 &quot;kmsKeyName&quot;: &quot;A String&quot;, # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
2400 },
2401 &quot;destinationTable&quot;: { # [Required] The destination table
2402 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
2403 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
2404 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
2405 },
2406 &quot;operationType&quot;: &quot;A String&quot;, # [Optional] Supported operation types in table copy job.
2407 &quot;writeDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a &#x27;duplicate&#x27; error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
2408 &quot;destinationExpirationTime&quot;: &quot;&quot;, # [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
2409 &quot;sourceTables&quot;: [ # [Pick one] Source tables to copy.
2410 {
2411 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
2412 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
2413 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
2414 },
2415 ],
2416 &quot;createDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a &#x27;notFound&#x27; error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
2417 },
2418 },
2419 }</pre>
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2420</div>
2421
2422<div class="method">
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2423 <code class="details" id="list">list(projectId, minCreationTime=None, pageToken=None, maxCreationTime=None, parentJobId=None, allUsers=None, projection=None, stateFilter=None, maxResults=None)</code>
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2424 <pre>Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property.
2425
2426Args:
2427 projectId: string, Project ID of the jobs to list (required)
2428 minCreationTime: string, Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2429 pageToken: string, Page token, returned by a previous call, to request the next page of results
2430 maxCreationTime: string, Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2431 parentJobId: string, If set, retrieves only jobs whose parent is this job. Otherwise, retrieves only jobs which have no parent
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2432 allUsers: boolean, Whether to display jobs owned by all users in the project. Default false
2433 projection: string, Restrict information returned to a set of selected fields
2434 Allowed values
2435 full - Includes all job data
2436 minimal - Does not include the job configuration
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2437 stateFilter: string, Filter for job state (repeated)
2438 Allowed values
2439 done - Finished jobs
2440 pending - Pending jobs
2441 running - Running jobs
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2442 maxResults: integer, Maximum number of results to return
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2443
2444Returns:
2445 An object of the form:
2446
2447 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2448 &quot;jobs&quot;: [ # List of jobs that were requested.
2449 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2450 &quot;kind&quot;: &quot;bigquery#job&quot;, # The resource type.
2451 &quot;jobReference&quot;: { # Job reference uniquely identifying the job.
2452 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this job.
2453 &quot;location&quot;: &quot;A String&quot;, # The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
2454 &quot;jobId&quot;: &quot;A String&quot;, # [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2455 },
2456 &quot;errorResult&quot;: { # A result object that will be present only if the job has failed.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2457 &quot;reason&quot;: &quot;A String&quot;, # A short error code that summarizes the error.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2458 &quot;debugInfo&quot;: &quot;A String&quot;, # Debugging information. This property is internal to Google and should not be used.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2459 &quot;location&quot;: &quot;A String&quot;, # Specifies where the error occurred, if present.
2460 &quot;message&quot;: &quot;A String&quot;, # A human-readable description of the error.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2461 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2462 &quot;status&quot;: { # [Full-projection-only] Describes the state of the job.
2463 &quot;state&quot;: &quot;A String&quot;, # [Output-only] Running state of the job.
2464 &quot;errors&quot;: [ # [Output-only] The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
2465 {
2466 &quot;reason&quot;: &quot;A String&quot;, # A short error code that summarizes the error.
2467 &quot;debugInfo&quot;: &quot;A String&quot;, # Debugging information. This property is internal to Google and should not be used.
2468 &quot;location&quot;: &quot;A String&quot;, # Specifies where the error occurred, if present.
2469 &quot;message&quot;: &quot;A String&quot;, # A human-readable description of the error.
2470 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2471 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2472 &quot;errorResult&quot;: { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
2473 &quot;reason&quot;: &quot;A String&quot;, # A short error code that summarizes the error.
2474 &quot;debugInfo&quot;: &quot;A String&quot;, # Debugging information. This property is internal to Google and should not be used.
2475 &quot;location&quot;: &quot;A String&quot;, # Specifies where the error occurred, if present.
2476 &quot;message&quot;: &quot;A String&quot;, # A human-readable description of the error.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2477 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2478 },
2479 &quot;state&quot;: &quot;A String&quot;, # Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed.
2480 &quot;statistics&quot;: { # [Output-only] Information about the job, including starting time and ending time of the job.
2481 &quot;startTime&quot;: &quot;A String&quot;, # [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.
2482 &quot;completionRatio&quot;: 3.14, # [TrustedTester] [Output-only] Job progress (0.0 -&gt; 1.0) for LOAD and EXTRACT jobs.
2483 &quot;rowLevelSecurityStatistics&quot;: { # [Output-only] [Preview] Statistics for row-level security. Present only for query and extract jobs.
2484 &quot;rowLevelSecurityApplied&quot;: True or False, # [Output-only] [Preview] Whether any accessed data was protected by row access policies.
2485 },
2486 &quot;numChildJobs&quot;: &quot;A String&quot;, # [Output-only] Number of child jobs executed.
2487 &quot;extract&quot;: { # [Output-only] Statistics for an extract job.
2488 &quot;inputBytes&quot;: &quot;A String&quot;, # [Output-only] Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.
2489 &quot;destinationUriFileCounts&quot;: [ # [Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the &#x27;destinationUris&#x27; field.
2490 &quot;A String&quot;,
2491 ],
2492 },
2493 &quot;transactionInfoTemplate&quot;: { # [Output-only] [Alpha] Information of the multi-statement transaction if this job is part of one.
2494 &quot;transactionId&quot;: &quot;A String&quot;, # [Output-only] // [Alpha] Id of the transaction.
2495 },
2496 &quot;reservationUsage&quot;: [ # [Output-only] Job resource usage breakdown by reservation.
2497 {
2498 &quot;slotMs&quot;: &quot;A String&quot;, # [Output-only] Slot-milliseconds the job spent in the given reservation.
2499 &quot;name&quot;: &quot;A String&quot;, # [Output-only] Reservation name or &quot;unreserved&quot; for on-demand resources usage.
2500 },
2501 ],
2502 &quot;creationTime&quot;: &quot;A String&quot;, # [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.
2503 &quot;totalBytesProcessed&quot;: &quot;A String&quot;, # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2504 &quot;reservation_id&quot;: &quot;A String&quot;, # [Output-only] Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2505 &quot;endTime&quot;: &quot;A String&quot;, # [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2506 &quot;query&quot;: { # [Output-only] Statistics for a query job.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2507 &quot;undeclaredQueryParameters&quot;: [ # Standard SQL only: list of undeclared query parameters detected during a dry run validation.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2508 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2509 &quot;parameterValue&quot;: { # [Required] The value of this parameter.
2510 &quot;arrayValues&quot;: [ # [Optional] The array values, if this is an array type.
2511 # Object with schema name: QueryParameterValue
2512 ],
2513 &quot;value&quot;: &quot;A String&quot;, # [Optional] The value of this value, if a simple scalar type.
2514 &quot;structValues&quot;: { # [Optional] The struct field values, in order of the struct type&#x27;s declaration.
2515 &quot;a_key&quot;: # Object with schema name: QueryParameterValue
2516 },
2517 },
2518 &quot;name&quot;: &quot;A String&quot;, # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
2519 &quot;parameterType&quot;: { # [Required] The type of this parameter.
2520 &quot;arrayType&quot;: # Object with schema name: QueryParameterType # [Optional] The type of the array&#x27;s elements, if this is an array.
2521 &quot;structTypes&quot;: [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
2522 {
2523 &quot;type&quot;: # Object with schema name: QueryParameterType # [Required] The type of this field.
2524 &quot;description&quot;: &quot;A String&quot;, # [Optional] Human-oriented description of the field.
2525 &quot;name&quot;: &quot;A String&quot;, # [Optional] The name of this field.
2526 },
2527 ],
2528 &quot;type&quot;: &quot;A String&quot;, # [Required] The top level type of this field.
2529 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2530 },
2531 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2532 &quot;ddlOperationPerformed&quot;: &quot;A String&quot;, # The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): &quot;CREATE&quot;: The query created the DDL target. &quot;SKIP&quot;: No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. &quot;REPLACE&quot;: The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. &quot;DROP&quot;: The query deleted the DDL target.
2533 &quot;schema&quot;: { # [Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.
2534 &quot;fields&quot;: [ # Describes the fields in a table.
2535 {
2536 &quot;type&quot;: &quot;A String&quot;, # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
2537 &quot;categories&quot;: { # [Optional] The categories attached to this field, used for field-level access control.
2538 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/taxonomies/2/categories/3&quot;. At most 5 categories are allowed.
2539 &quot;A String&quot;,
2540 ],
2541 },
2542 &quot;fields&quot;: [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
2543 # Object with schema name: TableFieldSchema
2544 ],
2545 &quot;name&quot;: &quot;A String&quot;, # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
2546 &quot;description&quot;: &quot;A String&quot;, # [Optional] The field description. The maximum length is 1,024 characters.
2547 &quot;policyTags&quot;: {
2548 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/location/eu/taxonomies/2/policyTags/3&quot;. At most 1 policy tag is allowed.
2549 &quot;A String&quot;,
2550 ],
2551 },
2552 &quot;mode&quot;: &quot;A String&quot;, # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
2553 },
2554 ],
2555 },
2556 &quot;totalSlotMs&quot;: &quot;A String&quot;, # [Output-only] Slot-milliseconds for the job.
2557 &quot;modelTrainingCurrentIteration&quot;: 42, # [Output-only, Beta] Deprecated; do not use.
2558 &quot;billingTier&quot;: 42, # [Output-only] Billing tier for the job.
2559 &quot;estimatedBytesProcessed&quot;: &quot;A String&quot;, # [Output-only] The original estimate of bytes processed for the job.
2560 &quot;totalBytesProcessed&quot;: &quot;A String&quot;, # [Output-only] Total bytes processed for the job.
2561 &quot;statementType&quot;: &quot;A String&quot;, # The type of query statement, if valid. Possible values (new values might be added in the future): &quot;SELECT&quot;: SELECT query. &quot;INSERT&quot;: INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. &quot;UPDATE&quot;: UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. &quot;DELETE&quot;: DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. &quot;MERGE&quot;: MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. &quot;ALTER_TABLE&quot;: ALTER TABLE query. &quot;ALTER_VIEW&quot;: ALTER VIEW query. &quot;ASSERT&quot;: ASSERT condition AS &#x27;description&#x27;. &quot;CREATE_FUNCTION&quot;: CREATE FUNCTION query. &quot;CREATE_MODEL&quot;: CREATE [OR REPLACE] MODEL ... AS SELECT ... . &quot;CREATE_PROCEDURE&quot;: CREATE PROCEDURE query. &quot;CREATE_TABLE&quot;: CREATE [OR REPLACE] TABLE without AS SELECT. &quot;CREATE_TABLE_AS_SELECT&quot;: CREATE [OR REPLACE] TABLE ... AS SELECT ... . &quot;CREATE_VIEW&quot;: CREATE [OR REPLACE] VIEW ... AS SELECT ... . &quot;DROP_FUNCTION&quot; : DROP FUNCTION query. &quot;DROP_PROCEDURE&quot;: DROP PROCEDURE query. &quot;DROP_TABLE&quot;: DROP TABLE query. &quot;DROP_VIEW&quot;: DROP VIEW query.
2562 &quot;ddlAffectedRowAccessPolicyCount&quot;: &quot;A String&quot;, # [Output-only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2563 &quot;referencedTables&quot;: [ # [Output-only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.
2564 {
2565 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
2566 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
2567 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
2568 },
2569 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2570 &quot;totalPartitionsProcessed&quot;: &quot;A String&quot;, # [Output-only] Total number of partitions processed from all partitioned tables referenced in the job.
2571 &quot;ddlTargetTable&quot;: { # [Output-only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
2572 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
2573 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
2574 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2575 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2576 &quot;referencedRoutines&quot;: [ # [Output-only] Referenced routines (persistent user-defined functions and stored procedures) for the job.
2577 {
2578 &quot;routineId&quot;: &quot;A String&quot;, # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2579 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this routine.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2580 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this routine.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2581 },
2582 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2583 &quot;timeline&quot;: [ # [Output-only] [Beta] Describes a timeline of job execution.
2584 {
2585 &quot;activeUnits&quot;: &quot;A String&quot;, # Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.
2586 &quot;completedUnits&quot;: &quot;A String&quot;, # Total parallel units of work completed by this query.
2587 &quot;pendingUnits&quot;: &quot;A String&quot;, # Total parallel units of work remaining for the active stages.
2588 &quot;totalSlotMs&quot;: &quot;A String&quot;, # Cumulative slot-ms consumed by the query.
2589 &quot;elapsedMs&quot;: &quot;A String&quot;, # Milliseconds elapsed since the start of query execution.
2590 },
2591 ],
2592 &quot;totalBytesBilled&quot;: &quot;A String&quot;, # [Output-only] Total bytes billed for the job.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2593 &quot;modelTraining&quot;: { # [Output-only, Beta] Information about create model query job progress.
2594 &quot;expectedTotalIterations&quot;: &quot;A String&quot;, # [Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.
2595 &quot;currentIteration&quot;: 42, # [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.
2596 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2597 &quot;numDmlAffectedRows&quot;: &quot;A String&quot;, # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2598 &quot;queryPlan&quot;: [ # [Output-only] Describes execution plan for the query.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2599 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2600 &quot;computeRatioAvg&quot;: 3.14, # Relative amount of time the average shard spent on CPU-bound tasks.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2601 &quot;waitMsMax&quot;: &quot;A String&quot;, # Milliseconds the slowest shard spent waiting to be scheduled.
2602 &quot;shuffleOutputBytes&quot;: &quot;A String&quot;, # Total number of bytes written to shuffle.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2603 &quot;computeMsAvg&quot;: &quot;A String&quot;, # Milliseconds the average shard spent on CPU-bound tasks.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2604 &quot;writeMsMax&quot;: &quot;A String&quot;, # Milliseconds the slowest shard spent on writing output.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2605 &quot;waitMsAvg&quot;: &quot;A String&quot;, # Milliseconds the average shard spent waiting to be scheduled.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2606 &quot;computeRatioMax&quot;: 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2607 &quot;writeMsAvg&quot;: &quot;A String&quot;, # Milliseconds the average shard spent on writing output.
2608 &quot;slotMs&quot;: &quot;A String&quot;, # Slot-milliseconds used by the stage.
2609 &quot;readMsAvg&quot;: &quot;A String&quot;, # Milliseconds the average shard spent reading input.
2610 &quot;waitRatioMax&quot;: 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled.
2611 &quot;shuffleOutputBytesSpilled&quot;: &quot;A String&quot;, # Total number of bytes written to shuffle and spilled to disk.
2612 &quot;startMs&quot;: &quot;A String&quot;, # Stage start time represented as milliseconds since epoch.
2613 &quot;completedParallelInputs&quot;: &quot;A String&quot;, # Number of parallel input segments completed.
2614 &quot;recordsRead&quot;: &quot;A String&quot;, # Number of records read into the stage.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2615 &quot;inputStages&quot;: [ # IDs for stages that are inputs to this stage.
2616 &quot;A String&quot;,
2617 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2618 &quot;computeMsMax&quot;: &quot;A String&quot;, # Milliseconds the slowest shard spent on CPU-bound tasks.
2619 &quot;id&quot;: &quot;A String&quot;, # Unique ID for stage within plan.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2620 &quot;readRatioMax&quot;: 3.14, # Relative amount of time the slowest shard spent reading input.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2621 &quot;writeRatioMax&quot;: 3.14, # Relative amount of time the slowest shard spent on writing output.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2622 &quot;readMsMax&quot;: &quot;A String&quot;, # Milliseconds the slowest shard spent reading input.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2623 &quot;readRatioAvg&quot;: 3.14, # Relative amount of time the average shard spent reading input.
2624 &quot;status&quot;: &quot;A String&quot;, # Current status for the stage.
2625 &quot;waitRatioAvg&quot;: 3.14, # Relative amount of time the average shard spent waiting to be scheduled.
2626 &quot;name&quot;: &quot;A String&quot;, # Human-readable name for stage.
2627 &quot;endMs&quot;: &quot;A String&quot;, # Stage end time represented as milliseconds since epoch.
2628 &quot;parallelInputs&quot;: &quot;A String&quot;, # Number of parallel input segments to be processed.
2629 &quot;recordsWritten&quot;: &quot;A String&quot;, # Number of records written by the stage.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2630 &quot;steps&quot;: [ # List of operations within the stage in dependency order (approximately chronological).
2631 {
2632 &quot;kind&quot;: &quot;A String&quot;, # Machine-readable operation type.
2633 &quot;substeps&quot;: [ # Human-readable stage descriptions.
2634 &quot;A String&quot;,
2635 ],
2636 },
2637 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2638 &quot;writeRatioAvg&quot;: 3.14, # Relative amount of time the average shard spent on writing output.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2639 },
2640 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2641 &quot;totalBytesProcessedAccuracy&quot;: &quot;A String&quot;, # [Output-only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.
2642 &quot;cacheHit&quot;: True or False, # [Output-only] Whether the query result was fetched from the query cache.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2643 &quot;modelTrainingExpectedTotalIteration&quot;: &quot;A String&quot;, # [Output-only, Beta] Deprecated; do not use.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2644 &quot;ddlTargetRowAccessPolicy&quot;: { # [Output-only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
2645 &quot;policyId&quot;: &quot;A String&quot;, # [Required] The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
2646 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this row access policy.
2647 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table containing this row access policy.
2648 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this row access policy.
2649 },
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2650 &quot;reservationUsage&quot;: [ # [Output-only] Job resource usage breakdown by reservation.
2651 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2652 &quot;slotMs&quot;: &quot;A String&quot;, # [Output-only] Slot-milliseconds the job spent in the given reservation.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2653 &quot;name&quot;: &quot;A String&quot;, # [Output-only] Reservation name or &quot;unreserved&quot; for on-demand resources usage.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2654 },
2655 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2656 &quot;ddlTargetRoutine&quot;: { # The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.
2657 &quot;routineId&quot;: &quot;A String&quot;, # [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.
2658 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this routine.
2659 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this routine.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2660 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2661 },
2662 &quot;quotaDeferments&quot;: [ # [Output-only] Quotas which delayed this job&#x27;s start time.
2663 &quot;A String&quot;,
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2664 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2665 &quot;scriptStatistics&quot;: { # [Output-only] Statistics for a child job of a script.
2666 &quot;stackFrames&quot;: [ # Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty.
2667 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2668 &quot;procedureId&quot;: &quot;A String&quot;, # [Output-only] Name of the active procedure, empty if in a top-level script.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2669 &quot;startColumn&quot;: 42, # [Output-only] One-based start column.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2670 &quot;startLine&quot;: 42, # [Output-only] One-based start line.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2671 &quot;endColumn&quot;: 42, # [Output-only] One-based end column.
2672 &quot;endLine&quot;: 42, # [Output-only] One-based end line.
2673 &quot;text&quot;: &quot;A String&quot;, # [Output-only] Text of the current statement/expression.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2674 },
2675 ],
2676 &quot;evaluationKind&quot;: &quot;A String&quot;, # [Output-only] Whether this child job was a statement or expression.
2677 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2678 &quot;parentJobId&quot;: &quot;A String&quot;, # [Output-only] If this is a child job, the id of the parent.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2679 &quot;totalSlotMs&quot;: &quot;A String&quot;, # [Output-only] Slot-milliseconds for the job.
2680 &quot;load&quot;: { # [Output-only] Statistics for a load job.
2681 &quot;outputRows&quot;: &quot;A String&quot;, # [Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.
2682 &quot;inputFileBytes&quot;: &quot;A String&quot;, # [Output-only] Number of bytes of source data in a load job.
2683 &quot;badRecords&quot;: &quot;A String&quot;, # [Output-only] The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.
2684 &quot;outputBytes&quot;: &quot;A String&quot;, # [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.
2685 &quot;inputFiles&quot;: &quot;A String&quot;, # [Output-only] Number of source files in a load job.
2686 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]2687 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2688 &quot;id&quot;: &quot;A String&quot;, # Unique opaque ID of the job.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2689 &quot;configuration&quot;: { # [Full-projection-only] Specifies the job configuration.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2690 &quot;extract&quot;: { # [Pick one] Configures an extract job.
2691 &quot;compression&quot;: &quot;A String&quot;, # [Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.
2692 &quot;destinationUris&quot;: [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.
2693 &quot;A String&quot;,
2694 ],
2695 &quot;useAvroLogicalTypes&quot;: True or False, # [Optional] If destinationFormat is set to &quot;AVRO&quot;, this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.
2696 &quot;destinationFormat&quot;: &quot;A String&quot;, # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.
2697 &quot;sourceTable&quot;: { # A reference to the table being exported.
2698 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
2699 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
2700 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2701 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2702 &quot;destinationUri&quot;: &quot;A String&quot;, # [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.
2703 &quot;fieldDelimiter&quot;: &quot;A String&quot;, # [Optional] Delimiter to use between fields in the exported data. Default is &#x27;,&#x27;. Not applicable when extracting models.
2704 &quot;printHeader&quot;: true, # [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.
2705 &quot;sourceModel&quot;: { # A reference to the model being exported.
2706 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this model.
2707 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this model.
2708 &quot;modelId&quot;: &quot;A String&quot;, # [Required] The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
2709 },
2710 },
2711 &quot;dryRun&quot;: True or False, # [Optional] If set, don&#x27;t actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn&#x27;t a dry run. Behavior of non-query jobs is undefined.
2712 &quot;load&quot;: { # [Pick one] Configures a load job.
2713 &quot;allowQuotedNewlines&quot;: True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
2714 &quot;schema&quot;: { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you&#x27;re loading data from Google Cloud Datastore.
2715 &quot;fields&quot;: [ # Describes the fields in a table.
2716 {
2717 &quot;type&quot;: &quot;A String&quot;, # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
2718 &quot;categories&quot;: { # [Optional] The categories attached to this field, used for field-level access control.
2719 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/taxonomies/2/categories/3&quot;. At most 5 categories are allowed.
2720 &quot;A String&quot;,
2721 ],
2722 },
2723 &quot;fields&quot;: [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
2724 # Object with schema name: TableFieldSchema
2725 ],
2726 &quot;name&quot;: &quot;A String&quot;, # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
2727 &quot;description&quot;: &quot;A String&quot;, # [Optional] The field description. The maximum length is 1,024 characters.
2728 &quot;policyTags&quot;: {
2729 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/location/eu/taxonomies/2/policyTags/3&quot;. At most 1 policy tag is allowed.
2730 &quot;A String&quot;,
2731 ],
2732 },
2733 &quot;mode&quot;: &quot;A String&quot;, # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
2734 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2735 ],
2736 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2737 &quot;decimalTargetTypes&quot;: [ # [Trusted Tester] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. For example: suppose decimal_target_type = [&quot;NUMERIC&quot;, &quot;BIGNUMERIC&quot;]. Then if (precision,scale) is: * (38,9) -&gt; NUMERIC; * (39,9) -&gt; BIGNUMERIC (NUMERIC cannot hold 30 integer digits); * (38,10) -&gt; BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); * (76,38) -&gt; BIGNUMERIC; * (77,38) -&gt; BIGNUMERIC (error if value exeeds supported range). For duplicated types in this field, only one will be considered and the rest will be ignored. The order of the types in this field is ignored. For example, [&quot;BIGNUMERIC&quot;, &quot;NUMERIC&quot;] is the same as [&quot;NUMERIC&quot;, &quot;BIGNUMERIC&quot;] and NUMERIC always takes precedence over BIGNUMERIC.
2738 &quot;A String&quot;,
2739 ],
2740 &quot;skipLeadingRows&quot;: 42, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.
2741 &quot;timePartitioning&quot;: { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
2742 &quot;requirePartitionFilter&quot;: True or False,
2743 &quot;type&quot;: &quot;A String&quot;, # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.
2744 &quot;expirationMs&quot;: &quot;A String&quot;, # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
2745 &quot;field&quot;: &quot;A String&quot;, # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either &#x27;_PARTITIONTIME&#x27; as TIMESTAMP type, or &#x27;_PARTITIONDATE&#x27; as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
2746 },
2747 &quot;destinationEncryptionConfiguration&quot;: { # Custom encryption configuration (e.g., Cloud KMS keys).
2748 &quot;kmsKeyName&quot;: &quot;A String&quot;, # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
2749 },
2750 &quot;schemaUpdateOptions&quot;: [ # Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
2751 &quot;A String&quot;,
2752 ],
2753 &quot;destinationTable&quot;: { # [Required] The destination table to load the data into.
2754 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
2755 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
2756 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
2757 },
2758 &quot;schemaInline&quot;: &quot;A String&quot;, # [Deprecated] The inline schema. For CSV schemas, specify as &quot;Field1:Type1[,Field2:Type2]*&quot;. For example, &quot;foo:STRING, bar:INTEGER, baz:FLOAT&quot;.
2759 &quot;projectionFields&quot;: [ # If sourceFormat is set to &quot;DATASTORE_BACKUP&quot;, indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn&#x27;t found in the Cloud Datastore backup, an invalid error is returned in the job result.
2760 &quot;A String&quot;,
2761 ],
2762 &quot;maxBadRecords&quot;: 42, # [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2763 &quot;allowJaggedRows&quot;: True or False, # [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2764 &quot;schemaInlineFormat&quot;: &quot;A String&quot;, # [Deprecated] The format of the schemaInline property.
2765 &quot;autodetect&quot;: True or False, # [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.
2766 &quot;encoding&quot;: &quot;A String&quot;, # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2767 &quot;destinationTableProperties&quot;: { # [Beta] [Optional] Properties with which to create the destination table if it is new.
2768 &quot;labels&quot;: { # [Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.
2769 &quot;a_key&quot;: &quot;A String&quot;,
2770 },
2771 &quot;description&quot;: &quot;A String&quot;, # [Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.
2772 &quot;friendlyName&quot;: &quot;A String&quot;, # [Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.
2773 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2774 &quot;createDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a &#x27;notFound&#x27; error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2775 &quot;sourceUris&quot;: [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one &#x27;*&#x27; wildcard character and it must come after the &#x27;bucket&#x27; name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the &#x27;*&#x27; wildcard character is not allowed.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2776 &quot;A String&quot;,
2777 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2778 &quot;rangePartitioning&quot;: { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
2779 &quot;field&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
2780 &quot;range&quot;: { # [TrustedTester] [Required] Defines the ranges for range partitioning.
2781 &quot;interval&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The width of each interval.
2782 &quot;end&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The end of range partitioning, exclusive.
2783 &quot;start&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The start of range partitioning, inclusive.
2784 },
2785 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2786 &quot;useAvroLogicalTypes&quot;: True or False, # [Optional] If sourceFormat is set to &quot;AVRO&quot;, indicates whether to enable interpreting logical types into their corresponding types (ie. TIMESTAMP), instead of only using their raw types (ie. INTEGER).
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2787 &quot;ignoreUnknownValues&quot;: True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don&#x27;t match any column names
2788 &quot;sourceFormat&quot;: &quot;A String&quot;, # [Optional] The format of the data files. For CSV files, specify &quot;CSV&quot;. For datastore backups, specify &quot;DATASTORE_BACKUP&quot;. For newline-delimited JSON, specify &quot;NEWLINE_DELIMITED_JSON&quot;. For Avro, specify &quot;AVRO&quot;. For parquet, specify &quot;PARQUET&quot;. For orc, specify &quot;ORC&quot;. The default value is CSV.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2789 &quot;fieldDelimiter&quot;: &quot;A String&quot;, # [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence &quot;\t&quot; to specify a tab separator. The default value is a comma (&#x27;,&#x27;).
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2790 &quot;clustering&quot;: { # [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
2791 &quot;fields&quot;: [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
2792 &quot;A String&quot;,
2793 ],
2794 },
2795 &quot;nullMarker&quot;: &quot;A String&quot;, # [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify &quot;\N&quot;, BigQuery interprets &quot;\N&quot; as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.
2796 &quot;quote&quot;: &quot;&quot;&quot;, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote (&#x27;&quot;&#x27;). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
2797 &quot;hivePartitioningOptions&quot;: { # [Optional, Trusted Tester] Options to configure hive partitioning support.
2798 &quot;requirePartitionFilter&quot;: True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
2799 &quot;mode&quot;: &quot;A String&quot;, # [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
2800 &quot;sourceUriPrefix&quot;: &quot;A String&quot;, # [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
2801 },
2802 &quot;writeDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a &#x27;duplicate&#x27; error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
2803 },
2804 &quot;jobType&quot;: &quot;A String&quot;, # [Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
2805 &quot;query&quot;: { # [Pick one] Configures a query job.
2806 &quot;query&quot;: &quot;A String&quot;, # [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.
2807 &quot;flattenResults&quot;: true, # [Optional] If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened.
2808 &quot;rangePartitioning&quot;: { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.
2809 &quot;field&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.
2810 &quot;range&quot;: { # [TrustedTester] [Required] Defines the ranges for range partitioning.
2811 &quot;interval&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The width of each interval.
2812 &quot;end&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The end of range partitioning, exclusive.
2813 &quot;start&quot;: &quot;A String&quot;, # [TrustedTester] [Required] The start of range partitioning, inclusive.
2814 },
2815 },
2816 &quot;maximumBillingTier&quot;: 1, # [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.
2817 &quot;priority&quot;: &quot;A String&quot;, # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.
2818 &quot;destinationTable&quot;: { # [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size.
2819 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
2820 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
2821 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
2822 },
2823 &quot;tableDefinitions&quot;: { # [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.
2824 &quot;a_key&quot;: {
2825 &quot;hivePartitioningOptions&quot;: { # [Optional, Trusted Tester] Options to configure hive partitioning support.
2826 &quot;requirePartitionFilter&quot;: True or False, # [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.
2827 &quot;mode&quot;: &quot;A String&quot;, # [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.
2828 &quot;sourceUriPrefix&quot;: &quot;A String&quot;, # [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).
2829 },
2830 &quot;schema&quot;: { # [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats.
2831 &quot;fields&quot;: [ # Describes the fields in a table.
2832 {
2833 &quot;type&quot;: &quot;A String&quot;, # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
2834 &quot;categories&quot;: { # [Optional] The categories attached to this field, used for field-level access control.
2835 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/taxonomies/2/categories/3&quot;. At most 5 categories are allowed.
2836 &quot;A String&quot;,
2837 ],
2838 },
2839 &quot;fields&quot;: [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
2840 # Object with schema name: TableFieldSchema
2841 ],
2842 &quot;name&quot;: &quot;A String&quot;, # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
2843 &quot;description&quot;: &quot;A String&quot;, # [Optional] The field description. The maximum length is 1,024 characters.
2844 &quot;policyTags&quot;: {
2845 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/location/eu/taxonomies/2/policyTags/3&quot;. At most 1 policy tag is allowed.
2846 &quot;A String&quot;,
2847 ],
2848 },
2849 &quot;mode&quot;: &quot;A String&quot;, # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
2850 },
2851 ],
2852 },
2853 &quot;maxBadRecords&quot;: 42, # [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
2854 &quot;bigtableOptions&quot;: { # [Optional] Additional options if sourceFormat is set to BIGTABLE.
2855 &quot;readRowkeyAsString&quot;: True or False, # [Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.
2856 &quot;ignoreUnspecifiedColumnFamilies&quot;: True or False, # [Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.
2857 &quot;columnFamilies&quot;: [ # [Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the &#x27;type&#x27; field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.
2858 {
2859 &quot;encoding&quot;: &quot;A String&quot;, # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in &#x27;columns&#x27; and specifying an encoding for it.
2860 &quot;onlyReadLatest&quot;: True or False, # [Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in &#x27;columns&#x27; and specifying a different setting for that column.
2861 &quot;familyId&quot;: &quot;A String&quot;, # Identifier of the column family.
2862 &quot;columns&quot;: [ # [Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.
2863 {
2864 &quot;fieldName&quot;: &quot;A String&quot;, # [Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.
2865 &quot;encoding&quot;: &quot;A String&quot;, # [Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. &#x27;encoding&#x27; can also be set at the column family level. However, the setting at this level takes precedence if &#x27;encoding&#x27; is set at both levels.
2866 &quot;type&quot;: &quot;A String&quot;, # [Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. &#x27;type&#x27; can also be set at the column family level. However, the setting at this level takes precedence if &#x27;type&#x27; is set at both levels.
2867 &quot;qualifierString&quot;: &quot;A String&quot;,
2868 &quot;qualifierEncoded&quot;: &quot;A String&quot;, # [Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.
2869 &quot;onlyReadLatest&quot;: True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. &#x27;onlyReadLatest&#x27; can also be set at the column family level. However, the setting at this level takes precedence if &#x27;onlyReadLatest&#x27; is set at both levels.
2870 },
2871 ],
2872 &quot;type&quot;: &quot;A String&quot;, # [Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in &#x27;columns&#x27; and specifying a type for it.
2873 },
2874 ],
2875 },
2876 &quot;autodetect&quot;: True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.
2877 &quot;sourceFormat&quot;: &quot;A String&quot;, # [Required] The data format. For CSV files, specify &quot;CSV&quot;. For Google sheets, specify &quot;GOOGLE_SHEETS&quot;. For newline-delimited JSON, specify &quot;NEWLINE_DELIMITED_JSON&quot;. For Avro files, specify &quot;AVRO&quot;. For Google Cloud Datastore backups, specify &quot;DATASTORE_BACKUP&quot;. [Beta] For Google Cloud Bigtable, specify &quot;BIGTABLE&quot;.
2878 &quot;connectionId&quot;: &quot;A String&quot;, # [Optional, Trusted Tester] Connection for external data source.
2879 &quot;ignoreUnknownValues&quot;: True or False, # [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don&#x27;t match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.
2880 &quot;csvOptions&quot;: { # Additional properties to set if sourceFormat is set to CSV.
2881 &quot;encoding&quot;: &quot;A String&quot;, # [Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.
2882 &quot;allowJaggedRows&quot;: True or False, # [Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.
2883 &quot;fieldDelimiter&quot;: &quot;A String&quot;, # [Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence &quot;\t&quot; to specify a tab separator. The default value is a comma (&#x27;,&#x27;).
2884 &quot;quote&quot;: &quot;&quot;&quot;, # [Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote (&#x27;&quot;&#x27;). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.
2885 &quot;skipLeadingRows&quot;: &quot;A String&quot;, # [Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N &gt; 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
2886 &quot;allowQuotedNewlines&quot;: True or False, # [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.
2887 },
2888 &quot;compression&quot;: &quot;A String&quot;, # [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.
2889 &quot;googleSheetsOptions&quot;: { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
2890 &quot;skipLeadingRows&quot;: &quot;A String&quot;, # [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N &gt; 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.
2891 &quot;range&quot;: &quot;A String&quot;, # [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20
2892 },
2893 &quot;sourceUris&quot;: [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one &#x27;*&#x27; wildcard character and it must come after the &#x27;bucket&#x27; name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the &#x27;*&#x27; wildcard character is not allowed.
2894 &quot;A String&quot;,
2895 ],
2896 },
2897 },
2898 &quot;queryParameters&quot;: [ # Query parameters for standard SQL queries.
2899 {
2900 &quot;parameterValue&quot;: { # [Required] The value of this parameter.
2901 &quot;arrayValues&quot;: [ # [Optional] The array values, if this is an array type.
2902 # Object with schema name: QueryParameterValue
2903 ],
2904 &quot;value&quot;: &quot;A String&quot;, # [Optional] The value of this value, if a simple scalar type.
2905 &quot;structValues&quot;: { # [Optional] The struct field values, in order of the struct type&#x27;s declaration.
2906 &quot;a_key&quot;: # Object with schema name: QueryParameterValue
2907 },
2908 },
2909 &quot;name&quot;: &quot;A String&quot;, # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
2910 &quot;parameterType&quot;: { # [Required] The type of this parameter.
2911 &quot;arrayType&quot;: # Object with schema name: QueryParameterType # [Optional] The type of the array&#x27;s elements, if this is an array.
2912 &quot;structTypes&quot;: [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
2913 {
2914 &quot;type&quot;: # Object with schema name: QueryParameterType # [Required] The type of this field.
2915 &quot;description&quot;: &quot;A String&quot;, # [Optional] Human-oriented description of the field.
2916 &quot;name&quot;: &quot;A String&quot;, # [Optional] The name of this field.
2917 },
2918 ],
2919 &quot;type&quot;: &quot;A String&quot;, # [Required] The top level type of this field.
2920 },
2921 },
2922 ],
2923 &quot;allowLargeResults&quot;: false, # [Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size.
2924 &quot;maximumBytesBilled&quot;: &quot;A String&quot;, # [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.
2925 &quot;destinationEncryptionConfiguration&quot;: { # Custom encryption configuration (e.g., Cloud KMS keys).
2926 &quot;kmsKeyName&quot;: &quot;A String&quot;, # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
2927 },
2928 &quot;useLegacySql&quot;: true, # Specifies whether to use BigQuery&#x27;s legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery&#x27;s standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.
2929 &quot;parameterMode&quot;: &quot;A String&quot;, # Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
2930 &quot;connectionProperties&quot;: [ # Connection properties.
2931 {
2932 &quot;key&quot;: &quot;A String&quot;, # [Required] Name of the connection property to set.
2933 &quot;value&quot;: &quot;A String&quot;, # [Required] Value of the connection property.
2934 },
2935 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2936 &quot;timePartitioning&quot;: { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.
2937 &quot;requirePartitionFilter&quot;: True or False,
2938 &quot;type&quot;: &quot;A String&quot;, # [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.
2939 &quot;expirationMs&quot;: &quot;A String&quot;, # [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.
2940 &quot;field&quot;: &quot;A String&quot;, # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either &#x27;_PARTITIONTIME&#x27; as TIMESTAMP type, or &#x27;_PARTITIONDATE&#x27; as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
2941 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2942 &quot;schemaUpdateOptions&quot;: [ # Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2943 &quot;A String&quot;,
2944 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2945 &quot;preserveNulls&quot;: True or False, # [Deprecated] This property is deprecated.
2946 &quot;userDefinedFunctionResources&quot;: [ # Describes user-defined function resources used in the query.
2947 { # This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions
2948 &quot;inlineCode&quot;: &quot;A String&quot;, # [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.
2949 &quot;resourceUri&quot;: &quot;A String&quot;, # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).
2950 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2951 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2952 &quot;defaultDataset&quot;: { # [Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names.
2953 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
2954 &quot;projectId&quot;: &quot;A String&quot;, # [Optional] The ID of the project containing this dataset.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2955 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2956 &quot;useQueryCache&quot;: true, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.
2957 &quot;clustering&quot;: { # [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
2958 &quot;fields&quot;: [ # [Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.
2959 &quot;A String&quot;,
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2960 ],
2961 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2962 &quot;createDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a &#x27;notFound&#x27; error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
2963 &quot;writeDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a &#x27;duplicate&#x27; error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
2964 },
2965 &quot;labels&quot;: { # The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
2966 &quot;a_key&quot;: &quot;A String&quot;,
2967 },
2968 &quot;jobTimeoutMs&quot;: &quot;A String&quot;, # [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.
2969 &quot;copy&quot;: { # [Pick one] Copies a table.
2970 &quot;sourceTable&quot;: { # [Pick one] Source table to copy.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2971 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
2972 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
2973 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
2974 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2975 &quot;destinationEncryptionConfiguration&quot;: { # Custom encryption configuration (e.g., Cloud KMS keys).
2976 &quot;kmsKeyName&quot;: &quot;A String&quot;, # [Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.
2977 },
2978 &quot;destinationTable&quot;: { # [Required] The destination table
2979 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
2980 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
2981 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
2982 },
2983 &quot;operationType&quot;: &quot;A String&quot;, # [Optional] Supported operation types in table copy job.
2984 &quot;writeDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a &#x27;duplicate&#x27; error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.
2985 &quot;destinationExpirationTime&quot;: &quot;&quot;, # [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2986 &quot;sourceTables&quot;: [ # [Pick one] Source tables to copy.
2987 {
2988 &quot;tableId&quot;: &quot;A String&quot;, # [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
2989 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] The ID of the dataset containing this table.
2990 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this table.
2991 },
2992 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]2993 &quot;createDisposition&quot;: &quot;A String&quot;, # [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a &#x27;notFound&#x27; error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]2994 },
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]2995 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2996 &quot;user_email&quot;: &quot;A String&quot;, # [Full-projection-only] Email address of the user who ran the job.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]2997 },
2998 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]2999 &quot;kind&quot;: &quot;bigquery#jobList&quot;, # The resource type of the response.
3000 &quot;etag&quot;: &quot;A String&quot;, # A hash of this page of results.
3001 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to request the next page of results.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3002 }</pre>
3003</div>
3004
3005<div class="method">
3006 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
3007 <pre>Retrieves the next page of results.
3008
3009Args:
3010 previous_request: The request for the previous page. (required)
3011 previous_response: The response from the request for the previous page. (required)
3012
3013Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3014 A request object that you can call &#x27;execute()&#x27; on to request the next
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3015 page. Returns None if there are no more items in the collection.
3016 </pre>
3017</div>
3018
3019<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3020 <code class="details" id="query">query(projectId, body=None)</code>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3021 <pre>Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.
3022
3023Args:
3024 projectId: string, Project ID of the project billed for the query (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]3025 body: object, The request body.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3026 The object takes the form of:
3027
3028{
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]3029 &quot;kind&quot;: &quot;bigquery#queryRequest&quot;, # The resource type of the request.
3030 &quot;location&quot;: &quot;A String&quot;, # The geographic location where the job should run. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
3031 &quot;timeoutMs&quot;: 42, # [Optional] How long to wait for the query to complete, in milliseconds, before the request times out and returns. Note that this is only a timeout for the request, not the query. If the query takes longer to run than the timeout value, the call returns without any results and with the &#x27;jobComplete&#x27; flag set to false. You can call GetQueryResults() to wait for the query to complete and read the results. The default value is 10000 milliseconds (10 seconds).
3032 &quot;parameterMode&quot;: &quot;A String&quot;, # Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.
3033 &quot;dryRun&quot;: True or False, # [Optional] If set to true, BigQuery doesn&#x27;t run the job. Instead, if the query is valid, BigQuery returns statistics about the job such as how many bytes would be processed. If the query is invalid, an error returns. The default value is false.
3034 &quot;useLegacySql&quot;: true, # Specifies whether to use BigQuery&#x27;s legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery&#x27;s standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.
3035 &quot;preserveNulls&quot;: True or False, # [Deprecated] This property is deprecated.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]3036 &quot;labels&quot;: { # The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.
3037 &quot;a_key&quot;: &quot;A String&quot;,
3038 },
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]3039 &quot;maximumBytesBilled&quot;: &quot;A String&quot;, # [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]3040 &quot;defaultDataset&quot;: { # [Optional] Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be qualified in the format &#x27;datasetId.tableId&#x27;.
3041 &quot;datasetId&quot;: &quot;A String&quot;, # [Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.
3042 &quot;projectId&quot;: &quot;A String&quot;, # [Optional] The ID of the project containing this dataset.
3043 },
3044 &quot;maxResults&quot;: 42, # [Optional] The maximum number of rows of data to return per page of results. Setting this flag to a small value such as 1000 and then paging through results might improve reliability when the query result set is large. In addition to this limit, responses are also limited to 10 MB. By default, there is no maximum row count, and only the byte limit applies.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]3045 &quot;query&quot;: &quot;A String&quot;, # [Required] A query string, following the BigQuery query syntax, of the query to execute. Example: &quot;SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]&quot;.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]3046 &quot;requestId&quot;: &quot;A String&quot;, # A unique user provided identifier to ensure idempotent behavior for queries. Note that this is different from the job_id. It has the following properties: 1. It is case-sensitive, limited to up to 36 ASCII characters. A UUID is recommended. 2. Read only queries can ignore this token since they are nullipotent by definition. 3. For the purposes of idempotency ensured by the request_id, a request is considered duplicate of another only if they have the same request_id and are actually duplicates. When determining whether a request is a duplicate of the previous request, all parameters in the request that may affect the behavior are considered. For example, query, connection_properties, query_parameters, use_legacy_sql are parameters that affect the result and are considered when determining whether a request is a duplicate, but properties like timeout_ms don&#x27;t affect the result and are thus not considered. Dry run query requests are never considered duplicate of another request. 4. When a duplicate mutating query request is detected, it returns: a. the results of the mutation if it completes successfully within the timeout. b. the running operation if it is still in progress at the end of the timeout. 5. Its lifetime is limited to 15 minutes. In other words, if two requests are sent with the same request_id, but more than 15 minutes apart, idempotency is not guaranteed.
3047 &quot;connectionProperties&quot;: [ # Connection properties.
3048 {
3049 &quot;key&quot;: &quot;A String&quot;, # [Required] Name of the connection property to set.
3050 &quot;value&quot;: &quot;A String&quot;, # [Required] Value of the connection property.
3051 },
3052 ],
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]3053 &quot;queryParameters&quot;: [ # Query parameters for Standard SQL queries.
3054 {
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]3055 &quot;parameterValue&quot;: { # [Required] The value of this parameter.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]3056 &quot;arrayValues&quot;: [ # [Optional] The array values, if this is an array type.
3057 # Object with schema name: QueryParameterValue
3058 ],
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]3059 &quot;value&quot;: &quot;A String&quot;, # [Optional] The value of this value, if a simple scalar type.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]3060 &quot;structValues&quot;: { # [Optional] The struct field values, in order of the struct type&#x27;s declaration.
3061 &quot;a_key&quot;: # Object with schema name: QueryParameterValue
3062 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]3063 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]3064 &quot;name&quot;: &quot;A String&quot;, # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]3065 &quot;parameterType&quot;: { # [Required] The type of this parameter.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]3066 &quot;arrayType&quot;: # Object with schema name: QueryParameterType # [Optional] The type of the array&#x27;s elements, if this is an array.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]3067 &quot;structTypes&quot;: [ # [Optional] The types of the fields of this struct, in order, if this is a struct.
3068 {
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]3069 &quot;type&quot;: # Object with schema name: QueryParameterType # [Required] The type of this field.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]3070 &quot;description&quot;: &quot;A String&quot;, # [Optional] Human-oriented description of the field.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]3071 &quot;name&quot;: &quot;A String&quot;, # [Optional] The name of this field.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]3072 },
3073 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]3074 &quot;type&quot;: &quot;A String&quot;, # [Required] The top level type of this field.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]3075 },
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]3076 },
3077 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]3078 &quot;useQueryCache&quot;: true, # [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3079 }
3080
3081
3082Returns:
3083 An object of the form:
3084
3085 {
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]3086 &quot;totalRows&quot;: &quot;A String&quot;, # The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results.
3087 &quot;errors&quot;: [ # [Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.
3088 {
3089 &quot;reason&quot;: &quot;A String&quot;, # A short error code that summarizes the error.
3090 &quot;debugInfo&quot;: &quot;A String&quot;, # Debugging information. This property is internal to Google and should not be used.
3091 &quot;location&quot;: &quot;A String&quot;, # Specifies where the error occurred, if present.
3092 &quot;message&quot;: &quot;A String&quot;, # A human-readable description of the error.
3093 },
3094 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]3095 &quot;schema&quot;: { # The schema of the results. Present only when the query completes successfully.
3096 &quot;fields&quot;: [ # Describes the fields in a table.
3097 {
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]3098 &quot;type&quot;: &quot;A String&quot;, # [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).
3099 &quot;categories&quot;: { # [Optional] The categories attached to this field, used for field-level access control.
3100 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/taxonomies/2/categories/3&quot;. At most 5 categories are allowed.
3101 &quot;A String&quot;,
3102 ],
3103 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]3104 &quot;fields&quot;: [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.
3105 # Object with schema name: TableFieldSchema
3106 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]3107 &quot;name&quot;: &quot;A String&quot;, # [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 128 characters.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]3108 &quot;description&quot;: &quot;A String&quot;, # [Optional] The field description. The maximum length is 1,024 characters.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]3109 &quot;policyTags&quot;: {
3110 &quot;names&quot;: [ # A list of category resource names. For example, &quot;projects/1/location/eu/taxonomies/2/policyTags/3&quot;. At most 1 policy tag is allowed.
3111 &quot;A String&quot;,
3112 ],
3113 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]3114 &quot;mode&quot;: &quot;A String&quot;, # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]3115 },
3116 ],
3117 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]3118 &quot;pageToken&quot;: &quot;A String&quot;, # A token used for paging results.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]3119 &quot;jobReference&quot;: { # Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults).
3120 &quot;projectId&quot;: &quot;A String&quot;, # [Required] The ID of the project containing this job.
3121 &quot;location&quot;: &quot;A String&quot;, # The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.
3122 &quot;jobId&quot;: &quot;A String&quot;, # [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.
3123 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]3124 &quot;cacheHit&quot;: True or False, # Whether the query result was fetched from the query cache.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]3125 &quot;jobComplete&quot;: True or False, # Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3126 &quot;rows&quot;: [ # An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]3127 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3128 &quot;f&quot;: [ # Represents a single row in the result set, consisting of one or more fields.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]3129 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]3130 &quot;v&quot;: &quot;&quot;,
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]3131 },
3132 ],
3133 },
3134 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame^]3135 &quot;numDmlAffectedRows&quot;: &quot;A String&quot;, # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
3136 &quot;totalBytesProcessed&quot;: &quot;A String&quot;, # The total number of bytes processed for this query. If this query was a dry run, this is the number of bytes that would be processed if the query were run.
3137 &quot;kind&quot;: &quot;bigquery#queryResponse&quot;, # The resource type.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]3138 }</pre>
3139</div>
3140
3141</body></html>