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

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

Contains name, type, mode and field type specific profile information.

Defined Under Namespace

Classes: Field

Instance Attribute Summary collapse

Instance Attribute Details

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

Returns Output only. List of fields with structural and profile information for each field.

Returns:



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

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

  # A field within a table.
  # @!attribute [r] name
  #   @return [::String]
  #     Output only. The name of the field.
  # @!attribute [r] type
  #   @return [::String]
  #     Output only. The data type retrieved from the schema of the data
  #     source. For instance, for a BigQuery native table, it is the [BigQuery
  #     Table
  #     Schema](https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#tablefieldschema).
  #     For a Dataplex Universal Catalog Entity, it is the [Entity
  #     Schema](https://cloud.google.com/dataplex/docs/reference/rpc/google.cloud.dataplex.v1#type_3).
  # @!attribute [r] mode
  #   @return [::String]
  #     Output only. The mode of the field. Possible values include:
  #
  #     * REQUIRED, if it is a required field.
  #     * NULLABLE, if it is an optional field.
  #     * REPEATED, if it is a repeated field.
  # @!attribute [r] profile
  #   @return [::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo]
  #     Output only. Profile information for the corresponding field.
  class Field
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The profile information for each field type.
    # @!attribute [r] null_ratio
    #   @return [::Float]
    #     Output only. Ratio of rows with null value against total scanned
    #     rows.
    # @!attribute [r] distinct_ratio
    #   @return [::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.
    # @!attribute [r] top_n_values
    #   @return [::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.
    # @!attribute [rw] string_profile
    #   @return [::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo::StringFieldInfo]
    #     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.
    # @!attribute [rw] integer_profile
    #   @return [::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo::IntegerFieldInfo]
    #     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.
    # @!attribute [rw] double_profile
    #   @return [::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo::DoubleFieldInfo]
    #     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.
    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
  end
end