forked from googleapis/google-api-python-client
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathbigquery.json
More file actions
2774 lines (2774 loc) 路 105 KB
/
Copy pathbigquery.json
File metadata and controls
2774 lines (2774 loc) 路 105 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"kind": "discovery#restDescription",
"etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/wyP_l3wPjLK3LUrJqeSGHNESSW0\"",
"discoveryVersion": "v1",
"id": "bigquery:v2",
"name": "bigquery",
"version": "v2",
"revision": "20161130",
"title": "BigQuery API",
"description": "A data platform for customers to create, manage, share and query data.",
"ownerDomain": "google.com",
"ownerName": "Google",
"icons": {
"x16": "https://www.google.com/images/icons/product/search-16.gif",
"x32": "https://www.google.com/images/icons/product/search-32.gif"
},
"documentationLink": "https://cloud.google.com/bigquery/",
"protocol": "rest",
"baseUrl": "https://www.googleapis.com/bigquery/v2/",
"basePath": "/bigquery/v2/",
"rootUrl": "https://www.googleapis.com/",
"mtlsRootUrl": "https://www.mtls.googleapis.com/",
"servicePath": "bigquery/v2/",
"batchPath": "batch",
"parameters": {
"alt": {
"type": "string",
"description": "Data format for the response.",
"default": "json",
"enum": [
"json"
],
"enumDescriptions": [
"Responses with Content-Type of application/json"
],
"location": "query"
},
"fields": {
"type": "string",
"description": "Selector specifying which fields to include in a partial response.",
"location": "query"
},
"key": {
"type": "string",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query"
},
"oauth_token": {
"type": "string",
"description": "OAuth 2.0 token for the current user.",
"location": "query"
},
"prettyPrint": {
"type": "boolean",
"description": "Returns response with indentations and line breaks.",
"default": "true",
"location": "query"
},
"quotaUser": {
"type": "string",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.",
"location": "query"
},
"userIp": {
"type": "string",
"description": "IP address of the site where the request originates. Use this if you want to enforce per-user limits.",
"location": "query"
}
},
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/bigquery": {
"description": "View and manage your data in Google BigQuery"
},
"https://www.googleapis.com/auth/bigquery.insertdata": {
"description": "Insert data into Google BigQuery"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/cloud-platform.read-only": {
"description": "View your data across Google Cloud Platform services"
},
"https://www.googleapis.com/auth/devstorage.full_control": {
"description": "Manage your data and permissions in Google Cloud Storage"
},
"https://www.googleapis.com/auth/devstorage.read_only": {
"description": "View your data in Google Cloud Storage"
},
"https://www.googleapis.com/auth/devstorage.read_write": {
"description": "Manage your data in Google Cloud Storage"
}
}
}
},
"schemas": {
"BigtableColumn": {
"id": "BigtableColumn",
"type": "object",
"properties": {
"encoding": {
"type": "string",
"description": "[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."
},
"fieldName": {
"type": "string",
"description": "[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."
},
"onlyReadLatest": {
"type": "boolean",
"description": "[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."
},
"qualifierEncoded": {
"type": "string",
"description": "[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.",
"format": "byte"
},
"qualifierString": {
"type": "string"
},
"type": {
"type": "string",
"description": "[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."
}
}
},
"BigtableColumnFamily": {
"id": "BigtableColumnFamily",
"type": "object",
"properties": {
"columns": {
"type": "array",
"description": "[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.",
"items": {
"$ref": "BigtableColumn"
}
},
"encoding": {
"type": "string",
"description": "[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."
},
"familyId": {
"type": "string",
"description": "Identifier of the column family."
},
"onlyReadLatest": {
"type": "boolean",
"description": "[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."
},
"type": {
"type": "string",
"description": "[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."
}
}
},
"BigtableOptions": {
"id": "BigtableOptions",
"type": "object",
"properties": {
"columnFamilies": {
"type": "array",
"description": "[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.",
"items": {
"$ref": "BigtableColumnFamily"
}
},
"ignoreUnspecifiedColumnFamilies": {
"type": "boolean",
"description": "[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."
},
"readRowkeyAsString": {
"type": "boolean",
"description": "[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."
}
}
},
"CsvOptions": {
"id": "CsvOptions",
"type": "object",
"properties": {
"allowJaggedRows": {
"type": "boolean",
"description": "[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."
},
"allowQuotedNewlines": {
"type": "boolean",
"description": "[Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false."
},
"encoding": {
"type": "string",
"description": "[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."
},
"fieldDelimiter": {
"type": "string",
"description": "[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 (',')."
},
"quote": {
"type": "string",
"description": "[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.",
"default": "\"",
"pattern": ".?"
},
"skipLeadingRows": {
"type": "string",
"description": "[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.",
"format": "int64"
}
}
},
"Dataset": {
"id": "Dataset",
"type": "object",
"properties": {
"access": {
"type": "array",
"description": "[Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;",
"items": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "[Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: \"example.com\"."
},
"groupByEmail": {
"type": "string",
"description": "[Pick one] An email address of a Google Group to grant access to."
},
"role": {
"type": "string",
"description": "[Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READER, WRITER, OWNER."
},
"specialGroup": {
"type": "string",
"description": "[Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users."
},
"userByEmail": {
"type": "string",
"description": "[Pick one] An email address of a user to grant access to. For example: fred@example.com."
},
"view": {
"$ref": "TableReference",
"description": "[Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation."
}
}
}
},
"creationTime": {
"type": "string",
"description": "[Output-only] The time when this dataset was created, in milliseconds since the epoch.",
"format": "int64"
},
"datasetReference": {
"$ref": "DatasetReference",
"description": "[Required] A reference that identifies the dataset."
},
"defaultTableExpirationMs": {
"type": "string",
"description": "[Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.",
"format": "int64"
},
"description": {
"type": "string",
"description": "[Optional] A user-friendly description of the dataset."
},
"etag": {
"type": "string",
"description": "[Output-only] A hash of the resource."
},
"friendlyName": {
"type": "string",
"description": "[Optional] A descriptive name for the dataset."
},
"id": {
"type": "string",
"description": "[Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field."
},
"kind": {
"type": "string",
"description": "[Output-only] The resource type.",
"default": "bigquery#dataset"
},
"labels": {
"type": "object",
"description": "[Experimental] The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Labeling Datasets for more information.",
"additionalProperties": {
"type": "string"
}
},
"lastModifiedTime": {
"type": "string",
"description": "[Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.",
"format": "int64"
},
"location": {
"type": "string",
"description": "[Experimental] The geographic location where the dataset should reside. Possible values include EU and US. The default value is US."
},
"selfLink": {
"type": "string",
"description": "[Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource."
}
}
},
"DatasetList": {
"id": "DatasetList",
"type": "object",
"properties": {
"datasets": {
"type": "array",
"description": "An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project.",
"items": {
"type": "object",
"properties": {
"datasetReference": {
"$ref": "DatasetReference",
"description": "The dataset reference. Use this property to access specific parts of the dataset's ID, such as project ID or dataset ID."
},
"friendlyName": {
"type": "string",
"description": "A descriptive name for the dataset, if one exists."
},
"id": {
"type": "string",
"description": "The fully-qualified, unique, opaque ID of the dataset."
},
"kind": {
"type": "string",
"description": "The resource type. This property always returns the value \"bigquery#dataset\".",
"default": "bigquery#dataset"
},
"labels": {
"type": "object",
"description": "[Experimental] The labels associated with this dataset. You can use these to organize and group your datasets.",
"additionalProperties": {
"type": "string"
}
}
}
}
},
"etag": {
"type": "string",
"description": "A hash value of the results page. You can use this property to determine if the page has changed since the last request."
},
"kind": {
"type": "string",
"description": "The list type. This property always returns the value \"bigquery#datasetList\".",
"default": "bigquery#datasetList"
},
"nextPageToken": {
"type": "string",
"description": "A token that can be used to request the next results page. This property is omitted on the final results page."
}
}
},
"DatasetReference": {
"id": "DatasetReference",
"type": "object",
"properties": {
"datasetId": {
"type": "string",
"description": "[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.",
"annotations": {
"required": [
"bigquery.datasets.update"
]
}
},
"projectId": {
"type": "string",
"description": "[Optional] The ID of the project containing this dataset.",
"annotations": {
"required": [
"bigquery.datasets.update"
]
}
}
}
},
"ErrorProto": {
"id": "ErrorProto",
"type": "object",
"properties": {
"debugInfo": {
"type": "string",
"description": "Debugging information. This property is internal to Google and should not be used."
},
"location": {
"type": "string",
"description": "Specifies where the error occurred, if present."
},
"message": {
"type": "string",
"description": "A human-readable description of the error."
},
"reason": {
"type": "string",
"description": "A short error code that summarizes the error."
}
}
},
"ExplainQueryStage": {
"id": "ExplainQueryStage",
"type": "object",
"properties": {
"computeRatioAvg": {
"type": "number",
"description": "Relative amount of time the average shard spent on CPU-bound tasks.",
"format": "double"
},
"computeRatioMax": {
"type": "number",
"description": "Relative amount of time the slowest shard spent on CPU-bound tasks.",
"format": "double"
},
"id": {
"type": "string",
"description": "Unique ID for stage within plan.",
"format": "int64"
},
"name": {
"type": "string",
"description": "Human-readable name for stage."
},
"readRatioAvg": {
"type": "number",
"description": "Relative amount of time the average shard spent reading input.",
"format": "double"
},
"readRatioMax": {
"type": "number",
"description": "Relative amount of time the slowest shard spent reading input.",
"format": "double"
},
"recordsRead": {
"type": "string",
"description": "Number of records read into the stage.",
"format": "int64"
},
"recordsWritten": {
"type": "string",
"description": "Number of records written by the stage.",
"format": "int64"
},
"steps": {
"type": "array",
"description": "List of operations within the stage in dependency order (approximately chronological).",
"items": {
"$ref": "ExplainQueryStep"
}
},
"waitRatioAvg": {
"type": "number",
"description": "Relative amount of time the average shard spent waiting to be scheduled.",
"format": "double"
},
"waitRatioMax": {
"type": "number",
"description": "Relative amount of time the slowest shard spent waiting to be scheduled.",
"format": "double"
},
"writeRatioAvg": {
"type": "number",
"description": "Relative amount of time the average shard spent on writing output.",
"format": "double"
},
"writeRatioMax": {
"type": "number",
"description": "Relative amount of time the slowest shard spent on writing output.",
"format": "double"
}
}
},
"ExplainQueryStep": {
"id": "ExplainQueryStep",
"type": "object",
"properties": {
"kind": {
"type": "string",
"description": "Machine-readable operation type."
},
"substeps": {
"type": "array",
"description": "Human-readable stage descriptions.",
"items": {
"type": "string"
}
}
}
},
"ExternalDataConfiguration": {
"id": "ExternalDataConfiguration",
"type": "object",
"properties": {
"autodetect": {
"type": "boolean",
"description": "[Experimental] Try to detect schema and format options automatically. Any option specified explicitly will be honored."
},
"bigtableOptions": {
"$ref": "BigtableOptions",
"description": "[Optional] Additional options if sourceFormat is set to BIGTABLE."
},
"compression": {
"type": "string",
"description": "[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."
},
"csvOptions": {
"$ref": "CsvOptions",
"description": "Additional properties to set if sourceFormat is set to CSV."
},
"googleSheetsOptions": {
"$ref": "GoogleSheetsOptions",
"description": "[Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS."
},
"ignoreUnknownValues": {
"type": "boolean",
"description": "[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."
},
"maxBadRecords": {
"type": "integer",
"description": "[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. 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.",
"format": "int32"
},
"schema": {
"$ref": "TableSchema",
"description": "[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."
},
"sourceFormat": {
"type": "string",
"description": "[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\". [Experimental] For Google Cloud Bigtable, specify \"BIGTABLE\". Please note that reading from Google Cloud Bigtable is experimental and has to be enabled for your project. Please contact Google Cloud Support to enable this for your project."
},
"sourceUris": {
"type": "array",
"description": "[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, and it must end with '.backup_info'. Also, the '*' wildcard character is not allowed.",
"items": {
"type": "string"
}
}
}
},
"GetQueryResultsResponse": {
"id": "GetQueryResultsResponse",
"type": "object",
"properties": {
"cacheHit": {
"type": "boolean",
"description": "Whether the query result was fetched from the query cache."
},
"errors": {
"type": "array",
"description": "[Output-only] All errors and warnings encountered during the running of the job. Errors here do not necessarily mean that the job has completed or was unsuccessful.",
"items": {
"$ref": "ErrorProto"
}
},
"etag": {
"type": "string",
"description": "A hash of this response."
},
"jobComplete": {
"type": "boolean",
"description": "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."
},
"jobReference": {
"$ref": "JobReference",
"description": "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)."
},
"kind": {
"type": "string",
"description": "The resource type of the response.",
"default": "bigquery#getQueryResultsResponse"
},
"numDmlAffectedRows": {
"type": "string",
"description": "[Output-only, Experimental] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.",
"format": "int64"
},
"pageToken": {
"type": "string",
"description": "A token used for paging results."
},
"rows": {
"type": "array",
"description": "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.",
"items": {
"$ref": "TableRow"
}
},
"schema": {
"$ref": "TableSchema",
"description": "The schema of the results. Present only when the query completes successfully."
},
"totalBytesProcessed": {
"type": "string",
"description": "The total number of bytes processed for this query.",
"format": "int64"
},
"totalRows": {
"type": "string",
"description": "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.",
"format": "uint64"
}
}
},
"GoogleSheetsOptions": {
"id": "GoogleSheetsOptions",
"type": "object",
"properties": {
"skipLeadingRows": {
"type": "string",
"description": "[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 \u003e 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.",
"format": "int64"
}
}
},
"Job": {
"id": "Job",
"type": "object",
"properties": {
"configuration": {
"$ref": "JobConfiguration",
"description": "[Required] Describes the job configuration."
},
"etag": {
"type": "string",
"description": "[Output-only] A hash of this resource."
},
"id": {
"type": "string",
"description": "[Output-only] Opaque ID field of the job"
},
"jobReference": {
"$ref": "JobReference",
"description": "[Optional] Reference describing the unique-per-user name of the job."
},
"kind": {
"type": "string",
"description": "[Output-only] The type of the resource.",
"default": "bigquery#job"
},
"selfLink": {
"type": "string",
"description": "[Output-only] A URL that can be used to access this resource again."
},
"statistics": {
"$ref": "JobStatistics",
"description": "[Output-only] Information about the job, including starting time and ending time of the job."
},
"status": {
"$ref": "JobStatus",
"description": "[Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete."
},
"user_email": {
"type": "string",
"description": "[Output-only] Email address of the user who ran the job."
}
}
},
"JobCancelResponse": {
"id": "JobCancelResponse",
"type": "object",
"properties": {
"job": {
"$ref": "Job",
"description": "The final state of the job."
},
"kind": {
"type": "string",
"description": "The resource type of the response.",
"default": "bigquery#jobCancelResponse"
}
}
},
"JobConfiguration": {
"id": "JobConfiguration",
"type": "object",
"properties": {
"copy": {
"$ref": "JobConfigurationTableCopy",
"description": "[Pick one] Copies a table."
},
"dryRun": {
"type": "boolean",
"description": "[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."
},
"extract": {
"$ref": "JobConfigurationExtract",
"description": "[Pick one] Configures an extract job."
},
"labels": {
"type": "object",
"description": "[Experimental] 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 letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and must be unique within a dataset. Both keys and values are additionally constrained to be \u003c= 128 bytes in size.",
"additionalProperties": {
"type": "string"
}
},
"load": {
"$ref": "JobConfigurationLoad",
"description": "[Pick one] Configures a load job."
},
"query": {
"$ref": "JobConfigurationQuery",
"description": "[Pick one] Configures a query job."
}
}
},
"JobConfigurationExtract": {
"id": "JobConfigurationExtract",
"type": "object",
"properties": {
"compression": {
"type": "string",
"description": "[Optional] The compression type to use for exported files. Possible values include GZIP and NONE. The default value is NONE."
},
"destinationFormat": {
"type": "string",
"description": "[Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV."
},
"destinationUri": {
"type": "string",
"description": "[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."
},
"destinationUris": {
"type": "array",
"description": "[Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.",
"items": {
"type": "string"
}
},
"fieldDelimiter": {
"type": "string",
"description": "[Optional] Delimiter to use between fields in the exported data. Default is ','"
},
"printHeader": {
"type": "boolean",
"description": "[Optional] Whether to print out a header row in the results. Default is true.",
"default": "true"
},
"sourceTable": {
"$ref": "TableReference",
"description": "[Required] A reference to the table being exported."
}
}
},
"JobConfigurationLoad": {
"id": "JobConfigurationLoad",
"type": "object",
"properties": {
"allowJaggedRows": {
"type": "boolean",
"description": "[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."
},
"allowQuotedNewlines": {
"type": "boolean",
"description": "Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false."
},
"autodetect": {
"type": "boolean",
"description": "[Experimental] Indicates if we should automatically infer the options and schema for CSV and JSON sources."
},
"createDisposition": {
"type": "string",
"description": "[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."
},
"destinationTable": {
"$ref": "TableReference",
"description": "[Required] The destination table to load the data into."
},
"encoding": {
"type": "string",
"description": "[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."
},
"fieldDelimiter": {
"type": "string",
"description": "[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 (',')."
},
"ignoreUnknownValues": {
"type": "boolean",
"description": "[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"
},
"maxBadRecords": {
"type": "integer",
"description": "[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. The default value is 0, which requires that all records are valid.",
"format": "int32"
},
"nullMarker": {
"type": "string",
"description": "[Optional] This string will be interpreted as a null value when it appears in a CSV file. The default value is the empty string. Please refer to the documentation for further information."
},
"projectionFields": {
"type": "array",
"description": "[Experimental] 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.",
"items": {
"type": "string"
}
},
"quote": {
"type": "string",
"description": "[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.",
"default": "\"",
"pattern": ".?"
},
"schema": {
"$ref": "TableSchema",
"description": "[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."
},
"schemaInline": {
"type": "string",
"description": "[Deprecated] The inline schema. For CSV schemas, specify as \"Field1:Type1[,Field2:Type2]*\". For example, \"foo:STRING, bar:INTEGER, baz:FLOAT\"."
},
"schemaInlineFormat": {
"type": "string",
"description": "[Deprecated] The format of the schemaInline property."
},
"schemaUpdateOptions": {
"type": "array",
"description": "[Experimental] Allows the schema of the desitination table to be updated as a side effect of the load 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.",
"items": {
"type": "string"
}
},
"skipLeadingRows": {
"type": "integer",
"description": "[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.",
"format": "int32"
},
"sourceFormat": {
"type": "string",
"description": "[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\". The default value is CSV."
},
"sourceUris": {
"type": "array",
"description": "[Required] The fully-qualified URIs that point to your data in Google Cloud Storage. Each URI can contain one '*' wildcard character and it must come after the 'bucket' name.",
"items": {
"type": "string"
}
},
"writeDisposition": {
"type": "string",
"description": "[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."
}
}
},
"JobConfigurationQuery": {
"id": "JobConfigurationQuery",
"type": "object",
"properties": {
"allowLargeResults": {
"type": "boolean",
"description": "If true, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set."
},
"createDisposition": {
"type": "string",
"description": "[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."
},
"defaultDataset": {
"$ref": "DatasetReference",
"description": "[Optional] Specifies the default dataset to use for unqualified table names in the query."
},
"destinationTable": {
"$ref": "TableReference",
"description": "[Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results."
},
"flattenResults": {
"type": "boolean",
"description": "[Optional] Flattens all nested and repeated fields in the query results. The default value is true. allowLargeResults must be true if this is set to false.",
"default": "true"
},
"maximumBillingTier": {
"type": "integer",
"description": "[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.",
"default": "1",
"format": "int32"
},
"maximumBytesBilled": {
"type": "string",
"description": "[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.",
"format": "int64"
},
"parameterMode": {
"type": "string",
"description": "[Experimental] Standard SQL only. Whether to use positional (?) or named (@myparam) query parameters in this query."
},
"preserveNulls": {
"type": "boolean",
"description": "[Deprecated] This property is deprecated."
},
"priority": {
"type": "string",
"description": "[Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE."
},
"query": {
"type": "string",
"description": "[Required] BigQuery SQL query to execute."
},
"queryParameters": {
"type": "array",
"description": "Query parameters for standard SQL queries.",
"items": {
"$ref": "QueryParameter"
}
},
"schemaUpdateOptions": {
"type": "array",
"description": "[Experimental] 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.",
"items": {
"type": "string"
}
},
"tableDefinitions": {
"type": "object",
"description": "[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.",
"additionalProperties": {
"$ref": "ExternalDataConfiguration"
}
},
"useLegacySql": {
"type": "boolean",
"description": "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 values of allowLargeResults and flattenResults are ignored; query will be run as if allowLargeResults is true and flattenResults is false."
},
"useQueryCache": {
"type": "boolean",
"description": "[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.",
"default": "true"
},
"userDefinedFunctionResources": {
"type": "array",
"description": "[Experimental] Describes user-defined function resources used in the query.",
"items": {
"$ref": "UserDefinedFunctionResource"
}
},
"writeDisposition": {
"type": "string",
"description": "[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."
}
}
},
"JobConfigurationTableCopy": {
"id": "JobConfigurationTableCopy",
"type": "object",
"properties": {
"createDisposition": {
"type": "string",
"description": "[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."
},
"destinationTable": {
"$ref": "TableReference",
"description": "[Required] The destination table"
},
"sourceTable": {
"$ref": "TableReference",
"description": "[Pick one] Source table to copy."
},
"sourceTables": {
"type": "array",
"description": "[Pick one] Source tables to copy.",
"items": {
"$ref": "TableReference"
}
},
"writeDisposition": {
"type": "string",
"description": "[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."
}
}
},
"JobList": {
"id": "JobList",
"type": "object",
"properties": {
"etag": {
"type": "string",
"description": "A hash of this page of results."
},
"jobs": {
"type": "array",
"description": "List of jobs that were requested.",
"items": {
"type": "object",
"properties": {
"configuration": {
"$ref": "JobConfiguration",
"description": "[Full-projection-only] Specifies the job configuration."
},
"errorResult": {
"$ref": "ErrorProto",
"description": "A result object that will be present only if the job has failed."
},
"id": {
"type": "string",
"description": "Unique opaque ID of the job."
},
"jobReference": {
"$ref": "JobReference",
"description": "Job reference uniquely identifying the job."
},
"kind": {
"type": "string",