google-apis-dataplex_v1 0.19.0 → 0.20.0

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 5697976e961c479927b3c358fd94108aff6a8ac96b4513f6fc70bf3a7ee26ce6
4
- data.tar.gz: 6b047346b20769d98e5f0e58e4917fcc03c46d3f82f5f8a05b25fa3c564d3ce2
3
+ metadata.gz: 857d68516d35b8e3614a863b60ed62dccf7af68026446e5d41204520ab641ed0
4
+ data.tar.gz: 180fe0489805722f8fbd6aa6c06f5b8b5cd8d16ea79db1c81697839292eb7652
5
5
  SHA512:
6
- metadata.gz: b6c42418d614abe109eee2ea626059b4aeca6c89dfb47831ff604cf9602862758b98d5b0781150dfe064e1b32d70f9c0967b85a0737a772e40471ed1d48555c9
7
- data.tar.gz: ee62a260caf850042a550b3fd5b3ae7e48021b7556f14a9a7109c5a99ce177f6a02817b509192a2a3c99aba1225a20a9a5163b6ca2ce0d7e459ec01881a6a729
6
+ metadata.gz: 458a20e7d4fae0a708fafd4c3416f047d1d318d498502bc44bae8b98311e4766d350fadabf295cdcae56668d2e032e4c7f1e84e5489df07491359c4fc303f6dc
7
+ data.tar.gz: 3055f42630cd323a1115a6a12595edf056fe8059963a033fcf76bdc0f0b004553e220853c7feee92d5c0f2404956785ad161c6c3469ddccea50a0057f42f3561
data/CHANGELOG.md CHANGED
@@ -1,5 +1,10 @@
1
1
  # Release history for google-apis-dataplex_v1
2
2
 
3
+ ### v0.20.0 (2023-01-08)
4
+
5
+ * Regenerated from discovery document revision 20230102
6
+ * Regenerated using generator version 0.11.1
7
+
3
8
  ### v0.19.0 (2022-12-14)
4
9
 
5
10
  * Regenerated from discovery document revision 20221212
@@ -471,8 +471,8 @@ module Google
471
471
  # 60 minutes apart. The default value is to run discovery every 60 minutes. To
472
472
  # explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "
473
473
  # CRON_TZ=$`IANA_TIME_ZONE`" or TZ=$`IANA_TIME_ZONE`". The $`IANA_TIME_ZONE` may
474
- # only be a valid string from IANA time zone database. For example, "CRON_TZ=
475
- # America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".
474
+ # only be a valid string from IANA time zone database. For example, CRON_TZ=
475
+ # America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *.
476
476
  # Corresponds to the JSON property `schedule`
477
477
  # @return [String]
478
478
  attr_accessor :schedule
@@ -908,13 +908,12 @@ module Google
908
908
  class GoogleCloudDataplexV1DataProfileResult
909
909
  include Google::Apis::Core::Hashable
910
910
 
911
- # Profile information describing the structure and layout of the data and
912
- # contains the profile info.
911
+ # Contains name, type, mode and field type specific profile information.
913
912
  # Corresponds to the JSON property `profile`
914
913
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataProfileResultProfile]
915
914
  attr_accessor :profile
916
915
 
917
- # The count of all rows in the sampled data. Return 0, if zero rows.
916
+ # The count of rows scanned.
918
917
  # Corresponds to the JSON property `rowCount`
919
918
  # @return [Fixnum]
920
919
  attr_accessor :row_count
@@ -936,12 +935,11 @@ module Google
936
935
  end
937
936
  end
938
937
 
939
- # Profile information describing the structure and layout of the data and
940
- # contains the profile info.
938
+ # Contains name, type, mode and field type specific profile information.
941
939
  class GoogleCloudDataplexV1DataProfileResultProfile
942
940
  include Google::Apis::Core::Hashable
943
941
 
944
- # The sequence of fields describing data in table entities.
942
+ # List of fields with structural and profile information for each field.
945
943
  # Corresponds to the JSON property `fields`
946
944
  # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1DataProfileResultProfileField>]
947
945
  attr_accessor :fields
@@ -956,12 +954,13 @@ module Google
956
954
  end
957
955
  end
958
956
 
959
- # Represents a column field within a table schema.
957
+ # A field within a table.
960
958
  class GoogleCloudDataplexV1DataProfileResultProfileField
961
959
  include Google::Apis::Core::Hashable
962
960
 
963
- # The mode of the field. Its value will be: REQUIRED, if it is a required field.
964
- # NULLABLE, if it is an optional field. REPEATED, if it is a repeated field.
961
+ # The mode of the field. Possible values include: REQUIRED, if it is a required
962
+ # field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated
963
+ # field.
965
964
  # Corresponds to the JSON property `mode`
966
965
  # @return [String]
967
966
  attr_accessor :mode
@@ -971,7 +970,7 @@ module Google
971
970
  # @return [String]
972
971
  attr_accessor :name
973
972
 
974
- # ProfileInfo defines the profile information for each schema field type.
973
+ # The profile information for each field type.
975
974
  # Corresponds to the JSON property `profile`
976
975
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo]
977
976
  attr_accessor :profile
@@ -995,39 +994,40 @@ module Google
995
994
  end
996
995
  end
997
996
 
998
- # ProfileInfo defines the profile information for each schema field type.
997
+ # The profile information for each field type.
999
998
  class GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo
1000
999
  include Google::Apis::Core::Hashable
1001
1000
 
1002
- # The ratio of rows that are distinct against the rows in the sampled data.
1001
+ # Ratio of rows with distinct values against total scanned rows. Not available
1002
+ # for complex non-groupable field type RECORD and fields with REPEATABLE mode.
1003
1003
  # Corresponds to the JSON property `distinctRatio`
1004
1004
  # @return [Float]
1005
1005
  attr_accessor :distinct_ratio
1006
1006
 
1007
- # DoubleFieldInfo defines output for any double type field.
1007
+ # The profile information for a double type field.
1008
1008
  # Corresponds to the JSON property `doubleProfile`
1009
1009
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo]
1010
1010
  attr_accessor :double_profile
1011
1011
 
1012
- # IntegerFieldInfo defines output for any integer type field.
1012
+ # The profile information for an integer type field.
1013
1013
  # Corresponds to the JSON property `integerProfile`
1014
1014
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo]
1015
1015
  attr_accessor :integer_profile
1016
1016
 
1017
- # The ratio of null rows against the rows in the sampled data.
1017
+ # Ratio of rows with null value against total scanned rows.
1018
1018
  # Corresponds to the JSON property `nullRatio`
1019
1019
  # @return [Float]
1020
1020
  attr_accessor :null_ratio
1021
1021
 
1022
- # StringFieldInfo defines output info for any string type field.
1022
+ # The profile information for a string type field.
1023
1023
  # Corresponds to the JSON property `stringProfile`
1024
1024
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo]
1025
1025
  attr_accessor :string_profile
1026
1026
 
1027
- # The array of top N values of the field in the sampled data. Currently N is set
1028
- # as 10 or equal to distinct values in the field, whichever is smaller. This
1029
- # will be optional for complex non-groupable data-types such as JSON, ARRAY,
1030
- # JSON, STRUCT.
1027
+ # The list of top N non-null values and number of times they occur in the
1028
+ # scanned data. N is 10 or equal to the number of distinct values in the field,
1029
+ # whichever is smaller. Not available for complex non-groupable field type
1030
+ # RECORD and fields with REPEATABLE mode.
1031
1031
  # Corresponds to the JSON property `topNValues`
1032
1032
  # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue>]
1033
1033
  attr_accessor :top_n_values
@@ -1047,43 +1047,41 @@ module Google
1047
1047
  end
1048
1048
  end
1049
1049
 
1050
- # DoubleFieldInfo defines output for any double type field.
1050
+ # The profile information for a double type field.
1051
1051
  class GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoDoubleFieldInfo
1052
1052
  include Google::Apis::Core::Hashable
1053
1053
 
1054
- # The average of non-null values of double field in the sampled data. Return NaN,
1055
- # if the field has a NaN. Optional if zero non-null rows.
1054
+ # Average of non-null values in the scanned data. NaN, if the field has a NaN.
1056
1055
  # Corresponds to the JSON property `average`
1057
1056
  # @return [Float]
1058
1057
  attr_accessor :average
1059
1058
 
1060
- # The maximum value of a double field in the sampled data. Return NaN, if the
1061
- # field has a NaN. Optional if zero non-null rows.
1059
+ # Maximum of non-null values in the scanned data. NaN, if the field has a NaN.
1062
1060
  # Corresponds to the JSON property `max`
1063
1061
  # @return [Float]
1064
1062
  attr_accessor :max
1065
1063
 
1066
- # The minimum value of a double field in the sampled data. Return NaN, if the
1067
- # field has a NaN. Optional if zero non-null rows.
1064
+ # Minimum of non-null values in the scanned data. NaN, if the field has a NaN.
1068
1065
  # Corresponds to the JSON property `min`
1069
1066
  # @return [Float]
1070
1067
  attr_accessor :min
1071
1068
 
1072
- # A quartile divide the numebr of data points into four parts, or quarters, of
1069
+ # A quartile divides the number of data points into four parts, or quarters, of
1073
1070
  # more-or-less equal size. Three main quartiles used are: The first quartile (Q1)
1074
1071
  # splits off the lowest 25% of data from the highest 75%. It is also known as
1075
1072
  # the lower or 25th empirical quartile, as 25% of the data is below this point.
1076
1073
  # The second quartile (Q2) is the median of a data set. So, 50% of the data lies
1077
1074
  # below this point. The third quartile (Q3) splits off the highest 25% of data
1078
1075
  # from the lowest 75%. It is known as the upper or 75th empirical quartile, as
1079
- # 75% of the data lies below this point. So, here the quartiles is provided as
1080
- # an ordered list of quartile values, occurring in order Q1, median, Q3.
1076
+ # 75% of the data lies below this point. Here, the quartiles is provided as an
1077
+ # ordered list of quartile values for the scanned data, occurring in order Q1,
1078
+ # median, Q3.
1081
1079
  # Corresponds to the JSON property `quartiles`
1082
1080
  # @return [Array<Float>]
1083
1081
  attr_accessor :quartiles
1084
1082
 
1085
- # The standard deviation of non-null of double field in the sampled data. Return
1086
- # NaN, if the field has a NaN. Optional if zero non-null rows.
1083
+ # Standard deviation of non-null values in the scanned data. NaN, if the field
1084
+ # has a NaN.
1087
1085
  # Corresponds to the JSON property `standardDeviation`
1088
1086
  # @return [Float]
1089
1087
  attr_accessor :standard_deviation
@@ -1102,43 +1100,41 @@ module Google
1102
1100
  end
1103
1101
  end
1104
1102
 
1105
- # IntegerFieldInfo defines output for any integer type field.
1103
+ # The profile information for an integer type field.
1106
1104
  class GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoIntegerFieldInfo
1107
1105
  include Google::Apis::Core::Hashable
1108
1106
 
1109
- # The average of non-null values of integer field in the sampled data. Return
1110
- # NaN, if the field has a NaN. Optional if zero non-null rows.
1107
+ # Average of non-null values in the scanned data. NaN, if the field has a NaN.
1111
1108
  # Corresponds to the JSON property `average`
1112
1109
  # @return [Float]
1113
1110
  attr_accessor :average
1114
1111
 
1115
- # The maximum value of an integer field in the sampled data. Return NaN, if the
1116
- # field has a NaN. Optional if zero non-null rows.
1112
+ # Maximum of non-null values in the scanned data. NaN, if the field has a NaN.
1117
1113
  # Corresponds to the JSON property `max`
1118
1114
  # @return [Fixnum]
1119
1115
  attr_accessor :max
1120
1116
 
1121
- # The minimum value of an integer field in the sampled data. Return NaN, if the
1122
- # field has a NaN. Optional if zero non-null rows.
1117
+ # Minimum of non-null values in the scanned data. NaN, if the field has a NaN.
1123
1118
  # Corresponds to the JSON property `min`
1124
1119
  # @return [Fixnum]
1125
1120
  attr_accessor :min
1126
1121
 
1127
- # A quartile divide the number of data points into four parts, or quarters, of
1122
+ # A quartile divides the number of data points into four parts, or quarters, of
1128
1123
  # more-or-less equal size. Three main quartiles used are: The first quartile (Q1)
1129
1124
  # splits off the lowest 25% of data from the highest 75%. It is also known as
1130
1125
  # the lower or 25th empirical quartile, as 25% of the data is below this point.
1131
1126
  # The second quartile (Q2) is the median of a data set. So, 50% of the data lies
1132
1127
  # below this point. The third quartile (Q3) splits off the highest 25% of data
1133
1128
  # from the lowest 75%. It is known as the upper or 75th empirical quartile, as
1134
- # 75% of the data lies below this point. So, here the quartiles is provided as
1135
- # an ordered list of quartile values, occurring in order Q1, median, Q3.
1129
+ # 75% of the data lies below this point. Here, the quartiles is provided as an
1130
+ # ordered list of quartile values for the scanned data, occurring in order Q1,
1131
+ # median, Q3.
1136
1132
  # Corresponds to the JSON property `quartiles`
1137
1133
  # @return [Array<Fixnum>]
1138
1134
  attr_accessor :quartiles
1139
1135
 
1140
- # The standard deviation of non-null of integer field in the sampled data.
1141
- # Return NaN, if the field has a NaN. Optional if zero non-null rows.
1136
+ # Standard deviation of non-null values in the scanned data. NaN, if the field
1137
+ # has a NaN.
1142
1138
  # Corresponds to the JSON property `standardDeviation`
1143
1139
  # @return [Float]
1144
1140
  attr_accessor :standard_deviation
@@ -1157,24 +1153,21 @@ module Google
1157
1153
  end
1158
1154
  end
1159
1155
 
1160
- # StringFieldInfo defines output info for any string type field.
1156
+ # The profile information for a string type field.
1161
1157
  class GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoStringFieldInfo
1162
1158
  include Google::Apis::Core::Hashable
1163
1159
 
1164
- # The average length of a string field in the sampled data. Optional if zero non-
1165
- # null rows.
1160
+ # Average length of non-null values in the scanned data.
1166
1161
  # Corresponds to the JSON property `averageLength`
1167
1162
  # @return [Float]
1168
1163
  attr_accessor :average_length
1169
1164
 
1170
- # The maximum length of a string field in the sampled data. Optional if zero non-
1171
- # null rows.
1165
+ # Maximum length of non-null values in the scanned data.
1172
1166
  # Corresponds to the JSON property `maxLength`
1173
1167
  # @return [Fixnum]
1174
1168
  attr_accessor :max_length
1175
1169
 
1176
- # The minimum length of the string field in the sampled data. Optional if zero
1177
- # non-null rows.
1170
+ # Minimum length of non-null values in the scanned data.
1178
1171
  # Corresponds to the JSON property `minLength`
1179
1172
  # @return [Fixnum]
1180
1173
  attr_accessor :min_length
@@ -1191,16 +1184,16 @@ module Google
1191
1184
  end
1192
1185
  end
1193
1186
 
1194
- # The TopNValue defines the structure of output of top N values of a field.
1187
+ # Top N non-null values in the scanned data.
1195
1188
  class GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue
1196
1189
  include Google::Apis::Core::Hashable
1197
1190
 
1198
- # The frequency count of the corresponding value in the field.
1191
+ # Count of the corresponding value in the scanned data.
1199
1192
  # Corresponds to the JSON property `count`
1200
1193
  # @return [Fixnum]
1201
1194
  attr_accessor :count
1202
1195
 
1203
- # The value is the string value of the actual value from the field.
1196
+ # String value of a top N non-null value.
1204
1197
  # Corresponds to the JSON property `value`
1205
1198
  # @return [String]
1206
1199
  attr_accessor :value
@@ -1229,8 +1222,8 @@ module Google
1229
1222
  end
1230
1223
  end
1231
1224
 
1232
- # DataQualityDimensionResult provides a more detailed, per-dimension level view
1233
- # of the results.
1225
+ # DataQualityDimensionResult provides a more detailed, per-dimension view of the
1226
+ # results.
1234
1227
  class GoogleCloudDataplexV1DataQualityDimensionResult
1235
1228
  include Google::Apis::Core::Hashable
1236
1229
 
@@ -1254,7 +1247,7 @@ module Google
1254
1247
  class GoogleCloudDataplexV1DataQualityResult
1255
1248
  include Google::Apis::Core::Hashable
1256
1249
 
1257
- # A list of results at the dimension-level.
1250
+ # A list of results at the dimension level.
1258
1251
  # Corresponds to the JSON property `dimensions`
1259
1252
  # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1DataQualityDimensionResult>]
1260
1253
  attr_accessor :dimensions
@@ -1304,7 +1297,7 @@ module Google
1304
1297
  attr_accessor :column
1305
1298
 
1306
1299
  # Required. The dimension a rule belongs to. Results are also aggregated at the
1307
- # dimension-level. Supported dimensions are "COMPLETENESS", "ACCURACY", "
1300
+ # dimension level. Supported dimensions are "COMPLETENESS", "ACCURACY", "
1308
1301
  # CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY"
1309
1302
  # Corresponds to the JSON property `dimension`
1310
1303
  # @return [String]
@@ -1312,7 +1305,7 @@ module Google
1312
1305
 
1313
1306
  # Optional. Rows with null values will automatically fail a rule, unless
1314
1307
  # ignore_null is true. In that case, such null rows are trivially considered
1315
- # passing. Only applicable to ColumnMap rules.
1308
+ # passing.Only applicable to ColumnMap rules.
1316
1309
  # Corresponds to the JSON property `ignoreNull`
1317
1310
  # @return [Boolean]
1318
1311
  attr_accessor :ignore_null
@@ -1333,9 +1326,9 @@ module Google
1333
1326
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataQualityRuleRegexExpectation]
1334
1327
  attr_accessor :regex_expectation
1335
1328
 
1336
- # Evaluates whether each row passes the specified condition. The SQL expression
1337
- # needs to use BigQuery standard SQL syntax and should produce a boolean per row
1338
- # as the result. Example: col1 >= 0 AND col2 < 10
1329
+ # Evaluates whether each row passes the specified condition.The SQL expression
1330
+ # needs to use BigQuery standard SQL syntax and should produce a boolean value
1331
+ # per row as the result.Example: col1 >= 0 AND col2 < 10
1339
1332
  # Corresponds to the JSON property `rowConditionExpectation`
1340
1333
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation]
1341
1334
  attr_accessor :row_condition_expectation
@@ -1351,7 +1344,7 @@ module Google
1351
1344
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectation]
1352
1345
  attr_accessor :statistic_range_expectation
1353
1346
 
1354
- # Evaluates whether the provided expression is true. The SQL expression needs to
1347
+ # Evaluates whether the provided expression is true.The SQL expression needs to
1355
1348
  # use BigQuery standard SQL syntax and should produce a scalar boolean result.
1356
1349
  # Example: MIN(col1) >= 0
1357
1350
  # Corresponds to the JSON property `tableConditionExpectation`
@@ -1359,7 +1352,7 @@ module Google
1359
1352
  attr_accessor :table_condition_expectation
1360
1353
 
1361
1354
  # Optional. The minimum ratio of passing_rows / total_rows required to pass this
1362
- # rule, with a range of 0.0, 1.00 indicates default value (i.e. 1.0)
1355
+ # rule, with a range of 0.0, 1.0.0 indicates default value (i.e. 1.0).
1363
1356
  # Corresponds to the JSON property `threshold`
1364
1357
  # @return [Float]
1365
1358
  attr_accessor :threshold
@@ -1420,7 +1413,7 @@ module Google
1420
1413
  attr_accessor :min_value
1421
1414
 
1422
1415
  # Optional. Whether each value needs to be strictly lesser than ('<') the
1423
- # maximum, or if equality is allowed. Only relevant if a max_value has been
1416
+ # maximum, or if equality is allowed.Only relevant if a max_value has been
1424
1417
  # defined. Default = false.
1425
1418
  # Corresponds to the JSON property `strictMaxEnabled`
1426
1419
  # @return [Boolean]
@@ -1428,7 +1421,7 @@ module Google
1428
1421
  alias_method :strict_max_enabled?, :strict_max_enabled
1429
1422
 
1430
1423
  # Optional. Whether each value needs to be strictly greater than ('>') the
1431
- # minimum, or if equality is allowed. Only relevant if a min_value has been
1424
+ # minimum, or if equality is allowed.Only relevant if a min_value has been
1432
1425
  # defined. Default = false.
1433
1426
  # Corresponds to the JSON property `strictMinEnabled`
1434
1427
  # @return [Boolean]
@@ -1452,7 +1445,7 @@ module Google
1452
1445
  class GoogleCloudDataplexV1DataQualityRuleRegexExpectation
1453
1446
  include Google::Apis::Core::Hashable
1454
1447
 
1455
- #
1448
+ # A regular expression the column value is expected to match.
1456
1449
  # Corresponds to the JSON property `regex`
1457
1450
  # @return [String]
1458
1451
  attr_accessor :regex
@@ -1467,15 +1460,14 @@ module Google
1467
1460
  end
1468
1461
  end
1469
1462
 
1470
- # DataQualityRuleResult provides a more detailed, per-rule level view of the
1471
- # results.
1463
+ # DataQualityRuleResult provides a more detailed, per-rule view of the results.
1472
1464
  class GoogleCloudDataplexV1DataQualityRuleResult
1473
1465
  include Google::Apis::Core::Hashable
1474
1466
 
1475
1467
  # The number of rows a rule was evaluated against. This field is only valid for
1476
- # ColumnMap type rules. Evaluated count can be configured to either (1) include
1477
- # all rows (default) - with null rows automatically failing rule evaluation OR (
1478
- # 2) exclude null rows from the evaluated_count, by setting ignore_nulls = true
1468
+ # ColumnMap type rules.Evaluated count can be configured to either include all
1469
+ # rows (default) - with null rows automatically failing rule evaluation, or
1470
+ # exclude null rows from the evaluated_count, by setting ignore_nulls = true.
1479
1471
  # Corresponds to the JSON property `evaluatedCount`
1480
1472
  # @return [Fixnum]
1481
1473
  attr_accessor :evaluated_count
@@ -1530,13 +1522,13 @@ module Google
1530
1522
  end
1531
1523
  end
1532
1524
 
1533
- # Evaluates whether each row passes the specified condition. The SQL expression
1534
- # needs to use BigQuery standard SQL syntax and should produce a boolean per row
1535
- # as the result. Example: col1 >= 0 AND col2 < 10
1525
+ # Evaluates whether each row passes the specified condition.The SQL expression
1526
+ # needs to use BigQuery standard SQL syntax and should produce a boolean value
1527
+ # per row as the result.Example: col1 >= 0 AND col2 < 10
1536
1528
  class GoogleCloudDataplexV1DataQualityRuleRowConditionExpectation
1537
1529
  include Google::Apis::Core::Hashable
1538
1530
 
1539
- #
1531
+ # The SQL expression.
1540
1532
  # Corresponds to the JSON property `sqlExpression`
1541
1533
  # @return [String]
1542
1534
  attr_accessor :sql_expression
@@ -1555,7 +1547,7 @@ module Google
1555
1547
  class GoogleCloudDataplexV1DataQualityRuleSetExpectation
1556
1548
  include Google::Apis::Core::Hashable
1557
1549
 
1558
- #
1550
+ # Expected values for the column value.
1559
1551
  # Corresponds to the JSON property `values`
1560
1552
  # @return [Array<String>]
1561
1553
  attr_accessor :values
@@ -1593,7 +1585,7 @@ module Google
1593
1585
  attr_accessor :statistic
1594
1586
 
1595
1587
  # Whether column statistic needs to be strictly lesser than ('<') the maximum,
1596
- # or if equality is allowed. Only relevant if a max_value has been defined.
1588
+ # or if equality is allowed.Only relevant if a max_value has been defined.
1597
1589
  # Default = false.
1598
1590
  # Corresponds to the JSON property `strictMaxEnabled`
1599
1591
  # @return [Boolean]
@@ -1601,7 +1593,7 @@ module Google
1601
1593
  alias_method :strict_max_enabled?, :strict_max_enabled
1602
1594
 
1603
1595
  # Whether column statistic needs to be strictly greater than ('>') the minimum,
1604
- # or if equality is allowed. Only relevant if a min_value has been defined.
1596
+ # or if equality is allowed.Only relevant if a min_value has been defined.
1605
1597
  # Default = false.
1606
1598
  # Corresponds to the JSON property `strictMinEnabled`
1607
1599
  # @return [Boolean]
@@ -1622,13 +1614,13 @@ module Google
1622
1614
  end
1623
1615
  end
1624
1616
 
1625
- # Evaluates whether the provided expression is true. The SQL expression needs to
1617
+ # Evaluates whether the provided expression is true.The SQL expression needs to
1626
1618
  # use BigQuery standard SQL syntax and should produce a scalar boolean result.
1627
1619
  # Example: MIN(col1) >= 0
1628
1620
  class GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation
1629
1621
  include Google::Apis::Core::Hashable
1630
1622
 
1631
- #
1623
+ # The SQL expression.
1632
1624
  # Corresponds to the JSON property `sqlExpression`
1633
1625
  # @return [String]
1634
1626
  attr_accessor :sql_expression
@@ -1677,8 +1669,8 @@ module Google
1677
1669
  end
1678
1670
 
1679
1671
  # Represents a user-visible job which provides the insights for the related data
1680
- # source. For examples: - Data Quality: generates queries based on the rules and
1681
- # run against the data to get data quality check results. - Data Profile:
1672
+ # source.For example: Data Quality: generates queries based on the rules and
1673
+ # runs against the data to get data quality check results. Data Profile:
1682
1674
  # analyzes the data in table(s) and generates insights about the structure,
1683
1675
  # content and relationships (such as null percent, cardinality, min/max/mean,
1684
1676
  # etc).
@@ -1716,12 +1708,12 @@ module Google
1716
1708
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataQualitySpec]
1717
1709
  attr_accessor :data_quality_spec
1718
1710
 
1719
- # Optional. Description of the scan. * Must be between 1-1024 characters.
1711
+ # Optional. Description of the scan. Must be between 1-1024 characters.
1720
1712
  # Corresponds to the JSON property `description`
1721
1713
  # @return [String]
1722
1714
  attr_accessor :description
1723
1715
 
1724
- # Optional. User friendly display name. * Must be between 1-256 characters.
1716
+ # Optional. User friendly display name. Must be between 1-256 characters.
1725
1717
  # Corresponds to the JSON property `displayName`
1726
1718
  # @return [String]
1727
1719
  attr_accessor :display_name
@@ -1742,9 +1734,8 @@ module Google
1742
1734
  attr_accessor :labels
1743
1735
 
1744
1736
  # Output only. The relative resource name of the scan, of the form: projects/`
1745
- # project`/locations/`location_id`/dataScans/`datascan_id`. where `project`
1746
- # refers to a project_id or project_number and location_id refers to a GCP
1747
- # region.
1737
+ # project`/locations/`location_id`/dataScans/`datascan_id`, where project refers
1738
+ # to a project_id or project_number and location_id refers to a GCP region.
1748
1739
  # Corresponds to the JSON property `name`
1749
1740
  # @return [String]
1750
1741
  attr_accessor :name
@@ -1938,8 +1929,9 @@ module Google
1938
1929
  class GoogleCloudDataplexV1DataScanExecutionSpec
1939
1930
  include Google::Apis::Core::Hashable
1940
1931
 
1941
- # Immutable. The unnested field (Date or Timestamp) that contains values that
1942
- # monotonically increase over time.
1932
+ # Immutable. The unnested field (of type Date or Timestamp) that contains values
1933
+ # which monotonically increase over time.If not specified, a data scan will run
1934
+ # for all data in the table.
1943
1935
  # Corresponds to the JSON property `field`
1944
1936
  # @return [String]
1945
1937
  attr_accessor :field
@@ -1985,7 +1977,7 @@ module Google
1985
1977
  end
1986
1978
  end
1987
1979
 
1988
- # A DataScanJob represents an instance of a data scan.
1980
+ # A DataScanJob represents an instance of DataScan execution.
1989
1981
  class GoogleCloudDataplexV1DataScanJob
1990
1982
  include Google::Apis::Core::Hashable
1991
1983
 
@@ -2022,7 +2014,7 @@ module Google
2022
2014
 
2023
2015
  # Output only. The relative resource name of the DataScanJob, of the form:
2024
2016
  # projects/`project`/locations/`location_id`/dataScans/`datascan_id`/jobs/`
2025
- # job_id`. where `project` refers to a project_id or project_number and
2017
+ # job_id`, where project refers to a project_id or project_number and
2026
2018
  # location_id refers to a GCP region.
2027
2019
  # Corresponds to the JSON property `name`
2028
2020
  # @return [String]
@@ -2072,9 +2064,9 @@ module Google
2072
2064
  class GoogleCloudDataplexV1DataSource
2073
2065
  include Google::Apis::Core::Hashable
2074
2066
 
2075
- # Immutable. The dataplex entity that contains the data for DataScan, of the
2076
- # form: projects/`project_number`/locations/`location_id`/lakes/`lake_id`/zones/`
2077
- # zone_id`/entities/`entity_id`.
2067
+ # Immutable. The Dataplex entity that represents the data source (e.g. BigQuery
2068
+ # table) for DataScan, of the form: projects/`project_number`/locations/`
2069
+ # location_id`/lakes/`lake_id`/zones/`zone_id`/entities/`entity_id`.
2078
2070
  # Corresponds to the JSON property `entity`
2079
2071
  # @return [String]
2080
2072
  attr_accessor :entity
@@ -2365,6 +2357,12 @@ module Google
2365
2357
  # @return [String]
2366
2358
  attr_accessor :type
2367
2359
 
2360
+ # Output only. System generated unique ID for the Entity. This ID will be
2361
+ # different if the Entity is deleted and re-created with the same name.
2362
+ # Corresponds to the JSON property `uid`
2363
+ # @return [String]
2364
+ attr_accessor :uid
2365
+
2368
2366
  # Output only. The time when the entity was last updated.
2369
2367
  # Corresponds to the JSON property `updateTime`
2370
2368
  # @return [String]
@@ -2392,6 +2390,7 @@ module Google
2392
2390
  @schema = args[:schema] if args.key?(:schema)
2393
2391
  @system = args[:system] if args.key?(:system)
2394
2392
  @type = args[:type] if args.key?(:type)
2393
+ @uid = args[:uid] if args.key?(:uid)
2395
2394
  @update_time = args[:update_time] if args.key?(:update_time)
2396
2395
  end
2397
2396
  end
@@ -3089,7 +3088,7 @@ module Google
3089
3088
  class GoogleCloudDataplexV1ListDataScanJobsResponse
3090
3089
  include Google::Apis::Core::Hashable
3091
3090
 
3092
- # DataScanJobs (metadata only) under a given dataScan.
3091
+ # DataScanJobs (BASIC view only) under a given dataScan.
3093
3092
  # Corresponds to the JSON property `dataScanJobs`
3094
3093
  # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1DataScanJob>]
3095
3094
  attr_accessor :data_scan_jobs
@@ -3115,7 +3114,7 @@ module Google
3115
3114
  class GoogleCloudDataplexV1ListDataScansResponse
3116
3115
  include Google::Apis::Core::Hashable
3117
3116
 
3118
- # DataScans (metadata only) under the given parent location.
3117
+ # DataScans (BASIC view only) under the given parent location.
3119
3118
  # Corresponds to the JSON property `dataScans`
3120
3119
  # @return [Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1DataScan>]
3121
3120
  attr_accessor :data_scans
@@ -3482,7 +3481,7 @@ module Google
3482
3481
  class GoogleCloudDataplexV1RunDataScanResponse
3483
3482
  include Google::Apis::Core::Hashable
3484
3483
 
3485
- # A DataScanJob represents an instance of a data scan.
3484
+ # A DataScanJob represents an instance of DataScan execution.
3486
3485
  # Corresponds to the JSON property `job`
3487
3486
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataScanJob]
3488
3487
  attr_accessor :job
@@ -3552,18 +3551,18 @@ module Google
3552
3551
  class GoogleCloudDataplexV1ScannedDataIncrementalField
3553
3552
  include Google::Apis::Core::Hashable
3554
3553
 
3555
- # Value that marks the end of the range
3554
+ # Value that marks the end of the range.
3556
3555
  # Corresponds to the JSON property `end`
3557
3556
  # @return [String]
3558
3557
  attr_accessor :end
3559
3558
 
3560
- # The field that contains values which monotonically increases over time (e.g.
3561
- # timestamp).
3559
+ # The field that contains values which monotonically increases over time (e.g. a
3560
+ # timestamp column).
3562
3561
  # Corresponds to the JSON property `field`
3563
3562
  # @return [String]
3564
3563
  attr_accessor :field
3565
3564
 
3566
- # Value that marks the start of the range
3565
+ # Value that marks the start of the range.
3567
3566
  # Corresponds to the JSON property `start`
3568
3567
  # @return [String]
3569
3568
  attr_accessor :start
@@ -4458,8 +4457,8 @@ module Google
4458
4457
  # periodically. To explicitly set a timezone to the cron tab, apply a prefix in
4459
4458
  # the cron tab: "CRON_TZ=$`IANA_TIME_ZONE`" or "TZ=$`IANA_TIME_ZONE`". The $`
4460
4459
  # IANA_TIME_ZONE` may only be a valid string from IANA time zone database. For
4461
- # example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * *
4462
- # *". This field is required for RECURRING tasks.
4460
+ # example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *.
4461
+ # This field is required for RECURRING tasks.
4463
4462
  # Corresponds to the JSON property `schedule`
4464
4463
  # @return [String]
4465
4464
  attr_accessor :schedule
@@ -4494,7 +4493,7 @@ module Google
4494
4493
  class GoogleCloudDataplexV1Trigger
4495
4494
  include Google::Apis::Core::Hashable
4496
4495
 
4497
- # The scan runs one-time via RunDataScan API.
4496
+ # The scan runs once via RunDataScan API.
4498
4497
  # Corresponds to the JSON property `onDemand`
4499
4498
  # @return [Google::Apis::DataplexV1::GoogleCloudDataplexV1TriggerOnDemand]
4500
4499
  attr_accessor :on_demand
@@ -4515,7 +4514,7 @@ module Google
4515
4514
  end
4516
4515
  end
4517
4516
 
4518
- # The scan runs one-time via RunDataScan API.
4517
+ # The scan runs once via RunDataScan API.
4519
4518
  class GoogleCloudDataplexV1TriggerOnDemand
4520
4519
  include Google::Apis::Core::Hashable
4521
4520
 
@@ -4532,12 +4531,13 @@ module Google
4532
4531
  class GoogleCloudDataplexV1TriggerSchedule
4533
4532
  include Google::Apis::Core::Hashable
4534
4533
 
4535
- # Required. Cron schedule (https://en.wikipedia.org/wiki/Cron) for running scans
4536
- # periodically. To explicitly set a timezone to the cron tab, apply a prefix in
4534
+ # Required. Cron (https://en.wikipedia.org/wiki/Cron) schedule for running scans
4535
+ # periodically.To explicitly set a timezone in the cron tab, apply a prefix in
4537
4536
  # the cron tab: "CRON_TZ=$`IANA_TIME_ZONE`" or "TZ=$`IANA_TIME_ZONE`". The $`
4538
- # IANA_TIME_ZONE` may only be a valid string from IANA time zone database. For
4539
- # example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * *
4540
- # *". This field is required for Schedule scans.
4537
+ # IANA_TIME_ZONE` may only be a valid string from IANA time zone database (
4538
+ # wikipedia (https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List)).
4539
+ # For example, CRON_TZ=America/New_York 1 * * * *, or TZ=America/New_York 1 * *
4540
+ # * *.This field is required for Schedule scans.
4541
4541
  # Corresponds to the JSON property `cron`
4542
4542
  # @return [String]
4543
4543
  attr_accessor :cron
@@ -4684,8 +4684,8 @@ module Google
4684
4684
  # 60 minutes apart. The default value is to run discovery every 60 minutes. To
4685
4685
  # explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "
4686
4686
  # CRON_TZ=$`IANA_TIME_ZONE`" or TZ=$`IANA_TIME_ZONE`". The $`IANA_TIME_ZONE` may
4687
- # only be a valid string from IANA time zone database. For example, "CRON_TZ=
4688
- # America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".
4687
+ # only be a valid string from IANA time zone database. For example, CRON_TZ=
4688
+ # America/New_York 1 * * * *, or TZ=America/New_York 1 * * * *.
4689
4689
  # Corresponds to the JSON property `schedule`
4690
4690
  # @return [String]
4691
4691
  attr_accessor :schedule
@@ -16,13 +16,13 @@ module Google
16
16
  module Apis
17
17
  module DataplexV1
18
18
  # Version of the google-apis-dataplex_v1 gem
19
- GEM_VERSION = "0.19.0"
19
+ GEM_VERSION = "0.20.0"
20
20
 
21
21
  # Version of the code generator used to generate this client
22
- GENERATOR_VERSION = "0.11.0"
22
+ GENERATOR_VERSION = "0.11.1"
23
23
 
24
24
  # Revision of the discovery document this client was generated from
25
- REVISION = "20221212"
25
+ REVISION = "20230102"
26
26
  end
27
27
  end
28
28
  end
@@ -1503,6 +1503,7 @@ module Google
1503
1503
 
1504
1504
  property :system, as: 'system'
1505
1505
  property :type, as: 'type'
1506
+ property :uid, as: 'uid'
1506
1507
  property :update_time, as: 'updateTime'
1507
1508
  end
1508
1509
  end
@@ -243,17 +243,17 @@ module Google
243
243
  execute_or_queue_command(command, &block)
244
244
  end
245
245
 
246
- # Creates a dataScan resource.
246
+ # Creates a DataScan resource.
247
247
  # @param [String] parent
248
248
  # Required. The resource name of the parent location: projects/`project`/
249
- # locations/`location_id` where `project` refers to a project_id or
250
- # project_number and location_id refers to a GCP region.
249
+ # locations/`location_id` where project refers to a project_id or project_number
250
+ # and location_id refers to a GCP region.
251
251
  # @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataScan] google_cloud_dataplex_v1_data_scan_object
252
252
  # @param [String] data_scan_id
253
- # Required. DataScan identifier. * Must contain only lowercase letters, numbers
254
- # and hyphens. * Must start with a letter. * Must end with a number or a letter.
255
- # * Must be between 1-63 characters. * Must be unique within the customer
256
- # project / location.
253
+ # Required. DataScan identifier. Must contain only lowercase letters, numbers
254
+ # and hyphens. Must start with a letter. Must end with a number or a letter.
255
+ # Must be between 1-63 characters. Must be unique within the customer project /
256
+ # location.
257
257
  # @param [String] fields
258
258
  # Selector specifying which fields to include in a partial response.
259
259
  # @param [String] quota_user
@@ -284,11 +284,11 @@ module Google
284
284
  execute_or_queue_command(command, &block)
285
285
  end
286
286
 
287
- # Delete the dataScan resource.
287
+ # Deletes a DataScan resource.
288
288
  # @param [String] name
289
289
  # Required. The resource name of the dataScan: projects/`project`/locations/`
290
- # location_id`/dataScans/`data_scan_id` where `project` refers to a project_id
291
- # or project_number and location_id refers to a GCP region.
290
+ # location_id`/dataScans/`data_scan_id` where project refers to a project_id or
291
+ # project_number and location_id refers to a GCP region.
292
292
  # @param [String] fields
293
293
  # Selector specifying which fields to include in a partial response.
294
294
  # @param [String] quota_user
@@ -316,14 +316,13 @@ module Google
316
316
  execute_or_queue_command(command, &block)
317
317
  end
318
318
 
319
- # Get dataScan resource.
319
+ # Gets a DataScan resource.
320
320
  # @param [String] name
321
321
  # Required. The resource name of the dataScan: projects/`project`/locations/`
322
- # location_id`/dataScans/`data_scan_id` where `project` refers to a project_id
323
- # or project_number and location_id refers to a GCP region.
322
+ # location_id`/dataScans/`data_scan_id` where project refers to a project_id or
323
+ # project_number and location_id refers to a GCP region.
324
324
  # @param [String] view
325
- # Optional. Used to select the subset of DataScan information to return.
326
- # Defaults to BASIC.
325
+ # Optional. Select the DataScan view to return. Defaults to BASIC.
327
326
  # @param [String] fields
328
327
  # Selector specifying which fields to include in a partial response.
329
328
  # @param [String] quota_user
@@ -397,10 +396,11 @@ module Google
397
396
  execute_or_queue_command(command, &block)
398
397
  end
399
398
 
400
- # Lists dataScans.
399
+ # Lists DataScans.
401
400
  # @param [String] parent
402
- # Required. projects/`project`/locations/`location_id` where `project` refers to
403
- # a project_id or project_number and location_id refers to a GCP region.
401
+ # Required. The resource name of the parent location: projects/`project`/
402
+ # locations/`location_id` where project refers to a project_id or project_number
403
+ # and location_id refers to a GCP region.
404
404
  # @param [String] filter
405
405
  # Optional. Filter request.
406
406
  # @param [String] order_by
@@ -445,12 +445,11 @@ module Google
445
445
  execute_or_queue_command(command, &block)
446
446
  end
447
447
 
448
- # Update the dataScan resource.
448
+ # Updates a DataScan resource.
449
449
  # @param [String] name
450
450
  # Output only. The relative resource name of the scan, of the form: projects/`
451
- # project`/locations/`location_id`/dataScans/`datascan_id`. where `project`
452
- # refers to a project_id or project_number and location_id refers to a GCP
453
- # region.
451
+ # project`/locations/`location_id`/dataScans/`datascan_id`, where project refers
452
+ # to a project_id or project_number and location_id refers to a GCP region.
454
453
  # @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1DataScan] google_cloud_dataplex_v1_data_scan_object
455
454
  # @param [String] update_mask
456
455
  # Required. Mask of fields to update.
@@ -484,12 +483,12 @@ module Google
484
483
  execute_or_queue_command(command, &block)
485
484
  end
486
485
 
487
- # Run an on demand execution of a DataScan.
486
+ # Runs an on-demand execution of a DataScan
488
487
  # @param [String] name
489
488
  # Required. The resource name of the DataScan: projects/`project`/locations/`
490
- # location_id`/dataScans/`data_scan_id`. where `project` refers to a project_id
491
- # or project_number and location_id refers to a GCP region. Only on-demand
492
- # DataScans are allowed.
489
+ # location_id`/dataScans/`data_scan_id`. where project refers to a project_id or
490
+ # project_number and location_id refers to a GCP region.Only OnDemand data scans
491
+ # are allowed.
493
492
  # @param [Google::Apis::DataplexV1::GoogleCloudDataplexV1RunDataScanRequest] google_cloud_dataplex_v1_run_data_scan_request_object
494
493
  # @param [String] fields
495
494
  # Selector specifying which fields to include in a partial response.
@@ -596,15 +595,14 @@ module Google
596
595
  execute_or_queue_command(command, &block)
597
596
  end
598
597
 
599
- # Get DataScanJob resource.
598
+ # Gets a DataScanJob resource.
600
599
  # @param [String] name
601
600
  # Required. The resource name of the DataScanJob: projects/`project`/locations/`
602
- # location_id`/dataScans/`data_scan_id`/dataScanJobs/`data_scan_job_id` where `
603
- # project` refers to a project_id or project_number and location_id refers to a
601
+ # location_id`/dataScans/`data_scan_id`/dataScanJobs/`data_scan_job_id` where
602
+ # project refers to a project_id or project_number and location_id refers to a
604
603
  # GCP region.
605
604
  # @param [String] view
606
- # Optional. Used to select the subset of DataScan information to return.
607
- # Defaults to BASIC.
605
+ # Optional. Select the DataScanJob view to return. Defaults to BASIC.
608
606
  # @param [String] fields
609
607
  # Selector specifying which fields to include in a partial response.
610
608
  # @param [String] quota_user
@@ -633,10 +631,10 @@ module Google
633
631
  execute_or_queue_command(command, &block)
634
632
  end
635
633
 
636
- # Lists DataScanJobs under the given dataScan.
634
+ # Lists DataScanJobs under the given DataScan.
637
635
  # @param [String] parent
638
636
  # Required. The resource name of the parent environment: projects/`project`/
639
- # locations/`location_id`/dataScans/`data_scan_id` where `project` refers to a
637
+ # locations/`location_id`/dataScans/`data_scan_id` where project refers to a
640
638
  # project_id or project_number and location_id refers to a GCP region.
641
639
  # @param [Fixnum] page_size
642
640
  # Optional. Maximum number of DataScanJobs to return. The service may return
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-dataplex_v1
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.19.0
4
+ version: 0.20.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-01-04 00:00:00.000000000 Z
11
+ date: 2023-01-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-dataplex_v1/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-dataplex_v1/v0.19.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-dataplex_v1/v0.20.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-dataplex_v1
63
63
  post_install_message:
64
64
  rdoc_options: []
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
75
75
  - !ruby/object:Gem::Version
76
76
  version: '0'
77
77
  requirements: []
78
- rubygems_version: 3.3.14
78
+ rubygems_version: 3.4.2
79
79
  signing_key:
80
80
  specification_version: 4
81
81
  summary: Simple REST client for Cloud Dataplex API V1