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 | |
|---|---|
| Name | Description |
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 | |
|---|---|
| Type | Description |
float | |
setNullRatio
Ratio of rows with null value against total scanned rows.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\TopNValue>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStringProfile
String type field information.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\StringFieldInfo|null | |
hasStringProfile
setStringProfile
String type field information.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\StringFieldInfo
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIntegerProfile
Integer type field information.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\IntegerFieldInfo|null | |
hasIntegerProfile
setIntegerProfile
Integer type field information.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\IntegerFieldInfo
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDoubleProfile
Double type field information.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\DoubleFieldInfo|null | |
hasDoubleProfile
setDoubleProfile
Double type field information.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\DoubleFieldInfo
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFieldInfo
| Returns | |
|---|---|
| Type | Description |
string | |