@maxim_mazurok/gapi.client.dataplex-v1 0.0.20230712 → 0.0.20230801

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.
Files changed (3) hide show
  1. package/index.d.ts +72 -11
  2. package/package.json +1 -1
  3. package/tests.ts +47 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://dataplex.googleapis.com/$discovery/rest?version=v1
12
- // Revision: 20230712
12
+ // Revision: 20230801
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -465,6 +465,9 @@ declare namespace gapi.client {
465
465
  string;
466
466
  }
467
467
  interface GoogleCloudDataplexV1DataProfileResult {
468
+ /** Output only. The result of post scan actions. */
469
+ postScanActionsResult?:
470
+ GoogleCloudDataplexV1DataProfileResultPostScanActionsResult;
468
471
  /** The profile information per field. */
469
472
  profile?:
470
473
  GoogleCloudDataplexV1DataProfileResultProfile;
@@ -475,6 +478,19 @@ declare namespace gapi.client {
475
478
  scannedData?:
476
479
  GoogleCloudDataplexV1ScannedData;
477
480
  }
481
+ interface GoogleCloudDataplexV1DataProfileResultPostScanActionsResult {
482
+ /** Output only. The result of BigQuery export post scan action. */
483
+ bigqueryExportResult?:
484
+ GoogleCloudDataplexV1DataProfileResultPostScanActionsResultBigQueryExportResult;
485
+ }
486
+ interface GoogleCloudDataplexV1DataProfileResultPostScanActionsResultBigQueryExportResult {
487
+ /** Output only. Additional information about the BigQuery exporting. */
488
+ message?:
489
+ string;
490
+ /** Output only. Execution state for the BigQuery exporting. */
491
+ state?:
492
+ string;
493
+ }
478
494
  interface GoogleCloudDataplexV1DataProfileResultProfile {
479
495
  /** List of fields with structural and profile information for each field. */
480
496
  fields?:
@@ -594,6 +610,9 @@ declare namespace gapi.client {
594
610
  /** Optional. The fields to include in data profile.If not specified, all fields at the time of profile scan job execution are included, except for ones listed in exclude_fields. */
595
611
  includeFields?:
596
612
  GoogleCloudDataplexV1DataProfileSpecSelectedFields;
613
+ /** Optional. Actions to take upon job completion.. */
614
+ postScanActions?:
615
+ GoogleCloudDataplexV1DataProfileSpecPostScanActions;
597
616
  /**
598
617
  * Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0
599
618
  * AND col2 < 10
@@ -607,6 +626,16 @@ declare namespace gapi.client {
607
626
  samplingPercent?:
608
627
  number;
609
628
  }
629
+ interface GoogleCloudDataplexV1DataProfileSpecPostScanActions {
630
+ /** Optional. If set, results will be exported to the provided BigQuery table. */
631
+ bigqueryExport?:
632
+ GoogleCloudDataplexV1DataProfileSpecPostScanActionsBigQueryExport;
633
+ }
634
+ interface GoogleCloudDataplexV1DataProfileSpecPostScanActionsBigQueryExport {
635
+ /** Optional. The BigQuery table to export DataProfileScan results to. Format: projects/{project}/datasets/{dataset}/tables/{table} */
636
+ resultsTable?:
637
+ string;
638
+ }
610
639
  interface GoogleCloudDataplexV1DataProfileSpecSelectedFields {
611
640
  /**
612
641
  * Optional. Expected input is a list of fully qualified names of fields as in the schema.Only top-level field names for nested fields are supported. For instance, if 'x' is of nested
@@ -627,6 +656,9 @@ declare namespace gapi.client {
627
656
  /** Overall data quality result -- true if all rules passed. */
628
657
  passed?:
629
658
  boolean;
659
+ /** Output only. The result of post scan actions. */
660
+ postScanActionsResult?:
661
+ GoogleCloudDataplexV1DataQualityResultPostScanActionsResult;
630
662
  /** The count of rows processed. */
631
663
  rowCount?:
632
664
  string;
@@ -637,6 +669,19 @@ declare namespace gapi.client {
637
669
  scannedData?:
638
670
  GoogleCloudDataplexV1ScannedData;
639
671
  }
672
+ interface GoogleCloudDataplexV1DataQualityResultPostScanActionsResult {
673
+ /** Output only. The result of BigQuery export post scan action. */
674
+ bigqueryExportResult?:
675
+ GoogleCloudDataplexV1DataQualityResultPostScanActionsResultBigQueryExportResult;
676
+ }
677
+ interface GoogleCloudDataplexV1DataQualityResultPostScanActionsResultBigQueryExportResult {
678
+ /** Output only. Additional information about the BigQuery exporting. */
679
+ message?:
680
+ string;
681
+ /** Output only. Execution state for the BigQuery exporting. */
682
+ state?:
683
+ string;
684
+ }
640
685
  interface GoogleCloudDataplexV1DataQualityRule {
641
686
  /** Optional. The unnested column which this rule is evaluated against. */
642
687
  column?:
@@ -711,7 +756,7 @@ declare namespace gapi.client {
711
756
  boolean;
712
757
  }
713
758
  interface GoogleCloudDataplexV1DataQualityRuleRegexExpectation {
714
- /** A regular expression the column value is expected to match. */
759
+ /** Optional. A regular expression the column value is expected to match. */
715
760
  regex?:
716
761
  string;
717
762
  }
@@ -742,34 +787,34 @@ declare namespace gapi.client {
742
787
  GoogleCloudDataplexV1DataQualityRule;
743
788
  }
744
789
  interface GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation {
745
- /** The SQL expression. */
790
+ /** Optional. The SQL expression. */
746
791
  sqlExpression?:
747
792
  string;
748
793
  }
749
794
  interface GoogleCloudDataplexV1DataQualityRuleSetExpectation {
750
- /** Expected values for the column value. */
795
+ /** Optional. Expected values for the column value. */
751
796
  values?:
752
797
  string[];
753
798
  }
754
799
  interface GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectation {
755
- /** The maximum column statistic value allowed for a row to pass this validation.At least one of min_value and max_value need to be provided. */
800
+ /** Optional. The maximum column statistic value allowed for a row to pass this validation.At least one of min_value and max_value need to be provided. */
756
801
  maxValue?:
757
802
  string;
758
- /** The minimum column statistic value allowed for a row to pass this validation.At least one of min_value and max_value need to be provided. */
803
+ /** Optional. The minimum column statistic value allowed for a row to pass this validation.At least one of min_value and max_value need to be provided. */
759
804
  minValue?:
760
805
  string;
761
- /** The aggregate metric to evaluate. */
806
+ /** Optional. The aggregate metric to evaluate. */
762
807
  statistic?:
763
808
  string;
764
- /** Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false. */
809
+ /** Optional. Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false. */
765
810
  strictMaxEnabled?:
766
811
  boolean;
767
- /** Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false. */
812
+ /** Optional. Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false. */
768
813
  strictMinEnabled?:
769
814
  boolean;
770
815
  }
771
816
  interface GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation {
772
- /** The SQL expression. */
817
+ /** Optional. The SQL expression. */
773
818
  sqlExpression?:
774
819
  string;
775
820
  }
@@ -815,13 +860,16 @@ declare namespace gapi.client {
815
860
  number;
816
861
  }
817
862
  interface GoogleCloudDataplexV1DataQualitySpec {
863
+ /** Optional. Actions to take upon job completion. */
864
+ postScanActions?:
865
+ GoogleCloudDataplexV1DataQualitySpecPostScanActions;
818
866
  /**
819
867
  * Optional. A filter applied to all rows in a single DataScan job. The filter needs to be a valid SQL expression for a WHERE clause in BigQuery standard SQL syntax. Example: col1 >= 0
820
868
  * AND col2 < 10
821
869
  */
822
870
  rowFilter?:
823
871
  string;
824
- /** The list of rules to evaluate against a data source. At least one rule is required. */
872
+ /** Required. The list of rules to evaluate against a data source. At least one rule is required. */
825
873
  rules?:
826
874
  GoogleCloudDataplexV1DataQualityRule[];
827
875
  /**
@@ -831,6 +879,16 @@ declare namespace gapi.client {
831
879
  samplingPercent?:
832
880
  number;
833
881
  }
882
+ interface GoogleCloudDataplexV1DataQualitySpecPostScanActions {
883
+ /** Optional. If set, results will be exported to the provided BigQuery table. */
884
+ bigqueryExport?:
885
+ GoogleCloudDataplexV1DataQualitySpecPostScanActionsBigQueryExport;
886
+ }
887
+ interface GoogleCloudDataplexV1DataQualitySpecPostScanActionsBigQueryExport {
888
+ /** Optional. The BigQuery table to export DataQualityScan results to. Format: projects/{project}/datasets/{dataset}/tables/{table} */
889
+ resultsTable?:
890
+ string;
891
+ }
834
892
  interface GoogleCloudDataplexV1DataScan {
835
893
  /** Output only. The time when the scan was created. */
836
894
  createTime?:
@@ -1063,6 +1121,9 @@ declare namespace gapi.client {
1063
1121
  /** Output only. The number of attributes in the DataTaxonomy. */
1064
1122
  attributeCount?:
1065
1123
  number;
1124
+ /** Output only. The number of classes in the DataTaxonomy. */
1125
+ classCount?:
1126
+ number;
1066
1127
  /** Output only. The time when the DataTaxonomy was created. */
1067
1128
  createTime?:
1068
1129
  string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.dataplex-v1",
3
- "version": "0.0.20230712",
3
+ "version": "0.0.20230801",
4
4
  "description": "TypeScript typings for Cloud Dataplex API v1",
5
5
  "license": "MIT",
6
6
  "author": {
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20230712
6
+ // Revision: 20230801
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -233,6 +233,12 @@ gapi.load('client', async () => {
233
233
  resource: "Test string",
234
234
  },
235
235
  dataProfileResult: {
236
+ postScanActionsResult: {
237
+ bigqueryExportResult: {
238
+ message: "Test string",
239
+ state: "Test string",
240
+ },
241
+ },
236
242
  profile: {
237
243
  fields: [
238
244
  {
@@ -296,6 +302,11 @@ gapi.load('client', async () => {
296
302
  "Test string"
297
303
  ],
298
304
  },
305
+ postScanActions: {
306
+ bigqueryExport: {
307
+ resultsTable: "Test string",
308
+ },
309
+ },
299
310
  rowFilter: "Test string",
300
311
  samplingPercent: 42,
301
312
  },
@@ -306,6 +317,12 @@ gapi.load('client', async () => {
306
317
  }
307
318
  ],
308
319
  passed: true,
320
+ postScanActionsResult: {
321
+ bigqueryExportResult: {
322
+ message: "Test string",
323
+ state: "Test string",
324
+ },
325
+ },
309
326
  rowCount: "Test string",
310
327
  rules: [
311
328
  {
@@ -365,6 +382,11 @@ gapi.load('client', async () => {
365
382
  },
366
383
  },
367
384
  dataQualitySpec: {
385
+ postScanActions: {
386
+ bigqueryExport: {
387
+ resultsTable: "Test string",
388
+ },
389
+ },
368
390
  rowFilter: "Test string",
369
391
  rules: [
370
392
  {
@@ -468,6 +490,12 @@ gapi.load('client', async () => {
468
490
  resource: "Test string",
469
491
  },
470
492
  dataProfileResult: {
493
+ postScanActionsResult: {
494
+ bigqueryExportResult: {
495
+ message: "Test string",
496
+ state: "Test string",
497
+ },
498
+ },
471
499
  profile: {
472
500
  fields: [
473
501
  {
@@ -531,6 +559,11 @@ gapi.load('client', async () => {
531
559
  "Test string"
532
560
  ],
533
561
  },
562
+ postScanActions: {
563
+ bigqueryExport: {
564
+ resultsTable: "Test string",
565
+ },
566
+ },
534
567
  rowFilter: "Test string",
535
568
  samplingPercent: 42,
536
569
  },
@@ -541,6 +574,12 @@ gapi.load('client', async () => {
541
574
  }
542
575
  ],
543
576
  passed: true,
577
+ postScanActionsResult: {
578
+ bigqueryExportResult: {
579
+ message: "Test string",
580
+ state: "Test string",
581
+ },
582
+ },
544
583
  rowCount: "Test string",
545
584
  rules: [
546
585
  {
@@ -600,6 +639,11 @@ gapi.load('client', async () => {
600
639
  },
601
640
  },
602
641
  dataQualitySpec: {
642
+ postScanActions: {
643
+ bigqueryExport: {
644
+ resultsTable: "Test string",
645
+ },
646
+ },
603
647
  rowFilter: "Test string",
604
648
  rules: [
605
649
  {
@@ -741,6 +785,7 @@ gapi.load('client', async () => {
741
785
  validateOnly: true,
742
786
  }, {
743
787
  attributeCount: 42,
788
+ classCount: 42,
744
789
  createTime: "Test string",
745
790
  description: "Test string",
746
791
  displayName: "Test string",
@@ -781,6 +826,7 @@ gapi.load('client', async () => {
781
826
  validateOnly: true,
782
827
  }, {
783
828
  attributeCount: 42,
829
+ classCount: 42,
784
830
  createTime: "Test string",
785
831
  description: "Test string",
786
832
  displayName: "Test string",