Google Cloud Dataplex V1 Client - Class StatisticRangeExpectation (0.4.0)

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

Methods

__construct

Constructor.

Parameters
NameDescription
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 min_value and max_value need to be provided.

↳ max_value string

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

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

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

The aggregate metric to evaluate.

Returns
TypeDescription
int

setStatistic

The aggregate metric to evaluate.

Parameter
NameDescription
var int
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var bool
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var bool
Returns
TypeDescription
$this