@googleapis/dataform 21.0.0 → 21.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/v1.ts CHANGED
@@ -230,6 +230,64 @@ export namespace dataform_v1 {
230
230
  */
231
231
  sqlScript?: string | null;
232
232
  }
233
+ /**
234
+ * Represents a BigQuery unit test.
235
+ */
236
+ export interface Schema$BigQueryUnitTest {
237
+ /**
238
+ * A list of actions that this action depends on.
239
+ */
240
+ dependencyTargets?: Schema$Target[];
241
+ /**
242
+ * Whether this action is disabled (i.e. should not be run).
243
+ */
244
+ disabled?: boolean | null;
245
+ /**
246
+ * The name of the unit test.
247
+ */
248
+ displayName?: string | null;
249
+ /**
250
+ * Expected output query to compare against the test query.
251
+ */
252
+ expectedOutputQuery?: string | null;
253
+ /**
254
+ * Arbitrary, user-defined tags on this action.
255
+ */
256
+ tags?: string[] | null;
257
+ /**
258
+ * Test query to execute.
259
+ */
260
+ testQuery?: string | null;
261
+ }
262
+ /**
263
+ * Represents a workflow action that will run a BigQuery unit test.
264
+ */
265
+ export interface Schema$BigQueryUnitTestAction {
266
+ /**
267
+ * Output only. Job ID for the actual results.
268
+ */
269
+ actualResultsJobId?: string | null;
270
+ /**
271
+ * Output only. SQL script for the actual results.
272
+ */
273
+ actualResultsSqlScript?: string | null;
274
+ /**
275
+ * Output only. Job ID for the expected results.
276
+ */
277
+ expectedResultsJobId?: string | null;
278
+ /**
279
+ * Output only. SQL script for the expected results.
280
+ */
281
+ expectedResultsSqlScript?: string | null;
282
+ /**
283
+ * Output only. Total bytes billed for this action. Combined total for actual and expected jobs.
284
+ */
285
+ totalBilledBytes?: string | null;
286
+ /**
287
+ * Output only. Total bytes processed for this action. Combined total for actual and expected jobs.
288
+ */
289
+ totalProcessedBytes?: string | null;
290
+ }
233
291
  /**
234
292
  * Associates `members`, or principals, with a `role`.
235
293
  */
@@ -505,6 +563,10 @@ export namespace dataform_v1 {
505
563
  * The assertion executed by this action.
506
564
  */
507
565
  assertion?: Schema$Assertion;
566
+ /**
567
+ * The unit test executed by this action.
568
+ */
569
+ bigqueryUnitTest?: Schema$BigQueryUnitTest;
508
570
  /**
509
571
  * The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result.
510
572
  */
@@ -684,6 +746,28 @@ export namespace dataform_v1 {
684
746
  * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
685
747
  */
686
748
  export interface Schema$Empty {}
749
+ /**
750
+ * Includes configuration options for repository end user authentication.
751
+ */
752
+ export interface Schema$EndUserAuthConfig {
753
+ /**
754
+ * Optional. OAuth configuration for repository end user authentication.
755
+ */
756
+ oauthConfig?: Schema$OAuthConfig;
757
+ }
758
+ /**
759
+ * Includes configuration options for end user authentication.
760
+ */
761
+ export interface Schema$EndUserAuthenticationConfig {
762
+ /**
763
+ * Optional. OAuth configuration for end user authentication.
764
+ */
765
+ oauthConfig?: Schema$OAuthConfig;
766
+ /**
767
+ * Output only. Email address of the user to run workflow invocations under.
768
+ */
769
+ userEmail?: string | null;
770
+ }
687
771
  /**
688
772
  * Error table information, used to write error data into a BigQuery table.
689
773
  */
@@ -789,7 +873,7 @@ export namespace dataform_v1 {
789
873
  */
790
874
  export interface Schema$FileSearchResult {
791
875
  /**
792
- * File system path relative to the workspace root.
876
+ * File system path relative to the file tree root.
793
877
  */
794
878
  path?: string | null;
795
879
  }
@@ -996,6 +1080,14 @@ export namespace dataform_v1 {
996
1080
  * Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included.
997
1081
  */
998
1082
  export interface Schema$InvocationConfig {
1083
+ /**
1084
+ * Optional. Configuration for end user authentication. Note that this should not be set when `service_account` is used.
1085
+ */
1086
+ endUserAuthConfig?: Schema$EndUserAuthenticationConfig;
1087
+ /**
1088
+ * Optional. Specifies the execution mode for the workflow invocation.
1089
+ */
1090
+ executionMode?: string | null;
999
1091
  /**
1000
1092
  * Optional. When set to true, any incremental tables will be fully refreshed.
1001
1093
  */
@@ -1323,6 +1415,15 @@ export namespace dataform_v1 {
1323
1415
  */
1324
1416
  gcsRepositorySnapshotDestination?: Schema$GcsRepositorySnapshotDestination;
1325
1417
  }
1418
+ /**
1419
+ * OAuth configuration for end user authentication.
1420
+ */
1421
+ export interface Schema$OAuthConfig {
1422
+ /**
1423
+ * Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery`
1424
+ */
1425
+ additionalOauthScopes?: string[] | null;
1426
+ }
1326
1427
  /**
1327
1428
  * This resource represents a long-running operation that is the result of a network API call.
1328
1429
  */
@@ -1786,6 +1887,10 @@ export namespace dataform_v1 {
1786
1887
  * Optional. The repository's user-friendly name.
1787
1888
  */
1788
1889
  displayName?: string | null;
1890
+ /**
1891
+ * Optional. Includes configuration options for end user authentication.
1892
+ */
1893
+ endUserAuthConfig?: Schema$EndUserAuthConfig;
1789
1894
  /**
1790
1895
  * Optional. If set, configures this repository to be linked to a Git remote.
1791
1896
  */
@@ -2191,6 +2296,10 @@ export namespace dataform_v1 {
2191
2296
  * Output only. The workflow action's bigquery action details.
2192
2297
  */
2193
2298
  bigqueryAction?: Schema$BigQueryAction;
2299
+ /**
2300
+ * Output only. The workflow action's unit test details.
2301
+ */
2302
+ bigqueryUnitTestAction?: Schema$BigQueryUnitTestAction;
2194
2303
  /**
2195
2304
  * Output only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result.
2196
2305
  */
@@ -5749,6 +5858,7 @@ export namespace dataform_v1 {
5749
5858
  * // "createTime": "my_createTime",
5750
5859
  * // "dataEncryptionState": {},
5751
5860
  * // "displayName": "my_displayName",
5861
+ * // "endUserAuthConfig": {},
5752
5862
  * // "gitRemoteSettings": {},
5753
5863
  * // "internalMetadata": "my_internalMetadata",
5754
5864
  * // "kmsKeyName": "my_kmsKeyName",
@@ -5770,6 +5880,7 @@ export namespace dataform_v1 {
5770
5880
  * // "createTime": "my_createTime",
5771
5881
  * // "dataEncryptionState": {},
5772
5882
  * // "displayName": "my_displayName",
5883
+ * // "endUserAuthConfig": {},
5773
5884
  * // "gitRemoteSettings": {},
5774
5885
  * // "internalMetadata": "my_internalMetadata",
5775
5886
  * // "kmsKeyName": "my_kmsKeyName",
@@ -6356,6 +6467,7 @@ export namespace dataform_v1 {
6356
6467
  * // "createTime": "my_createTime",
6357
6468
  * // "dataEncryptionState": {},
6358
6469
  * // "displayName": "my_displayName",
6470
+ * // "endUserAuthConfig": {},
6359
6471
  * // "gitRemoteSettings": {},
6360
6472
  * // "internalMetadata": "my_internalMetadata",
6361
6473
  * // "kmsKeyName": "my_kmsKeyName",
@@ -6951,6 +7063,7 @@ export namespace dataform_v1 {
6951
7063
  * // "createTime": "my_createTime",
6952
7064
  * // "dataEncryptionState": {},
6953
7065
  * // "displayName": "my_displayName",
7066
+ * // "endUserAuthConfig": {},
6954
7067
  * // "gitRemoteSettings": {},
6955
7068
  * // "internalMetadata": "my_internalMetadata",
6956
7069
  * // "kmsKeyName": "my_kmsKeyName",
@@ -6972,6 +7085,7 @@ export namespace dataform_v1 {
6972
7085
  * // "createTime": "my_createTime",
6973
7086
  * // "dataEncryptionState": {},
6974
7087
  * // "displayName": "my_displayName",
7088
+ * // "endUserAuthConfig": {},
6975
7089
  * // "gitRemoteSettings": {},
6976
7090
  * // "internalMetadata": "my_internalMetadata",
6977
7091
  * // "kmsKeyName": "my_kmsKeyName",
package/v1beta1.ts CHANGED
@@ -230,6 +230,64 @@ export namespace dataform_v1beta1 {
230
230
  */
231
231
  sqlScript?: string | null;
232
232
  }
233
+ /**
234
+ * Represents a BigQuery unit test.
235
+ */
236
+ export interface Schema$BigQueryUnitTest {
237
+ /**
238
+ * A list of actions that this action depends on.
239
+ */
240
+ dependencyTargets?: Schema$Target[];
241
+ /**
242
+ * Whether this action is disabled (i.e. should not be run).
243
+ */
244
+ disabled?: boolean | null;
245
+ /**
246
+ * The name of the unit test.
247
+ */
248
+ displayName?: string | null;
249
+ /**
250
+ * Expected output query to compare against the test query.
251
+ */
252
+ expectedOutputQuery?: string | null;
253
+ /**
254
+ * Arbitrary, user-defined tags on this action.
255
+ */
256
+ tags?: string[] | null;
257
+ /**
258
+ * Test query to execute.
259
+ */
260
+ testQuery?: string | null;
261
+ }
262
+ /**
263
+ * Represents a workflow action that will run a BigQuery unit test.
264
+ */
265
+ export interface Schema$BigQueryUnitTestAction {
266
+ /**
267
+ * Output only. Job ID for the actual results.
268
+ */
269
+ actualResultsJobId?: string | null;
270
+ /**
271
+ * Output only. SQL script for the actual results.
272
+ */
273
+ actualResultsSqlScript?: string | null;
274
+ /**
275
+ * Output only. Job ID for the expected results.
276
+ */
277
+ expectedResultsJobId?: string | null;
278
+ /**
279
+ * Output only. SQL script for the expected results.
280
+ */
281
+ expectedResultsSqlScript?: string | null;
282
+ /**
283
+ * Output only. Total bytes billed for this action. Combined total for actual and expected jobs.
284
+ */
285
+ totalBilledBytes?: string | null;
286
+ /**
287
+ * Output only. Total bytes processed for this action. Combined total for actual and expected jobs.
288
+ */
289
+ totalProcessedBytes?: string | null;
290
+ }
233
291
  /**
234
292
  * Associates `members`, or principals, with a `role`.
235
293
  */
@@ -535,6 +593,10 @@ export namespace dataform_v1beta1 {
535
593
  * The assertion executed by this action.
536
594
  */
537
595
  assertion?: Schema$Assertion;
596
+ /**
597
+ * The unit test executed by this action.
598
+ */
599
+ bigqueryUnitTest?: Schema$BigQueryUnitTest;
538
600
  /**
539
601
  * The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result.
540
602
  */
@@ -740,6 +802,28 @@ export namespace dataform_v1beta1 {
740
802
  * A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
741
803
  */
742
804
  export interface Schema$Empty {}
805
+ /**
806
+ * Includes configuration options for repository end user authentication.
807
+ */
808
+ export interface Schema$EndUserAuthConfig {
809
+ /**
810
+ * Optional. OAuth configuration for repository end user authentication.
811
+ */
812
+ oauthConfig?: Schema$OAuthConfig;
813
+ }
814
+ /**
815
+ * Includes configuration options for end user authentication.
816
+ */
817
+ export interface Schema$EndUserAuthenticationConfig {
818
+ /**
819
+ * Optional. OAuth configuration for end user authentication.
820
+ */
821
+ oauthConfig?: Schema$OAuthConfig;
822
+ /**
823
+ * Output only. Email address of the user to run workflow invocations under.
824
+ */
825
+ userEmail?: string | null;
826
+ }
743
827
  /**
744
828
  * Error table information, used to write error data into a BigQuery table.
745
829
  */
@@ -867,7 +951,7 @@ export namespace dataform_v1beta1 {
867
951
  */
868
952
  export interface Schema$FileSearchResult {
869
953
  /**
870
- * File system path relative to the workspace root.
954
+ * File system path relative to the file tree root.
871
955
  */
872
956
  path?: string | null;
873
957
  }
@@ -1074,6 +1158,14 @@ export namespace dataform_v1beta1 {
1074
1158
  * Includes various configuration options for a workflow invocation. If both `included_targets` and `included_tags` are unset, all actions will be included.
1075
1159
  */
1076
1160
  export interface Schema$InvocationConfig {
1161
+ /**
1162
+ * Optional. Configuration for end user authentication. Note that this should not be set when `service_account` is used.
1163
+ */
1164
+ endUserAuthConfig?: Schema$EndUserAuthenticationConfig;
1165
+ /**
1166
+ * Optional. Specifies the execution mode for the workflow invocation.
1167
+ */
1168
+ executionMode?: string | null;
1077
1169
  /**
1078
1170
  * Optional. When set to true, any incremental tables will be fully refreshed.
1079
1171
  */
@@ -1401,6 +1493,15 @@ export namespace dataform_v1beta1 {
1401
1493
  */
1402
1494
  gcsRepositorySnapshotDestination?: Schema$GcsRepositorySnapshotDestination;
1403
1495
  }
1496
+ /**
1497
+ * OAuth configuration for end user authentication.
1498
+ */
1499
+ export interface Schema$OAuthConfig {
1500
+ /**
1501
+ * Optional. Additional OAuth scopes to use for BigQuery executions. Scopes always in use: `https://www.googleapis.com/auth/bigquery`
1502
+ */
1503
+ additionalOauthScopes?: string[] | null;
1504
+ }
1404
1505
  /**
1405
1506
  * This resource represents a long-running operation that is the result of a network API call.
1406
1507
  */
@@ -1864,6 +1965,10 @@ export namespace dataform_v1beta1 {
1864
1965
  * Optional. The repository's user-friendly name.
1865
1966
  */
1866
1967
  displayName?: string | null;
1968
+ /**
1969
+ * Optional. Includes configuration options for end user authentication.
1970
+ */
1971
+ endUserAuthConfig?: Schema$EndUserAuthConfig;
1867
1972
  /**
1868
1973
  * Optional. If set, configures this repository to be linked to a Git remote.
1869
1974
  */
@@ -2316,6 +2421,10 @@ export namespace dataform_v1beta1 {
2316
2421
  * Output only. The workflow action's bigquery action details.
2317
2422
  */
2318
2423
  bigqueryAction?: Schema$BigQueryAction;
2424
+ /**
2425
+ * Output only. The workflow action's unit test details.
2426
+ */
2427
+ bigqueryUnitTestAction?: Schema$BigQueryUnitTestAction;
2319
2428
  /**
2320
2429
  * Output only. The action's identifier if the project had been compiled without any overrides configured. Unique within the compilation result.
2321
2430
  */
@@ -5941,6 +6050,7 @@ export namespace dataform_v1beta1 {
5941
6050
  * // "createTime": "my_createTime",
5942
6051
  * // "dataEncryptionState": {},
5943
6052
  * // "displayName": "my_displayName",
6053
+ * // "endUserAuthConfig": {},
5944
6054
  * // "gitRemoteSettings": {},
5945
6055
  * // "internalMetadata": "my_internalMetadata",
5946
6056
  * // "kmsKeyName": "my_kmsKeyName",
@@ -5962,6 +6072,7 @@ export namespace dataform_v1beta1 {
5962
6072
  * // "createTime": "my_createTime",
5963
6073
  * // "dataEncryptionState": {},
5964
6074
  * // "displayName": "my_displayName",
6075
+ * // "endUserAuthConfig": {},
5965
6076
  * // "gitRemoteSettings": {},
5966
6077
  * // "internalMetadata": "my_internalMetadata",
5967
6078
  * // "kmsKeyName": "my_kmsKeyName",
@@ -6700,6 +6811,7 @@ export namespace dataform_v1beta1 {
6700
6811
  * // "createTime": "my_createTime",
6701
6812
  * // "dataEncryptionState": {},
6702
6813
  * // "displayName": "my_displayName",
6814
+ * // "endUserAuthConfig": {},
6703
6815
  * // "gitRemoteSettings": {},
6704
6816
  * // "internalMetadata": "my_internalMetadata",
6705
6817
  * // "kmsKeyName": "my_kmsKeyName",
@@ -7298,6 +7410,7 @@ export namespace dataform_v1beta1 {
7298
7410
  * // "createTime": "my_createTime",
7299
7411
  * // "dataEncryptionState": {},
7300
7412
  * // "displayName": "my_displayName",
7413
+ * // "endUserAuthConfig": {},
7301
7414
  * // "gitRemoteSettings": {},
7302
7415
  * // "internalMetadata": "my_internalMetadata",
7303
7416
  * // "kmsKeyName": "my_kmsKeyName",
@@ -7319,6 +7432,7 @@ export namespace dataform_v1beta1 {
7319
7432
  * // "createTime": "my_createTime",
7320
7433
  * // "dataEncryptionState": {},
7321
7434
  * // "displayName": "my_displayName",
7435
+ * // "endUserAuthConfig": {},
7322
7436
  * // "gitRemoteSettings": {},
7323
7437
  * // "internalMetadata": "my_internalMetadata",
7324
7438
  * // "kmsKeyName": "my_kmsKeyName",