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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
|
// Copyright 2022 Google LLC
//
// 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.
syntax = "proto3";
package google.cloud.audit;
import "google/iam/v1/policy.proto";
import "google/protobuf/duration.proto";
import "google/protobuf/timestamp.proto";
import "google/rpc/status.proto";
option csharp_namespace = "Google.Cloud.Audit";
option go_package = "google.golang.org/genproto/googleapis/cloud/audit;audit";
option java_multiple_files = true;
option java_outer_classname = "BigQueryAuditMetadataProto";
option java_package = "com.google.cloud.audit";
option objc_class_prefix = "GCA";
option php_namespace = "Google\\Cloud\\Audit";
// Audit log format for BigQuery cloud audit logs metadata.
//
message BigQueryAuditMetadata {
// Job insertion event.
message JobInsertion {
// Describes how the job was inserted.
enum Reason {
// Unknown.
REASON_UNSPECIFIED = 0;
// Job was inserted using the jobs.insert API.
JOB_INSERT_REQUEST = 1;
// Job was inserted using the jobs.query RPC.
QUERY_REQUEST = 2;
}
// Job metadata.
Job job = 1;
// Describes how the job was inserted.
Reason reason = 2;
}
// Job state change event.
message JobChange {
// Job state before the job state change.
JobState before = 1;
// Job state after the job state change.
JobState after = 2;
// Job metadata.
Job job = 3;
}
// Job deletion event.
message JobDeletion {
// Describes how the job was deleted.
enum Reason {
// Unknown.
REASON_UNSPECIFIED = 0;
// Job was deleted using the jobs.delete API.
JOB_DELETE_REQUEST = 1;
}
// Job URI.
//
// Format: `projects/<project_id>/jobs/<job_id>`.
string job_name = 1;
// Describes how the job was deleted.
Reason reason = 2;
}
// Dataset creation event.
message DatasetCreation {
// Describes how the dataset was created.
enum Reason {
// Unknown.
REASON_UNSPECIFIED = 0;
// Dataset was created using the datasets.create API.
CREATE = 1;
// Dataset was created using a query job, e.g., CREATE SCHEMA statement.
QUERY = 2;
}
// Dataset metadata.
Dataset dataset = 1;
// Describes how the dataset was created.
Reason reason = 2;
// The URI of the job that created the dataset.
// Present if the reason is QUERY.
//
// Format: `projects/<project_id>/jobs/<job_id>`.
string job_name = 3;
}
// Dataset change event.
message DatasetChange {
// Describes how the dataset was changed.
enum Reason {
// Unknown.
REASON_UNSPECIFIED = 0;
// Dataset was changed using the datasets.update or datasets.patch API.
UPDATE = 1;
// Dataset was changed using the SetIamPolicy API.
SET_IAM_POLICY = 2;
// Dataset was changed using a query job, e.g., ALTER SCHEMA statement.
QUERY = 3;
}
// Dataset metadata after the change.
Dataset dataset = 1;
// Describes how the dataset was changed.
Reason reason = 2;
// The URI of the job that updated the dataset.
// Present if the reason is QUERY.
//
// Format: `projects/<project_id>/jobs/<job_id>`.
string job_name = 3;
}
// Dataset deletion event.
message DatasetDeletion {
// Describes how the dataset was deleted.
enum Reason {
// Unknown.
REASON_UNSPECIFIED = 0;
// Dataset was deleted using the datasets.delete API.
DELETE = 1;
// Dataset was deleted using a query job, e.g., DROP SCHEMA statement.
QUERY = 2;
}
// Describes how the dataset was deleted.
Reason reason = 1;
// The URI of the job that deleted the dataset.
// Present if the reason is QUERY.
//
// Format: `projects/<project_id>/jobs/<job_id>`.
string job_name = 2;
}
// Table creation event.
message TableCreation {
// Describes how the table was created.
enum Reason {
// Unknown.
REASON_UNSPECIFIED = 0;
// Table was created as a destination table during a query, load or copy
// job.
JOB = 1;
// Table was created using a DDL query.
QUERY = 2;
// Table was created using the tables.create API.
TABLE_INSERT_REQUEST = 3;
}
// Table metadata.
Table table = 1;
// Describes how the table was created.
Reason reason = 3;
// The URI of the job that created a table.
// Present if the reason is JOB or QUERY.
//
// Format: `projects/<project_id>/jobs/<job_id>`.
string job_name = 4;
}
// Model creation event.
message ModelCreation {
// Describes how the model was created.
enum Reason {
// Unknown.
REASON_UNSPECIFIED = 0;
// Model was created using a DDL query.
QUERY = 2;
}
// Model metadata.
Model model = 1;
// Describes how the model was created.
Reason reason = 3;
// The URI of the job that created the model.
//
// Format: `projects/<project_id>/jobs/<job_id>`.
string job_name = 4;
}
// Routine creation event.
message RoutineCreation {
// Describes how the routine was created.
enum Reason {
// Unknown.
REASON_UNSPECIFIED = 0;
// Routine was created using a DDL query.
QUERY = 1;
// Routine was created using the routines.create API.
ROUTINE_INSERT_REQUEST = 2;
}
// Created routine.
Routine routine = 1;
// Describes how the routine was created.
Reason reason = 3;
// The URI of the job that created the routine.
//
// Format: `projects/<project_id>/jobs/<job_id>`.
string job_name = 4;
}
// Table data read event.
message TableDataRead {
// Describes how the table data was read.
enum Reason {
// Unknown.
REASON_UNSPECIFIED = 0;
// Table was used as a source table during a BigQuery job.
JOB = 1;
// Table data was accessed using the tabledata.list API.
TABLEDATA_LIST_REQUEST = 2;
// Table data was accessed using the jobs.getQueryResults API.
GET_QUERY_RESULTS_REQUEST = 3;
// Table data was accessed using the jobs.query RPC.
QUERY_REQUEST = 4;
// Table data was accessed using storage.CreateReadSession API.
CREATE_READ_SESSION = 5;
// Table data was accessed during a materialized view refresh.
MATERIALIZED_VIEW_REFRESH = 6;
}
// List of the accessed fields. Entire list is truncated if the record size
// exceeds 100K.
repeated string fields = 2;
// True if the fields list was truncated.
bool fields_truncated = 8;
// List of the referenced policy tags. That is, policy tags attached to the
// accessed fields or their ancestors.
// Policy tag resource name is a string of the format:
// `projects/<project_id>/locations/<location_id>/taxonomies/<taxonomy_id>/policyTags/<policy_tag_id>`
repeated string policy_tags = 9;
// True if the policy tag list was truncated. At most 100 policy tags can be
// saved.
bool policy_tags_truncated = 10;
// Describes how the table data was read.
Reason reason = 3;
// The URI of the job that read a table.
// Present if the reason is JOB but can be redacted for privacy reasons.
//
// Format: `projects/<project_id>/jobs/<job_id>`.
string job_name = 4;
// The URI of the read session that read a table.
// Present if the reason is CREATE_READ_SESSION.
//
// Format:
// `projects/<project_id>/locations/<location>/sessions/<session_id>`.
string session_name = 5;
}
// Table metadata change event.
message TableChange {
// Describes how the table metadata was changed.
enum Reason {
// Unknown.
REASON_UNSPECIFIED = 0;
// Table metadata was updated using the tables.update or tables.patch API.
TABLE_UPDATE_REQUEST = 1;
// Table was used as a job destination table.
JOB = 2;
// Table metadata was updated using a DML or DDL query.
QUERY = 3;
}
// Updated table metadata.
Table table = 1;
// True if the table was truncated.
bool truncated = 4;
// Describes how the table metadata was changed.
Reason reason = 5;
// The URI of the job that changed a table.
// Present if the reason is JOB or QUERY.
//
// Format: `projects/<project_id>/jobs/<job_id>`.
string job_name = 6;
}
// Model metadata change event.
message ModelMetadataChange {
// Describes how the model metadata was changed.
enum Reason {
// Unknown.
REASON_UNSPECIFIED = 0;
// Model metadata was updated using the models.patch API.
MODEL_PATCH_REQUEST = 1;
// Model metadata was updated using a DDL query.
QUERY = 2;
}
// Updated model.
Model model = 1;
// Describes how the model metadata was changed.
Reason reason = 2;
// The URI of the job that changed the model metadata.
// Present if and only if the reason is QUERY.
//
// Format: `projects/<project_id>/jobs/<job_id>`.
string job_name = 3;
}
// Routine change event.
message RoutineChange {
// Describes how the routine was updated.
enum Reason {
// Unknown.
REASON_UNSPECIFIED = 0;
// Routine was updated using a DDL query.
QUERY = 1;
// Routine was updated using the routines.update or routines.patch API.
ROUTINE_UPDATE_REQUEST = 2;
}
// Updated routine.
Routine routine = 1;
// Describes how the routine was updated.
Reason reason = 3;
// The URI of the job that updated the routine.
//
// Format: `projects/<project_id>/jobs/<job_id>`.
string job_name = 4;
}
// Table data change event.
message TableDataChange {
// Describes how the table data was changed.
enum Reason {
// Unknown.
REASON_UNSPECIFIED = 0;
// Table was used as a job destination table.
JOB = 1;
// Table data was updated using a DML or DDL query.
QUERY = 2;
// Table data was updated during a materialized view refresh.
MATERIALIZED_VIEW_REFRESH = 3;
// Table data was added using the Write API.
WRITE_API = 4;
}
// Number of deleted rows.
int64 deleted_rows_count = 1;
// Number of inserted rows.
int64 inserted_rows_count = 2;
// True if the table was truncated.
bool truncated = 3;
// Describes how the table data was changed.
Reason reason = 4;
// The URI of the job that changed a table.
//
// Format: `projects/<project_id>/jobs/<job_id>`.
string job_name = 5;
// If written from WRITE_API, the name of the stream.
//
// Format:
// `projects/<project_id>/datasets/<dataset_id>/tables/<table_id>/streams/<stream_id>`
string stream_name = 6;
}
// Model data change event.
message ModelDataChange {
// Describes how the model data was changed.
enum Reason {
// Unknown.
REASON_UNSPECIFIED = 0;
// Model data was changed using a DDL query.
QUERY = 1;
}
// Describes how the model data was changed.
Reason reason = 1;
// The URI of the job that changed the model data.
//
// Format: `projects/<project_id>/jobs/<job_id>`.
string job_name = 2;
}
// Model data read event.
message ModelDataRead {
// Describes how the model data was read.
enum Reason {
// Unknown.
REASON_UNSPECIFIED = 0;
// Model was used as a source model during a BigQuery job.
JOB = 1;
}
// Describes how the model data was read.
Reason reason = 1;
// The URI of the job that read the model data.
//
// Format: `projects/<project_id>/jobs/<job_id>`.
string job_name = 2;
}
// Table deletion event.
message TableDeletion {
// Describes how the table was deleted.
enum Reason {
// Unknown.
REASON_UNSPECIFIED = 0;
// Table was deleted using the tables.delete API.
TABLE_DELETE_REQUEST = 2;
// Table expired.
EXPIRED = 3;
// Table deleted using a DDL query.
QUERY = 4;
}
// Describes how table was deleted.
Reason reason = 1;
// The URI of the job that deleted a table.
// Present if the reason is QUERY.
//
// Format: `projects/<project_id>/jobs/<job_id>`.
string job_name = 2;
}
// Model deletion event.
message ModelDeletion {
// Describes how the model was deleted.
enum Reason {
// Unknown.
REASON_UNSPECIFIED = 0;
// Model was deleted using the models.delete API.
MODEL_DELETE_REQUEST = 1;
// Model expired.
EXPIRED = 2;
// Model was deleted using DDL query.
QUERY = 3;
}
// Describes how the model was deleted.
Reason reason = 1;
// The URI of the job that deleted a model.
// Present if the reason is QUERY.
//
// Format: `projects/<project_id>/jobs/<job_id>`.
string job_name = 2;
}
// Routine deletion event.
message RoutineDeletion {
// Describes how the routine was deleted.
enum Reason {
// Unknown.
REASON_UNSPECIFIED = 0;
// Routine was deleted using DDL query.
QUERY = 1;
// Routine was deleted using the API.
ROUTINE_DELETE_REQUEST = 2;
}
// Deleted routine.
Routine routine = 1;
// Describes how the routine was deleted.
Reason reason = 3;
// The URI of the job that deleted the routine.
// Present if the reason is QUERY.
//
// Format: `projects/<project_id>/jobs/<job_id>`.
string job_name = 4;
}
// Row access policy creation event.
message RowAccessPolicyCreation {
// The row access policy created by this event.
RowAccessPolicy row_access_policy = 1;
// The URI of the job that created this row access policy.
//
// Format: `projects/<project_id>/jobs/<job_id>`.
string job_name = 2;
}
// Row access policy change event.
message RowAccessPolicyChange {
// The row access policy that was changed by this event.
RowAccessPolicy row_access_policy = 1;
// The URI of the job that created this row access policy.
//
// Format: `projects/<project_id>/jobs/<job_id>`.
string job_name = 2;
}
// Row access policy deletion event.
message RowAccessPolicyDeletion {
// The row access policies that were deleted. At present, only populated
// when a single policy is dropped.
repeated RowAccessPolicy row_access_policies = 1;
// The job that deleted these row access policies.
//
// Format: `projects/<project_id>/jobs/<job_id>`.
string job_name = 2;
// This field is set to true when a DROP ALL command has been executed, thus
// removing all row access policies on the table.
bool all_row_access_policies_dropped = 3;
}
// Unlink linked dataset from its source dataset event
message UnlinkDataset {
// Describes how the unlinking operation occurred.
enum Reason {
// Unknown.
REASON_UNSPECIFIED = 0;
// Linked dataset unlinked via API
UNLINK_API = 1;
}
// The linked dataset URI which is unlinked from its source.
//
// Format: `projects/<project_id>/datasets/<dataset_id>`.
string linked_dataset = 1;
// The source dataset URI from which the linked dataset is unlinked.
//
// Format: `projects/<project_id>/datasets/<dataset_id>`.
string source_dataset = 2;
// Reason for unlinking linked dataset
Reason reason = 3;
}
// BigQuery job.
message Job {
// Job URI.
//
// Format: `projects/<project_id>/jobs/<job_id>`.
string job_name = 1;
// Job configuration.
JobConfig job_config = 2;
// Job status.
JobStatus job_status = 3;
// Job statistics.
JobStats job_stats = 4;
}
// Job configuration.
// See the [Jobs](https://cloud.google.com/bigquery/docs/reference/v2/jobs)
// API resource for more details on individual fields.
message JobConfig {
// Job type.
enum Type {
// Unknown.
TYPE_UNSPECIFIED = 0;
// Query job.
QUERY = 1;
// Table copy job.
COPY = 2;
// Export (extract) job.
EXPORT = 3;
// Import (load) job.
IMPORT = 4;
}
// Query job configuration.
message Query {
// Priority given to the query.
enum Priority {
// Unknown.
PRIORITY_UNSPECIFIED = 0;
// Interactive query.
QUERY_INTERACTIVE = 1;
// Batch query.
QUERY_BATCH = 2;
}
// The SQL query to run. Truncated if exceeds 50K.
string query = 1;
// True if the query field was truncated.
bool query_truncated = 10;
// The destination table for the query results.
string destination_table = 2;
// Destination table create disposition.
CreateDisposition create_disposition = 3;
// Destination table write disposition.
WriteDisposition write_disposition = 4;
// Default dataset for the query.
string default_dataset = 5;
// External data sources used in the query.
repeated TableDefinition table_definitions = 6;
// Priority given to the query.
Priority priority = 7;
// Result table encryption information. Set when non-default encryption is
// used.
EncryptionInfo destination_table_encryption = 8;
// Type of the query.
QueryStatementType statement_type = 9;
}
// Load job configuration.
message Load {
// URIs for the data to be imported. Entire list is truncated if exceeds
// 40K.
repeated string source_uris = 1;
// True if the source_URIs field was truncated.
bool source_uris_truncated = 7;
// The table schema in JSON format. Entire field is truncated if exceeds
// 40K.
string schema_json = 2;
// True if the schema_json field was truncated.
bool schema_json_truncated = 8;
// The destination table for the import.
string destination_table = 3;
// Destination table create disposition.
CreateDisposition create_disposition = 4;
// Destination table write disposition.
WriteDisposition write_disposition = 5;
// Result table encryption information. Set when non-default encryption is
// used.
EncryptionInfo destination_table_encryption = 6;
}
// Extract job configuration.
message Extract {
// URIs where extracted data should be written. Entire list is truncated
// if exceeds 50K.
repeated string destination_uris = 1;
// True if the destination_URIs field was truncated.
bool destination_uris_truncated = 3;
oneof source {
// The source table.
string source_table = 2;
// The source model.
string source_model = 4;
}
}
// Table copy job configuration.
message TableCopy {
// Source tables. Entire list is truncated if exceeds 50K.
repeated string source_tables = 1;
// True if the source_tables field was truncated.
bool source_tables_truncated = 6;
// Destination table.
string destination_table = 2;
// Destination table create disposition.
CreateDisposition create_disposition = 3;
// Destination table write disposition.
WriteDisposition write_disposition = 4;
// Result table encryption information. Set when non-default encryption is
// used.
EncryptionInfo destination_table_encryption = 5;
// Supported operation types in the table copy job.
OperationType operation_type = 7;
// Expiration time set on the destination table. Expired tables will be
// deleted and their storage reclaimed.
google.protobuf.Timestamp destination_expiration_time = 8;
}
// Job type.
Type type = 1;
// Job configuration information.
oneof config {
// Query job information.
Query query_config = 2;
// Load job information.
Load load_config = 3;
// Extract job information.
Extract extract_config = 4;
// TableCopy job information.
TableCopy table_copy_config = 5;
}
// Labels provided for the job.
map<string, string> labels = 6;
}
// Definition of an external data source used in a query.
message TableDefinition {
// Name of the table, used in queries.
string name = 1;
// URIs for the data.
repeated string source_uris = 2;
}
// Describes whether a job should create a destination table if it doesn't
// exist.
enum CreateDisposition {
// Unknown.
CREATE_DISPOSITION_UNSPECIFIED = 0;
// This job should never create tables.
CREATE_NEVER = 1;
// This job should create a table if it doesn't already exist.
CREATE_IF_NEEDED = 2;
}
// Describes whether a job should overwrite or append the existing destination
// table if it already exists.
enum WriteDisposition {
// Unknown.
WRITE_DISPOSITION_UNSPECIFIED = 0;
// This job should only be writing to empty tables.
WRITE_EMPTY = 1;
// This job will truncate the existing table data.
WRITE_TRUNCATE = 2;
// This job will append to the table.
WRITE_APPEND = 3;
}
// Table copy job operation type.
enum OperationType {
// Unspecified operation type.
OPERATION_TYPE_UNSPECIFIED = 0;
// The source and the destination table have the same table type.
COPY = 1;
// The source table type is TABLE and
// the destination table type is SNAPSHOT.
SNAPSHOT = 2;
// The source table type is SNAPSHOT and
// the destination table type is TABLE.
RESTORE = 3;
}
// State of a job.
enum JobState {
// State unknown.
JOB_STATE_UNSPECIFIED = 0;
// Job is waiting for the resources.
PENDING = 1;
// Job is running.
RUNNING = 2;
// Job is done.
DONE = 3;
}
// Type of the statement (e.g. SELECT, INSERT, CREATE_TABLE, CREATE_MODEL..)
enum QueryStatementType {
// Unknown.
QUERY_STATEMENT_TYPE_UNSPECIFIED = 0;
// SELECT ... FROM <Table list> ...
SELECT = 1;
// ASSERT <condition> AS 'description'
ASSERT = 23;
// INSERT INTO <Table> ....
INSERT = 2;
// UPDATE <Table> SET ...
UPDATE = 3;
// DELETE <Table> ...
DELETE = 4;
// MERGE INTO <Table> ....
MERGE = 5;
// CREATE TABLE <Table> <column list>
CREATE_TABLE = 6;
// CREATE TABLE <Table> AS SELECT
CREATE_TABLE_AS_SELECT = 7;
// CREATE VIEW <View>
CREATE_VIEW = 8;
// CREATE MODEL <Model> AS <Query>
CREATE_MODEL = 9;
// CREATE MATERIALIZED VIEW <View> AS ...
CREATE_MATERIALIZED_VIEW = 13;
// CREATE FUNCTION <Function>(<Signature>) AS ...
CREATE_FUNCTION = 14;
// CREATE TABLE FUNCTION <Function>(<Signature>) AS ...
CREATE_TABLE_FUNCTION = 56;
// CREATE PROCEDURE <Procedure>
CREATE_PROCEDURE = 20;
// CREATE ROW ACCESS POLICY <RowAccessPolicy> ON <Table>
CREATE_ROW_ACCESS_POLICY = 24;
// CREATE SCHEMA <Schema>
CREATE_SCHEMA = 53;
// CREATE SNAPSHOT TABLE <Snapshot> CLONE <Table>
CREATE_SNAPSHOT_TABLE = 59;
// DROP TABLE <Table>
DROP_TABLE = 10;
// DROP EXTERNAL TABLE <Table>
DROP_EXTERNAL_TABLE = 33;
// DROP VIEW <View>
DROP_VIEW = 11;
// DROP MODEL <Model>
DROP_MODEL = 12;
// DROP MATERIALIZED VIEW <View>
DROP_MATERIALIZED_VIEW = 15;
// DROP FUNCTION <Function>
DROP_FUNCTION = 16;
// DROP PROCEDURE <Procedure>
DROP_PROCEDURE = 21;
// DROP SCHEMA <Schema>
DROP_SCHEMA = 54;
// DROP ROW ACCESS POLICY <RowAccessPolicy> ON <Table> <or> DROP
// ALL ROW ACCESS POLICIES ON ON <Table>
DROP_ROW_ACCESS_POLICY = 25;
// DROP SNAPSHOT TABLE <Snapshot>
DROP_SNAPSHOT_TABLE = 62;
// ALTER TABLE <Table>
ALTER_TABLE = 17;
// ALTER VIEW <View>
ALTER_VIEW = 18;
// ALTER MATERIALIZED_VIEW <view>
ALTER_MATERIALIZED_VIEW = 22;
// ALTER SCHEMA <Schema>
ALTER_SCHEMA = 55;
// Script
SCRIPT = 19;
// TRUNCATE TABLE <Table>
TRUNCATE_TABLE = 26;
// CREATE EXTERNAL TABLE <TABLE>
CREATE_EXTERNAL_TABLE = 27;
// EXPORT DATA;
EXPORT_DATA = 28;
// CALL <stored procedure>
CALL = 29;
}
// Status of a job.
message JobStatus {
// State of the job.
JobState job_state = 1;
// Job error, if the job failed.
google.rpc.Status error_result = 2;
// Errors encountered during the running of the job. Does not necessarily
// mean that the job has completed or was unsuccessful.
repeated google.rpc.Status errors = 3;
}
// Job statistics.
message JobStats {
// Query job statistics.
message Query {
// Total bytes processed by the query job.
int64 total_processed_bytes = 1;
// Total bytes billed by the query job.
int64 total_billed_bytes = 2;
// The tier assigned by the CPU-based billing.
int32 billing_tier = 3;
// Tables accessed by the query job.
repeated string referenced_tables = 6;
// Views accessed by the query job.
repeated string referenced_views = 7;
// Routines accessed by the query job.
repeated string referenced_routines = 10;
// Number of output rows produced by the query job.
int64 output_row_count = 8;
// True if the query job results were read from the query cache.
bool cache_hit = 9;
}
// Load job statistics.
message Load {
// Total bytes loaded by the import job.
int64 total_output_bytes = 1;
}
// Extract job statistics.
message Extract {
// Total bytes exported by the extract job.
int64 total_input_bytes = 1;
}
// Job resource usage breakdown by reservation.
message ReservationResourceUsage {
// Reservation name or "unreserved" for on-demand resources usage.
string name = 1;
// Total slot milliseconds used by the reservation for a particular job.
int64 slot_ms = 2;
}
// Job creation time.
google.protobuf.Timestamp create_time = 1;
// Job execution start time.
google.protobuf.Timestamp start_time = 2;
// Job completion time.
google.protobuf.Timestamp end_time = 3;
// Statistics specific to the job type.
oneof extended {
// Query job statistics.
Query query_stats = 8;
// Load job statistics.
Load load_stats = 9;
// Extract job statistics.
Extract extract_stats = 13;
}
// The total number of slot-ms consumed by the query job.
int64 total_slot_ms = 10;
// Reservation usage attributed from each tier of a reservation hierarchy.
repeated ReservationResourceUsage reservation_usage = 11;
// Parent job name. Only present for child jobs.
string parent_job_name = 12;
}
// BigQuery table.
message Table {
// Table URI.
//
// Format: `projects/<project_id>/datasets/<dataset_id>/tables/<table_id>`.
string table_name = 1;
// User-provided metadata for the table.
EntityInfo table_info = 10;
// A JSON representation of the table's schema. Entire field is truncated
// if exceeds 40K.
string schema_json = 3;
// True if the schema_json field was truncated.
bool schema_json_truncated = 11;
// View metadata. Only present for views.
TableViewDefinition view = 4;
// Table expiration time.
google.protobuf.Timestamp expire_time = 5;
// The table creation time.
google.protobuf.Timestamp create_time = 6;
// The last time metadata update time.
google.protobuf.Timestamp update_time = 7;
// The last table truncation time.
google.protobuf.Timestamp truncate_time = 8;
// Table encryption information. Set when non-default encryption is used.
EncryptionInfo encryption = 9;
}
// Trained BigQuery ML model.
message Model {
// Model URI.
//
// Format: `projects/<project_id>/datasets/<dataset_id>/models/<model_id>`.
string model_name = 1;
// User-provided metadata for the model.
EntityInfo model_info = 2;
// Model expiration time.
google.protobuf.Timestamp expire_time = 5;
// Model creation time.
google.protobuf.Timestamp create_time = 6;
// Model last update time.
google.protobuf.Timestamp update_time = 7;
// Model encryption information. Set when non-default encryption is used.
EncryptionInfo encryption = 8;
}
// User Defined Function (UDF) or Stored Procedure.
message Routine {
// Routine URI.
//
// Format:
// `projects/<project_id>/datasets/<dataset_id>/routines/<routine_id>`.
string routine_name = 1;
// Routine creation time.
google.protobuf.Timestamp create_time = 5;
// Routine last update time.
google.protobuf.Timestamp update_time = 6;
}
// User-provided metadata for an entity, for e.g. dataset, table or model.
message EntityInfo {
// A short name for the entity.
string friendly_name = 1;
// A long description for the entity.
string description = 2;
// Labels provided for the entity.
map<string, string> labels = 3;
}
// View definition.
message TableViewDefinition {
// SQL query defining the view. Truncated if exceeds 40K.
string query = 1;
// True if the schema_json field was truncated.
bool query_truncated = 2;
}
// BigQuery dataset.
message Dataset {
// Dataset URI.
//
// Format: `projects/<project_id>/datasets/<dataset_id>`.
string dataset_name = 1;
// User-provided metadata for the dataset.
EntityInfo dataset_info = 7;
// Dataset creation time.
google.protobuf.Timestamp create_time = 3;
// Dataset metadata last update time.
google.protobuf.Timestamp update_time = 4;
// The access control list for the dataset.
BigQueryAcl acl = 5;
// Default expiration time for tables in the dataset.
google.protobuf.Duration default_table_expire_duration = 6;
// Default encryption for tables in the dataset.
EncryptionInfo default_encryption = 8;
// Default collation for the dataset.
string default_collation = 9;
}
// An access control list.
message BigQueryAcl {
// IAM policy for the resource.
google.iam.v1.Policy policy = 1;
// List of authorized views for a dataset.
//
// Format: `projects/<project_id>/datasets/<dataset_id>/tables/<view_id>`.
repeated string authorized_views = 2;
}
// Encryption properties for a table or a job
message EncryptionInfo {
// Cloud kms key identifier.
//
// Format:
// `projects/<project_id>/locations/<location>/keyRings/<key_ring_name>/cryptoKeys/<key_name>`
string kms_key_name = 1;
}
// BigQuery row access policy.
message RowAccessPolicy {
// Row access policy URI.
//
// Format:
// `projects/<project_id>/datasets/<dataset_id>/tables/<table_id>/rowAccessPolicies/<row_access_policy_id>`
string row_access_policy_name = 1;
}
// First party (Google) application specific request metadata.
message FirstPartyAppMetadata {
oneof metadata {
// Google Sheets metadata.
SheetsMetadata sheets_metadata = 1;
}
}
// Google Sheets specific request metadata.
message SheetsMetadata {
// The ID of the spreadsheet from which the request is sent.
string doc_id = 1;
}
// BigQuery event information.
oneof event {
// Job insertion event.
JobInsertion job_insertion = 1;
// Job state change event.
JobChange job_change = 2;
// Job deletion event.
JobDeletion job_deletion = 23;
// Dataset creation event.
DatasetCreation dataset_creation = 3;
// Dataset change event.
DatasetChange dataset_change = 4;
// Dataset deletion event.
DatasetDeletion dataset_deletion = 5;
// Table creation event.
TableCreation table_creation = 6;
// Table metadata change event.
TableChange table_change = 8;
// Table deletion event.
TableDeletion table_deletion = 9;
// Table data read event.
TableDataRead table_data_read = 10;
// Table data change event.
TableDataChange table_data_change = 11;
// Model deletion event.
ModelDeletion model_deletion = 12;
// Model creation event.
ModelCreation model_creation = 13;
// Model metadata change event.
ModelMetadataChange model_metadata_change = 14;
// Model data change event.
ModelDataChange model_data_change = 15;
// Model data read event.
ModelDataRead model_data_read = 19;
// Routine creation event.
RoutineCreation routine_creation = 16;
// Routine change event.
RoutineChange routine_change = 17;
// Routine deletion event.
RoutineDeletion routine_deletion = 18;
// Row access policy create event.
RowAccessPolicyCreation row_access_policy_creation = 20;
// Row access policy change event.
RowAccessPolicyChange row_access_policy_change = 21;
// Row access policy deletion event.
RowAccessPolicyDeletion row_access_policy_deletion = 22;
// Unlink linked dataset from its source dataset event
UnlinkDataset unlink_dataset = 25;
}
// First party (Google) application specific metadata.
FirstPartyAppMetadata first_party_app_metadata = 24;
}
|