Package com.ibm.cloud.dph_services.dph.v1.model

Class ContractQualityRule

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel
    public class ContractQualityRule
extends com.ibm.cloud.sdk.core.service.model.GenericModel
    Defines a quality rule for validating data assets.

    • Method Detail

      • id

        public java.lang.String id()
        Gets the id. Unique identifier for the quality rule.
        Returns:
        the id

      • type

        public java.lang.String type()
        Gets the type. The type of the quality rule: 'text', 'library', or 'sql'.
        Returns:
        the type

      • description

        public java.lang.String description()
        Gets the description. A descriptive explanation of the quality rule.
        Returns:
        the description

      • tags

        public java.util.List<java.lang.String> tags()
        Gets the tags. Tags associated with the quality rule.
        Returns:
        the tags

      • metric

        public java.lang.String metric()
        Gets the metric. Metric name used by the quality rule (if applicable).
        Returns:
        the metric

      • threshold

        public java.lang.String threshold()
        Gets the threshold. Threshold value used by the quality rule.
        Returns:
        the threshold

      • validValues

        public java.util.List<java.lang.String> validValues()
        Gets the validValues. Allowed/valid values for the quality rule.
        Returns:
        the validValues

      • dimension

        public java.lang.String dimension()
        Gets the dimension. Dimension used by the quality rule.
        Returns:
        the dimension

      • method

        public java.lang.String method()
        Gets the method. Method used to evaluate the quality rule.
        Returns:
        the method

      • severity

        public java.lang.String severity()
        Gets the severity. Severity level for the quality rule (e.g., low, medium, high).
        Returns:
        the severity

      • businessImpact

        public java.lang.String businessImpact()
        Gets the businessImpact. Business impact description for rule violations.
        Returns:
        the businessImpact

      • scheduler

        public java.lang.String scheduler()
        Gets the scheduler. Scheduler identifier for periodic rule execution.
        Returns:
        the scheduler

      • schedule

        public java.lang.String schedule()
        Gets the schedule. Schedule expression (cron or human-readable) for running the rule.
        Returns:
        the schedule

      • rule

        public java.lang.String rule()
        Gets the rule. The name or identifier of the library-based quality rule to be applied.
        Returns:
        the rule

      • implementation

        public java.lang.String implementation()
        Gets the implementation. A text (non-parsed) block of code required for the third-party DQ engine to run.
        Returns:
        the implementation

      • engine

        public java.lang.String engine()
        Gets the engine. Required for custom DQ rule: name of the third-party engine being used. Common values include soda, greatExpectations, montecarlo, etc.
        Returns:
        the engine

      • mustBeLessThan

        public java.lang.String mustBeLessThan()
        Gets the mustBeLessThan. The threshold value that the quality check result must be less than.
        Returns:
        the mustBeLessThan

      • mustBeLessOrEqualTo

        public java.lang.String mustBeLessOrEqualTo()
        Gets the mustBeLessOrEqualTo. The threshold value that the quality check result must be less than or equal to.
        Returns:
        the mustBeLessOrEqualTo

      • mustBeGreaterThan

        public java.lang.String mustBeGreaterThan()
        Gets the mustBeGreaterThan. The threshold value that the quality check result must be greater than.
        Returns:
        the mustBeGreaterThan

      • customProperties

        public java.util.List<ContractTemplateCustomProperty> customProperties()
        Gets the customProperties. Custom Properties for Quality Rule.
        Returns:
        the customProperties

      • mustBeGreaterOrEqualTo

        public java.lang.String mustBeGreaterOrEqualTo()
        Gets the mustBeGreaterOrEqualTo. The threshold value that the quality check result must be greater than or equal to.
        Returns:
        the mustBeGreaterOrEqualTo

      • mustBeBetween

        public java.util.List<java.lang.String> mustBeBetween()
        Gets the mustBeBetween. Inclusive range (min and max) for the quality check result.
        Returns:
        the mustBeBetween

      • mustNotBeBetween

        public java.util.List<java.lang.String> mustNotBeBetween()
        Gets the mustNotBeBetween. Inclusive range (min and max) the quality check must not fall within.
        Returns:
        the mustNotBeBetween

      • mustBe

        public java.lang.String mustBe()
        Gets the mustBe. The exact value(s) the quality check result must match.
        Returns:
        the mustBe

      • mustNotBe

        public java.lang.String mustNotBe()
        Gets the mustNotBe. The exact value(s) the quality check result must not match.
        Returns:
        the mustNotBe

      • name

        public java.lang.String name()
        Gets the name. User-friendly name for the quality rule.
        Returns:
        the name

      • unit

        public java.lang.String unit()
        Gets the unit. Unit used for evaluating the quality rule (e.g., rows, records).
        Returns:
        the unit

      • query

        public java.lang.String query()
        Gets the query. The SQL query to execute for validating quality in case of a 'sql' rule type.
        Returns:
        the query

      • arguments

        public java.util.Map<java.lang.String,​java.lang.Object> arguments()
        Gets the arguments. Additional arguments for the metric (when type='library'). A dictionary/map of key-value pairs.
        Returns:
        the arguments

      • authoritativeDefinitions

        public java.util.List<ContractAuthoritativeDefinition> authoritativeDefinitions()
        Gets the authoritativeDefinitions. List of links to sources that provide more details on the data contract.
        Returns:
        the authoritativeDefinitions