/
data_quality.pb.go
executable file
·2612 lines (2337 loc) · 113 KB
/
data_quality.pb.go
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 2023 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.
// Code generated by protoc-gen-go. DO NOT EDIT.
// versions:
// protoc-gen-go v1.32.0
// protoc v4.25.2
// source: google/cloud/dataplex/v1/data_quality.proto
package dataplexpb
import (
reflect "reflect"
sync "sync"
_ "google.golang.org/genproto/googleapis/api/annotations"
protoreflect "google.golang.org/protobuf/reflect/protoreflect"
protoimpl "google.golang.org/protobuf/runtime/protoimpl"
)
const (
// Verify that this generated code is sufficiently up-to-date.
_ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion)
// Verify that runtime/protoimpl is sufficiently up-to-date.
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
// Execution state for the exporting.
type DataQualityResult_PostScanActionsResult_BigQueryExportResult_State int32
const (
// The exporting state is unspecified.
DataQualityResult_PostScanActionsResult_BigQueryExportResult_STATE_UNSPECIFIED DataQualityResult_PostScanActionsResult_BigQueryExportResult_State = 0
// The exporting completed successfully.
DataQualityResult_PostScanActionsResult_BigQueryExportResult_SUCCEEDED DataQualityResult_PostScanActionsResult_BigQueryExportResult_State = 1
// The exporting is no longer running due to an error.
DataQualityResult_PostScanActionsResult_BigQueryExportResult_FAILED DataQualityResult_PostScanActionsResult_BigQueryExportResult_State = 2
// The exporting is skipped due to no valid scan result to export
// (usually caused by scan failed).
DataQualityResult_PostScanActionsResult_BigQueryExportResult_SKIPPED DataQualityResult_PostScanActionsResult_BigQueryExportResult_State = 3
)
// Enum value maps for DataQualityResult_PostScanActionsResult_BigQueryExportResult_State.
var (
DataQualityResult_PostScanActionsResult_BigQueryExportResult_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "SUCCEEDED",
2: "FAILED",
3: "SKIPPED",
}
DataQualityResult_PostScanActionsResult_BigQueryExportResult_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"SUCCEEDED": 1,
"FAILED": 2,
"SKIPPED": 3,
}
)
func (x DataQualityResult_PostScanActionsResult_BigQueryExportResult_State) Enum() *DataQualityResult_PostScanActionsResult_BigQueryExportResult_State {
p := new(DataQualityResult_PostScanActionsResult_BigQueryExportResult_State)
*p = x
return p
}
func (x DataQualityResult_PostScanActionsResult_BigQueryExportResult_State) String() string {
return protoimpl.X.EnumStringOf(x.Descriptor(), protoreflect.EnumNumber(x))
}
func (DataQualityResult_PostScanActionsResult_BigQueryExportResult_State) Descriptor() protoreflect.EnumDescriptor {
return file_google_cloud_dataplex_v1_data_quality_proto_enumTypes[0].Descriptor()
}
func (DataQualityResult_PostScanActionsResult_BigQueryExportResult_State) Type() protoreflect.EnumType {
return &file_google_cloud_dataplex_v1_data_quality_proto_enumTypes[0]
}
func (x DataQualityResult_PostScanActionsResult_BigQueryExportResult_State) Number() protoreflect.EnumNumber {
return protoreflect.EnumNumber(x)
}
// Deprecated: Use DataQualityResult_PostScanActionsResult_BigQueryExportResult_State.Descriptor instead.
func (DataQualityResult_PostScanActionsResult_BigQueryExportResult_State) EnumDescriptor() ([]byte, []int) {
return file_google_cloud_dataplex_v1_data_quality_proto_rawDescGZIP(), []int{1, 0, 0, 0}
}
// The list of aggregate metrics a rule can be evaluated against.
type DataQualityRule_StatisticRangeExpectation_ColumnStatistic int32
const (
// Unspecified statistic type
DataQualityRule_StatisticRangeExpectation_STATISTIC_UNDEFINED DataQualityRule_StatisticRangeExpectation_ColumnStatistic = 0
// Evaluate the column mean
DataQualityRule_StatisticRangeExpectation_MEAN DataQualityRule_StatisticRangeExpectation_ColumnStatistic = 1
// Evaluate the column min
DataQualityRule_StatisticRangeExpectation_MIN DataQualityRule_StatisticRangeExpectation_ColumnStatistic = 2
// Evaluate the column max
DataQualityRule_StatisticRangeExpectation_MAX DataQualityRule_StatisticRangeExpectation_ColumnStatistic = 3
)
// Enum value maps for DataQualityRule_StatisticRangeExpectation_ColumnStatistic.
var (
DataQualityRule_StatisticRangeExpectation_ColumnStatistic_name = map[int32]string{
0: "STATISTIC_UNDEFINED",
1: "MEAN",
2: "MIN",
3: "MAX",
}
DataQualityRule_StatisticRangeExpectation_ColumnStatistic_value = map[string]int32{
"STATISTIC_UNDEFINED": 0,
"MEAN": 1,
"MIN": 2,
"MAX": 3,
}
)
func (x DataQualityRule_StatisticRangeExpectation_ColumnStatistic) Enum() *DataQualityRule_StatisticRangeExpectation_ColumnStatistic {
p := new(DataQualityRule_StatisticRangeExpectation_ColumnStatistic)
*p = x
return p
}
func (x DataQualityRule_StatisticRangeExpectation_ColumnStatistic) String() string {
return protoimpl.X.EnumStringOf(x.Descriptor(), protoreflect.EnumNumber(x))
}
func (DataQualityRule_StatisticRangeExpectation_ColumnStatistic) Descriptor() protoreflect.EnumDescriptor {
return file_google_cloud_dataplex_v1_data_quality_proto_enumTypes[1].Descriptor()
}
func (DataQualityRule_StatisticRangeExpectation_ColumnStatistic) Type() protoreflect.EnumType {
return &file_google_cloud_dataplex_v1_data_quality_proto_enumTypes[1]
}
func (x DataQualityRule_StatisticRangeExpectation_ColumnStatistic) Number() protoreflect.EnumNumber {
return protoreflect.EnumNumber(x)
}
// Deprecated: Use DataQualityRule_StatisticRangeExpectation_ColumnStatistic.Descriptor instead.
func (DataQualityRule_StatisticRangeExpectation_ColumnStatistic) EnumDescriptor() ([]byte, []int) {
return file_google_cloud_dataplex_v1_data_quality_proto_rawDescGZIP(), []int{5, 5, 0}
}
// DataQualityScan related setting.
type DataQualitySpec struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Required. The list of rules to evaluate against a data source. At least one
// rule is required.
Rules []*DataQualityRule `protobuf:"bytes,1,rep,name=rules,proto3" json:"rules,omitempty"`
// Optional. The percentage of the records to be selected from the dataset for
// DataScan.
//
// * Value can range between 0.0 and 100.0 with up to 3 significant decimal
// digits.
// * Sampling is not applied if `sampling_percent` is not specified, 0 or
// 100.
SamplingPercent float32 `protobuf:"fixed32,4,opt,name=sampling_percent,json=samplingPercent,proto3" json:"sampling_percent,omitempty"`
// 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 AND col2 < 10
RowFilter string `protobuf:"bytes,5,opt,name=row_filter,json=rowFilter,proto3" json:"row_filter,omitempty"`
// Optional. Actions to take upon job completion.
PostScanActions *DataQualitySpec_PostScanActions `protobuf:"bytes,6,opt,name=post_scan_actions,json=postScanActions,proto3" json:"post_scan_actions,omitempty"`
}
func (x *DataQualitySpec) Reset() {
*x = DataQualitySpec{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_dataplex_v1_data_quality_proto_msgTypes[0]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *DataQualitySpec) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*DataQualitySpec) ProtoMessage() {}
func (x *DataQualitySpec) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_dataplex_v1_data_quality_proto_msgTypes[0]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use DataQualitySpec.ProtoReflect.Descriptor instead.
func (*DataQualitySpec) Descriptor() ([]byte, []int) {
return file_google_cloud_dataplex_v1_data_quality_proto_rawDescGZIP(), []int{0}
}
func (x *DataQualitySpec) GetRules() []*DataQualityRule {
if x != nil {
return x.Rules
}
return nil
}
func (x *DataQualitySpec) GetSamplingPercent() float32 {
if x != nil {
return x.SamplingPercent
}
return 0
}
func (x *DataQualitySpec) GetRowFilter() string {
if x != nil {
return x.RowFilter
}
return ""
}
func (x *DataQualitySpec) GetPostScanActions() *DataQualitySpec_PostScanActions {
if x != nil {
return x.PostScanActions
}
return nil
}
// The output of a DataQualityScan.
type DataQualityResult struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Overall data quality result -- `true` if all rules passed.
Passed bool `protobuf:"varint,5,opt,name=passed,proto3" json:"passed,omitempty"`
// Output only. The overall data quality score.
//
// The score ranges between [0, 100] (up to two decimal points).
Score *float32 `protobuf:"fixed32,9,opt,name=score,proto3,oneof" json:"score,omitempty"`
// A list of results at the dimension level.
//
// A dimension will have a corresponding `DataQualityDimensionResult` if and
// only if there is at least one rule with the 'dimension' field set to it.
Dimensions []*DataQualityDimensionResult `protobuf:"bytes,2,rep,name=dimensions,proto3" json:"dimensions,omitempty"`
// Output only. A list of results at the column level.
//
// A column will have a corresponding `DataQualityColumnResult` if and only if
// there is at least one rule with the 'column' field set to it.
Columns []*DataQualityColumnResult `protobuf:"bytes,10,rep,name=columns,proto3" json:"columns,omitempty"`
// A list of all the rules in a job, and their results.
Rules []*DataQualityRuleResult `protobuf:"bytes,3,rep,name=rules,proto3" json:"rules,omitempty"`
// The count of rows processed.
RowCount int64 `protobuf:"varint,4,opt,name=row_count,json=rowCount,proto3" json:"row_count,omitempty"`
// The data scanned for this result.
ScannedData *ScannedData `protobuf:"bytes,7,opt,name=scanned_data,json=scannedData,proto3" json:"scanned_data,omitempty"`
// Output only. The result of post scan actions.
PostScanActionsResult *DataQualityResult_PostScanActionsResult `protobuf:"bytes,8,opt,name=post_scan_actions_result,json=postScanActionsResult,proto3" json:"post_scan_actions_result,omitempty"`
}
func (x *DataQualityResult) Reset() {
*x = DataQualityResult{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_dataplex_v1_data_quality_proto_msgTypes[1]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *DataQualityResult) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*DataQualityResult) ProtoMessage() {}
func (x *DataQualityResult) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_dataplex_v1_data_quality_proto_msgTypes[1]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use DataQualityResult.ProtoReflect.Descriptor instead.
func (*DataQualityResult) Descriptor() ([]byte, []int) {
return file_google_cloud_dataplex_v1_data_quality_proto_rawDescGZIP(), []int{1}
}
func (x *DataQualityResult) GetPassed() bool {
if x != nil {
return x.Passed
}
return false
}
func (x *DataQualityResult) GetScore() float32 {
if x != nil && x.Score != nil {
return *x.Score
}
return 0
}
func (x *DataQualityResult) GetDimensions() []*DataQualityDimensionResult {
if x != nil {
return x.Dimensions
}
return nil
}
func (x *DataQualityResult) GetColumns() []*DataQualityColumnResult {
if x != nil {
return x.Columns
}
return nil
}
func (x *DataQualityResult) GetRules() []*DataQualityRuleResult {
if x != nil {
return x.Rules
}
return nil
}
func (x *DataQualityResult) GetRowCount() int64 {
if x != nil {
return x.RowCount
}
return 0
}
func (x *DataQualityResult) GetScannedData() *ScannedData {
if x != nil {
return x.ScannedData
}
return nil
}
func (x *DataQualityResult) GetPostScanActionsResult() *DataQualityResult_PostScanActionsResult {
if x != nil {
return x.PostScanActionsResult
}
return nil
}
// DataQualityRuleResult provides a more detailed, per-rule view of the results.
type DataQualityRuleResult struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// The rule specified in the DataQualitySpec, as is.
Rule *DataQualityRule `protobuf:"bytes,1,opt,name=rule,proto3" json:"rule,omitempty"`
// Whether the rule passed or failed.
Passed bool `protobuf:"varint,7,opt,name=passed,proto3" json:"passed,omitempty"`
// The number of rows a rule was evaluated against.
//
// This field is only valid for row-level type rules.
//
// # Evaluated count can be configured to either
//
// * include all rows (default) - with `null` rows automatically failing rule
// evaluation, or
// * exclude `null` rows from the `evaluated_count`, by setting
// `ignore_nulls = true`.
EvaluatedCount int64 `protobuf:"varint,9,opt,name=evaluated_count,json=evaluatedCount,proto3" json:"evaluated_count,omitempty"`
// The number of rows which passed a rule evaluation.
//
// This field is only valid for row-level type rules.
PassedCount int64 `protobuf:"varint,8,opt,name=passed_count,json=passedCount,proto3" json:"passed_count,omitempty"`
// The number of rows with null values in the specified column.
NullCount int64 `protobuf:"varint,5,opt,name=null_count,json=nullCount,proto3" json:"null_count,omitempty"`
// The ratio of **passed_count / evaluated_count**.
//
// This field is only valid for row-level type rules.
PassRatio float64 `protobuf:"fixed64,6,opt,name=pass_ratio,json=passRatio,proto3" json:"pass_ratio,omitempty"`
// The query to find rows that did not pass this rule.
//
// This field is only valid for row-level type rules.
FailingRowsQuery string `protobuf:"bytes,10,opt,name=failing_rows_query,json=failingRowsQuery,proto3" json:"failing_rows_query,omitempty"`
}
func (x *DataQualityRuleResult) Reset() {
*x = DataQualityRuleResult{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_dataplex_v1_data_quality_proto_msgTypes[2]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *DataQualityRuleResult) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*DataQualityRuleResult) ProtoMessage() {}
func (x *DataQualityRuleResult) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_dataplex_v1_data_quality_proto_msgTypes[2]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use DataQualityRuleResult.ProtoReflect.Descriptor instead.
func (*DataQualityRuleResult) Descriptor() ([]byte, []int) {
return file_google_cloud_dataplex_v1_data_quality_proto_rawDescGZIP(), []int{2}
}
func (x *DataQualityRuleResult) GetRule() *DataQualityRule {
if x != nil {
return x.Rule
}
return nil
}
func (x *DataQualityRuleResult) GetPassed() bool {
if x != nil {
return x.Passed
}
return false
}
func (x *DataQualityRuleResult) GetEvaluatedCount() int64 {
if x != nil {
return x.EvaluatedCount
}
return 0
}
func (x *DataQualityRuleResult) GetPassedCount() int64 {
if x != nil {
return x.PassedCount
}
return 0
}
func (x *DataQualityRuleResult) GetNullCount() int64 {
if x != nil {
return x.NullCount
}
return 0
}
func (x *DataQualityRuleResult) GetPassRatio() float64 {
if x != nil {
return x.PassRatio
}
return 0
}
func (x *DataQualityRuleResult) GetFailingRowsQuery() string {
if x != nil {
return x.FailingRowsQuery
}
return ""
}
// DataQualityDimensionResult provides a more detailed, per-dimension view of
// the results.
type DataQualityDimensionResult struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Output only. The dimension config specified in the DataQualitySpec, as is.
Dimension *DataQualityDimension `protobuf:"bytes,1,opt,name=dimension,proto3" json:"dimension,omitempty"`
// Whether the dimension passed or failed.
Passed bool `protobuf:"varint,3,opt,name=passed,proto3" json:"passed,omitempty"`
// Output only. The dimension-level data quality score for this data scan job
// if and only if the 'dimension' field is set.
//
// The score ranges between [0, 100] (up to two decimal
// points).
Score *float32 `protobuf:"fixed32,4,opt,name=score,proto3,oneof" json:"score,omitempty"`
}
func (x *DataQualityDimensionResult) Reset() {
*x = DataQualityDimensionResult{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_dataplex_v1_data_quality_proto_msgTypes[3]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *DataQualityDimensionResult) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*DataQualityDimensionResult) ProtoMessage() {}
func (x *DataQualityDimensionResult) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_dataplex_v1_data_quality_proto_msgTypes[3]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use DataQualityDimensionResult.ProtoReflect.Descriptor instead.
func (*DataQualityDimensionResult) Descriptor() ([]byte, []int) {
return file_google_cloud_dataplex_v1_data_quality_proto_rawDescGZIP(), []int{3}
}
func (x *DataQualityDimensionResult) GetDimension() *DataQualityDimension {
if x != nil {
return x.Dimension
}
return nil
}
func (x *DataQualityDimensionResult) GetPassed() bool {
if x != nil {
return x.Passed
}
return false
}
func (x *DataQualityDimensionResult) GetScore() float32 {
if x != nil && x.Score != nil {
return *x.Score
}
return 0
}
// A dimension captures data quality intent about a defined subset of the rules
// specified.
type DataQualityDimension struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// The dimension name a rule belongs to. Supported dimensions are
// ["COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS",
// "INTEGRITY"]
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
}
func (x *DataQualityDimension) Reset() {
*x = DataQualityDimension{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_dataplex_v1_data_quality_proto_msgTypes[4]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *DataQualityDimension) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*DataQualityDimension) ProtoMessage() {}
func (x *DataQualityDimension) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_dataplex_v1_data_quality_proto_msgTypes[4]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use DataQualityDimension.ProtoReflect.Descriptor instead.
func (*DataQualityDimension) Descriptor() ([]byte, []int) {
return file_google_cloud_dataplex_v1_data_quality_proto_rawDescGZIP(), []int{4}
}
func (x *DataQualityDimension) GetName() string {
if x != nil {
return x.Name
}
return ""
}
// A rule captures data quality intent about a data source.
type DataQualityRule struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// The rule-specific configuration.
//
// Types that are assignable to RuleType:
//
// *DataQualityRule_RangeExpectation_
// *DataQualityRule_NonNullExpectation_
// *DataQualityRule_SetExpectation_
// *DataQualityRule_RegexExpectation_
// *DataQualityRule_UniquenessExpectation_
// *DataQualityRule_StatisticRangeExpectation_
// *DataQualityRule_RowConditionExpectation_
// *DataQualityRule_TableConditionExpectation_
RuleType isDataQualityRule_RuleType `protobuf_oneof:"rule_type"`
// Optional. The unnested column which this rule is evaluated against.
Column string `protobuf:"bytes,500,opt,name=column,proto3" json:"column,omitempty"`
// Optional. Rows with `null` values will automatically fail a rule, unless
// `ignore_null` is `true`. In that case, such `null` rows are trivially
// considered passing.
//
// This field is only valid for the following type of rules:
//
// * RangeExpectation
// * RegexExpectation
// * SetExpectation
// * UniquenessExpectation
IgnoreNull bool `protobuf:"varint,501,opt,name=ignore_null,json=ignoreNull,proto3" json:"ignore_null,omitempty"`
// Required. The dimension a rule belongs to. Results are also aggregated at
// the dimension level. Supported dimensions are **["COMPLETENESS",
// "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"]**
Dimension string `protobuf:"bytes,502,opt,name=dimension,proto3" json:"dimension,omitempty"`
// Optional. The minimum ratio of **passing_rows / total_rows** required to
// pass this rule, with a range of [0.0, 1.0].
//
// 0 indicates default value (i.e. 1.0).
//
// This field is only valid for row-level type rules.
Threshold float64 `protobuf:"fixed64,503,opt,name=threshold,proto3" json:"threshold,omitempty"`
// Optional. A mutable name for the rule.
//
// * The name must contain only letters (a-z, A-Z), numbers (0-9), or
// hyphens (-).
// * The maximum length is 63 characters.
// * Must start with a letter.
// * Must end with a number or a letter.
Name string `protobuf:"bytes,504,opt,name=name,proto3" json:"name,omitempty"`
// Optional. Description of the rule.
//
// * The maximum length is 1,024 characters.
Description string `protobuf:"bytes,505,opt,name=description,proto3" json:"description,omitempty"`
}
func (x *DataQualityRule) Reset() {
*x = DataQualityRule{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_dataplex_v1_data_quality_proto_msgTypes[5]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *DataQualityRule) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*DataQualityRule) ProtoMessage() {}
func (x *DataQualityRule) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_dataplex_v1_data_quality_proto_msgTypes[5]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use DataQualityRule.ProtoReflect.Descriptor instead.
func (*DataQualityRule) Descriptor() ([]byte, []int) {
return file_google_cloud_dataplex_v1_data_quality_proto_rawDescGZIP(), []int{5}
}
func (m *DataQualityRule) GetRuleType() isDataQualityRule_RuleType {
if m != nil {
return m.RuleType
}
return nil
}
func (x *DataQualityRule) GetRangeExpectation() *DataQualityRule_RangeExpectation {
if x, ok := x.GetRuleType().(*DataQualityRule_RangeExpectation_); ok {
return x.RangeExpectation
}
return nil
}
func (x *DataQualityRule) GetNonNullExpectation() *DataQualityRule_NonNullExpectation {
if x, ok := x.GetRuleType().(*DataQualityRule_NonNullExpectation_); ok {
return x.NonNullExpectation
}
return nil
}
func (x *DataQualityRule) GetSetExpectation() *DataQualityRule_SetExpectation {
if x, ok := x.GetRuleType().(*DataQualityRule_SetExpectation_); ok {
return x.SetExpectation
}
return nil
}
func (x *DataQualityRule) GetRegexExpectation() *DataQualityRule_RegexExpectation {
if x, ok := x.GetRuleType().(*DataQualityRule_RegexExpectation_); ok {
return x.RegexExpectation
}
return nil
}
func (x *DataQualityRule) GetUniquenessExpectation() *DataQualityRule_UniquenessExpectation {
if x, ok := x.GetRuleType().(*DataQualityRule_UniquenessExpectation_); ok {
return x.UniquenessExpectation
}
return nil
}
func (x *DataQualityRule) GetStatisticRangeExpectation() *DataQualityRule_StatisticRangeExpectation {
if x, ok := x.GetRuleType().(*DataQualityRule_StatisticRangeExpectation_); ok {
return x.StatisticRangeExpectation
}
return nil
}
func (x *DataQualityRule) GetRowConditionExpectation() *DataQualityRule_RowConditionExpectation {
if x, ok := x.GetRuleType().(*DataQualityRule_RowConditionExpectation_); ok {
return x.RowConditionExpectation
}
return nil
}
func (x *DataQualityRule) GetTableConditionExpectation() *DataQualityRule_TableConditionExpectation {
if x, ok := x.GetRuleType().(*DataQualityRule_TableConditionExpectation_); ok {
return x.TableConditionExpectation
}
return nil
}
func (x *DataQualityRule) GetColumn() string {
if x != nil {
return x.Column
}
return ""
}
func (x *DataQualityRule) GetIgnoreNull() bool {
if x != nil {
return x.IgnoreNull
}
return false
}
func (x *DataQualityRule) GetDimension() string {
if x != nil {
return x.Dimension
}
return ""
}
func (x *DataQualityRule) GetThreshold() float64 {
if x != nil {
return x.Threshold
}
return 0
}
func (x *DataQualityRule) GetName() string {
if x != nil {
return x.Name
}
return ""
}
func (x *DataQualityRule) GetDescription() string {
if x != nil {
return x.Description
}
return ""
}
type isDataQualityRule_RuleType interface {
isDataQualityRule_RuleType()
}
type DataQualityRule_RangeExpectation_ struct {
// Row-level rule which evaluates whether each column value lies between a
// specified range.
RangeExpectation *DataQualityRule_RangeExpectation `protobuf:"bytes,1,opt,name=range_expectation,json=rangeExpectation,proto3,oneof"`
}
type DataQualityRule_NonNullExpectation_ struct {
// Row-level rule which evaluates whether each column value is null.
NonNullExpectation *DataQualityRule_NonNullExpectation `protobuf:"bytes,2,opt,name=non_null_expectation,json=nonNullExpectation,proto3,oneof"`
}
type DataQualityRule_SetExpectation_ struct {
// Row-level rule which evaluates whether each column value is contained by
// a specified set.
SetExpectation *DataQualityRule_SetExpectation `protobuf:"bytes,3,opt,name=set_expectation,json=setExpectation,proto3,oneof"`
}
type DataQualityRule_RegexExpectation_ struct {
// Row-level rule which evaluates whether each column value matches a
// specified regex.
RegexExpectation *DataQualityRule_RegexExpectation `protobuf:"bytes,4,opt,name=regex_expectation,json=regexExpectation,proto3,oneof"`
}
type DataQualityRule_UniquenessExpectation_ struct {
// Row-level rule which evaluates whether each column value is unique.
UniquenessExpectation *DataQualityRule_UniquenessExpectation `protobuf:"bytes,100,opt,name=uniqueness_expectation,json=uniquenessExpectation,proto3,oneof"`
}
type DataQualityRule_StatisticRangeExpectation_ struct {
// Aggregate rule which evaluates whether the column aggregate
// statistic lies between a specified range.
StatisticRangeExpectation *DataQualityRule_StatisticRangeExpectation `protobuf:"bytes,101,opt,name=statistic_range_expectation,json=statisticRangeExpectation,proto3,oneof"`
}
type DataQualityRule_RowConditionExpectation_ struct {
// Row-level rule which evaluates whether each row in a table passes the
// specified condition.
RowConditionExpectation *DataQualityRule_RowConditionExpectation `protobuf:"bytes,200,opt,name=row_condition_expectation,json=rowConditionExpectation,proto3,oneof"`
}
type DataQualityRule_TableConditionExpectation_ struct {
// Aggregate rule which evaluates whether the provided expression is true
// for a table.
TableConditionExpectation *DataQualityRule_TableConditionExpectation `protobuf:"bytes,201,opt,name=table_condition_expectation,json=tableConditionExpectation,proto3,oneof"`
}
func (*DataQualityRule_RangeExpectation_) isDataQualityRule_RuleType() {}
func (*DataQualityRule_NonNullExpectation_) isDataQualityRule_RuleType() {}
func (*DataQualityRule_SetExpectation_) isDataQualityRule_RuleType() {}
func (*DataQualityRule_RegexExpectation_) isDataQualityRule_RuleType() {}
func (*DataQualityRule_UniquenessExpectation_) isDataQualityRule_RuleType() {}
func (*DataQualityRule_StatisticRangeExpectation_) isDataQualityRule_RuleType() {}
func (*DataQualityRule_RowConditionExpectation_) isDataQualityRule_RuleType() {}
func (*DataQualityRule_TableConditionExpectation_) isDataQualityRule_RuleType() {}
// DataQualityColumnResult provides a more detailed, per-column view of
// the results.
type DataQualityColumnResult struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Output only. The column specified in the DataQualityRule.
Column string `protobuf:"bytes,1,opt,name=column,proto3" json:"column,omitempty"`
// Output only. The column-level data quality score for this data scan job if
// and only if the 'column' field is set.
//
// The score ranges between between [0, 100] (up to two decimal
// points).
Score *float32 `protobuf:"fixed32,2,opt,name=score,proto3,oneof" json:"score,omitempty"`
}
func (x *DataQualityColumnResult) Reset() {
*x = DataQualityColumnResult{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_dataplex_v1_data_quality_proto_msgTypes[6]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *DataQualityColumnResult) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*DataQualityColumnResult) ProtoMessage() {}
func (x *DataQualityColumnResult) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_dataplex_v1_data_quality_proto_msgTypes[6]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use DataQualityColumnResult.ProtoReflect.Descriptor instead.
func (*DataQualityColumnResult) Descriptor() ([]byte, []int) {
return file_google_cloud_dataplex_v1_data_quality_proto_rawDescGZIP(), []int{6}
}
func (x *DataQualityColumnResult) GetColumn() string {
if x != nil {
return x.Column
}
return ""
}
func (x *DataQualityColumnResult) GetScore() float32 {
if x != nil && x.Score != nil {
return *x.Score
}
return 0
}
// The configuration of post scan actions of DataQualityScan.
type DataQualitySpec_PostScanActions struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Optional. If set, results will be exported to the provided BigQuery
// table.
BigqueryExport *DataQualitySpec_PostScanActions_BigQueryExport `protobuf:"bytes,1,opt,name=bigquery_export,json=bigqueryExport,proto3" json:"bigquery_export,omitempty"`
// Optional. If set, results will be sent to the provided notification
// receipts upon triggers.
NotificationReport *DataQualitySpec_PostScanActions_NotificationReport `protobuf:"bytes,2,opt,name=notification_report,json=notificationReport,proto3" json:"notification_report,omitempty"`
}
func (x *DataQualitySpec_PostScanActions) Reset() {
*x = DataQualitySpec_PostScanActions{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_dataplex_v1_data_quality_proto_msgTypes[7]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *DataQualitySpec_PostScanActions) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*DataQualitySpec_PostScanActions) ProtoMessage() {}
func (x *DataQualitySpec_PostScanActions) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_dataplex_v1_data_quality_proto_msgTypes[7]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use DataQualitySpec_PostScanActions.ProtoReflect.Descriptor instead.
func (*DataQualitySpec_PostScanActions) Descriptor() ([]byte, []int) {
return file_google_cloud_dataplex_v1_data_quality_proto_rawDescGZIP(), []int{0, 0}
}
func (x *DataQualitySpec_PostScanActions) GetBigqueryExport() *DataQualitySpec_PostScanActions_BigQueryExport {
if x != nil {
return x.BigqueryExport
}
return nil
}
func (x *DataQualitySpec_PostScanActions) GetNotificationReport() *DataQualitySpec_PostScanActions_NotificationReport {
if x != nil {
return x.NotificationReport
}
return nil
}
// The configuration of BigQuery export post scan action.
type DataQualitySpec_PostScanActions_BigQueryExport struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Optional. The BigQuery table to export DataQualityScan results to.
// Format:
// //bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID
ResultsTable string `protobuf:"bytes,1,opt,name=results_table,json=resultsTable,proto3" json:"results_table,omitempty"`
}
func (x *DataQualitySpec_PostScanActions_BigQueryExport) Reset() {
*x = DataQualitySpec_PostScanActions_BigQueryExport{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_dataplex_v1_data_quality_proto_msgTypes[8]