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 Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String description()
      Gets the description.
      java.lang.String engine()
      Gets the engine.
      java.lang.String implementation()
      Gets the implementation.
      java.lang.String mustBe()
      Gets the mustBe.
      java.util.List<java.lang.String> mustBeBetween()
      Gets the mustBeBetween.
      java.lang.String mustBeGreaterOrEqualTo()
      Gets the mustBeGreaterOrEqualTo.
      java.lang.String mustBeGreaterThan()
      Gets the mustBeGreaterThan.
      java.lang.String mustBeLessOrEqualTo()
      Gets the mustBeLessOrEqualTo.
      java.lang.String mustBeLessThan()
      Gets the mustBeLessThan.
      java.lang.String mustNotBe()
      Gets the mustNotBe.
      java.util.List<java.lang.String> mustNotBeBetween()
      Gets the mustNotBeBetween.
      java.lang.String name()
      Gets the name.
      ContractQualityRule.Builder newBuilder()
      New builder.
      java.lang.String query()
      Gets the query.
      java.lang.String rule()
      Gets the rule.
      java.lang.String type()
      Gets the type.
      java.lang.String unit()
      Gets the unit.

      • Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

        equals, hashCode, toString

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Method Detail

      • 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

      • 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

      • 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