Class: Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dataplex/v1/data_profile.rb

Overview

The profile information for each field type.

Defined Under Namespace

Classes: DoubleFieldInfo, IntegerFieldInfo, StringFieldInfo, TopNValue

Instance Attribute Summary collapse

Instance Attribute Details

#distinct_ratio ⇒ ::Float (readonly)

Returns Output only. Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode.

Returns:

  • (::Float) —

    Output only. Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode.



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
 
# File 'proto_docs/google/cloud/dataplex/v1/data_profile.rb', line 182

class ProfileInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The profile information for a string type field.
  # @!attribute [r] min_length
  #   @return [::Integer]
  #     Output only. Minimum length of non-null values in the scanned data.
  # @!attribute [r] max_length
  #   @return [::Integer]
  #     Output only. Maximum length of non-null values in the scanned data.
  # @!attribute [r] average_length
  #   @return [::Float]
  #     Output only. Average length of non-null values in the scanned data.
  class StringFieldInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The profile information for an integer type field.
  # @!attribute [r] average
  #   @return [::Float]
  #     Output only. Average of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  # @!attribute [r] standard_deviation
  #   @return [::Float]
  #     Output only. Standard deviation of non-null values in the scanned
  #     data. NaN, if the field has a NaN.
  # @!attribute [r] min
  #   @return [::Integer]
  #     Output only. Minimum of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  # @!attribute [r] quartiles
  #   @return [::Array<::Integer>]
  #     Output only. A quartile divides the number of data points into four
  #     parts, or quarters, of more-or-less equal size. Three main
  #     quartiles used are: The first quartile (Q1) splits off the lowest
  #     25% of data from the highest 75%. It is also known as the lower or
  #     25th empirical quartile, as 25% of the data is below this point.
  #     The second quartile (Q2) is the median of a data set. So, 50% of
  #     the data lies below this point. The third quartile (Q3) splits off
  #     the highest 25% of data from the lowest 75%. It is known as the
  #     upper or 75th empirical quartile, as 75% of the data lies below
  #     this point. Here, the quartiles is provided as an ordered list of
  #     approximate quartile values for the scanned data, occurring in
  #     order Q1, median, Q3.
  # @!attribute [r] max
  #   @return [::Integer]
  #     Output only. Maximum of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  class IntegerFieldInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The profile information for a double type field.
  # @!attribute [r] average
  #   @return [::Float]
  #     Output only. Average of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  # @!attribute [r] standard_deviation
  #   @return [::Float]
  #     Output only. Standard deviation of non-null values in the scanned
  #     data. NaN, if the field has a NaN.
  # @!attribute [r] min
  #   @return [::Float]
  #     Output only. Minimum of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  # @!attribute [r] quartiles
  #   @return [::Array<::Float>]
  #     Output only. A quartile divides the number of data points into four
  #     parts, or quarters, of more-or-less equal size. Three main
  #     quartiles used are: The first quartile (Q1) splits off the lowest
  #     25% of data from the highest 75%. It is also known as the lower or
  #     25th empirical quartile, as 25% of the data is below this point.
  #     The second quartile (Q2) is the median of a data set. So, 50% of
  #     the data lies below this point. The third quartile (Q3) splits off
  #     the highest 25% of data from the lowest 75%. It is known as the
  #     upper or 75th empirical quartile, as 75% of the data lies below
  #     this point. Here, the quartiles is provided as an ordered list of
  #     quartile values for the scanned data, occurring in order Q1,
  #     median, Q3.
  # @!attribute [r] max
  #   @return [::Float]
  #     Output only. Maximum of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  class DoubleFieldInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Top N non-null values in the scanned data.
  # @!attribute [r] value
  #   @return [::String]
  #     Output only. String value of a top N non-null value.
  # @!attribute [r] count
  #   @return [::Integer]
  #     Output only. Count of the corresponding value in the scanned data.
  # @!attribute [r] ratio
  #   @return [::Float]
  #     Output only. Ratio of the corresponding value in the field against
  #     the total number of rows in the scanned data.
  class TopNValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#double_profile ⇒ ::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo::DoubleFieldInfo

Returns Double type field information.

Note: The following fields are mutually exclusive: double_profile, string_profile, integer_profile. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



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
 
# File 'proto_docs/google/cloud/dataplex/v1/data_profile.rb', line 182

class ProfileInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The profile information for a string type field.
  # @!attribute [r] min_length
  #   @return [::Integer]
  #     Output only. Minimum length of non-null values in the scanned data.
  # @!attribute [r] max_length
  #   @return [::Integer]
  #     Output only. Maximum length of non-null values in the scanned data.
  # @!attribute [r] average_length
  #   @return [::Float]
  #     Output only. Average length of non-null values in the scanned data.
  class StringFieldInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The profile information for an integer type field.
  # @!attribute [r] average
  #   @return [::Float]
  #     Output only. Average of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  # @!attribute [r] standard_deviation
  #   @return [::Float]
  #     Output only. Standard deviation of non-null values in the scanned
  #     data. NaN, if the field has a NaN.
  # @!attribute [r] min
  #   @return [::Integer]
  #     Output only. Minimum of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  # @!attribute [r] quartiles
  #   @return [::Array<::Integer>]
  #     Output only. A quartile divides the number of data points into four
  #     parts, or quarters, of more-or-less equal size. Three main
  #     quartiles used are: The first quartile (Q1) splits off the lowest
  #     25% of data from the highest 75%. It is also known as the lower or
  #     25th empirical quartile, as 25% of the data is below this point.
  #     The second quartile (Q2) is the median of a data set. So, 50% of
  #     the data lies below this point. The third quartile (Q3) splits off
  #     the highest 25% of data from the lowest 75%. It is known as the
  #     upper or 75th empirical quartile, as 75% of the data lies below
  #     this point. Here, the quartiles is provided as an ordered list of
  #     approximate quartile values for the scanned data, occurring in
  #     order Q1, median, Q3.
  # @!attribute [r] max
  #   @return [::Integer]
  #     Output only. Maximum of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  class IntegerFieldInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The profile information for a double type field.
  # @!attribute [r] average
  #   @return [::Float]
  #     Output only. Average of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  # @!attribute [r] standard_deviation
  #   @return [::Float]
  #     Output only. Standard deviation of non-null values in the scanned
  #     data. NaN, if the field has a NaN.
  # @!attribute [r] min
  #   @return [::Float]
  #     Output only. Minimum of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  # @!attribute [r] quartiles
  #   @return [::Array<::Float>]
  #     Output only. A quartile divides the number of data points into four
  #     parts, or quarters, of more-or-less equal size. Three main
  #     quartiles used are: The first quartile (Q1) splits off the lowest
  #     25% of data from the highest 75%. It is also known as the lower or
  #     25th empirical quartile, as 25% of the data is below this point.
  #     The second quartile (Q2) is the median of a data set. So, 50% of
  #     the data lies below this point. The third quartile (Q3) splits off
  #     the highest 25% of data from the lowest 75%. It is known as the
  #     upper or 75th empirical quartile, as 75% of the data lies below
  #     this point. Here, the quartiles is provided as an ordered list of
  #     quartile values for the scanned data, occurring in order Q1,
  #     median, Q3.
  # @!attribute [r] max
  #   @return [::Float]
  #     Output only. Maximum of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  class DoubleFieldInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Top N non-null values in the scanned data.
  # @!attribute [r] value
  #   @return [::String]
  #     Output only. String value of a top N non-null value.
  # @!attribute [r] count
  #   @return [::Integer]
  #     Output only. Count of the corresponding value in the scanned data.
  # @!attribute [r] ratio
  #   @return [::Float]
  #     Output only. Ratio of the corresponding value in the field against
  #     the total number of rows in the scanned data.
  class TopNValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#integer_profile ⇒ ::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo::IntegerFieldInfo

Returns Integer type field information.

Note: The following fields are mutually exclusive: integer_profile, string_profile, double_profile. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



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
 
# File 'proto_docs/google/cloud/dataplex/v1/data_profile.rb', line 182

class ProfileInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The profile information for a string type field.
  # @!attribute [r] min_length
  #   @return [::Integer]
  #     Output only. Minimum length of non-null values in the scanned data.
  # @!attribute [r] max_length
  #   @return [::Integer]
  #     Output only. Maximum length of non-null values in the scanned data.
  # @!attribute [r] average_length
  #   @return [::Float]
  #     Output only. Average length of non-null values in the scanned data.
  class StringFieldInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The profile information for an integer type field.
  # @!attribute [r] average
  #   @return [::Float]
  #     Output only. Average of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  # @!attribute [r] standard_deviation
  #   @return [::Float]
  #     Output only. Standard deviation of non-null values in the scanned
  #     data. NaN, if the field has a NaN.
  # @!attribute [r] min
  #   @return [::Integer]
  #     Output only. Minimum of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  # @!attribute [r] quartiles
  #   @return [::Array<::Integer>]
  #     Output only. A quartile divides the number of data points into four
  #     parts, or quarters, of more-or-less equal size. Three main
  #     quartiles used are: The first quartile (Q1) splits off the lowest
  #     25% of data from the highest 75%. It is also known as the lower or
  #     25th empirical quartile, as 25% of the data is below this point.
  #     The second quartile (Q2) is the median of a data set. So, 50% of
  #     the data lies below this point. The third quartile (Q3) splits off
  #     the highest 25% of data from the lowest 75%. It is known as the
  #     upper or 75th empirical quartile, as 75% of the data lies below
  #     this point. Here, the quartiles is provided as an ordered list of
  #     approximate quartile values for the scanned data, occurring in
  #     order Q1, median, Q3.
  # @!attribute [r] max
  #   @return [::Integer]
  #     Output only. Maximum of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  class IntegerFieldInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The profile information for a double type field.
  # @!attribute [r] average
  #   @return [::Float]
  #     Output only. Average of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  # @!attribute [r] standard_deviation
  #   @return [::Float]
  #     Output only. Standard deviation of non-null values in the scanned
  #     data. NaN, if the field has a NaN.
  # @!attribute [r] min
  #   @return [::Float]
  #     Output only. Minimum of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  # @!attribute [r] quartiles
  #   @return [::Array<::Float>]
  #     Output only. A quartile divides the number of data points into four
  #     parts, or quarters, of more-or-less equal size. Three main
  #     quartiles used are: The first quartile (Q1) splits off the lowest
  #     25% of data from the highest 75%. It is also known as the lower or
  #     25th empirical quartile, as 25% of the data is below this point.
  #     The second quartile (Q2) is the median of a data set. So, 50% of
  #     the data lies below this point. The third quartile (Q3) splits off
  #     the highest 25% of data from the lowest 75%. It is known as the
  #     upper or 75th empirical quartile, as 75% of the data lies below
  #     this point. Here, the quartiles is provided as an ordered list of
  #     quartile values for the scanned data, occurring in order Q1,
  #     median, Q3.
  # @!attribute [r] max
  #   @return [::Float]
  #     Output only. Maximum of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  class DoubleFieldInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Top N non-null values in the scanned data.
  # @!attribute [r] value
  #   @return [::String]
  #     Output only. String value of a top N non-null value.
  # @!attribute [r] count
  #   @return [::Integer]
  #     Output only. Count of the corresponding value in the scanned data.
  # @!attribute [r] ratio
  #   @return [::Float]
  #     Output only. Ratio of the corresponding value in the field against
  #     the total number of rows in the scanned data.
  class TopNValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#null_ratio ⇒ ::Float (readonly)

Returns Output only. Ratio of rows with null value against total scanned rows.

Returns:

  • (::Float) —

    Output only. Ratio of rows with null value against total scanned rows.



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
 
# File 'proto_docs/google/cloud/dataplex/v1/data_profile.rb', line 182

class ProfileInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The profile information for a string type field.
  # @!attribute [r] min_length
  #   @return [::Integer]
  #     Output only. Minimum length of non-null values in the scanned data.
  # @!attribute [r] max_length
  #   @return [::Integer]
  #     Output only. Maximum length of non-null values in the scanned data.
  # @!attribute [r] average_length
  #   @return [::Float]
  #     Output only. Average length of non-null values in the scanned data.
  class StringFieldInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The profile information for an integer type field.
  # @!attribute [r] average
  #   @return [::Float]
  #     Output only. Average of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  # @!attribute [r] standard_deviation
  #   @return [::Float]
  #     Output only. Standard deviation of non-null values in the scanned
  #     data. NaN, if the field has a NaN.
  # @!attribute [r] min
  #   @return [::Integer]
  #     Output only. Minimum of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  # @!attribute [r] quartiles
  #   @return [::Array<::Integer>]
  #     Output only. A quartile divides the number of data points into four
  #     parts, or quarters, of more-or-less equal size. Three main
  #     quartiles used are: The first quartile (Q1) splits off the lowest
  #     25% of data from the highest 75%. It is also known as the lower or
  #     25th empirical quartile, as 25% of the data is below this point.
  #     The second quartile (Q2) is the median of a data set. So, 50% of
  #     the data lies below this point. The third quartile (Q3) splits off
  #     the highest 25% of data from the lowest 75%. It is known as the
  #     upper or 75th empirical quartile, as 75% of the data lies below
  #     this point. Here, the quartiles is provided as an ordered list of
  #     approximate quartile values for the scanned data, occurring in
  #     order Q1, median, Q3.
  # @!attribute [r] max
  #   @return [::Integer]
  #     Output only. Maximum of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  class IntegerFieldInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The profile information for a double type field.
  # @!attribute [r] average
  #   @return [::Float]
  #     Output only. Average of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  # @!attribute [r] standard_deviation
  #   @return [::Float]
  #     Output only. Standard deviation of non-null values in the scanned
  #     data. NaN, if the field has a NaN.
  # @!attribute [r] min
  #   @return [::Float]
  #     Output only. Minimum of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  # @!attribute [r] quartiles
  #   @return [::Array<::Float>]
  #     Output only. A quartile divides the number of data points into four
  #     parts, or quarters, of more-or-less equal size. Three main
  #     quartiles used are: The first quartile (Q1) splits off the lowest
  #     25% of data from the highest 75%. It is also known as the lower or
  #     25th empirical quartile, as 25% of the data is below this point.
  #     The second quartile (Q2) is the median of a data set. So, 50% of
  #     the data lies below this point. The third quartile (Q3) splits off
  #     the highest 25% of data from the lowest 75%. It is known as the
  #     upper or 75th empirical quartile, as 75% of the data lies below
  #     this point. Here, the quartiles is provided as an ordered list of
  #     quartile values for the scanned data, occurring in order Q1,
  #     median, Q3.
  # @!attribute [r] max
  #   @return [::Float]
  #     Output only. Maximum of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  class DoubleFieldInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Top N non-null values in the scanned data.
  # @!attribute [r] value
  #   @return [::String]
  #     Output only. String value of a top N non-null value.
  # @!attribute [r] count
  #   @return [::Integer]
  #     Output only. Count of the corresponding value in the scanned data.
  # @!attribute [r] ratio
  #   @return [::Float]
  #     Output only. Ratio of the corresponding value in the field against
  #     the total number of rows in the scanned data.
  class TopNValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#string_profile ⇒ ::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo::StringFieldInfo

Returns String type field information.

Note: The following fields are mutually exclusive: string_profile, integer_profile, double_profile. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:



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
 
# File 'proto_docs/google/cloud/dataplex/v1/data_profile.rb', line 182

class ProfileInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The profile information for a string type field.
  # @!attribute [r] min_length
  #   @return [::Integer]
  #     Output only. Minimum length of non-null values in the scanned data.
  # @!attribute [r] max_length
  #   @return [::Integer]
  #     Output only. Maximum length of non-null values in the scanned data.
  # @!attribute [r] average_length
  #   @return [::Float]
  #     Output only. Average length of non-null values in the scanned data.
  class StringFieldInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The profile information for an integer type field.
  # @!attribute [r] average
  #   @return [::Float]
  #     Output only. Average of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  # @!attribute [r] standard_deviation
  #   @return [::Float]
  #     Output only. Standard deviation of non-null values in the scanned
  #     data. NaN, if the field has a NaN.
  # @!attribute [r] min
  #   @return [::Integer]
  #     Output only. Minimum of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  # @!attribute [r] quartiles
  #   @return [::Array<::Integer>]
  #     Output only. A quartile divides the number of data points into four
  #     parts, or quarters, of more-or-less equal size. Three main
  #     quartiles used are: The first quartile (Q1) splits off the lowest
  #     25% of data from the highest 75%. It is also known as the lower or
  #     25th empirical quartile, as 25% of the data is below this point.
  #     The second quartile (Q2) is the median of a data set. So, 50% of
  #     the data lies below this point. The third quartile (Q3) splits off
  #     the highest 25% of data from the lowest 75%. It is known as the
  #     upper or 75th empirical quartile, as 75% of the data lies below
  #     this point. Here, the quartiles is provided as an ordered list of
  #     approximate quartile values for the scanned data, occurring in
  #     order Q1, median, Q3.
  # @!attribute [r] max
  #   @return [::Integer]
  #     Output only. Maximum of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  class IntegerFieldInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The profile information for a double type field.
  # @!attribute [r] average
  #   @return [::Float]
  #     Output only. Average of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  # @!attribute [r] standard_deviation
  #   @return [::Float]
  #     Output only. Standard deviation of non-null values in the scanned
  #     data. NaN, if the field has a NaN.
  # @!attribute [r] min
  #   @return [::Float]
  #     Output only. Minimum of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  # @!attribute [r] quartiles
  #   @return [::Array<::Float>]
  #     Output only. A quartile divides the number of data points into four
  #     parts, or quarters, of more-or-less equal size. Three main
  #     quartiles used are: The first quartile (Q1) splits off the lowest
  #     25% of data from the highest 75%. It is also known as the lower or
  #     25th empirical quartile, as 25% of the data is below this point.
  #     The second quartile (Q2) is the median of a data set. So, 50% of
  #     the data lies below this point. The third quartile (Q3) splits off
  #     the highest 25% of data from the lowest 75%. It is known as the
  #     upper or 75th empirical quartile, as 75% of the data lies below
  #     this point. Here, the quartiles is provided as an ordered list of
  #     quartile values for the scanned data, occurring in order Q1,
  #     median, Q3.
  # @!attribute [r] max
  #   @return [::Float]
  #     Output only. Maximum of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  class DoubleFieldInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Top N non-null values in the scanned data.
  # @!attribute [r] value
  #   @return [::String]
  #     Output only. String value of a top N non-null value.
  # @!attribute [r] count
  #   @return [::Integer]
  #     Output only. Count of the corresponding value in the scanned data.
  # @!attribute [r] ratio
  #   @return [::Float]
  #     Output only. Ratio of the corresponding value in the field against
  #     the total number of rows in the scanned data.
  class TopNValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#top_n_values ⇒ ::Array<::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo::TopNValue> (readonly)

Returns Output only. The list of top N non-null values, frequency and ratio with which they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode.

Returns:

  • (::Array<::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo::TopNValue>) —

    Output only. The list of top N non-null values, frequency and ratio with which they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode.



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
 
# File 'proto_docs/google/cloud/dataplex/v1/data_profile.rb', line 182

class ProfileInfo
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The profile information for a string type field.
  # @!attribute [r] min_length
  #   @return [::Integer]
  #     Output only. Minimum length of non-null values in the scanned data.
  # @!attribute [r] max_length
  #   @return [::Integer]
  #     Output only. Maximum length of non-null values in the scanned data.
  # @!attribute [r] average_length
  #   @return [::Float]
  #     Output only. Average length of non-null values in the scanned data.
  class StringFieldInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The profile information for an integer type field.
  # @!attribute [r] average
  #   @return [::Float]
  #     Output only. Average of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  # @!attribute [r] standard_deviation
  #   @return [::Float]
  #     Output only. Standard deviation of non-null values in the scanned
  #     data. NaN, if the field has a NaN.
  # @!attribute [r] min
  #   @return [::Integer]
  #     Output only. Minimum of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  # @!attribute [r] quartiles
  #   @return [::Array<::Integer>]
  #     Output only. A quartile divides the number of data points into four
  #     parts, or quarters, of more-or-less equal size. Three main
  #     quartiles used are: The first quartile (Q1) splits off the lowest
  #     25% of data from the highest 75%. It is also known as the lower or
  #     25th empirical quartile, as 25% of the data is below this point.
  #     The second quartile (Q2) is the median of a data set. So, 50% of
  #     the data lies below this point. The third quartile (Q3) splits off
  #     the highest 25% of data from the lowest 75%. It is known as the
  #     upper or 75th empirical quartile, as 75% of the data lies below
  #     this point. Here, the quartiles is provided as an ordered list of
  #     approximate quartile values for the scanned data, occurring in
  #     order Q1, median, Q3.
  # @!attribute [r] max
  #   @return [::Integer]
  #     Output only. Maximum of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  class IntegerFieldInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The profile information for a double type field.
  # @!attribute [r] average
  #   @return [::Float]
  #     Output only. Average of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  # @!attribute [r] standard_deviation
  #   @return [::Float]
  #     Output only. Standard deviation of non-null values in the scanned
  #     data. NaN, if the field has a NaN.
  # @!attribute [r] min
  #   @return [::Float]
  #     Output only. Minimum of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  # @!attribute [r] quartiles
  #   @return [::Array<::Float>]
  #     Output only. A quartile divides the number of data points into four
  #     parts, or quarters, of more-or-less equal size. Three main
  #     quartiles used are: The first quartile (Q1) splits off the lowest
  #     25% of data from the highest 75%. It is also known as the lower or
  #     25th empirical quartile, as 25% of the data is below this point.
  #     The second quartile (Q2) is the median of a data set. So, 50% of
  #     the data lies below this point. The third quartile (Q3) splits off
  #     the highest 25% of data from the lowest 75%. It is known as the
  #     upper or 75th empirical quartile, as 75% of the data lies below
  #     this point. Here, the quartiles is provided as an ordered list of
  #     quartile values for the scanned data, occurring in order Q1,
  #     median, Q3.
  # @!attribute [r] max
  #   @return [::Float]
  #     Output only. Maximum of non-null values in the scanned data. NaN,
  #     if the field has a NaN.
  class DoubleFieldInfo
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Top N non-null values in the scanned data.
  # @!attribute [r] value
  #   @return [::String]
  #     Output only. String value of a top N non-null value.
  # @!attribute [r] count
  #   @return [::Integer]
  #     Output only. Count of the corresponding value in the scanned data.
  # @!attribute [r] ratio
  #   @return [::Float]
  #     Output only. Ratio of the corresponding value in the field against
  #     the total number of rows in the scanned data.
  class TopNValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end