Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ProfileInfo.
ProfileInfo defines the profile information for each schema 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
The ratio of null rows against the rows in the sampled data. |
↳ distinct_ratio |
float
The ratio of rows that are distinct against the rows in the sampled data. |
↳ top_n_values |
array<Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\TopNValue>
The array of top N values of the field in the sampled data. Currently N is set as 10 or equal to distinct values in the field, whichever is smaller. This will be optional for complex non-groupable data-types such as JSON, ARRAY, JSON, STRUCT. |
↳ string_profile |
Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\StringFieldInfo
The corresponding string field profile. |
↳ integer_profile |
Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\IntegerFieldInfo
The corresponding integer field profile. |
↳ double_profile |
Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\DoubleFieldInfo
The corresponding double field profile. |
getNullRatio
The ratio of null rows against the rows in the sampled data.
| Returns | |
|---|---|
| Type | Description |
float | |
setNullRatio
The ratio of null rows against the rows in the sampled data.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDistinctRatio
The ratio of rows that are distinct against the rows in the sampled data.
| Returns | |
|---|---|
| Type | Description |
float | |
setDistinctRatio
The ratio of rows that are distinct against the rows in the sampled data.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTopNValues
The array of top N values of the field in the sampled data.
Currently N is set as 10 or equal to distinct values in the field, whichever is smaller. This will be optional for complex non-groupable data-types such as JSON, ARRAY, JSON, STRUCT.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setTopNValues
The array of top N values of the field in the sampled data.
Currently N is set as 10 or equal to distinct values in the field, whichever is smaller. This will be optional for complex non-groupable data-types such as JSON, ARRAY, JSON, STRUCT.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\TopNValue>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStringProfile
The corresponding string field profile.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\StringFieldInfo|null | |
hasStringProfile
setStringProfile
The corresponding string field profile.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\StringFieldInfo
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getIntegerProfile
The corresponding integer field profile.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\IntegerFieldInfo|null | |
hasIntegerProfile
setIntegerProfile
The corresponding integer field profile.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\IntegerFieldInfo
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDoubleProfile
The corresponding double field profile.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\DoubleFieldInfo|null | |
hasDoubleProfile
setDoubleProfile
The corresponding double field profile.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dataplex\V1\DataProfileResult\Profile\Field\ProfileInfo\DoubleFieldInfo
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFieldInfo
| Returns | |
|---|---|
| Type | Description |
string | |