Blame - docs/dyn/bigquery_v2.jobs.html - platform/external/python/google-api-python-client

2015-06-15 16:44:50 +0000

[diff] [blame]

80

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

81

<code><a href="#get">get(projectId, jobId, location=None)</a></code></p>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

82

<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 Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

83

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

84

<code><a href="#getQueryResults">getQueryResults(projectId, jobId, startIndex=None, location=None, pageToken=None, timeoutMs=None, maxResults=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

85

<p class="firstline">Retrieves the results of a query job.</p>

86

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

87

<code><a href="#getQueryResults_next">getQueryResults_next(previous_request, previous_response)</a></code></p>

88

<p class="firstline">Retrieves the next page of results.</p>

89

Jon Wayne Parrott

692617a

2017-01-06 09:58:29 -0800

[diff] [blame]

90

<code><a href="#insert">insert(projectId, body=None, media_body=None, media_mime_type=None)</a></code></p>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

91

<p class="firstline">Starts a new asynchronous job. Requires the Can View project role.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

92

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

93

<code><a href="#list">list(projectId, stateFilter=None, projection=None, minCreationTime=None, parentJobId=None, allUsers=None, pageToken=None, maxCreationTime=None, maxResults=None)</a></code></p>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

94

<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 Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

95

96

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

97

<p class="firstline">Retrieves the next page of results.</p>

98

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

99

<code><a href="#query">query(projectId, body=None)</a></code></p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

100

<p class="firstline">Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.</p>

101

<h3>Method Details</h3>

102

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

103

<code class="details" id="cancel">cancel(projectId, jobId, location=None)</code>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

104

<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 Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

105

106

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

107

projectId: string, [Required] Project ID of the job to cancel (required)

108

jobId: string, [Required] Job ID of the job to cancel (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

109

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 Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

110

111

Returns:

112

An object of the form:

113

114

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

115

"job": { # The final state of the job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

116

"status": { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.

117

"errors": [ # [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.

118

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

119

"reason": "A String", # A short error code that summarizes the error.

120

"message": "A String", # A human-readable description of the error.

121

"location": "A String", # Specifies where the error occurred, if present.

122

"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.

123

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

124

],

125

"state": "A String", # [Output-only] Running state of the job.

126

"errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.

127

"reason": "A String", # A short error code that summarizes the error.

128

"message": "A String", # A human-readable description of the error.

129

"location": "A String", # Specifies where the error occurred, if present.

130

"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

131

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

132

},

133

"statistics": { # [Output-only] Information about the job, including starting time and ending time of the job.

134

"extract": { # [Output-only] Statistics for an extract job.

135

"destinationUriFileCounts": [ # [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 'destinationUris' field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

136

"A String",

137

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

138

"inputBytes": "A String", # [Output-only] Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.

139

},

140

"endTime": "A String", # [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.

141

"completionRatio": 3.14, # [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.

142

"startTime": "A String", # [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

"totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.

144

"scriptStatistics": { # [Output-only] Statistics for a child job of a script.

145

"evaluationKind": "A String", # [Output-only] Whether this child job was a statement or expression.

146

"stackFrames": [ # 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.

147

{

148

"procedureId": "A String", # [Output-only] Name of the active procedure, empty if in a top-level script.

149

"startLine": 42, # [Output-only] One-based start line.

150

"text": "A String", # [Output-only] Text of the current statement/expression.

151

"endColumn": 42, # [Output-only] One-based end column.

152

"endLine": 42, # [Output-only] One-based end line.

153

"startColumn": 42, # [Output-only] One-based start column.

},

],

},

"query": { # [Output-only] Statistics for a query job.

158

"timeline": [ # [Output-only] [Beta] Describes a timeline of job execution.

159

{

160

"activeUnits": "A String", # 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.

161

"completedUnits": "A String", # Total parallel units of work completed by this query.

162

"elapsedMs": "A String", # Milliseconds elapsed since the start of query execution.

163

"pendingUnits": "A String", # Total parallel units of work remaining for the active stages.

164

"totalSlotMs": "A String", # Cumulative slot-ms consumed by the query.

165

},

166

],

167

"ddlTargetRoutine": { # The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.

168

"projectId": "A String", # [Required] The ID of the project containing this routine.

169

"datasetId": "A String", # [Required] The ID of the dataset containing this routine.

170

"routineId": "A String", # [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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

171

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

172

"queryPlan": [ # [Output-only] Describes execution plan for the query.

173

{

174

"steps": [ # List of operations within the stage in dependency order (approximately chronological).

175

{

176

"substeps": [ # Human-readable stage descriptions.

177

"A String",

178

],

179

"kind": "A String", # Machine-readable operation type.

180

},

181

],

182

"startMs": "A String", # Stage start time represented as milliseconds since epoch.

183

"writeMsMax": "A String", # Milliseconds the slowest shard spent on writing output.

184

"shuffleOutputBytesSpilled": "A String", # Total number of bytes written to shuffle and spilled to disk.

185

"readMsAvg": "A String", # Milliseconds the average shard spent reading input.

186

"waitMsAvg": "A String", # Milliseconds the average shard spent waiting to be scheduled.

187

"recordsRead": "A String", # Number of records read into the stage.

188

"writeMsAvg": "A String", # Milliseconds the average shard spent on writing output.

189

"waitRatioMax": 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled.

190

"waitMsMax": "A String", # Milliseconds the slowest shard spent waiting to be scheduled.

191

"writeRatioAvg": 3.14, # Relative amount of time the average shard spent on writing output.

192

"computeRatioAvg": 3.14, # Relative amount of time the average shard spent on CPU-bound tasks.

193

"completedParallelInputs": "A String", # Number of parallel input segments completed.

194

"recordsWritten": "A String", # Number of records written by the stage.

195

"waitRatioAvg": 3.14, # Relative amount of time the average shard spent waiting to be scheduled.

196

"readRatioMax": 3.14, # Relative amount of time the slowest shard spent reading input.

197

"readRatioAvg": 3.14, # Relative amount of time the average shard spent reading input.

198

"id": "A String", # Unique ID for stage within plan.

199

"writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output.

200

"endMs": "A String", # Stage end time represented as milliseconds since epoch.

201

"inputStages": [ # IDs for stages that are inputs to this stage.

202

"A String",

203

],

204

"computeMsAvg": "A String", # Milliseconds the average shard spent on CPU-bound tasks.

205

"computeMsMax": "A String", # Milliseconds the slowest shard spent on CPU-bound tasks.

206

"slotMs": "A String", # Slot-milliseconds used by the stage.

207

"readMsMax": "A String", # Milliseconds the slowest shard spent reading input.

208

"shuffleOutputBytes": "A String", # Total number of bytes written to shuffle.

209

"parallelInputs": "A String", # Number of parallel input segments to be processed.

210

"status": "A String", # Current status for the stage.

211

"name": "A String", # Human-readable name for stage.

212

"computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks.

213

},

214

],

215

"ddlTargetTable": { # [Output-only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.

216

"projectId": "A String", # [Required] The ID of the project containing this table.

217

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

218

"tableId": "A String", # [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.

219

},

220

"schema": { # [Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.

221

"fields": [ # Describes the fields in a table.

222

{

223

"name": "A String", # [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.

224

"type": "A String", # [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).

225

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

226

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

231

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

232

"policyTags": {

233

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

"A String",

],

},

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

238

# Object with schema name: TableFieldSchema

],

},

],

},

"estimatedBytesProcessed": "A String", # [Output-only] The original estimate of bytes processed for the job.

244

"referencedTables": [ # [Output-only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.

245

{

246

"projectId": "A String", # [Required] The ID of the project containing this table.

247

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

248

"tableId": "A String", # [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.

249

},

250

],

251

"modelTrainingCurrentIteration": 42, # [Output-only, Beta] Deprecated; do not use.

252

"numDmlAffectedRows": "A String", # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.

253

"totalBytesProcessed": "A String", # [Output-only] Total bytes processed for the job.

254

"statementType": "A String", # The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.

255

"ddlOperationPerformed": "A String", # The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": 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. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target.

256

"billingTier": 42, # [Output-only] Billing tier for the job.

257

"ddlTargetRowAccessPolicy": { # [Output-only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.

258

"datasetId": "A String", # [Required] The ID of the dataset containing this row access policy.

259

"policyId": "A String", # [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.

260

"tableId": "A String", # [Required] The ID of the table containing this row access policy.

261

"projectId": "A String", # [Required] The ID of the project containing this row access policy.

262

},

263

"modelTraining": { # [Output-only, Beta] Information about create model query job progress.

264

"expectedTotalIterations": "A String", # [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.

265

"currentIteration": 42, # [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.

266

},

267

"cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

268

"reservationUsage": [ # [Output-only] Job resource usage breakdown by reservation.

269

{

270

"slotMs": "A String", # [Output-only] Slot-milliseconds the job spent in the given reservation.

271

"name": "A String", # [Output-only] Reservation name or "unreserved" for on-demand resources usage.

272

},

273

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

274

"undeclaredQueryParameters": [ # Standard SQL only: list of undeclared query parameters detected during a dry run validation.

275

{

276

"name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.

277

"parameterType": { # [Required] The type of this parameter.

278

"arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.

279

"type": "A String", # [Required] The top level type of this field.

280

"structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.

281

{

282

"name": "A String", # [Optional] The name of this field.

283

"description": "A String", # [Optional] Human-oriented description of the field.

284

"type": # Object with schema name: QueryParameterType # [Required] The type of this field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

285

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

286

],

287

},

288

"parameterValue": { # [Required] The value of this parameter.

289

"structValues": { # [Optional] The struct field values, in order of the struct type's declaration.

290

"a_key": # Object with schema name: QueryParameterValue

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

291

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

292

"arrayValues": [ # [Optional] The array values, if this is an array type.

293

# Object with schema name: QueryParameterValue

294

],

295

"value": "A String", # [Optional] The value of this value, if a simple scalar type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

296

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

297

},

298

],

299

"totalPartitionsProcessed": "A String", # [Output-only] Total number of partitions processed from all partitioned tables referenced in the job.

300

"modelTrainingExpectedTotalIteration": "A String", # [Output-only, Beta] Deprecated; do not use.

301

"ddlAffectedRowAccessPolicyCount": "A String", # [Output-only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.

302

"totalSlotMs": "A String", # [Output-only] Slot-milliseconds for the job.

303

"totalBytesBilled": "A String", # [Output-only] Total bytes billed for the job.

304

"totalBytesProcessedAccuracy": "A String", # [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.

305

"referencedRoutines": [ # [Output-only] Referenced routines (persistent user-defined functions and stored procedures) for the job.

306

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

307

"projectId": "A String", # [Required] The ID of the project containing this routine.

308

"datasetId": "A String", # [Required] The ID of the dataset containing this routine.

309

"routineId": "A String", # [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.

310

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

311

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

312

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

313

"numChildJobs": "A String", # [Output-only] Number of child jobs executed.

314

"totalSlotMs": "A String", # [Output-only] Slot-milliseconds for the job.

315

"parentJobId": "A String", # [Output-only] If this is a child job, the id of the parent.

316

"reservation_id": "A String", # [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.

317

"quotaDeferments": [ # [Output-only] Quotas which delayed this job's start time.

318

"A String",

319

],

320

"rowLevelSecurityStatistics": { # [Output-only] [Preview] Statistics for row-level security. Present only for query and extract jobs.

321

"rowLevelSecurityApplied": True or False, # [Output-only] [Preview] Whether any accessed data was protected by row access policies.

322

},

323

"reservationUsage": [ # [Output-only] Job resource usage breakdown by reservation.

324

{

325

"slotMs": "A String", # [Output-only] Slot-milliseconds the job spent in the given reservation.

326

"name": "A String", # [Output-only] Reservation name or "unreserved" for on-demand resources usage.

327

},

328

],

329

"creationTime": "A String", # [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.

330

"load": { # [Output-only] Statistics for a load job.

331

"badRecords": "A String", # [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.

332

"inputFileBytes": "A String", # [Output-only] Number of bytes of source data in a load job.

333

"inputFiles": "A String", # [Output-only] Number of source files in a load job.

334

"outputRows": "A String", # [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.

335

"outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.

336

},

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

337

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

338

"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.

339

"id": "A String", # [Output-only] Opaque ID field of the job

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

340

"configuration": { # [Required] Describes the job configuration.

341

"copy": { # [Pick one] Copies a table.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

342

"destinationTable": { # [Required] The destination table

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

343

"projectId": "A String", # [Required] The ID of the project containing this table.

344

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

345

"tableId": "A String", # [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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

346

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

347

"destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

348

"kmsKeyName": "A String", # [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.

349

},

350

"sourceTables": [ # [Pick one] Source tables to copy.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

351

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

352

"projectId": "A String", # [Required] The ID of the project containing this table.

353

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

354

"tableId": "A String", # [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.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

355

},

356

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

357

"createDisposition": "A String", # [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 'notFound' 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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

358

"sourceTable": { # [Pick one] Source table to copy.

359

"projectId": "A String", # [Required] The ID of the project containing this table.

360

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

361

"tableId": "A String", # [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.

362

},

363

"writeDisposition": "A String", # [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 'duplicate' 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.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

364

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

365

"jobTimeoutMs": "A String", # [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.

366

"query": { # [Pick one] Configures a query job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

367

"queryParameters": [ # Query parameters for standard SQL queries.

368

{

369

"name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.

370

"parameterType": { # [Required] The type of this parameter.

371

"arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.

372

"type": "A String", # [Required] The top level type of this field.

373

"structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.

374

{

375

"name": "A String", # [Optional] The name of this field.

376

"description": "A String", # [Optional] Human-oriented description of the field.

377

"type": # Object with schema name: QueryParameterType # [Required] The type of this field.

},

],

},

"parameterValue": { # [Required] The value of this parameter.

382

"structValues": { # [Optional] The struct field values, in order of the struct type's declaration.

383

"a_key": # Object with schema name: QueryParameterValue

384

},

385

"arrayValues": [ # [Optional] The array values, if this is an array type.

386

# Object with schema name: QueryParameterValue

387

],

388

"value": "A String", # [Optional] The value of this value, if a simple scalar type.

},

},

],

"useLegacySql": true, # Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery'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.

393

"destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

394

"kmsKeyName": "A String", # [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.

395

},

396

"clustering": { # [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.

397

"fields": [ # [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.

"A String",

],

},

"createDisposition": "A String", # [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 'notFound' 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

402

"maximumBytesBilled": "A String", # [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.

403

"schemaUpdateOptions": [ # 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.

404

"A String",

405

],

406

"priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.

407

"connectionProperties": [ # Connection properties.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

408

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

409

"key": "A String", # [Required] Name of the connection property to set.

410

"value": "A String", # [Required] Value of the connection property.

411

},

412

],

413

"allowLargeResults": 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.

414

"rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

415

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

416

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

417

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

418

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

419

},

420

"field": "A String", # [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.

421

},

422

"parameterMode": "A String", # Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.

423

"useQueryCache": 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.

424

"flattenResults": 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.

425

"tableDefinitions": { # [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.

426

"a_key": {

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

427

"compression": "A String", # [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.

428

"maxBadRecords": 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.

429

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' 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 '*' wildcard character is not allowed.

430

"A String",

431

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

432

"csvOptions": { # Additional properties to set if sourceFormat is set to CSV.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

433

"quote": """, # [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 ('"'). 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.

434

"skipLeadingRows": "A String", # [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 > 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.

435

"allowJaggedRows": 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.

436

"fieldDelimiter": "A String", # [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 "\t" to specify a tab separator. The default value is a comma (',').

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

437

"encoding": "A String", # [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.

438

"allowQuotedNewlines": 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

439

},

440

"bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

441

"readRowkeyAsString": 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

442

"columnFamilies": [ # [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 'type' 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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

443

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

444

"onlyReadLatest": 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 'columns' and specifying a different setting for that column.

445

"encoding": "A String", # [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 'columns' and specifying an encoding for it.

446

"columns": [ # [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.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

447

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

448

"fieldName": "A String", # [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.

449

"qualifierString": "A String",

450

"encoding": "A String", # [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. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.

451

"type": "A String", # [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. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

452

"qualifierEncoded": "A String", # [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.

453

"onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

454

},

455

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

456

"type": "A String", # [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 'columns' and specifying a type for it.

457

"familyId": "A String", # Identifier of the column family.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

458

},

459

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

460

"ignoreUnspecifiedColumnFamilies": 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.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

461

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

462

"schema": { # [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.

463

"fields": [ # Describes the fields in a table.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

464

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

465

"name": "A String", # [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.

466

"type": "A String", # [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).

467

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

468

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

469

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

470

],

471

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

472

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

473

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

474

"policyTags": {

475

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

476

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

477

],

478

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

479

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

480

# Object with schema name: TableFieldSchema

481

],

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

482

},

483

],

484

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

485

"connectionId": "A String", # [Optional, Trusted Tester] Connection for external data source.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

486

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

487

"sourceUriPrefix": "A String", # [Optional, Trusted Tester] 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).

488

"mode": "A String", # [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two 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. 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.

489

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

490

"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.

491

"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

492

"range": "A String", # [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

493

"skipLeadingRows": "A String", # [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 > 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.

494

},

495

"ignoreUnknownValues": 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'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.

496

"sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

497

},

498

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

499

"defaultDataset": { # [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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

500

"datasetId": "A String", # [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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

501

"projectId": "A String", # [Optional] The ID of the project containing this dataset.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

502

},

503

"maximumBillingTier": 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.

504

"preserveNulls": True or False, # [Deprecated] This property is deprecated.

505

"timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

506

"requirePartitionFilter": True or False,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

507

"field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' 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.

508

"expirationMs": "A String", # [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.

509

"type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

510

},

511

"writeDisposition": "A String", # [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 'duplicate' 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.

512

"query": "A String", # [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.

513

"userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

514

{ # 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

515

"inlineCode": "A String", # [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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

516

"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

517

},

518

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

519

"destinationTable": { # [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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

520

"projectId": "A String", # [Required] The ID of the project containing this table.

521

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

522

"tableId": "A String", # [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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

523

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

524

},

525

"dryRun": True or False, # [Optional] If set, don'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't a dry run. Behavior of non-query jobs is undefined.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

526

"load": { # [Pick one] Configures a load job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

527

"nullMarker": "A String", # [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" 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.

528

"schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.

529

"fields": [ # Describes the fields in a table.

530

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

531

"name": "A String", # [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.

532

"type": "A String", # [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).

533

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

534

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

539

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

540

"policyTags": {

541

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

542

"A String",

543

],

544

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

545

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

546

# Object with schema name: TableFieldSchema

547

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.

552

"quote": """, # [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 ('"'). 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.

553

"writeDisposition": "A String", # [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 'duplicate' 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.

554

"destinationTableProperties": { # [Beta] [Optional] Properties with which to create the destination table if it is new.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

555

"labels": { # [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.

556

"a_key": "A String",

557

},

558

"friendlyName": "A String", # [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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

559

"description": "A String", # [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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

560

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

561

"sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

562

"ignoreUnknownValues": 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't match any column names

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

563

"destinationTable": { # [Required] The destination table to load the data into.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

564

"projectId": "A String", # [Required] The ID of the project containing this table.

565

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

566

"tableId": "A String", # [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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

567

},

568

"encoding": "A String", # [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.

569

"clustering": { # [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.

570

"fields": [ # [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.

"A String",

],

},

"createDisposition": "A String", # [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 'notFound' 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.

575

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' 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 '*' wildcard character is not allowed.

576

"A String",

577

],

578

"maxBadRecords": 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.

579

"allowJaggedRows": 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.

580

"fieldDelimiter": "A String", # [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 "\t" to specify a tab separator. The default value is a comma (',').

581

"projectionFields": [ # If sourceFormat is set to "DATASTORE_BACKUP", 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't found in the Cloud Datastore backup, an invalid error is returned in the job result.

582

"A String",

583

],

584

"allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

585

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

586

"sourceUriPrefix": "A String", # [Optional, Trusted Tester] 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).

587

"mode": "A String", # [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two 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. 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.

588

},

589

"useAvroLogicalTypes": True or False, # [Optional] If sourceFormat is set to "AVRO", indicates whether to enable interpreting logical types into their corresponding types (ie. TIMESTAMP), instead of only using their raw types (ie. INTEGER).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

590

"timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

591

"requirePartitionFilter": True or False,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

592

"field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' 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.

593

"expirationMs": "A String", # [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.

594

"type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

595

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

596

"skipLeadingRows": 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.

597

"autodetect": True or False, # [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.

598

"destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

599

"kmsKeyName": "A String", # [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.

600

},

601

"schemaUpdateOptions": [ # 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.

602

"A String",

603

],

604

"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".

605

"rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

606

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

607

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

608

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

609

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

610

},

611

"field": "A String", # [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.

612

},

613

},

614

"labels": { # 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.

615

"a_key": "A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

616

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

617

"jobType": "A String", # [Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.

618

"extract": { # [Pick one] Configures an extract job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

619

"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.

620

"destinationUri": "A String", # [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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

621

"printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.

622

"compression": "A String", # [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.

623

"destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.

624

"A String",

625

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

626

"destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

627

"sourceModel": { # A reference to the model being exported.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

628

"projectId": "A String", # [Required] The ID of the project containing this model.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

629

"datasetId": "A String", # [Required] The ID of the dataset containing this model.

630

"modelId": "A String", # [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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

631

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

632

"useAvroLogicalTypes": True or False, # [Optional] If destinationFormat is set to "AVRO", 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.

633

"sourceTable": { # A reference to the table being exported.

634

"projectId": "A String", # [Required] The ID of the project containing this table.

635

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

636

"tableId": "A String", # [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.

637

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

638

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

639

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

640

"user_email": "A String", # [Output-only] Email address of the user who ran the job.

641

"kind": "bigquery#job", # [Output-only] The type of the resource.

642

"etag": "A String", # [Output-only] A hash of this resource.

643

"jobReference": { # [Optional] Reference describing the unique-per-user name of the job.

644

"jobId": "A String", # [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.

645

"projectId": "A String", # [Required] The ID of the project containing this job.

646

"location": "A String", # The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

647

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

648

},

649

"kind": "bigquery#jobCancelResponse", # The resource type of the response.

}</pre>

</div>

<code class="details" id="get">get(projectId, jobId, location=None)</code>

655

<pre>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.

656

657

Args:

658

projectId: string, [Required] Project ID of the requested job (required)

659

jobId: string, [Required] Job ID of the requested job (required)

660

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.

661

662

Returns:

663

An object of the form:

664

665

{

666

"status": { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.

667

"errors": [ # [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.

668

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

669

"reason": "A String", # A short error code that summarizes the error.

670

"message": "A String", # A human-readable description of the error.

671

"location": "A String", # Specifies where the error occurred, if present.

672

"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.

673

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

674

],

675

"state": "A String", # [Output-only] Running state of the job.

676

"errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.

677

"reason": "A String", # A short error code that summarizes the error.

678

"message": "A String", # A human-readable description of the error.

679

"location": "A String", # Specifies where the error occurred, if present.

680

"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

681

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

682

},

683

"statistics": { # [Output-only] Information about the job, including starting time and ending time of the job.

684

"extract": { # [Output-only] Statistics for an extract job.

685

"destinationUriFileCounts": [ # [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 'destinationUris' field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

686

"A String",

687

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

688

"inputBytes": "A String", # [Output-only] Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.

689

},

690

"endTime": "A String", # [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.

691

"completionRatio": 3.14, # [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.

692

"startTime": "A String", # [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.

693

"totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.

694

"scriptStatistics": { # [Output-only] Statistics for a child job of a script.

695

"evaluationKind": "A String", # [Output-only] Whether this child job was a statement or expression.

696

"stackFrames": [ # 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.

697

{

698

"procedureId": "A String", # [Output-only] Name of the active procedure, empty if in a top-level script.

699

"startLine": 42, # [Output-only] One-based start line.

700

"text": "A String", # [Output-only] Text of the current statement/expression.

701

"endColumn": 42, # [Output-only] One-based end column.

702

"endLine": 42, # [Output-only] One-based end line.

703

"startColumn": 42, # [Output-only] One-based start column.

},

],

},

"query": { # [Output-only] Statistics for a query job.

708

"timeline": [ # [Output-only] [Beta] Describes a timeline of job execution.

709

{

710

"activeUnits": "A String", # 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.

711

"completedUnits": "A String", # Total parallel units of work completed by this query.

712

"elapsedMs": "A String", # Milliseconds elapsed since the start of query execution.

713

"pendingUnits": "A String", # Total parallel units of work remaining for the active stages.

714

"totalSlotMs": "A String", # Cumulative slot-ms consumed by the query.

715

},

716

],

717

"ddlTargetRoutine": { # The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.

718

"projectId": "A String", # [Required] The ID of the project containing this routine.

719

"datasetId": "A String", # [Required] The ID of the dataset containing this routine.

720

"routineId": "A String", # [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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

721

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

722

"queryPlan": [ # [Output-only] Describes execution plan for the query.

723

{

724

"steps": [ # List of operations within the stage in dependency order (approximately chronological).

725

{

726

"substeps": [ # Human-readable stage descriptions.

727

"A String",

728

],

729

"kind": "A String", # Machine-readable operation type.

730

},

731

],

732

"startMs": "A String", # Stage start time represented as milliseconds since epoch.

733

"writeMsMax": "A String", # Milliseconds the slowest shard spent on writing output.

734

"shuffleOutputBytesSpilled": "A String", # Total number of bytes written to shuffle and spilled to disk.

735

"readMsAvg": "A String", # Milliseconds the average shard spent reading input.

736

"waitMsAvg": "A String", # Milliseconds the average shard spent waiting to be scheduled.

737

"recordsRead": "A String", # Number of records read into the stage.

738

"writeMsAvg": "A String", # Milliseconds the average shard spent on writing output.

739

"waitRatioMax": 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled.

740

"waitMsMax": "A String", # Milliseconds the slowest shard spent waiting to be scheduled.

741

"writeRatioAvg": 3.14, # Relative amount of time the average shard spent on writing output.

742

"computeRatioAvg": 3.14, # Relative amount of time the average shard spent on CPU-bound tasks.

743

"completedParallelInputs": "A String", # Number of parallel input segments completed.

744

"recordsWritten": "A String", # Number of records written by the stage.

745

"waitRatioAvg": 3.14, # Relative amount of time the average shard spent waiting to be scheduled.

746

"readRatioMax": 3.14, # Relative amount of time the slowest shard spent reading input.

747

"readRatioAvg": 3.14, # Relative amount of time the average shard spent reading input.

748

"id": "A String", # Unique ID for stage within plan.

749

"writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output.

750

"endMs": "A String", # Stage end time represented as milliseconds since epoch.

751

"inputStages": [ # IDs for stages that are inputs to this stage.

752

"A String",

753

],

754

"computeMsAvg": "A String", # Milliseconds the average shard spent on CPU-bound tasks.

755

"computeMsMax": "A String", # Milliseconds the slowest shard spent on CPU-bound tasks.

756

"slotMs": "A String", # Slot-milliseconds used by the stage.

757

"readMsMax": "A String", # Milliseconds the slowest shard spent reading input.

758

"shuffleOutputBytes": "A String", # Total number of bytes written to shuffle.

759

"parallelInputs": "A String", # Number of parallel input segments to be processed.

760

"status": "A String", # Current status for the stage.

761

"name": "A String", # Human-readable name for stage.

762

"computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks.

763

},

764

],

765

"ddlTargetTable": { # [Output-only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.

766

"projectId": "A String", # [Required] The ID of the project containing this table.

767

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

768

"tableId": "A String", # [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.

769

},

770

"schema": { # [Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.

771

"fields": [ # Describes the fields in a table.

772

{

773

"name": "A String", # [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.

774

"type": "A String", # [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).

775

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

776

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

781

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

782

"policyTags": {

783

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

"A String",

],

},

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

788

# Object with schema name: TableFieldSchema

],

},

],

},

"estimatedBytesProcessed": "A String", # [Output-only] The original estimate of bytes processed for the job.

794

"referencedTables": [ # [Output-only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.

795

{

796

"projectId": "A String", # [Required] The ID of the project containing this table.

797

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

798

"tableId": "A String", # [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.

799

},

800

],

801

"modelTrainingCurrentIteration": 42, # [Output-only, Beta] Deprecated; do not use.

802

"numDmlAffectedRows": "A String", # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.

803

"totalBytesProcessed": "A String", # [Output-only] Total bytes processed for the job.

804

"statementType": "A String", # The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.

805

"ddlOperationPerformed": "A String", # The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": 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. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target.

806

"billingTier": 42, # [Output-only] Billing tier for the job.

807

"ddlTargetRowAccessPolicy": { # [Output-only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.

808

"datasetId": "A String", # [Required] The ID of the dataset containing this row access policy.

809

"policyId": "A String", # [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.

810

"tableId": "A String", # [Required] The ID of the table containing this row access policy.

811

"projectId": "A String", # [Required] The ID of the project containing this row access policy.

812

},

813

"modelTraining": { # [Output-only, Beta] Information about create model query job progress.

814

"expectedTotalIterations": "A String", # [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.

815

"currentIteration": 42, # [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.

816

},

817

"cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

818

"reservationUsage": [ # [Output-only] Job resource usage breakdown by reservation.

819

{

820

"slotMs": "A String", # [Output-only] Slot-milliseconds the job spent in the given reservation.

821

"name": "A String", # [Output-only] Reservation name or "unreserved" for on-demand resources usage.

822

},

823

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

824

"undeclaredQueryParameters": [ # Standard SQL only: list of undeclared query parameters detected during a dry run validation.

825

{

826

"name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.

827

"parameterType": { # [Required] The type of this parameter.

828

"arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.

829

"type": "A String", # [Required] The top level type of this field.

830

"structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.

831

{

832

"name": "A String", # [Optional] The name of this field.

833

"description": "A String", # [Optional] Human-oriented description of the field.

834

"type": # Object with schema name: QueryParameterType # [Required] The type of this field.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

835

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

836

],

837

},

838

"parameterValue": { # [Required] The value of this parameter.

839

"structValues": { # [Optional] The struct field values, in order of the struct type's declaration.

840

"a_key": # Object with schema name: QueryParameterValue

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

841

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

842

"arrayValues": [ # [Optional] The array values, if this is an array type.

843

# Object with schema name: QueryParameterValue

844

],

845

"value": "A String", # [Optional] The value of this value, if a simple scalar type.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

846

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

847

},

848

],

849

"totalPartitionsProcessed": "A String", # [Output-only] Total number of partitions processed from all partitioned tables referenced in the job.

850

"modelTrainingExpectedTotalIteration": "A String", # [Output-only, Beta] Deprecated; do not use.

851

"ddlAffectedRowAccessPolicyCount": "A String", # [Output-only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.

852

"totalSlotMs": "A String", # [Output-only] Slot-milliseconds for the job.

853

"totalBytesBilled": "A String", # [Output-only] Total bytes billed for the job.

854

"totalBytesProcessedAccuracy": "A String", # [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.

855

"referencedRoutines": [ # [Output-only] Referenced routines (persistent user-defined functions and stored procedures) for the job.

856

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

857

"projectId": "A String", # [Required] The ID of the project containing this routine.

858

"datasetId": "A String", # [Required] The ID of the dataset containing this routine.

859

"routineId": "A String", # [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.

860

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

861

],

862

},

863

"numChildJobs": "A String", # [Output-only] Number of child jobs executed.

864

"totalSlotMs": "A String", # [Output-only] Slot-milliseconds for the job.

865

"parentJobId": "A String", # [Output-only] If this is a child job, the id of the parent.

866

"reservation_id": "A String", # [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.

867

"quotaDeferments": [ # [Output-only] Quotas which delayed this job's start time.

868

"A String",

869

],

870

"rowLevelSecurityStatistics": { # [Output-only] [Preview] Statistics for row-level security. Present only for query and extract jobs.

871

"rowLevelSecurityApplied": True or False, # [Output-only] [Preview] Whether any accessed data was protected by row access policies.

872

},

873

"reservationUsage": [ # [Output-only] Job resource usage breakdown by reservation.

874

{

875

"slotMs": "A String", # [Output-only] Slot-milliseconds the job spent in the given reservation.

876

"name": "A String", # [Output-only] Reservation name or "unreserved" for on-demand resources usage.

877

},

878

],

879

"creationTime": "A String", # [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.

880

"load": { # [Output-only] Statistics for a load job.

881

"badRecords": "A String", # [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.

882

"inputFileBytes": "A String", # [Output-only] Number of bytes of source data in a load job.

883

"inputFiles": "A String", # [Output-only] Number of source files in a load job.

884

"outputRows": "A String", # [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.

885

"outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.

886

},

887

},

888

"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.

889

"id": "A String", # [Output-only] Opaque ID field of the job

890

"configuration": { # [Required] Describes the job configuration.

891

"copy": { # [Pick one] Copies a table.

892

"destinationTable": { # [Required] The destination table

893

"projectId": "A String", # [Required] The ID of the project containing this table.

894

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

895

"tableId": "A String", # [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.

896

},

897

"destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

898

"kmsKeyName": "A String", # [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.

899

},

900

"sourceTables": [ # [Pick one] Source tables to copy.

901

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

902

"projectId": "A String", # [Required] The ID of the project containing this table.

903

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

904

"tableId": "A String", # [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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

905

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

906

],

907

"createDisposition": "A String", # [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 'notFound' 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.

908

"sourceTable": { # [Pick one] Source table to copy.

909

"projectId": "A String", # [Required] The ID of the project containing this table.

910

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

911

"tableId": "A String", # [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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

912

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

913

"writeDisposition": "A String", # [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 'duplicate' 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

914

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

915

"jobTimeoutMs": "A String", # [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.

916

"query": { # [Pick one] Configures a query job.

917

"queryParameters": [ # Query parameters for standard SQL queries.

918

{

919

"name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.

920

"parameterType": { # [Required] The type of this parameter.

921

"arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.

922

"type": "A String", # [Required] The top level type of this field.

923

"structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.

924

{

925

"name": "A String", # [Optional] The name of this field.

926

"description": "A String", # [Optional] Human-oriented description of the field.

927

"type": # Object with schema name: QueryParameterType # [Required] The type of this field.

},

],

},

"parameterValue": { # [Required] The value of this parameter.

932

"structValues": { # [Optional] The struct field values, in order of the struct type's declaration.

933

"a_key": # Object with schema name: QueryParameterValue

934

},

935

"arrayValues": [ # [Optional] The array values, if this is an array type.

936

# Object with schema name: QueryParameterValue

937

],

938

"value": "A String", # [Optional] The value of this value, if a simple scalar type.

},

},

],

"useLegacySql": true, # Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery'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.

943

"destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

944

"kmsKeyName": "A String", # [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.

945

},

946

"clustering": { # [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.

947

"fields": [ # [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.

"A String",

],

},

"createDisposition": "A String", # [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 'notFound' 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.

952

"maximumBytesBilled": "A String", # [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.

953

"schemaUpdateOptions": [ # 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.

954

"A String",

955

],

956

"priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.

957

"connectionProperties": [ # Connection properties.

958

{

959

"key": "A String", # [Required] Name of the connection property to set.

960

"value": "A String", # [Required] Value of the connection property.

961

},

962

],

963

"allowLargeResults": 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.

964

"rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

965

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

966

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

967

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

968

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

969

},

970

"field": "A String", # [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.

971

},

972

"parameterMode": "A String", # Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.

973

"useQueryCache": 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.

974

"flattenResults": 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.

975

"tableDefinitions": { # [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.

976

"a_key": {

977

"compression": "A String", # [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.

978

"maxBadRecords": 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.

979

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' 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 '*' wildcard character is not allowed.

980

"A String",

981

],

982

"csvOptions": { # Additional properties to set if sourceFormat is set to CSV.

983

"quote": """, # [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 ('"'). 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.

984

"skipLeadingRows": "A String", # [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 > 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.

985

"allowJaggedRows": 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.

986

"fieldDelimiter": "A String", # [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 "\t" to specify a tab separator. The default value is a comma (',').

987

"encoding": "A String", # [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.

988

"allowQuotedNewlines": 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.

989

},

990

"bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.

991

"readRowkeyAsString": 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.

992

"columnFamilies": [ # [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 'type' 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.

993

{

994

"onlyReadLatest": 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 'columns' and specifying a different setting for that column.

995

"encoding": "A String", # [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 'columns' and specifying an encoding for it.

996

"columns": [ # [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.

997

{

998

"fieldName": "A String", # [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.

999

"qualifierString": "A String",

1000

"encoding": "A String", # [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. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.

1001

"type": "A String", # [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. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.

1002

"qualifierEncoded": "A String", # [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.

1003

"onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.

1004

},

1005

],

1006

"type": "A String", # [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 'columns' and specifying a type for it.

1007

"familyId": "A String", # Identifier of the column family.

1008

},

1009

],

1010

"ignoreUnspecifiedColumnFamilies": 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.

1011

},

1012

"schema": { # [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.

1013

"fields": [ # Describes the fields in a table.

1014

{

1015

"name": "A String", # [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.

1016

"type": "A String", # [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).

1017

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

1018

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

1023

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

1024

"policyTags": {

1025

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

"A String",

],

},

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

1030

# Object with schema name: TableFieldSchema

],

},

],

},

"connectionId": "A String", # [Optional, Trusted Tester] Connection for external data source.

1036

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

1037

"sourceUriPrefix": "A String", # [Optional, Trusted Tester] 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).

1038

"mode": "A String", # [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two 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. 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.

1039

},

1040

"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.

1041

"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

1042

"range": "A String", # [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

1043

"skipLeadingRows": "A String", # [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 > 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.

1044

},

1045

"ignoreUnknownValues": 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'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.

1046

"sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

1047

},

1048

},

1049

"defaultDataset": { # [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.

1050

"datasetId": "A String", # [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.

1051

"projectId": "A String", # [Optional] The ID of the project containing this dataset.

1052

},

1053

"maximumBillingTier": 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.

1054

"preserveNulls": True or False, # [Deprecated] This property is deprecated.

1055

"timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.

1056

"requirePartitionFilter": True or False,

1057

"field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' 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.

1058

"expirationMs": "A String", # [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.

1059

"type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day.

1060

},

1061

"writeDisposition": "A String", # [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 'duplicate' 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.

1062

"query": "A String", # [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.

1063

"userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.

1064

{ # 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

1065

"inlineCode": "A String", # [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.

1066

"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

1067

},

1068

],

1069

"destinationTable": { # [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.

1070

"projectId": "A String", # [Required] The ID of the project containing this table.

1071

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

1072

"tableId": "A String", # [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.

1073

},

1074

},

1075

"dryRun": True or False, # [Optional] If set, don'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't a dry run. Behavior of non-query jobs is undefined.

1076

"load": { # [Pick one] Configures a load job.

1077

"nullMarker": "A String", # [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" 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.

1078

"schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.

1079

"fields": [ # Describes the fields in a table.

1080

{

1081

"name": "A String", # [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.

1082

"type": "A String", # [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).

1083

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

1084

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

1089

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

1090

"policyTags": {

1091

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

"A String",

],

},

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

1096

# Object with schema name: TableFieldSchema

],

},

],

},

"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.

1102

"quote": """, # [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 ('"'). 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.

1103

"writeDisposition": "A String", # [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 'duplicate' 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.

1104

"destinationTableProperties": { # [Beta] [Optional] Properties with which to create the destination table if it is new.

1105

"labels": { # [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.

1106

"a_key": "A String",

1107

},

1108

"friendlyName": "A String", # [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.

1109

"description": "A String", # [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.

1110

},

1111

"sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.

1112

"ignoreUnknownValues": 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't match any column names

1113

"destinationTable": { # [Required] The destination table to load the data into.

1114

"projectId": "A String", # [Required] The ID of the project containing this table.

1115

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

1116

"tableId": "A String", # [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.

1117

},

1118

"encoding": "A String", # [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.

1119

"clustering": { # [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.

1120

"fields": [ # [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.

"A String",

],

},

"createDisposition": "A String", # [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 'notFound' 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.

1125

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' 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 '*' wildcard character is not allowed.

1126

"A String",

1127

],

1128

"maxBadRecords": 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.

1129

"allowJaggedRows": 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.

1130

"fieldDelimiter": "A String", # [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 "\t" to specify a tab separator. The default value is a comma (',').

1131

"projectionFields": [ # If sourceFormat is set to "DATASTORE_BACKUP", 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't found in the Cloud Datastore backup, an invalid error is returned in the job result.

1132

"A String",

1133

],

1134

"allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

1135

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

1136

"sourceUriPrefix": "A String", # [Optional, Trusted Tester] 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).

1137

"mode": "A String", # [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two 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. 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.

1138

},

1139

"useAvroLogicalTypes": True or False, # [Optional] If sourceFormat is set to "AVRO", indicates whether to enable interpreting logical types into their corresponding types (ie. TIMESTAMP), instead of only using their raw types (ie. INTEGER).

1140

"timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.

1141

"requirePartitionFilter": True or False,

1142

"field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' 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.

1143

"expirationMs": "A String", # [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.

1144

"type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day.

1145

},

1146

"skipLeadingRows": 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.

1147

"autodetect": True or False, # [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.

1148

"destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

1149

"kmsKeyName": "A String", # [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.

1150

},

1151

"schemaUpdateOptions": [ # 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.

1152

"A String",

1153

],

1154

"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".

1155

"rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

1156

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

1157

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

1158

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

1159

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

1160

},

1161

"field": "A String", # [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.

1162

},

1163

},

1164

"labels": { # 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.

1165

"a_key": "A String",

1166

},

1167

"jobType": "A String", # [Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.

1168

"extract": { # [Pick one] Configures an extract job.

1169

"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.

1170

"destinationUri": "A String", # [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.

1171

"printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.

1172

"compression": "A String", # [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.

1173

"destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.

1174

"A String",

1175

],

1176

"destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON 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.

1177

"sourceModel": { # A reference to the model being exported.

1178

"projectId": "A String", # [Required] The ID of the project containing this model.

1179

"datasetId": "A String", # [Required] The ID of the dataset containing this model.

1180

"modelId": "A String", # [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.

1181

},

1182

"useAvroLogicalTypes": True or False, # [Optional] If destinationFormat is set to "AVRO", 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.

1183

"sourceTable": { # A reference to the table being exported.

1184

"projectId": "A String", # [Required] The ID of the project containing this table.

1185

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

1186

"tableId": "A String", # [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.

},

},

},

"user_email": "A String", # [Output-only] Email address of the user who ran the job.

1191

"kind": "bigquery#job", # [Output-only] The type of the resource.

1192

"etag": "A String", # [Output-only] A hash of this resource.

1193

"jobReference": { # [Optional] Reference describing the unique-per-user name of the job.

1194

"jobId": "A String", # [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.

1195

"projectId": "A String", # [Required] The ID of the project containing this job.

1196

"location": "A String", # The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

1197

},

1198

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1202

<code class="details" id="getQueryResults">getQueryResults(projectId, jobId, startIndex=None, location=None, pageToken=None, timeoutMs=None, maxResults=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1203

<pre>Retrieves the results of a query job.

1204

1205

Args:

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1206

projectId: string, [Required] Project ID of the query job (required)

1207

jobId: string, [Required] Job ID of the query job (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1208

startIndex: string, Zero-based index of the starting row

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1209

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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1210

pageToken: string, Page token, returned by a previous call, to request the next page of results

1211

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 'jobComplete' field in the response will be false

1212

maxResults: integer, Maximum number of results to read

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1213

1214

Returns:

1215

An object of the form:

1216

1217

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1218

"schema": { # The schema of the results. Present only when the query completes successfully.

1219

"fields": [ # Describes the fields in a table.

1220

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1221

"name": "A String", # [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.

1222

"type": "A String", # [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).

1223

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

1224

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

1229

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

1230

"policyTags": {

1231

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

1232

"A String",

1233

],

1234

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1235

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

1236

# Object with schema name: TableFieldSchema

1237

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"errors": [ # [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.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1242

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1243

"reason": "A String", # A short error code that summarizes the error.

1244

"message": "A String", # A human-readable description of the error.

1245

"location": "A String", # Specifies where the error occurred, if present.

1246

"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.

1247

},

1248

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1249

"totalBytesProcessed": "A String", # The total number of bytes processed for this query.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1250

"numDmlAffectedRows": "A String", # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.

1251

"jobComplete": 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.

1252

"totalRows": "A String", # 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1253

"rows": [ # 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.

1254

{

1255

"f": [ # Represents a single row in the result set, consisting of one or more fields.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1256

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1257

"v": "",

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

},

],

},

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1262

"pageToken": "A String", # A token used for paging results.

1263

"kind": "bigquery#getQueryResultsResponse", # The resource type of the response.

1264

"etag": "A String", # A hash of this response.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1265

"jobReference": { # 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).

1266

"jobId": "A String", # [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.

1267

"projectId": "A String", # [Required] The ID of the project containing this job.

1268

"location": "A String", # The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1269

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1270

"cacheHit": True or False, # Whether the query result was fetched from the query cache.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1275

<code class="details" id="getQueryResults_next">getQueryResults_next(previous_request, previous_response)</code>

1276

<pre>Retrieves the next page of results.

1277

1278

Args:

1279

previous_request: The request for the previous page. (required)

1280

previous_response: The response from the request for the previous page. (required)

1281

1282

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1283

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

c30d2b5

2017-03-13 12:12:03 -0400

[diff] [blame]

1284

page. Returns None if there are no more items in the collection.

</pre>

</div>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1289

<code class="details" id="insert">insert(projectId, body=None, media_body=None, media_mime_type=None)</code>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1290

<pre>Starts a new asynchronous job. Requires the Can View project role.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

1291

1292

Args:

1293

projectId: string, Project ID of the project that will be billed for the job (required)

1294

body: object, The request body.

1295

The object takes the form of:

1296

1297

{

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

1298

"status": { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.

1299

"errors": [ # [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.

1300

{

1301

"reason": "A String", # A short error code that summarizes the error.

1302

"message": "A String", # A human-readable description of the error.

1303

"location": "A String", # Specifies where the error occurred, if present.

1304

"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.

1305

},

1306

],

1307

"state": "A String", # [Output-only] Running state of the job.

1308

"errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.

1309

"reason": "A String", # A short error code that summarizes the error.

1310

"message": "A String", # A human-readable description of the error.

1311

"location": "A String", # Specifies where the error occurred, if present.

1312

"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.

1313

},

1314

},

1315

"statistics": { # [Output-only] Information about the job, including starting time and ending time of the job.

1316

"extract": { # [Output-only] Statistics for an extract job.

1317

"destinationUriFileCounts": [ # [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 'destinationUris' field.

1318

"A String",

1319

],

1320

"inputBytes": "A String", # [Output-only] Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.

1321

},

1322

"endTime": "A String", # [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.

1323

"completionRatio": 3.14, # [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.

1324

"startTime": "A String", # [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.

1325

"totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.

1326

"scriptStatistics": { # [Output-only] Statistics for a child job of a script.

1327

"evaluationKind": "A String", # [Output-only] Whether this child job was a statement or expression.

1328

"stackFrames": [ # 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.

1329

{

1330

"procedureId": "A String", # [Output-only] Name of the active procedure, empty if in a top-level script.

1331

"startLine": 42, # [Output-only] One-based start line.

1332

"text": "A String", # [Output-only] Text of the current statement/expression.

1333

"endColumn": 42, # [Output-only] One-based end column.

1334

"endLine": 42, # [Output-only] One-based end line.

1335

"startColumn": 42, # [Output-only] One-based start column.

},

],

},

"query": { # [Output-only] Statistics for a query job.

1340

"timeline": [ # [Output-only] [Beta] Describes a timeline of job execution.

1341

{

1342

"activeUnits": "A String", # 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.

1343

"completedUnits": "A String", # Total parallel units of work completed by this query.

1344

"elapsedMs": "A String", # Milliseconds elapsed since the start of query execution.

1345

"pendingUnits": "A String", # Total parallel units of work remaining for the active stages.

1346

"totalSlotMs": "A String", # Cumulative slot-ms consumed by the query.

1347

},

1348

],

1349

"ddlTargetRoutine": { # The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.

1350

"projectId": "A String", # [Required] The ID of the project containing this routine.

1351

"datasetId": "A String", # [Required] The ID of the dataset containing this routine.

1352

"routineId": "A String", # [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.

1353

},

1354

"queryPlan": [ # [Output-only] Describes execution plan for the query.

1355

{

1356

"steps": [ # List of operations within the stage in dependency order (approximately chronological).

1357

{

1358

"substeps": [ # Human-readable stage descriptions.

1359

"A String",

1360

],

1361

"kind": "A String", # Machine-readable operation type.

1362

},

1363

],

1364

"startMs": "A String", # Stage start time represented as milliseconds since epoch.

1365

"writeMsMax": "A String", # Milliseconds the slowest shard spent on writing output.

1366

"shuffleOutputBytesSpilled": "A String", # Total number of bytes written to shuffle and spilled to disk.

1367

"readMsAvg": "A String", # Milliseconds the average shard spent reading input.

1368

"waitMsAvg": "A String", # Milliseconds the average shard spent waiting to be scheduled.

1369

"recordsRead": "A String", # Number of records read into the stage.

1370

"writeMsAvg": "A String", # Milliseconds the average shard spent on writing output.

1371

"waitRatioMax": 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled.

1372

"waitMsMax": "A String", # Milliseconds the slowest shard spent waiting to be scheduled.

1373

"writeRatioAvg": 3.14, # Relative amount of time the average shard spent on writing output.

1374

"computeRatioAvg": 3.14, # Relative amount of time the average shard spent on CPU-bound tasks.

1375

"completedParallelInputs": "A String", # Number of parallel input segments completed.

1376

"recordsWritten": "A String", # Number of records written by the stage.

1377

"waitRatioAvg": 3.14, # Relative amount of time the average shard spent waiting to be scheduled.

1378

"readRatioMax": 3.14, # Relative amount of time the slowest shard spent reading input.

1379

"readRatioAvg": 3.14, # Relative amount of time the average shard spent reading input.

1380

"id": "A String", # Unique ID for stage within plan.

1381

"writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output.

1382

"endMs": "A String", # Stage end time represented as milliseconds since epoch.

1383

"inputStages": [ # IDs for stages that are inputs to this stage.

1384

"A String",

1385

],

1386

"computeMsAvg": "A String", # Milliseconds the average shard spent on CPU-bound tasks.

1387

"computeMsMax": "A String", # Milliseconds the slowest shard spent on CPU-bound tasks.

1388

"slotMs": "A String", # Slot-milliseconds used by the stage.

1389

"readMsMax": "A String", # Milliseconds the slowest shard spent reading input.

1390

"shuffleOutputBytes": "A String", # Total number of bytes written to shuffle.

1391

"parallelInputs": "A String", # Number of parallel input segments to be processed.

1392

"status": "A String", # Current status for the stage.

1393

"name": "A String", # Human-readable name for stage.

1394

"computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks.

1395

},

1396

],

1397

"ddlTargetTable": { # [Output-only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.

1398

"projectId": "A String", # [Required] The ID of the project containing this table.

1399

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

1400

"tableId": "A String", # [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.

1401

},

1402

"schema": { # [Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.

1403

"fields": [ # Describes the fields in a table.

1404

{

1405

"name": "A String", # [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.

1406

"type": "A String", # [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).

1407

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

1408

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

1413

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

1414

"policyTags": {

1415

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

"A String",

],

},

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

1420

# Object with schema name: TableFieldSchema

],

},

],

},

"estimatedBytesProcessed": "A String", # [Output-only] The original estimate of bytes processed for the job.

1426

"referencedTables": [ # [Output-only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.

1427

{

1428

"projectId": "A String", # [Required] The ID of the project containing this table.

1429

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

1430

"tableId": "A String", # [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.

1431

},

1432

],

1433

"modelTrainingCurrentIteration": 42, # [Output-only, Beta] Deprecated; do not use.

1434

"numDmlAffectedRows": "A String", # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.

1435

"totalBytesProcessed": "A String", # [Output-only] Total bytes processed for the job.

1436

"statementType": "A String", # The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.

1437

"ddlOperationPerformed": "A String", # The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": 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. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target.

1438

"billingTier": 42, # [Output-only] Billing tier for the job.

1439

"ddlTargetRowAccessPolicy": { # [Output-only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.

1440

"datasetId": "A String", # [Required] The ID of the dataset containing this row access policy.

1441

"policyId": "A String", # [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.

1442

"tableId": "A String", # [Required] The ID of the table containing this row access policy.

1443

"projectId": "A String", # [Required] The ID of the project containing this row access policy.

1444

},

1445

"modelTraining": { # [Output-only, Beta] Information about create model query job progress.

1446

"expectedTotalIterations": "A String", # [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.

1447

"currentIteration": 42, # [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.

1448

},

1449

"cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.

1450

"reservationUsage": [ # [Output-only] Job resource usage breakdown by reservation.

1451

{

1452

"slotMs": "A String", # [Output-only] Slot-milliseconds the job spent in the given reservation.

1453

"name": "A String", # [Output-only] Reservation name or "unreserved" for on-demand resources usage.

1454

},

1455

],

1456

"undeclaredQueryParameters": [ # Standard SQL only: list of undeclared query parameters detected during a dry run validation.

1457

{

1458

"name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.

1459

"parameterType": { # [Required] The type of this parameter.

1460

"arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.

1461

"type": "A String", # [Required] The top level type of this field.

1462

"structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.

1463

{

1464

"name": "A String", # [Optional] The name of this field.

1465

"description": "A String", # [Optional] Human-oriented description of the field.

1466

"type": # Object with schema name: QueryParameterType # [Required] The type of this field.

},

],

},

"parameterValue": { # [Required] The value of this parameter.

1471

"structValues": { # [Optional] The struct field values, in order of the struct type's declaration.

1472

"a_key": # Object with schema name: QueryParameterValue

1473

},

1474

"arrayValues": [ # [Optional] The array values, if this is an array type.

1475

# Object with schema name: QueryParameterValue

1476

],

1477

"value": "A String", # [Optional] The value of this value, if a simple scalar type.

},

},

],

"totalPartitionsProcessed": "A String", # [Output-only] Total number of partitions processed from all partitioned tables referenced in the job.

1482

"modelTrainingExpectedTotalIteration": "A String", # [Output-only, Beta] Deprecated; do not use.

1483

"ddlAffectedRowAccessPolicyCount": "A String", # [Output-only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.

1484

"totalSlotMs": "A String", # [Output-only] Slot-milliseconds for the job.

1485

"totalBytesBilled": "A String", # [Output-only] Total bytes billed for the job.

1486

"totalBytesProcessedAccuracy": "A String", # [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.

1487

"referencedRoutines": [ # [Output-only] Referenced routines (persistent user-defined functions and stored procedures) for the job.

1488

{

1489

"projectId": "A String", # [Required] The ID of the project containing this routine.

1490

"datasetId": "A String", # [Required] The ID of the dataset containing this routine.

1491

"routineId": "A String", # [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.

},

],

},

"numChildJobs": "A String", # [Output-only] Number of child jobs executed.

1496

"totalSlotMs": "A String", # [Output-only] Slot-milliseconds for the job.

1497

"parentJobId": "A String", # [Output-only] If this is a child job, the id of the parent.

1498

"reservation_id": "A String", # [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.

1499

"quotaDeferments": [ # [Output-only] Quotas which delayed this job's start time.

1500

"A String",

1501

],

1502

"rowLevelSecurityStatistics": { # [Output-only] [Preview] Statistics for row-level security. Present only for query and extract jobs.

1503

"rowLevelSecurityApplied": True or False, # [Output-only] [Preview] Whether any accessed data was protected by row access policies.

1504

},

1505

"reservationUsage": [ # [Output-only] Job resource usage breakdown by reservation.

1506

{

1507

"slotMs": "A String", # [Output-only] Slot-milliseconds the job spent in the given reservation.

1508

"name": "A String", # [Output-only] Reservation name or "unreserved" for on-demand resources usage.

1509

},

1510

],

1511

"creationTime": "A String", # [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.

1512

"load": { # [Output-only] Statistics for a load job.

1513

"badRecords": "A String", # [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.

1514

"inputFileBytes": "A String", # [Output-only] Number of bytes of source data in a load job.

1515

"inputFiles": "A String", # [Output-only] Number of source files in a load job.

1516

"outputRows": "A String", # [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.

1517

"outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.

1518

},

1519

},

1520

"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.

1521

"id": "A String", # [Output-only] Opaque ID field of the job

1522

"configuration": { # [Required] Describes the job configuration.

1523

"copy": { # [Pick one] Copies a table.

1524

"destinationTable": { # [Required] The destination table

1525

"projectId": "A String", # [Required] The ID of the project containing this table.

1526

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

1527

"tableId": "A String", # [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.

1528

},

1529

"destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

1530

"kmsKeyName": "A String", # [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.

1531

},

1532

"sourceTables": [ # [Pick one] Source tables to copy.

1533

{

1534

"projectId": "A String", # [Required] The ID of the project containing this table.

1535

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

1536

"tableId": "A String", # [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.

1537

},

1538

],

1539

"createDisposition": "A String", # [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 'notFound' 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.

1540

"sourceTable": { # [Pick one] Source table to copy.

1541

"projectId": "A String", # [Required] The ID of the project containing this table.

1542

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

1543

"tableId": "A String", # [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.

1544

},

1545

"writeDisposition": "A String", # [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 'duplicate' 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.

1546

},

1547

"jobTimeoutMs": "A String", # [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.

1548

"query": { # [Pick one] Configures a query job.

1549

"queryParameters": [ # Query parameters for standard SQL queries.

1550

{

1551

"name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.

1552

"parameterType": { # [Required] The type of this parameter.

1553

"arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.

1554

"type": "A String", # [Required] The top level type of this field.

1555

"structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.

1556

{

1557

"name": "A String", # [Optional] The name of this field.

1558

"description": "A String", # [Optional] Human-oriented description of the field.

1559

"type": # Object with schema name: QueryParameterType # [Required] The type of this field.

},

],

},

"parameterValue": { # [Required] The value of this parameter.

1564

"structValues": { # [Optional] The struct field values, in order of the struct type's declaration.

1565

"a_key": # Object with schema name: QueryParameterValue

1566

},

1567

"arrayValues": [ # [Optional] The array values, if this is an array type.

1568

# Object with schema name: QueryParameterValue

1569

],

1570

"value": "A String", # [Optional] The value of this value, if a simple scalar type.

},

},

],

"useLegacySql": true, # Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery'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.

1575

"destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

1576

"kmsKeyName": "A String", # [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.

1577

},

1578

"clustering": { # [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.

1579

"fields": [ # [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.

"A String",

],

},

"createDisposition": "A String", # [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 'notFound' 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.

1584

"maximumBytesBilled": "A String", # [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.

1585

"schemaUpdateOptions": [ # 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.

1586

"A String",

1587

],

1588

"priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.

1589

"connectionProperties": [ # Connection properties.

1590

{

1591

"key": "A String", # [Required] Name of the connection property to set.

1592

"value": "A String", # [Required] Value of the connection property.

1593

},

1594

],

1595

"allowLargeResults": 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.

1596

"rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

1597

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

1598

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

1599

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

1600

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

1601

},

1602

"field": "A String", # [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.

1603

},

1604

"parameterMode": "A String", # Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.

1605

"useQueryCache": 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.

1606

"flattenResults": 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.

1607

"tableDefinitions": { # [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.

1608

"a_key": {

1609

"compression": "A String", # [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.

1610

"maxBadRecords": 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.

1611

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' 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 '*' wildcard character is not allowed.

1612

"A String",

1613

],

1614

"csvOptions": { # Additional properties to set if sourceFormat is set to CSV.

1615

"quote": """, # [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 ('"'). 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.

1616

"skipLeadingRows": "A String", # [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 > 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.

1617

"allowJaggedRows": 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.

1618

"fieldDelimiter": "A String", # [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 "\t" to specify a tab separator. The default value is a comma (',').

1619

"encoding": "A String", # [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.

1620

"allowQuotedNewlines": 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.

1621

},

1622

"bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.

1623

"readRowkeyAsString": 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.

1624

"columnFamilies": [ # [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 'type' 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.

1625

{

1626

"onlyReadLatest": 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 'columns' and specifying a different setting for that column.

1627

"encoding": "A String", # [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 'columns' and specifying an encoding for it.

1628

"columns": [ # [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.

1629

{

1630

"fieldName": "A String", # [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.

1631

"qualifierString": "A String",

1632

"encoding": "A String", # [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. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.

1633

"type": "A String", # [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. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.

1634

"qualifierEncoded": "A String", # [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.

1635

"onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.

1636

},

1637

],

1638

"type": "A String", # [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 'columns' and specifying a type for it.

1639

"familyId": "A String", # Identifier of the column family.

1640

},

1641

],

1642

"ignoreUnspecifiedColumnFamilies": 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.

1643

},

1644

"schema": { # [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.

1645

"fields": [ # Describes the fields in a table.

1646

{

1647

"name": "A String", # [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.

1648

"type": "A String", # [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).

1649

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

1650

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

1655

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

1656

"policyTags": {

1657

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

"A String",

],

},

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

1662

# Object with schema name: TableFieldSchema

],

},

],

},

"connectionId": "A String", # [Optional, Trusted Tester] Connection for external data source.

1668

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

1669

"sourceUriPrefix": "A String", # [Optional, Trusted Tester] 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).

1670

"mode": "A String", # [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two 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. 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.

1671

},

1672

"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.

1673

"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

1674

"range": "A String", # [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

1675

"skipLeadingRows": "A String", # [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 > 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.

1676

},

1677

"ignoreUnknownValues": 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'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.

1678

"sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

1679

},

1680

},

1681

"defaultDataset": { # [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.

1682

"datasetId": "A String", # [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.

1683

"projectId": "A String", # [Optional] The ID of the project containing this dataset.

1684

},

1685

"maximumBillingTier": 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.

1686

"preserveNulls": True or False, # [Deprecated] This property is deprecated.

1687

"timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.

1688

"requirePartitionFilter": True or False,

1689

"field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' 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.

1690

"expirationMs": "A String", # [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.

1691

"type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day.

1692

},

1693

"writeDisposition": "A String", # [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 'duplicate' 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.

1694

"query": "A String", # [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.

1695

"userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.

1696

{ # 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

1697

"inlineCode": "A String", # [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.

1698

"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

1699

},

1700

],

1701

"destinationTable": { # [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.

1702

"projectId": "A String", # [Required] The ID of the project containing this table.

1703

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

1704

"tableId": "A String", # [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.

1705

},

1706

},

1707

"dryRun": True or False, # [Optional] If set, don'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't a dry run. Behavior of non-query jobs is undefined.

1708

"load": { # [Pick one] Configures a load job.

1709

"nullMarker": "A String", # [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" 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.

1710

"schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.

1711

"fields": [ # Describes the fields in a table.

1712

{

1713

"name": "A String", # [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.

1714

"type": "A String", # [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).

1715

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

1716

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

1721

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

1722

"policyTags": {

1723

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

"A String",

],

},

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

1728

# Object with schema name: TableFieldSchema

],

},

],

},

"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.

1734

"quote": """, # [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 ('"'). 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.

1735

"writeDisposition": "A String", # [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 'duplicate' 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.

1736

"destinationTableProperties": { # [Beta] [Optional] Properties with which to create the destination table if it is new.

1737

"labels": { # [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.

1738

"a_key": "A String",

1739

},

1740

"friendlyName": "A String", # [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.

1741

"description": "A String", # [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.

1742

},

1743

"sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.

1744

"ignoreUnknownValues": 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't match any column names

1745

"destinationTable": { # [Required] The destination table to load the data into.

1746

"projectId": "A String", # [Required] The ID of the project containing this table.

1747

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

1748

"tableId": "A String", # [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.

1749

},

1750

"encoding": "A String", # [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.

1751

"clustering": { # [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.

1752

"fields": [ # [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.

"A String",

],

},

"createDisposition": "A String", # [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 'notFound' 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.

1757

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' 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 '*' wildcard character is not allowed.

1758

"A String",

1759

],

1760

"maxBadRecords": 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.

1761

"allowJaggedRows": 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.

1762

"fieldDelimiter": "A String", # [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 "\t" to specify a tab separator. The default value is a comma (',').

1763

"projectionFields": [ # If sourceFormat is set to "DATASTORE_BACKUP", 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't found in the Cloud Datastore backup, an invalid error is returned in the job result.

1764

"A String",

1765

],

1766

"allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

1767

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

1768

"sourceUriPrefix": "A String", # [Optional, Trusted Tester] 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).

1769

"mode": "A String", # [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two 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. 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.

1770

},

1771

"useAvroLogicalTypes": True or False, # [Optional] If sourceFormat is set to "AVRO", indicates whether to enable interpreting logical types into their corresponding types (ie. TIMESTAMP), instead of only using their raw types (ie. INTEGER).

1772

"timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.

1773

"requirePartitionFilter": True or False,

1774

"field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' 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.

1775

"expirationMs": "A String", # [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.

1776

"type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day.

1777

},

1778

"skipLeadingRows": 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.

1779

"autodetect": True or False, # [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.

1780

"destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

1781

"kmsKeyName": "A String", # [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.

1782

},

1783

"schemaUpdateOptions": [ # 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.

1784

"A String",

1785

],

1786

"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".

1787

"rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

1788

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

1789

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

1790

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

1791

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

1792

},

1793

"field": "A String", # [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.

1794

},

1795

},

1796

"labels": { # 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.

1797

"a_key": "A String",

1798

},

1799

"jobType": "A String", # [Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.

1800

"extract": { # [Pick one] Configures an extract job.

1801

"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.

1802

"destinationUri": "A String", # [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.

1803

"printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.

1804

"compression": "A String", # [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.

1805

"destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.

1806

"A String",

1807

],

1808

"destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON 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.

1809

"sourceModel": { # A reference to the model being exported.

1810

"projectId": "A String", # [Required] The ID of the project containing this model.

1811

"datasetId": "A String", # [Required] The ID of the dataset containing this model.

1812

"modelId": "A String", # [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.

1813

},

1814

"useAvroLogicalTypes": True or False, # [Optional] If destinationFormat is set to "AVRO", 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.

1815

"sourceTable": { # A reference to the table being exported.

1816

"projectId": "A String", # [Required] The ID of the project containing this table.

1817

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

1818

"tableId": "A String", # [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.

},

},

},

"user_email": "A String", # [Output-only] Email address of the user who ran the job.

1823

"kind": "bigquery#job", # [Output-only] The type of the resource.

1824

"etag": "A String", # [Output-only] A hash of this resource.

1825

"jobReference": { # [Optional] Reference describing the unique-per-user name of the job.

1826

"jobId": "A String", # [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.

1827

"projectId": "A String", # [Required] The ID of the project containing this job.

1828

"location": "A String", # The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

},

}

media_body: string, The filename of the media request body, or an instance of a MediaUpload object.

1833

media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object.

1834

1835

Returns:

1836

An object of the form:

1837

1838

{

1839

"status": { # [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.

1840

"errors": [ # [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.

1841

{

1842

"reason": "A String", # A short error code that summarizes the error.

1843

"message": "A String", # A human-readable description of the error.

1844

"location": "A String", # Specifies where the error occurred, if present.

1845

"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.

1846

},

1847

],

1848

"state": "A String", # [Output-only] Running state of the job.

1849

"errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.

1850

"reason": "A String", # A short error code that summarizes the error.

1851

"message": "A String", # A human-readable description of the error.

1852

"location": "A String", # Specifies where the error occurred, if present.

1853

"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.

1854

},

1855

},

1856

"statistics": { # [Output-only] Information about the job, including starting time and ending time of the job.

1857

"extract": { # [Output-only] Statistics for an extract job.

1858

"destinationUriFileCounts": [ # [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 'destinationUris' field.

1859

"A String",

1860

],

1861

"inputBytes": "A String", # [Output-only] Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.

1862

},

1863

"endTime": "A String", # [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.

1864

"completionRatio": 3.14, # [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.

1865

"startTime": "A String", # [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.

1866

"totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.

1867

"scriptStatistics": { # [Output-only] Statistics for a child job of a script.

1868

"evaluationKind": "A String", # [Output-only] Whether this child job was a statement or expression.

1869

"stackFrames": [ # 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.

1870

{

1871

"procedureId": "A String", # [Output-only] Name of the active procedure, empty if in a top-level script.

1872

"startLine": 42, # [Output-only] One-based start line.

1873

"text": "A String", # [Output-only] Text of the current statement/expression.

1874

"endColumn": 42, # [Output-only] One-based end column.

1875

"endLine": 42, # [Output-only] One-based end line.

1876

"startColumn": 42, # [Output-only] One-based start column.

},

],

},

"query": { # [Output-only] Statistics for a query job.

1881

"timeline": [ # [Output-only] [Beta] Describes a timeline of job execution.

1882

{

1883

"activeUnits": "A String", # 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.

1884

"completedUnits": "A String", # Total parallel units of work completed by this query.

1885

"elapsedMs": "A String", # Milliseconds elapsed since the start of query execution.

1886

"pendingUnits": "A String", # Total parallel units of work remaining for the active stages.

1887

"totalSlotMs": "A String", # Cumulative slot-ms consumed by the query.

1888

},

1889

],

1890

"ddlTargetRoutine": { # The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.

1891

"projectId": "A String", # [Required] The ID of the project containing this routine.

1892

"datasetId": "A String", # [Required] The ID of the dataset containing this routine.

1893

"routineId": "A String", # [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.

1894

},

1895

"queryPlan": [ # [Output-only] Describes execution plan for the query.

1896

{

1897

"steps": [ # List of operations within the stage in dependency order (approximately chronological).

1898

{

1899

"substeps": [ # Human-readable stage descriptions.

1900

"A String",

1901

],

1902

"kind": "A String", # Machine-readable operation type.

1903

},

1904

],

1905

"startMs": "A String", # Stage start time represented as milliseconds since epoch.

1906

"writeMsMax": "A String", # Milliseconds the slowest shard spent on writing output.

1907

"shuffleOutputBytesSpilled": "A String", # Total number of bytes written to shuffle and spilled to disk.

1908

"readMsAvg": "A String", # Milliseconds the average shard spent reading input.

1909

"waitMsAvg": "A String", # Milliseconds the average shard spent waiting to be scheduled.

1910

"recordsRead": "A String", # Number of records read into the stage.

1911

"writeMsAvg": "A String", # Milliseconds the average shard spent on writing output.

1912

"waitRatioMax": 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled.

1913

"waitMsMax": "A String", # Milliseconds the slowest shard spent waiting to be scheduled.

1914

"writeRatioAvg": 3.14, # Relative amount of time the average shard spent on writing output.

1915

"computeRatioAvg": 3.14, # Relative amount of time the average shard spent on CPU-bound tasks.

1916

"completedParallelInputs": "A String", # Number of parallel input segments completed.

1917

"recordsWritten": "A String", # Number of records written by the stage.

1918

"waitRatioAvg": 3.14, # Relative amount of time the average shard spent waiting to be scheduled.

1919

"readRatioMax": 3.14, # Relative amount of time the slowest shard spent reading input.

1920

"readRatioAvg": 3.14, # Relative amount of time the average shard spent reading input.

1921

"id": "A String", # Unique ID for stage within plan.

1922

"writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output.

1923

"endMs": "A String", # Stage end time represented as milliseconds since epoch.

1924

"inputStages": [ # IDs for stages that are inputs to this stage.

1925

"A String",

1926

],

1927

"computeMsAvg": "A String", # Milliseconds the average shard spent on CPU-bound tasks.

1928

"computeMsMax": "A String", # Milliseconds the slowest shard spent on CPU-bound tasks.

1929

"slotMs": "A String", # Slot-milliseconds used by the stage.

1930

"readMsMax": "A String", # Milliseconds the slowest shard spent reading input.

1931

"shuffleOutputBytes": "A String", # Total number of bytes written to shuffle.

1932

"parallelInputs": "A String", # Number of parallel input segments to be processed.

1933

"status": "A String", # Current status for the stage.

1934

"name": "A String", # Human-readable name for stage.

1935

"computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks.

1936

},

1937

],

1938

"ddlTargetTable": { # [Output-only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.

1939

"projectId": "A String", # [Required] The ID of the project containing this table.

1940

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

1941

"tableId": "A String", # [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.

1942

},

1943

"schema": { # [Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.

1944

"fields": [ # Describes the fields in a table.

1945

{

1946

"name": "A String", # [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.

1947

"type": "A String", # [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).

1948

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

1949

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

1954

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

1955

"policyTags": {

1956

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

"A String",

],

},

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

1961

# Object with schema name: TableFieldSchema

],

},

],

},

"estimatedBytesProcessed": "A String", # [Output-only] The original estimate of bytes processed for the job.

1967

"referencedTables": [ # [Output-only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.

1968

{

1969

"projectId": "A String", # [Required] The ID of the project containing this table.

1970

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

1971

"tableId": "A String", # [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.

1972

},

1973

],

1974

"modelTrainingCurrentIteration": 42, # [Output-only, Beta] Deprecated; do not use.

1975

"numDmlAffectedRows": "A String", # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.

1976

"totalBytesProcessed": "A String", # [Output-only] Total bytes processed for the job.

1977

"statementType": "A String", # The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.

1978

"ddlOperationPerformed": "A String", # The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": 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. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target.

1979

"billingTier": 42, # [Output-only] Billing tier for the job.

1980

"ddlTargetRowAccessPolicy": { # [Output-only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.

1981

"datasetId": "A String", # [Required] The ID of the dataset containing this row access policy.

1982

"policyId": "A String", # [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.

1983

"tableId": "A String", # [Required] The ID of the table containing this row access policy.

1984

"projectId": "A String", # [Required] The ID of the project containing this row access policy.

1985

},

1986

"modelTraining": { # [Output-only, Beta] Information about create model query job progress.

1987

"expectedTotalIterations": "A String", # [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.

1988

"currentIteration": 42, # [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.

1989

},

1990

"cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.

1991

"reservationUsage": [ # [Output-only] Job resource usage breakdown by reservation.

1992

{

1993

"slotMs": "A String", # [Output-only] Slot-milliseconds the job spent in the given reservation.

1994

"name": "A String", # [Output-only] Reservation name or "unreserved" for on-demand resources usage.

1995

},

1996

],

1997

"undeclaredQueryParameters": [ # Standard SQL only: list of undeclared query parameters detected during a dry run validation.

1998

{

1999

"name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.

2000

"parameterType": { # [Required] The type of this parameter.

2001

"arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.

2002

"type": "A String", # [Required] The top level type of this field.

2003

"structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.

2004

{

2005

"name": "A String", # [Optional] The name of this field.

2006

"description": "A String", # [Optional] Human-oriented description of the field.

2007

"type": # Object with schema name: QueryParameterType # [Required] The type of this field.

},

],

},

"parameterValue": { # [Required] The value of this parameter.

2012

"structValues": { # [Optional] The struct field values, in order of the struct type's declaration.

2013

"a_key": # Object with schema name: QueryParameterValue

2014

},

2015

"arrayValues": [ # [Optional] The array values, if this is an array type.

2016

# Object with schema name: QueryParameterValue

2017

],

2018

"value": "A String", # [Optional] The value of this value, if a simple scalar type.

},

},

],

"totalPartitionsProcessed": "A String", # [Output-only] Total number of partitions processed from all partitioned tables referenced in the job.

2023

"modelTrainingExpectedTotalIteration": "A String", # [Output-only, Beta] Deprecated; do not use.

2024

"ddlAffectedRowAccessPolicyCount": "A String", # [Output-only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.

2025

"totalSlotMs": "A String", # [Output-only] Slot-milliseconds for the job.

2026

"totalBytesBilled": "A String", # [Output-only] Total bytes billed for the job.

2027

"totalBytesProcessedAccuracy": "A String", # [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.

2028

"referencedRoutines": [ # [Output-only] Referenced routines (persistent user-defined functions and stored procedures) for the job.

2029

{

2030

"projectId": "A String", # [Required] The ID of the project containing this routine.

2031

"datasetId": "A String", # [Required] The ID of the dataset containing this routine.

2032

"routineId": "A String", # [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.

},

],

},

"numChildJobs": "A String", # [Output-only] Number of child jobs executed.

2037

"totalSlotMs": "A String", # [Output-only] Slot-milliseconds for the job.

2038

"parentJobId": "A String", # [Output-only] If this is a child job, the id of the parent.

2039

"reservation_id": "A String", # [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.

2040

"quotaDeferments": [ # [Output-only] Quotas which delayed this job's start time.

2041

"A String",

2042

],

2043

"rowLevelSecurityStatistics": { # [Output-only] [Preview] Statistics for row-level security. Present only for query and extract jobs.

2044

"rowLevelSecurityApplied": True or False, # [Output-only] [Preview] Whether any accessed data was protected by row access policies.

2045

},

2046

"reservationUsage": [ # [Output-only] Job resource usage breakdown by reservation.

2047

{

2048

"slotMs": "A String", # [Output-only] Slot-milliseconds the job spent in the given reservation.

2049

"name": "A String", # [Output-only] Reservation name or "unreserved" for on-demand resources usage.

2050

},

2051

],

2052

"creationTime": "A String", # [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.

2053

"load": { # [Output-only] Statistics for a load job.

2054

"badRecords": "A String", # [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.

2055

"inputFileBytes": "A String", # [Output-only] Number of bytes of source data in a load job.

2056

"inputFiles": "A String", # [Output-only] Number of source files in a load job.

2057

"outputRows": "A String", # [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.

2058

"outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.

2059

},

2060

},

2061

"selfLink": "A String", # [Output-only] A URL that can be used to access this resource again.

2062

"id": "A String", # [Output-only] Opaque ID field of the job

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2063

"configuration": { # [Required] Describes the job configuration.

2064

"copy": { # [Pick one] Copies a table.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2065

"destinationTable": { # [Required] The destination table

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2066

"projectId": "A String", # [Required] The ID of the project containing this table.

2067

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2068

"tableId": "A String", # [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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2069

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2070

"destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

2071

"kmsKeyName": "A String", # [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.

2072

},

2073

"sourceTables": [ # [Pick one] Source tables to copy.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2074

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2075

"projectId": "A String", # [Required] The ID of the project containing this table.

2076

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2077

"tableId": "A String", # [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.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2078

},

2079

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2080

"createDisposition": "A String", # [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 'notFound' 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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2081

"sourceTable": { # [Pick one] Source table to copy.

2082

"projectId": "A String", # [Required] The ID of the project containing this table.

2083

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

2084

"tableId": "A String", # [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.

2085

},

2086

"writeDisposition": "A String", # [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 'duplicate' 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.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2087

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2088

"jobTimeoutMs": "A String", # [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.

2089

"query": { # [Pick one] Configures a query job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2090

"queryParameters": [ # Query parameters for standard SQL queries.

2091

{

2092

"name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.

2093

"parameterType": { # [Required] The type of this parameter.

2094

"arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.

2095

"type": "A String", # [Required] The top level type of this field.

2096

"structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.

2097

{

2098

"name": "A String", # [Optional] The name of this field.

2099

"description": "A String", # [Optional] Human-oriented description of the field.

2100

"type": # Object with schema name: QueryParameterType # [Required] The type of this field.

},

],

},

"parameterValue": { # [Required] The value of this parameter.

2105

"structValues": { # [Optional] The struct field values, in order of the struct type's declaration.

2106

"a_key": # Object with schema name: QueryParameterValue

2107

},

2108

"arrayValues": [ # [Optional] The array values, if this is an array type.

2109

# Object with schema name: QueryParameterValue

2110

],

2111

"value": "A String", # [Optional] The value of this value, if a simple scalar type.

},

},

],

"useLegacySql": true, # Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery'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.

2116

"destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

2117

"kmsKeyName": "A String", # [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.

2118

},

2119

"clustering": { # [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.

2120

"fields": [ # [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.

"A String",

],

},

"createDisposition": "A String", # [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 'notFound' 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2125

"maximumBytesBilled": "A String", # [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.

2126

"schemaUpdateOptions": [ # 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.

2127

"A String",

2128

],

2129

"priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.

2130

"connectionProperties": [ # Connection properties.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2131

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2132

"key": "A String", # [Required] Name of the connection property to set.

2133

"value": "A String", # [Required] Value of the connection property.

2134

},

2135

],

2136

"allowLargeResults": 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.

2137

"rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

2138

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

2139

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

2140

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

2141

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

2142

},

2143

"field": "A String", # [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.

2144

},

2145

"parameterMode": "A String", # Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.

2146

"useQueryCache": 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.

2147

"flattenResults": 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.

2148

"tableDefinitions": { # [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.

2149

"a_key": {

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2150

"compression": "A String", # [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.

2151

"maxBadRecords": 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.

2152

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' 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 '*' wildcard character is not allowed.

2153

"A String",

2154

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2155

"csvOptions": { # Additional properties to set if sourceFormat is set to CSV.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2156

"quote": """, # [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 ('"'). 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.

2157

"skipLeadingRows": "A String", # [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 > 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.

2158

"allowJaggedRows": 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.

2159

"fieldDelimiter": "A String", # [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 "\t" to specify a tab separator. The default value is a comma (',').

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2160

"encoding": "A String", # [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.

2161

"allowQuotedNewlines": 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2162

},

2163

"bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2164

"readRowkeyAsString": 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2165

"columnFamilies": [ # [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 'type' 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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2166

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2167

"onlyReadLatest": 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 'columns' and specifying a different setting for that column.

2168

"encoding": "A String", # [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 'columns' and specifying an encoding for it.

2169

"columns": [ # [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.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2170

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2171

"fieldName": "A String", # [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.

2172

"qualifierString": "A String",

2173

"encoding": "A String", # [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. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.

2174

"type": "A String", # [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. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2175

"qualifierEncoded": "A String", # [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.

2176

"onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2177

},

2178

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2179

"type": "A String", # [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 'columns' and specifying a type for it.

2180

"familyId": "A String", # Identifier of the column family.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2181

},

2182

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2183

"ignoreUnspecifiedColumnFamilies": 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.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2184

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2185

"schema": { # [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.

2186

"fields": [ # Describes the fields in a table.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2187

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2188

"name": "A String", # [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.

2189

"type": "A String", # [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).

2190

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

2191

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

2192

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2193

],

2194

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2195

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

2196

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

2197

"policyTags": {

2198

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

2199

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2200

],

2201

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2202

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

2203

# Object with schema name: TableFieldSchema

2204

],

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2205

},

2206

],

2207

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2208

"connectionId": "A String", # [Optional, Trusted Tester] Connection for external data source.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2209

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

2210

"sourceUriPrefix": "A String", # [Optional, Trusted Tester] 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).

2211

"mode": "A String", # [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two 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. 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.

2212

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2213

"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.

2214

"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

2215

"range": "A String", # [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

2216

"skipLeadingRows": "A String", # [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 > 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.

2217

},

2218

"ignoreUnknownValues": 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'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.

2219

"sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2220

},

2221

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2222

"defaultDataset": { # [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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2223

"datasetId": "A String", # [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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2224

"projectId": "A String", # [Optional] The ID of the project containing this dataset.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2225

},

2226

"maximumBillingTier": 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.

2227

"preserveNulls": True or False, # [Deprecated] This property is deprecated.

2228

"timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2229

"requirePartitionFilter": True or False,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2230

"field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' 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.

2231

"expirationMs": "A String", # [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.

2232

"type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2233

},

2234

"writeDisposition": "A String", # [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 'duplicate' 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.

2235

"query": "A String", # [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.

2236

"userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2237

{ # 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2238

"inlineCode": "A String", # [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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2239

"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2240

},

2241

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2242

"destinationTable": { # [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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2243

"projectId": "A String", # [Required] The ID of the project containing this table.

2244

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2245

"tableId": "A String", # [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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2246

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2247

},

2248

"dryRun": True or False, # [Optional] If set, don'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't a dry run. Behavior of non-query jobs is undefined.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2249

"load": { # [Pick one] Configures a load job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2250

"nullMarker": "A String", # [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" 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.

2251

"schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.

2252

"fields": [ # Describes the fields in a table.

2253

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2254

"name": "A String", # [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.

2255

"type": "A String", # [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).

2256

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

2257

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

2262

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

2263

"policyTags": {

2264

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

2265

"A String",

2266

],

2267

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2268

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

2269

# Object with schema name: TableFieldSchema

2270

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.

2275

"quote": """, # [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 ('"'). 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.

2276

"writeDisposition": "A String", # [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 'duplicate' 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.

2277

"destinationTableProperties": { # [Beta] [Optional] Properties with which to create the destination table if it is new.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2278

"labels": { # [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.

2279

"a_key": "A String",

2280

},

2281

"friendlyName": "A String", # [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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2282

"description": "A String", # [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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2283

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2284

"sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2285

"ignoreUnknownValues": 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't match any column names

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2286

"destinationTable": { # [Required] The destination table to load the data into.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2287

"projectId": "A String", # [Required] The ID of the project containing this table.

2288

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2289

"tableId": "A String", # [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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2290

},

2291

"encoding": "A String", # [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.

2292

"clustering": { # [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.

2293

"fields": [ # [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.

"A String",

],

},

"createDisposition": "A String", # [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 'notFound' 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.

2298

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' 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 '*' wildcard character is not allowed.

2299

"A String",

2300

],

2301

"maxBadRecords": 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.

2302

"allowJaggedRows": 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.

2303

"fieldDelimiter": "A String", # [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 "\t" to specify a tab separator. The default value is a comma (',').

2304

"projectionFields": [ # If sourceFormat is set to "DATASTORE_BACKUP", 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't found in the Cloud Datastore backup, an invalid error is returned in the job result.

2305

"A String",

2306

],

2307

"allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

2308

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

2309

"sourceUriPrefix": "A String", # [Optional, Trusted Tester] 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).

2310

"mode": "A String", # [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two 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. 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.

2311

},

2312

"useAvroLogicalTypes": True or False, # [Optional] If sourceFormat is set to "AVRO", indicates whether to enable interpreting logical types into their corresponding types (ie. TIMESTAMP), instead of only using their raw types (ie. INTEGER).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2313

"timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2314

"requirePartitionFilter": True or False,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2315

"field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' 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.

2316

"expirationMs": "A String", # [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.

2317

"type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2318

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2319

"skipLeadingRows": 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.

2320

"autodetect": True or False, # [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.

2321

"destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

2322

"kmsKeyName": "A String", # [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.

2323

},

2324

"schemaUpdateOptions": [ # 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.

2325

"A String",

2326

],

2327

"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".

2328

"rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

2329

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

2330

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

2331

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

2332

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

2333

},

2334

"field": "A String", # [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.

2335

},

2336

},

2337

"labels": { # 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.

2338

"a_key": "A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2339

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2340

"jobType": "A String", # [Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.

2341

"extract": { # [Pick one] Configures an extract job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2342

"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.

2343

"destinationUri": "A String", # [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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2344

"printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.

2345

"compression": "A String", # [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.

2346

"destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.

2347

"A String",

2348

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2349

"destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2350

"sourceModel": { # A reference to the model being exported.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2351

"projectId": "A String", # [Required] The ID of the project containing this model.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2352

"datasetId": "A String", # [Required] The ID of the dataset containing this model.

2353

"modelId": "A String", # [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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2354

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2355

"useAvroLogicalTypes": True or False, # [Optional] If destinationFormat is set to "AVRO", 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.

2356

"sourceTable": { # A reference to the table being exported.

2357

"projectId": "A String", # [Required] The ID of the project containing this table.

2358

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

2359

"tableId": "A String", # [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.

2360

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2361

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2362

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2363

"user_email": "A String", # [Output-only] Email address of the user who ran the job.

2364

"kind": "bigquery#job", # [Output-only] The type of the resource.

2365

"etag": "A String", # [Output-only] A hash of this resource.

2366

"jobReference": { # [Optional] Reference describing the unique-per-user name of the job.

2367

"jobId": "A String", # [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.

2368

"projectId": "A String", # [Required] The ID of the project containing this job.

2369

"location": "A String", # The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

2370

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2371

}</pre>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2375

<code class="details" id="list">list(projectId, stateFilter=None, projection=None, minCreationTime=None, parentJobId=None, allUsers=None, pageToken=None, maxCreationTime=None, maxResults=None)</code>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

2376

<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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2377

2378

Args:

2379

projectId: string, Project ID of the jobs to list (required)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2380

stateFilter: string, Filter for job state (repeated)

2381

Allowed values

2382

done - Finished jobs

2383

pending - Pending jobs

2384

running - Running jobs

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2385

projection: string, Restrict information returned to a set of selected fields

2386

Allowed values

2387

full - Includes all job data

2388

minimal - Does not include the job configuration

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2389

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

2390

parentJobId: string, If set, retrieves only jobs whose parent is this job. Otherwise, retrieves only jobs which have no parent

2391

allUsers: boolean, Whether to display jobs owned by all users in the project. Default false

2392

pageToken: string, Page token, returned by a previous call, to request the next page of results

2393

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

2394

maxResults: integer, Maximum number of results to return

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2395

2396

Returns:

2397

An object of the form:

2398

2399

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2400

"jobs": [ # List of jobs that were requested.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2401

{

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2402

"id": "A String", # Unique opaque ID of the job.

2403

"configuration": { # [Full-projection-only] Specifies the job configuration.

2404

"copy": { # [Pick one] Copies a table.

2405

"destinationTable": { # [Required] The destination table

2406

"projectId": "A String", # [Required] The ID of the project containing this table.

2407

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

2408

"tableId": "A String", # [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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2409

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2410

"destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

2411

"kmsKeyName": "A String", # [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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2412

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2413

"sourceTables": [ # [Pick one] Source tables to copy.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2414

{

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2415

"projectId": "A String", # [Required] The ID of the project containing this table.

2416

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

2417

"tableId": "A String", # [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.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2418

},

2419

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2420

"createDisposition": "A String", # [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 'notFound' 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.

2421

"sourceTable": { # [Pick one] Source table to copy.

2422

"projectId": "A String", # [Required] The ID of the project containing this table.

2423

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

2424

"tableId": "A String", # [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.

2425

},

2426

"writeDisposition": "A String", # [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 'duplicate' 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.

2427

},

2428

"jobTimeoutMs": "A String", # [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.

2429

"query": { # [Pick one] Configures a query job.

2430

"queryParameters": [ # Query parameters for standard SQL queries.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2431

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2432

"name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.

2433

"parameterType": { # [Required] The type of this parameter.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2434

"arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2435

"type": "A String", # [Required] The top level type of this field.

2436

"structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2437

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2438

"name": "A String", # [Optional] The name of this field.

2439

"description": "A String", # [Optional] Human-oriented description of the field.

2440

"type": # Object with schema name: QueryParameterType # [Required] The type of this field.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2441

},

2442

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2443

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2444

"parameterValue": { # [Required] The value of this parameter.

2445

"structValues": { # [Optional] The struct field values, in order of the struct type's declaration.

2446

"a_key": # Object with schema name: QueryParameterValue

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2447

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2448

"arrayValues": [ # [Optional] The array values, if this is an array type.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2449

# Object with schema name: QueryParameterValue

2450

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2451

"value": "A String", # [Optional] The value of this value, if a simple scalar type.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2452

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2453

},

2454

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2455

"useLegacySql": true, # Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery'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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2456

"destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

2457

"kmsKeyName": "A String", # [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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2458

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2459

"clustering": { # [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.

2460

"fields": [ # [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.

2461

"A String",

2462

],

2463

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2464

"createDisposition": "A String", # [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 'notFound' 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2465

"maximumBytesBilled": "A String", # [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.

2466

"schemaUpdateOptions": [ # 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.

2467

"A String",

Jon Wayne Parrott

2016-08-29 10:21:22 -0700

[diff] [blame]

2468

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2469

"priority": "A String", # [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.

2470

"connectionProperties": [ # Connection properties.

Jon Wayne Parrott

2016-08-29 10:21:22 -0700

[diff] [blame]

2471

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2472

"key": "A String", # [Required] Name of the connection property to set.

2473

"value": "A String", # [Required] Value of the connection property.

2474

},

2475

],

2476

"allowLargeResults": 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.

2477

"rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

2478

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

2479

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

2480

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

2481

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

2482

},

2483

"field": "A String", # [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.

2484

},

2485

"parameterMode": "A String", # Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.

2486

"useQueryCache": 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.

2487

"flattenResults": 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.

2488

"tableDefinitions": { # [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.

2489

"a_key": {

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2490

"compression": "A String", # [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.

2491

"maxBadRecords": 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.

2492

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' 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 '*' wildcard character is not allowed.

2493

"A String",

2494

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2495

"csvOptions": { # Additional properties to set if sourceFormat is set to CSV.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2496

"quote": """, # [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 ('"'). 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.

2497

"skipLeadingRows": "A String", # [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 > 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.

2498

"allowJaggedRows": 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.

2499

"fieldDelimiter": "A String", # [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 "\t" to specify a tab separator. The default value is a comma (',').

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2500

"encoding": "A String", # [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.

2501

"allowQuotedNewlines": 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2502

},

2503

"bigtableOptions": { # [Optional] Additional options if sourceFormat is set to BIGTABLE.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2504

"readRowkeyAsString": 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2505

"columnFamilies": [ # [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 'type' 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.

Jon Wayne Parrott

2016-08-29 10:21:22 -0700

[diff] [blame]

2506

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2507

"onlyReadLatest": 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 'columns' and specifying a different setting for that column.

2508

"encoding": "A String", # [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 'columns' and specifying an encoding for it.

2509

"columns": [ # [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.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2510

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2511

"fieldName": "A String", # [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.

2512

"qualifierString": "A String",

2513

"encoding": "A String", # [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. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.

2514

"type": "A String", # [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. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2515

"qualifierEncoded": "A String", # [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.

2516

"onlyReadLatest": True or False, # [Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2517

},

2518

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2519

"type": "A String", # [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 'columns' and specifying a type for it.

2520

"familyId": "A String", # Identifier of the column family.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2521

},

2522

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2523

"ignoreUnspecifiedColumnFamilies": 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.

Jon Wayne Parrott

2016-05-19 10:54:38 -0700

[diff] [blame]

2524

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2525

"schema": { # [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.

2526

"fields": [ # Describes the fields in a table.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2527

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2528

"name": "A String", # [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.

2529

"type": "A String", # [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).

2530

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

2531

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

2532

"A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2533

],

2534

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2535

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

2536

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

2537

"policyTags": {

2538

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

2539

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2540

],

2541

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2542

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

2543

# Object with schema name: TableFieldSchema

2544

],

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2545

},

2546

],

2547

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2548

"connectionId": "A String", # [Optional, Trusted Tester] Connection for external data source.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2549

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

2550

"sourceUriPrefix": "A String", # [Optional, Trusted Tester] 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).

2551

"mode": "A String", # [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two 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. 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.

2552

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2553

"autodetect": True or False, # Try to detect schema and format options automatically. Any option specified explicitly will be honored.

2554

"googleSheetsOptions": { # [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.

2555

"range": "A String", # [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

2556

"skipLeadingRows": "A String", # [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 > 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.

2557

},

2558

"ignoreUnknownValues": 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'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.

2559

"sourceFormat": "A String", # [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

2560

},

2561

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2562

"defaultDataset": { # [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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2563

"datasetId": "A String", # [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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2564

"projectId": "A String", # [Optional] The ID of the project containing this dataset.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2565

},

2566

"maximumBillingTier": 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.

2567

"preserveNulls": True or False, # [Deprecated] This property is deprecated.

2568

"timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2569

"requirePartitionFilter": True or False,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2570

"field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' 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.

2571

"expirationMs": "A String", # [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.

2572

"type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2573

},

2574

"writeDisposition": "A String", # [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 'duplicate' 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.

2575

"query": "A String", # [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.

2576

"userDefinedFunctionResources": [ # Describes user-defined function resources used in the query.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2577

{ # 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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2578

"inlineCode": "A String", # [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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2579

"resourceUri": "A String", # [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2580

},

2581

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2582

"destinationTable": { # [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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2583

"projectId": "A String", # [Required] The ID of the project containing this table.

2584

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2585

"tableId": "A String", # [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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

2586

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2587

},

2588

"dryRun": True or False, # [Optional] If set, don'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't a dry run. Behavior of non-query jobs is undefined.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2589

"load": { # [Pick one] Configures a load job.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2590

"nullMarker": "A String", # [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" 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.

2591

"schema": { # [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore.

2592

"fields": [ # Describes the fields in a table.

2593

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2594

"name": "A String", # [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.

2595

"type": "A String", # [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).

2596

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

2597

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

2602

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

2603

"policyTags": {

2604

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

2605

"A String",

2606

],

2607

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2608

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

2609

# Object with schema name: TableFieldSchema

2610

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

},

],

},

"schemaInlineFormat": "A String", # [Deprecated] The format of the schemaInline property.

2615

"quote": """, # [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 ('"'). 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.

2616

"writeDisposition": "A String", # [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 'duplicate' 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.

2617

"destinationTableProperties": { # [Beta] [Optional] Properties with which to create the destination table if it is new.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2618

"labels": { # [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.

2619

"a_key": "A String",

2620

},

2621

"friendlyName": "A String", # [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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2622

"description": "A String", # [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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2623

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2624

"sourceFormat": "A String", # [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2625

"ignoreUnknownValues": 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't match any column names

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2626

"destinationTable": { # [Required] The destination table to load the data into.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2627

"projectId": "A String", # [Required] The ID of the project containing this table.

2628

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2629

"tableId": "A String", # [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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2630

},

2631

"encoding": "A String", # [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.

2632

"clustering": { # [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.

2633

"fields": [ # [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.

"A String",

],

},

"createDisposition": "A String", # [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 'notFound' 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.

2638

"sourceUris": [ # [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character and it must come after the 'bucket' 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 '*' wildcard character is not allowed.

2639

"A String",

2640

],

2641

"maxBadRecords": 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.

2642

"allowJaggedRows": 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.

2643

"fieldDelimiter": "A String", # [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 "\t" to specify a tab separator. The default value is a comma (',').

2644

"projectionFields": [ # If sourceFormat is set to "DATASTORE_BACKUP", 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't found in the Cloud Datastore backup, an invalid error is returned in the job result.

2645

"A String",

2646

],

2647

"allowQuotedNewlines": True or False, # Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

2648

"hivePartitioningOptions": { # [Optional, Trusted Tester] Options to configure hive partitioning support.

2649

"sourceUriPrefix": "A String", # [Optional, Trusted Tester] 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).

2650

"mode": "A String", # [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data. Two 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. 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.

2651

},

2652

"useAvroLogicalTypes": True or False, # [Optional] If sourceFormat is set to "AVRO", indicates whether to enable interpreting logical types into their corresponding types (ie. TIMESTAMP), instead of only using their raw types (ie. INTEGER).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2653

"timePartitioning": { # Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2654

"requirePartitionFilter": True or False,

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2655

"field": "A String", # [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' 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.

2656

"expirationMs": "A String", # [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.

2657

"type": "A String", # [Required] The only type supported is DAY, which will generate one partition per day.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2658

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2659

"skipLeadingRows": 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.

2660

"autodetect": True or False, # [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.

2661

"destinationEncryptionConfiguration": { # Custom encryption configuration (e.g., Cloud KMS keys).

2662

"kmsKeyName": "A String", # [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.

2663

},

2664

"schemaUpdateOptions": [ # 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.

2665

"A String",

2666

],

2667

"schemaInline": "A String", # [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".

2668

"rangePartitioning": { # [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified.

2669

"range": { # [TrustedTester] [Required] Defines the ranges for range partitioning.

2670

"interval": "A String", # [TrustedTester] [Required] The width of each interval.

2671

"start": "A String", # [TrustedTester] [Required] The start of range partitioning, inclusive.

2672

"end": "A String", # [TrustedTester] [Required] The end of range partitioning, exclusive.

2673

},

2674

"field": "A String", # [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.

2675

},

2676

},

2677

"labels": { # 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.

2678

"a_key": "A String",

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

2679

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2680

"jobType": "A String", # [Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.

2681

"extract": { # [Pick one] Configures an extract job.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2682

"fieldDelimiter": "A String", # [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.

2683

"destinationUri": "A String", # [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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2684

"printHeader": true, # [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.

2685

"compression": "A String", # [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.

2686

"destinationUris": [ # [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.

2687

"A String",

2688

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2689

"destinationFormat": "A String", # [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON 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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2690

"sourceModel": { # A reference to the model being exported.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2691

"projectId": "A String", # [Required] The ID of the project containing this model.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2692

"datasetId": "A String", # [Required] The ID of the dataset containing this model.

2693

"modelId": "A String", # [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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2694

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2695

"useAvroLogicalTypes": True or False, # [Optional] If destinationFormat is set to "AVRO", 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

"sourceTable": { # A reference to the table being exported.

2697

"projectId": "A String", # [Required] The ID of the project containing this table.

2698

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

2699

"tableId": "A String", # [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.

2700

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2701

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2702

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2703

"user_email": "A String", # [Full-projection-only] Email address of the user who ran the job.

2704

"errorResult": { # A result object that will be present only if the job has failed.

2705

"reason": "A String", # A short error code that summarizes the error.

2706

"message": "A String", # A human-readable description of the error.

2707

"location": "A String", # Specifies where the error occurred, if present.

2708

"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.

2709

},

2710

"kind": "bigquery#job", # The resource type.

2711

"jobReference": { # Job reference uniquely identifying the job.

2712

"jobId": "A String", # [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.

2713

"projectId": "A String", # [Required] The ID of the project containing this job.

2714

"location": "A String", # The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2715

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2716

"status": { # [Full-projection-only] Describes the state of the job.

2717

"errors": [ # [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.

2718

{

2719

"reason": "A String", # A short error code that summarizes the error.

2720

"message": "A String", # A human-readable description of the error.

2721

"location": "A String", # Specifies where the error occurred, if present.

2722

"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.

2723

},

2724

],

2725

"state": "A String", # [Output-only] Running state of the job.

2726

"errorResult": { # [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful.

2727

"reason": "A String", # A short error code that summarizes the error.

2728

"message": "A String", # A human-readable description of the error.

2729

"location": "A String", # Specifies where the error occurred, if present.

2730

"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.

2731

},

2732

},

2733

"state": "A String", # Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed.

2734

"statistics": { # [Output-only] Information about the job, including starting time and ending time of the job.

2735

"extract": { # [Output-only] Statistics for an extract job.

2736

"destinationUriFileCounts": [ # [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 'destinationUris' field.

2737

"A String",

2738

],

2739

"inputBytes": "A String", # [Output-only] Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.

2740

},

2741

"endTime": "A String", # [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.

2742

"completionRatio": 3.14, # [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.

2743

"startTime": "A String", # [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.

2744

"totalBytesProcessed": "A String", # [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.

2745

"scriptStatistics": { # [Output-only] Statistics for a child job of a script.

2746

"evaluationKind": "A String", # [Output-only] Whether this child job was a statement or expression.

2747

"stackFrames": [ # 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.

2748

{

2749

"procedureId": "A String", # [Output-only] Name of the active procedure, empty if in a top-level script.

2750

"startLine": 42, # [Output-only] One-based start line.

2751

"text": "A String", # [Output-only] Text of the current statement/expression.

2752

"endColumn": 42, # [Output-only] One-based end column.

2753

"endLine": 42, # [Output-only] One-based end line.

2754

"startColumn": 42, # [Output-only] One-based start column.

},

],

},

"query": { # [Output-only] Statistics for a query job.

2759

"timeline": [ # [Output-only] [Beta] Describes a timeline of job execution.

2760

{

2761

"activeUnits": "A String", # 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.

2762

"completedUnits": "A String", # Total parallel units of work completed by this query.

2763

"elapsedMs": "A String", # Milliseconds elapsed since the start of query execution.

2764

"pendingUnits": "A String", # Total parallel units of work remaining for the active stages.

2765

"totalSlotMs": "A String", # Cumulative slot-ms consumed by the query.

2766

},

2767

],

2768

"ddlTargetRoutine": { # The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries.

2769

"projectId": "A String", # [Required] The ID of the project containing this routine.

2770

"datasetId": "A String", # [Required] The ID of the dataset containing this routine.

2771

"routineId": "A String", # [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.

2772

},

2773

"queryPlan": [ # [Output-only] Describes execution plan for the query.

2774

{

2775

"steps": [ # List of operations within the stage in dependency order (approximately chronological).

2776

{

2777

"substeps": [ # Human-readable stage descriptions.

2778

"A String",

2779

],

2780

"kind": "A String", # Machine-readable operation type.

2781

},

2782

],

2783

"startMs": "A String", # Stage start time represented as milliseconds since epoch.

2784

"writeMsMax": "A String", # Milliseconds the slowest shard spent on writing output.

2785

"shuffleOutputBytesSpilled": "A String", # Total number of bytes written to shuffle and spilled to disk.

2786

"readMsAvg": "A String", # Milliseconds the average shard spent reading input.

2787

"waitMsAvg": "A String", # Milliseconds the average shard spent waiting to be scheduled.

2788

"recordsRead": "A String", # Number of records read into the stage.

2789

"writeMsAvg": "A String", # Milliseconds the average shard spent on writing output.

2790

"waitRatioMax": 3.14, # Relative amount of time the slowest shard spent waiting to be scheduled.

2791

"waitMsMax": "A String", # Milliseconds the slowest shard spent waiting to be scheduled.

2792

"writeRatioAvg": 3.14, # Relative amount of time the average shard spent on writing output.

2793

"computeRatioAvg": 3.14, # Relative amount of time the average shard spent on CPU-bound tasks.

2794

"completedParallelInputs": "A String", # Number of parallel input segments completed.

2795

"recordsWritten": "A String", # Number of records written by the stage.

2796

"waitRatioAvg": 3.14, # Relative amount of time the average shard spent waiting to be scheduled.

2797

"readRatioMax": 3.14, # Relative amount of time the slowest shard spent reading input.

2798

"readRatioAvg": 3.14, # Relative amount of time the average shard spent reading input.

2799

"id": "A String", # Unique ID for stage within plan.

2800

"writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output.

2801

"endMs": "A String", # Stage end time represented as milliseconds since epoch.

2802

"inputStages": [ # IDs for stages that are inputs to this stage.

2803

"A String",

2804

],

2805

"computeMsAvg": "A String", # Milliseconds the average shard spent on CPU-bound tasks.

2806

"computeMsMax": "A String", # Milliseconds the slowest shard spent on CPU-bound tasks.

2807

"slotMs": "A String", # Slot-milliseconds used by the stage.

2808

"readMsMax": "A String", # Milliseconds the slowest shard spent reading input.

2809

"shuffleOutputBytes": "A String", # Total number of bytes written to shuffle.

2810

"parallelInputs": "A String", # Number of parallel input segments to be processed.

2811

"status": "A String", # Current status for the stage.

2812

"name": "A String", # Human-readable name for stage.

2813

"computeRatioMax": 3.14, # Relative amount of time the slowest shard spent on CPU-bound tasks.

2814

},

2815

],

2816

"ddlTargetTable": { # [Output-only] The DDL target table. Present only for CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.

2817

"projectId": "A String", # [Required] The ID of the project containing this table.

2818

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

2819

"tableId": "A String", # [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

},

2821

"schema": { # [Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries.

2822

"fields": [ # Describes the fields in a table.

2823

{

2824

"name": "A String", # [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.

2825

"type": "A String", # [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).

2826

"categories": { # [Optional] The categories attached to this field, used for field-level access control.

2827

"names": [ # A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

"A String",

],

},

"mode": "A String", # [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

2832

"description": "A String", # [Optional] The field description. The maximum length is 1,024 characters.

2833

"policyTags": {

2834

"names": [ # A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

"A String",

],

},

"fields": [ # [Optional] Describes the nested schema fields if the type property is set to RECORD.

2839

# Object with schema name: TableFieldSchema

],

},

],

},

"estimatedBytesProcessed": "A String", # [Output-only] The original estimate of bytes processed for the job.

2845

"referencedTables": [ # [Output-only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.

2846

{

2847

"projectId": "A String", # [Required] The ID of the project containing this table.

2848

"datasetId": "A String", # [Required] The ID of the dataset containing this table.

2849

"tableId": "A String", # [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.

2850

},

2851

],

2852

"modelTrainingCurrentIteration": 42, # [Output-only, Beta] Deprecated; do not use.

2853

"numDmlAffectedRows": "A String", # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.

2854

"totalBytesProcessed": "A String", # [Output-only] Total bytes processed for the job.

2855

"statementType": "A String", # The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.

2856

"ddlOperationPerformed": "A String", # The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": 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. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target.

2857

"billingTier": 42, # [Output-only] Billing tier for the job.

2858

"ddlTargetRowAccessPolicy": { # [Output-only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.

2859

"datasetId": "A String", # [Required] The ID of the dataset containing this row access policy.

2860

"policyId": "A String", # [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.

2861

"tableId": "A String", # [Required] The ID of the table containing this row access policy.

2862

"projectId": "A String", # [Required] The ID of the project containing this row access policy.

2863

},

2864

"modelTraining": { # [Output-only, Beta] Information about create model query job progress.

2865

"expectedTotalIterations": "A String", # [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.

2866

"currentIteration": 42, # [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.

2867

},

2868

"cacheHit": True or False, # [Output-only] Whether the query result was fetched from the query cache.

2869

"reservationUsage": [ # [Output-only] Job resource usage breakdown by reservation.

2870

{

2871

"slotMs": "A String", # [Output-only] Slot-milliseconds the job spent in the given reservation.

2872

"name": "A String", # [Output-only] Reservation name or "unreserved" for on-demand resources usage.

2873

},

2874

],

2875

"undeclaredQueryParameters": [ # Standard SQL only: list of undeclared query parameters detected during a dry run validation.

2876

{

2877

"name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.

2878

"parameterType": { # [Required] The type of this parameter.

2879

"arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.

2880

"type": "A String", # [Required] The top level type of this field.

2881

"structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.

2882

{

2883

"name": "A String", # [Optional] The name of this field.

2884

"description": "A String", # [Optional] Human-oriented description of the field.

2885

"type": # Object with schema name: QueryParameterType # [Required] The type of this field.

},

],

},

"parameterValue": { # [Required] The value of this parameter.

2890

"structValues": { # [Optional] The struct field values, in order of the struct type's declaration.

2891

"a_key": # Object with schema name: QueryParameterValue

2892

},

2893

"arrayValues": [ # [Optional] The array values, if this is an array type.

2894

# Object with schema name: QueryParameterValue

2895

],

2896

"value": "A String", # [Optional] The value of this value, if a simple scalar type.

},

},

],

"totalPartitionsProcessed": "A String", # [Output-only] Total number of partitions processed from all partitioned tables referenced in the job.

2901

"modelTrainingExpectedTotalIteration": "A String", # [Output-only, Beta] Deprecated; do not use.

2902

"ddlAffectedRowAccessPolicyCount": "A String", # [Output-only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.

2903

"totalSlotMs": "A String", # [Output-only] Slot-milliseconds for the job.

2904

"totalBytesBilled": "A String", # [Output-only] Total bytes billed for the job.

2905

"totalBytesProcessedAccuracy": "A String", # [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.

2906

"referencedRoutines": [ # [Output-only] Referenced routines (persistent user-defined functions and stored procedures) for the job.

2907

{

2908

"projectId": "A String", # [Required] The ID of the project containing this routine.

2909

"datasetId": "A String", # [Required] The ID of the dataset containing this routine.

2910

"routineId": "A String", # [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.

},

],

},

"numChildJobs": "A String", # [Output-only] Number of child jobs executed.

2915

"totalSlotMs": "A String", # [Output-only] Slot-milliseconds for the job.

2916

"parentJobId": "A String", # [Output-only] If this is a child job, the id of the parent.

2917

"reservation_id": "A String", # [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.

2918

"quotaDeferments": [ # [Output-only] Quotas which delayed this job's start time.

2919

"A String",

2920

],

2921

"rowLevelSecurityStatistics": { # [Output-only] [Preview] Statistics for row-level security. Present only for query and extract jobs.

2922

"rowLevelSecurityApplied": True or False, # [Output-only] [Preview] Whether any accessed data was protected by row access policies.

2923

},

2924

"reservationUsage": [ # [Output-only] Job resource usage breakdown by reservation.

2925

{

2926

"slotMs": "A String", # [Output-only] Slot-milliseconds the job spent in the given reservation.

2927

"name": "A String", # [Output-only] Reservation name or "unreserved" for on-demand resources usage.

2928

},

2929

],

2930

"creationTime": "A String", # [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.

2931

"load": { # [Output-only] Statistics for a load job.

2932

"badRecords": "A String", # [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.

2933

"inputFileBytes": "A String", # [Output-only] Number of bytes of source data in a load job.

2934

"inputFiles": "A String", # [Output-only] Number of source files in a load job.

2935

"outputRows": "A String", # [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.

2936

"outputBytes": "A String", # [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.

2937

},

2938

},

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2939

},

2940

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2941

"nextPageToken": "A String", # A token to request the next page of results.

2942

"kind": "bigquery#jobList", # The resource type of the response.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2943

"etag": "A String", # A hash of this page of results.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

2949

<pre>Retrieves the next page of results.

2950

2951

Args:

2952

previous_request: The request for the previous page. (required)

2953

previous_response: The response from the request for the previous page. (required)

2954

2955

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2956

A request object that you can call 'execute()' on to request the next

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2957

page. Returns None if there are no more items in the collection.

</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2962

<code class="details" id="query">query(projectId, body=None)</code>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2963

<pre>Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.

2964

2965

Args:

2966

projectId: string, Project ID of the project billed for the query (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

2967

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2968

The object takes the form of:

2969

2970

{

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2971

"connectionProperties": [ # Connection properties.

2972

{

2973

"key": "A String", # [Required] Name of the connection property to set.

2974

"value": "A String", # [Required] Value of the connection property.

2975

},

2976

],

2977

"timeoutMs": 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 'jobComplete' 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).

2978

"kind": "bigquery#queryRequest", # The resource type of the request.

2979

"parameterMode": "A String", # Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2980

"useQueryCache": 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.

2981

"defaultDataset": { # [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 'datasetId.tableId'.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2982

"datasetId": "A String", # [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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2983

"projectId": "A String", # [Optional] The ID of the project containing this dataset.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

2984

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2985

"location": "A String", # The geographic location where the job should run. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

2986

"preserveNulls": True or False, # [Deprecated] This property is deprecated.

2987

"maxResults": 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.

2988

"query": "A String", # [Required] A query string, following the BigQuery query syntax, of the query to execute. Example: "SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]".

2989

"dryRun": True or False, # [Optional] If set to true, BigQuery doesn'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.

2990

"queryParameters": [ # Query parameters for Standard SQL queries.

Jon Wayne Parrott

2016-08-29 10:21:22 -0700

[diff] [blame]

2991

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2992

"name": "A String", # [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.

2993

"parameterType": { # [Required] The type of this parameter.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

2994

"arrayType": # Object with schema name: QueryParameterType # [Optional] The type of the array's elements, if this is an array.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2995

"type": "A String", # [Required] The top level type of this field.

2996

"structTypes": [ # [Optional] The types of the fields of this struct, in order, if this is a struct.

Jon Wayne Parrott

2016-08-29 10:21:22 -0700

[diff] [blame]

2997

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

2998

"name": "A String", # [Optional] The name of this field.

2999

"description": "A String", # [Optional] Human-oriented description of the field.

3000

"type": # Object with schema name: QueryParameterType # [Required] The type of this field.

Jon Wayne Parrott

2016-08-29 10:21:22 -0700

[diff] [blame]

3001

},

3002

],

Jon Wayne Parrott

2016-08-29 10:21:22 -0700

[diff] [blame]

3003

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3004

"parameterValue": { # [Required] The value of this parameter.

3005

"structValues": { # [Optional] The struct field values, in order of the struct type's declaration.

3006

"a_key": # Object with schema name: QueryParameterValue

Sai Cheemalapati

ea3a5e1

2016-10-12 14:05:53 -0700

[diff] [blame]

3007

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3008

"arrayValues": [ # [Optional] The array values, if this is an array type.

Jon Wayne Parrott

2016-08-29 10:21:22 -0700

[diff] [blame]

3009

# Object with schema name: QueryParameterValue

3010

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3011

"value": "A String", # [Optional] The value of this value, if a simple scalar type.

Jon Wayne Parrott

2016-08-29 10:21:22 -0700

[diff] [blame]

3012

},

Jon Wayne Parrott

2016-08-29 10:21:22 -0700

[diff] [blame]

3013

},

3014

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3015

"useLegacySql": true, # Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery'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.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}

Returns:

An object of the form:

3021

3022

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3023

"rows": [ # 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 Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

3024

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3025

"f": [ # Represents a single row in the result set, consisting of one or more fields.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

3026

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3027

"v": "",

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

},

],

},

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3032

"errors": [ # [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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3033

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3034

"reason": "A String", # A short error code that summarizes the error.

3035

"message": "A String", # A human-readable description of the error.

3036

"location": "A String", # Specifies where the error occurred, if present.

3037

"debugInfo": "A String", # Debugging information. This property is internal to Google and should not be used.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

3038

},

3039

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

3040

"pageToken": "A String", # A token used for paging results.

3041

"kind": "bigquery#queryResponse", # The resource type.

3042

"jobComplete": 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.

3043

"numDmlAffectedRows": "A String", # [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.

3044

"totalBytesProcessed": "A String", # 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.

3045

"totalRows": "A String", # 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.

Bu Sun Kim