Google Cloud Dataplex V1 Client - Class StatisticRangeExpectation (1.7.1)

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 \ DataQualityRule

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ statistic int

Optional. The aggregate metric to evaluate.

↳ min_value string

Optional. 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.

↳ max_value string

Optional. 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.

↳ strict_min_enabled bool

Optional. 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.

↳ strict_max_enabled bool

Optional. 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.

getStatistic

Optional. The aggregate metric to evaluate.

Returns
Type Description
int Enum of type ColumnStatistic.

setStatistic

Optional. The aggregate metric to evaluate.

Parameter
Name Description
var int

Enum of type ColumnStatistic.

Returns
Type Description
$this

getMinValue

Optional. 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

Optional. 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

Optional. 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

Optional. 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

Optional. 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

Optional. 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

Optional. 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

Optional. 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