/
v2.ts
5478 lines (5305 loc) · 197 KB
/
v2.ts
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
/**
* Copyright 2015 Google Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import {AxiosPromise} from 'axios';
import {Compute, JWT, OAuth2Client, UserRefreshClient} from 'google-auth-library';
import {BodyResponseCallback, createAPIRequest, GlobalOptions, GoogleConfigurable, MethodOptions} from '../../shared/src';
// tslint:disable: no-any
// tslint:disable: class-name
// tslint:disable: variable-name
// tslint:disable: jsdoc-format
// tslint:disable: no-namespace
export namespace bigquery_v2 {
export interface Options extends GlobalOptions {
version: 'v2';
}
/**
* BigQuery API
*
* A data platform for customers to create, manage, share and query data.
*
* @example
* const {google} = require('googleapis');
* const bigquery = google.bigquery('v2');
*
* @namespace bigquery
* @type {Function}
* @version v2
* @variation v2
* @param {object=} options Options for Bigquery
*/
export class Bigquery {
_options: GlobalOptions;
google?: GoogleConfigurable;
root = this;
datasets: Resource$Datasets;
jobs: Resource$Jobs;
projects: Resource$Projects;
tabledata: Resource$Tabledata;
tables: Resource$Tables;
constructor(options: GlobalOptions, google?: GoogleConfigurable) {
this._options = options || {};
this.google = google;
this.getRoot.bind(this);
this.datasets = new Resource$Datasets(this);
this.jobs = new Resource$Jobs(this);
this.projects = new Resource$Projects(this);
this.tabledata = new Resource$Tabledata(this);
this.tables = new Resource$Tables(this);
}
getRoot() {
return this.root;
}
}
export interface Schema$BigtableColumn {
/**
* [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.
*/
encoding?: 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.
*/
fieldName?: string;
/**
* [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.
*/
onlyReadLatest?: boolean;
/**
* [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.
*/
qualifierEncoded?: string;
qualifierString?: 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.
*/
type?: string;
}
export interface Schema$BigtableColumnFamily {
/**
* [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.
*/
columns?: Schema$BigtableColumn[];
/**
* [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.
*/
encoding?: string;
/**
* Identifier of the column family.
*/
familyId?: string;
/**
* [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.
*/
onlyReadLatest?: boolean;
/**
* [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.
*/
type?: string;
}
export interface Schema$BigtableOptions {
/**
* [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.
*/
columnFamilies?: Schema$BigtableColumnFamily[];
/**
* [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.
*/
ignoreUnspecifiedColumnFamilies?: boolean;
/**
* [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.
*/
readRowkeyAsString?: boolean;
}
export interface Schema$Clustering {
/**
* [Repeated] One or more fields on which data should be clustered. Only
* top-level, non-repeated, simple-type fields are supported. The order of
* the fields will determine how clusters will be generated, so it is
* important.
*/
fields?: string[];
}
export interface Schema$CsvOptions {
/**
* [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.
*/
allowJaggedRows?: boolean;
/**
* [Optional] Indicates if BigQuery should allow quoted data sections that
* contain newline characters in a CSV file. The default value is false.
*/
allowQuotedNewlines?: boolean;
/**
* [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.
*/
encoding?: 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 (',').
*/
fieldDelimiter?: string;
/**
* [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.
*/
quote?: 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.
*/
skipLeadingRows?: string;
}
export interface Schema$Dataset {
/**
* [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;
*/
access?: any[];
/**
* [Output-only] The time when this dataset was created, in milliseconds
* since the epoch.
*/
creationTime?: string;
/**
* [Required] A reference that identifies the dataset.
*/
datasetReference?: Schema$DatasetReference;
/**
* [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.
*/
defaultTableExpirationMs?: string;
/**
* [Optional] A user-friendly description of the dataset.
*/
description?: string;
/**
* [Output-only] A hash of the resource.
*/
etag?: string;
/**
* [Optional] A descriptive name for the dataset.
*/
friendlyName?: string;
/**
* [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.
*/
id?: string;
/**
* [Output-only] The resource type.
*/
kind?: string;
/**
* 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.
*/
labels?: any;
/**
* [Output-only] The date when this dataset or any of its tables was last
* modified, in milliseconds since the epoch.
*/
lastModifiedTime?: string;
/**
* The geographic location where the dataset should reside. The default
* value is US. See details at
* https://cloud.google.com/bigquery/docs/dataset-locations.
*/
location?: string;
/**
* [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.
*/
selfLink?: string;
}
export interface Schema$DatasetList {
/**
* 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.
*/
datasets?: any[];
/**
* A hash value of the results page. You can use this property to determine
* if the page has changed since the last request.
*/
etag?: string;
/**
* The list type. This property always returns the value
* "bigquery#datasetList".
*/
kind?: string;
/**
* A token that can be used to request the next results page. This property
* is omitted on the final results page.
*/
nextPageToken?: string;
}
export interface Schema$DatasetReference {
/**
* [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.
*/
datasetId?: string;
/**
* [Optional] The ID of the project containing this dataset.
*/
projectId?: string;
}
export interface Schema$DestinationTableProperties {
/**
* [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.
*/
description?: 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.
*/
friendlyName?: string;
}
export interface Schema$EncryptionConfiguration {
/**
* [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.
*/
kmsKeyName?: string;
}
export interface Schema$ErrorProto {
/**
* Debugging information. This property is internal to Google and should not
* be used.
*/
debugInfo?: string;
/**
* Specifies where the error occurred, if present.
*/
location?: string;
/**
* A human-readable description of the error.
*/
message?: string;
/**
* A short error code that summarizes the error.
*/
reason?: string;
}
export interface Schema$ExplainQueryStage {
/**
* Number of parallel input segments completed.
*/
completedParallelInputs?: string;
/**
* Milliseconds the average shard spent on CPU-bound tasks.
*/
computeMsAvg?: string;
/**
* Milliseconds the slowest shard spent on CPU-bound tasks.
*/
computeMsMax?: string;
/**
* Relative amount of time the average shard spent on CPU-bound tasks.
*/
computeRatioAvg?: number;
/**
* Relative amount of time the slowest shard spent on CPU-bound tasks.
*/
computeRatioMax?: number;
/**
* Stage end time represented as milliseconds since epoch.
*/
endMs?: string;
/**
* Unique ID for stage within plan.
*/
id?: string;
/**
* IDs for stages that are inputs to this stage.
*/
inputStages?: string[];
/**
* Human-readable name for stage.
*/
name?: string;
/**
* Number of parallel input segments to be processed.
*/
parallelInputs?: string;
/**
* Milliseconds the average shard spent reading input.
*/
readMsAvg?: string;
/**
* Milliseconds the slowest shard spent reading input.
*/
readMsMax?: string;
/**
* Relative amount of time the average shard spent reading input.
*/
readRatioAvg?: number;
/**
* Relative amount of time the slowest shard spent reading input.
*/
readRatioMax?: number;
/**
* Number of records read into the stage.
*/
recordsRead?: string;
/**
* Number of records written by the stage.
*/
recordsWritten?: string;
/**
* Total number of bytes written to shuffle.
*/
shuffleOutputBytes?: string;
/**
* Total number of bytes written to shuffle and spilled to disk.
*/
shuffleOutputBytesSpilled?: string;
/**
* Stage start time represented as milliseconds since epoch.
*/
startMs?: string;
/**
* Current status for the stage.
*/
status?: string;
/**
* List of operations within the stage in dependency order (approximately
* chronological).
*/
steps?: Schema$ExplainQueryStep[];
/**
* Milliseconds the average shard spent waiting to be scheduled.
*/
waitMsAvg?: string;
/**
* Milliseconds the slowest shard spent waiting to be scheduled.
*/
waitMsMax?: string;
/**
* Relative amount of time the average shard spent waiting to be scheduled.
*/
waitRatioAvg?: number;
/**
* Relative amount of time the slowest shard spent waiting to be scheduled.
*/
waitRatioMax?: number;
/**
* Milliseconds the average shard spent on writing output.
*/
writeMsAvg?: string;
/**
* Milliseconds the slowest shard spent on writing output.
*/
writeMsMax?: string;
/**
* Relative amount of time the average shard spent on writing output.
*/
writeRatioAvg?: number;
/**
* Relative amount of time the slowest shard spent on writing output.
*/
writeRatioMax?: number;
}
export interface Schema$ExplainQueryStep {
/**
* Machine-readable operation type.
*/
kind?: string;
/**
* Human-readable stage descriptions.
*/
substeps?: string[];
}
export interface Schema$ExternalDataConfiguration {
/**
* Try to detect schema and format options automatically. Any option
* specified explicitly will be honored.
*/
autodetect?: boolean;
/**
* [Optional] Additional options if sourceFormat is set to BIGTABLE.
*/
bigtableOptions?: Schema$BigtableOptions;
/**
* [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.
*/
compression?: string;
/**
* Additional properties to set if sourceFormat is set to CSV.
*/
csvOptions?: Schema$CsvOptions;
/**
* [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS.
*/
googleSheetsOptions?: Schema$GoogleSheetsOptions;
/**
* [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.
*/
ignoreUnknownValues?: boolean;
/**
* [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.
*/
maxBadRecords?: number;
/**
* [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.
*/
schema?: Schema$TableSchema;
/**
* [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".
*/
sourceFormat?: string;
/**
* [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.
*/
sourceUris?: string[];
}
export interface Schema$GetQueryResultsResponse {
/**
* Whether the query result was fetched from the query cache.
*/
cacheHit?: boolean;
/**
* [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.
*/
errors?: Schema$ErrorProto[];
/**
* A hash of this response.
*/
etag?: string;
/**
* 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.
*/
jobComplete?: boolean;
/**
* 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).
*/
jobReference?: Schema$JobReference;
/**
* The resource type of the response.
*/
kind?: string;
/**
* [Output-only] The number of rows affected by a DML statement. Present
* only for DML statements INSERT, UPDATE or DELETE.
*/
numDmlAffectedRows?: string;
/**
* A token used for paging results.
*/
pageToken?: string;
/**
* 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.
*/
rows?: Schema$TableRow[];
/**
* The schema of the results. Present only when the query completes
* successfully.
*/
schema?: Schema$TableSchema;
/**
* The total number of bytes processed for this query.
*/
totalBytesProcessed?: 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.
*/
totalRows?: string;
}
export interface Schema$GetServiceAccountResponse {
/**
* The service account email address.
*/
email?: string;
/**
* The resource type of the response.
*/
kind?: string;
}
export interface Schema$GoogleSheetsOptions {
/**
* [Experimental] [Optional] Range of a sheet to query from. Only used when
* non-empty. Typical format: !:
*/
range?: 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.
*/
skipLeadingRows?: string;
}
export interface Schema$Job {
/**
* [Required] Describes the job configuration.
*/
configuration?: Schema$JobConfiguration;
/**
* [Output-only] A hash of this resource.
*/
etag?: string;
/**
* [Output-only] Opaque ID field of the job
*/
id?: string;
/**
* [Optional] Reference describing the unique-per-user name of the job.
*/
jobReference?: Schema$JobReference;
/**
* [Output-only] The type of the resource.
*/
kind?: string;
/**
* [Output-only] A URL that can be used to access this resource again.
*/
selfLink?: string;
/**
* [Output-only] Information about the job, including starting time and
* ending time of the job.
*/
statistics?: Schema$JobStatistics;
/**
* [Output-only] The status of this job. Examine this value when polling an
* asynchronous job to see if the job is complete.
*/
status?: Schema$JobStatus;
/**
* [Output-only] Email address of the user who ran the job.
*/
user_email?: string;
}
export interface Schema$JobCancelResponse {
/**
* The final state of the job.
*/
job?: Schema$Job;
/**
* The resource type of the response.
*/
kind?: string;
}
export interface Schema$JobConfiguration {
/**
* [Pick one] Copies a table.
*/
copy?: Schema$JobConfigurationTableCopy;
/**
* [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.
*/
dryRun?: boolean;
/**
* [Pick one] Configures an extract job.
*/
extract?: Schema$JobConfigurationExtract;
/**
* [Optional] Job timeout in milliseconds. If this time limit is exceeded,
* BigQuery may attempt to terminate the job.
*/
jobTimeoutMs?: string;
/**
* 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.
*/
labels?: any;
/**
* [Pick one] Configures a load job.
*/
load?: Schema$JobConfigurationLoad;
/**
* [Pick one] Configures a query job.
*/
query?: Schema$JobConfigurationQuery;
}
export interface Schema$JobConfigurationExtract {
/**
* [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.
*/
compression?: string;
/**
* [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.
*/
destinationFormat?: 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.
*/
destinationUri?: string;
/**
* [Pick one] A list of fully-qualified Google Cloud Storage URIs where the
* extracted table should be written.
*/
destinationUris?: string[];
/**
* [Optional] Delimiter to use between fields in the exported data. Default
* is ','
*/
fieldDelimiter?: string;
/**
* [Optional] Whether to print out a header row in the results. Default is
* true.
*/
printHeader?: boolean;
/**
* [Required] A reference to the table being exported.
*/
sourceTable?: Schema$TableReference;
}
export interface Schema$JobConfigurationLoad {
/**
* [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.
*/
allowJaggedRows?: boolean;
/**
* Indicates if BigQuery should allow quoted data sections that contain
* newline characters in a CSV file. The default value is false.
*/
allowQuotedNewlines?: boolean;
/**
* [Optional] Indicates if we should automatically infer the options and
* schema for CSV and JSON sources.
*/
autodetect?: boolean;
/**
* [Experimental] Clustering specification for the destination table. Must
* be specified with time-based partitioning, data in the table will be
* first partitioned and subsequently clustered.
*/
clustering?: Schema$Clustering;
/**
* [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.
*/
createDisposition?: string;
/**
* Custom encryption configuration (e.g., Cloud KMS keys).
*/
destinationEncryptionConfiguration?: Schema$EncryptionConfiguration;
/**
* [Required] The destination table to load the data into.
*/
destinationTable?: Schema$TableReference;
/**
* [Experimental] [Optional] Properties with which to create the destination
* table if it is new.
*/
destinationTableProperties?: Schema$DestinationTableProperties;
/**
* [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.
*/
encoding?: 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 (',').
*/
fieldDelimiter?: string;
/**
* [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
*/
ignoreUnknownValues?: boolean;
/**
* [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.
*/
maxBadRecords?: number;
/**
* [Optional] Specifies a string that represents a null value in a CSV file.
* For example, if you specify "x/", BigQuery interprets
* "x/" 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.
*/
nullMarker?: string;
/**
* 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.
*/
projectionFields?: string[];
/**
* [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.
*/
quote?: string;
/**
* [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.
*/
schema?: Schema$TableSchema;
/**
* [Deprecated] The inline schema. For CSV schemas, specify as
* "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING,
* bar:INTEGER, baz:FLOAT".
*/
schemaInline?: string;
/**
* [Deprecated] The format of the schemaInline property.
*/
schemaInlineFormat?: string;
/**
* 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.
*/
schemaUpdateOptions?: string[];
/**
* [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.
*/
skipLeadingRows?: number;
/**
* [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.
*/
sourceFormat?: string;
/**
* [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.
*/
sourceUris?: string[];
/**
* Time-based partitioning specification for the destination table.
*/
timePartitioning?: Schema$TimePartitioning;
/**
* [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