Dataplex V1 API - Class Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo (v2.0.0)

Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo.

The profile information for each field type.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#distinct_ratio

def distinct_ratio() -> ::Float

Returns

(::Float) — 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.

#distinct_ratio=

def distinct_ratio=(value) -> ::Float

Parameter

value (::Float) — 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) — 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.

#double_profile

def double_profile() -> ::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo::DoubleFieldInfo

Returns

(::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.

#double_profile=

def double_profile=(value) -> ::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo::DoubleFieldInfo

Parameter

value (::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.

Returns

(::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.

#integer_profile

def integer_profile() -> ::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo::IntegerFieldInfo

Returns

(::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.

#integer_profile=

def integer_profile=(value) -> ::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo::IntegerFieldInfo

Parameter

value (::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.

Returns

(::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.

#null_ratio

def null_ratio() -> ::Float

Returns

(::Float) — Ratio of rows with null value against total scanned rows.

#null_ratio=

def null_ratio=(value) -> ::Float

Parameter

value (::Float) — Ratio of rows with null value against total scanned rows.

Returns

(::Float) — Ratio of rows with null value against total scanned rows.

#string_profile

def string_profile() -> ::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo::StringFieldInfo

Returns

(::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.

#string_profile=

def string_profile=(value) -> ::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo::StringFieldInfo

Parameter

value (::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.

Returns

(::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.

#top_n_values

def top_n_values() -> ::Array<::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo::TopNValue>

Returns

(::Array<::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo::TopNValue>) — 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.

#top_n_values=

def top_n_values=(value) -> ::Array<::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo::TopNValue>

Parameter

value (::Array<::Google::Cloud::Dataplex::V1::DataProfileResult::Profile::Field::ProfileInfo::TopNValue>) — 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>) — 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.