Google Cloud Dataplex V1 Client - Class ProfileInfo (0.3.0)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ProfileInfo.

The profile information for each field type.

Generated from protobuf message google.cloud.dataplex.v1.DataProfileResult.Profile.Field.ProfileInfo

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ null_ratio float

Ratio of rows with null value against total scanned rows.

↳ distinct_ratio float

Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode.

↳ top_n_values array<Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\TopNValue>

The list of top N non-null values and number of times 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 RECORD and fields with REPEATABLE mode.

↳ string_profile Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\StringFieldInfo

String type field information.

↳ integer_profile Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\IntegerFieldInfo

Integer type field information.

↳ double_profile Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\DoubleFieldInfo

Double type field information.

getNullRatio

Ratio of rows with null value against total scanned rows.

Returns
TypeDescription
float

setNullRatio

Ratio of rows with null value against total scanned rows.

Parameter
NameDescription
var float
Returns
TypeDescription
$this

getDistinctRatio

Ratio of rows with distinct values against total scanned rows.

Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode.

Returns
TypeDescription
float

setDistinctRatio

Ratio of rows with distinct values against total scanned rows.

Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode.

Parameter
NameDescription
var float
Returns
TypeDescription
$this

getTopNValues

The list of top N non-null values and number of times 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 RECORD and fields with REPEATABLE mode.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setTopNValues

The list of top N non-null values and number of times 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 RECORD and fields with REPEATABLE mode.

Parameter
NameDescription
var array<Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\TopNValue>
Returns
TypeDescription
$this

getStringProfile

String type field information.

Returns
TypeDescription
Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\StringFieldInfo|null

hasStringProfile

setStringProfile

String type field information.

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\StringFieldInfo
Returns
TypeDescription
$this

getIntegerProfile

Integer type field information.

Returns
TypeDescription
Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\IntegerFieldInfo|null

hasIntegerProfile

setIntegerProfile

Integer type field information.

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\IntegerFieldInfo
Returns
TypeDescription
$this

getDoubleProfile

Double type field information.

Returns
TypeDescription
Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\DoubleFieldInfo|null

hasDoubleProfile

setDoubleProfile

Double type field information.

Parameter
NameDescription
var Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\DoubleFieldInfo
Returns
TypeDescription
$this

getFieldInfo

Returns
TypeDescription
string