Class: Google::Cloud::Dataplex::V1::DataQualityRule::StatisticRangeExpectation

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dataplex/v1/data_quality.rb

Overview

Evaluates whether the column aggregate statistic lies between a specified range.

Defined Under Namespace

Modules: ColumnStatistic

Instance Attribute Summary collapse

Instance Attribute Details

#max_value ⇒ ::String

Returns 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:

  • (::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.



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'proto_docs/google/cloud/dataplex/v1/data_quality.rb', line 453

class StatisticRangeExpectation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The list of aggregate metrics a rule can be evaluated against.
  module ColumnStatistic
    # Unspecified statistic type
    STATISTIC_UNDEFINED = 0

    # Evaluate the column mean
    MEAN = 1

    # Evaluate the column min
    MIN = 2

    # Evaluate the column max
    MAX = 3
  end
end

#min_value ⇒ ::String

Returns 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:

  • (::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.



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'proto_docs/google/cloud/dataplex/v1/data_quality.rb', line 453

class StatisticRangeExpectation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The list of aggregate metrics a rule can be evaluated against.
  module ColumnStatistic
    # Unspecified statistic type
    STATISTIC_UNDEFINED = 0

    # Evaluate the column mean
    MEAN = 1

    # Evaluate the column min
    MIN = 2

    # Evaluate the column max
    MAX = 3
  end
end

#statistic ⇒ ::Google::Cloud::Dataplex::V1::DataQualityRule::StatisticRangeExpectation::ColumnStatistic

Returns Optional. The aggregate metric to evaluate.

Returns:



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'proto_docs/google/cloud/dataplex/v1/data_quality.rb', line 453

class StatisticRangeExpectation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The list of aggregate metrics a rule can be evaluated against.
  module ColumnStatistic
    # Unspecified statistic type
    STATISTIC_UNDEFINED = 0

    # Evaluate the column mean
    MEAN = 1

    # Evaluate the column min
    MIN = 2

    # Evaluate the column max
    MAX = 3
  end
end

#strict_max_enabled ⇒ ::Boolean

Returns 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:

  • (::Boolean) —

    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.



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'proto_docs/google/cloud/dataplex/v1/data_quality.rb', line 453

class StatisticRangeExpectation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The list of aggregate metrics a rule can be evaluated against.
  module ColumnStatistic
    # Unspecified statistic type
    STATISTIC_UNDEFINED = 0

    # Evaluate the column mean
    MEAN = 1

    # Evaluate the column min
    MIN = 2

    # Evaluate the column max
    MAX = 3
  end
end

#strict_min_enabled ⇒ ::Boolean

Returns 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:

  • (::Boolean) —

    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.



453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'proto_docs/google/cloud/dataplex/v1/data_quality.rb', line 453

class StatisticRangeExpectation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The list of aggregate metrics a rule can be evaluated against.
  module ColumnStatistic
    # Unspecified statistic type
    STATISTIC_UNDEFINED = 0

    # Evaluate the column mean
    MEAN = 1

    # Evaluate the column min
    MIN = 2

    # Evaluate the column max
    MAX = 3
  end
end