Reference documentation and code samples for the Google Cloud Dataplex V1 Client class StatisticRangeExpectation.
Evaluates whether the column aggregate statistic lies between a specified range.
Generated from protobuf message google.cloud.dataplex.v1.DataQualityRule.StatisticRangeExpectation
Namespace
Google \ Cloud \ Dataplex \ V1 \ DataQualityRuleMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ statistic |
int
The aggregate metric to evaluate. |
↳ min_value |
string
The minimum column statistic value allowed for a row to pass this validation. At least one of |
↳ max_value |
string
The maximum column statistic value allowed for a row to pass this validation. At least one of |
↳ strict_min_enabled |
bool
Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed. Only relevant if a |
↳ strict_max_enabled |
bool
Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed. Only relevant if a |
getStatistic
The aggregate metric to evaluate.
| Returns | |
|---|---|
| Type | Description |
int | |
setStatistic
The aggregate metric to evaluate.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMinValue
The minimum column statistic value allowed for a row to pass this validation.
At least one of min_value and max_value need to be provided.
| Returns | |
|---|---|
| Type | Description |
string | |
setMinValue
The minimum column statistic value allowed for a row to pass this validation.
At least one of min_value and max_value need to be provided.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMaxValue
The maximum column statistic value allowed for a row to pass this validation.
At least one of min_value and max_value need to be provided.
| Returns | |
|---|---|
| Type | Description |
string | |
setMaxValue
The maximum column statistic value allowed for a row to pass this validation.
At least one of min_value and max_value need to be provided.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStrictMinEnabled
Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.
Only relevant if a min_value has been defined. Default = false.
| Returns | |
|---|---|
| Type | Description |
bool | |
setStrictMinEnabled
Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.
Only relevant if a min_value has been defined. Default = false.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getStrictMaxEnabled
Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.
Only relevant if a max_value has been defined. Default = false.
| Returns | |
|---|---|
| Type | Description |
bool | |
setStrictMaxEnabled
Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.
Only relevant if a max_value has been defined. Default = false.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |