Class RuleSummary.Builder

  • Enclosing class:
    RuleSummary

    public static class RuleSummary.Builder
    extends Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • key

        public RuleSummary.Builder key​(String key)
        Immutable unique key of a rule.
        Parameters:
        key - the value to set
        Returns:
        this builder
      • displayName

        public RuleSummary.Builder displayName​(String displayName)
        A user-friendly display name.

        Does not have to be unique, and it’s changeable. Avoid entering confidential information.

        Parameters:
        displayName - the value to set
        Returns:
        this builder
      • description

        public RuleSummary.Builder description​(String description)
        Detailed description of a rule.
        Parameters:
        description - the value to set
        Returns:
        this builder
      • ruleType

        public RuleSummary.Builder ruleType​(RuleType ruleType)
        Type of a rule.
        Parameters:
        ruleType - the value to set
        Returns:
        this builder
      • externalKey

        public RuleSummary.Builder externalKey​(String externalKey)
        External URI that can be used to reference the object.

        Format will differ based on the type of object.

        Parameters:
        externalKey - the value to set
        Returns:
        this builder
      • attributes

        public RuleSummary.Builder attributes​(List<RuleAttribute> attributes)
        Attributes associated with a rule.

        A UNIQUEKEY rule would contain (at least) one attribute, for the local table column(s) on which uniqueness is defined.

        Parameters:
        attributes - the value to set
        Returns:
        this builder
      • referencedFolderKey

        public RuleSummary.Builder referencedFolderKey​(String referencedFolderKey)
        Folder key that represents the referenced folder, applicable only when rule type FOREIGNKEY.
        Parameters:
        referencedFolderKey - the value to set
        Returns:
        this builder
      • referencedFolderName

        public RuleSummary.Builder referencedFolderName​(String referencedFolderName)
        Folder name that represents the referenced folder, applicable only when rule type FOREIGNKEY.
        Parameters:
        referencedFolderName - the value to set
        Returns:
        this builder
      • referencedEntityKey

        public RuleSummary.Builder referencedEntityKey​(String referencedEntityKey)
        Entity key that represents the referenced entity, applicable only when rule type is FOREIGNKEY.
        Parameters:
        referencedEntityKey - the value to set
        Returns:
        this builder
      • referencedEntityName

        public RuleSummary.Builder referencedEntityName​(String referencedEntityName)
        Entity name that represents the referenced entity, applicable only when rule type is FOREIGNKEY.
        Parameters:
        referencedEntityName - the value to set
        Returns:
        this builder
      • referencedRuleKey

        public RuleSummary.Builder referencedRuleKey​(String referencedRuleKey)
        Rule key that represents the referenced rule, applicable only when rule type is FOREIGNKEY.
        Parameters:
        referencedRuleKey - the value to set
        Returns:
        this builder
      • referencedRuleName

        public RuleSummary.Builder referencedRuleName​(String referencedRuleName)
        Rule name that represents the referenced rule, applicable only when rule type is FOREIGNKEY.
        Parameters:
        referencedRuleName - the value to set
        Returns:
        this builder
      • referencedAttributes

        public RuleSummary.Builder referencedAttributes​(List<RuleAttribute> referencedAttributes)
        Attributes associated with referenced rule, applicable only when rule type is FOREIGNKEY.

        A FOREIGNKEY rule would contain (at least) one attribute, for the local table column(s), and (at least) one referencedAttribute for referenced table column(s).

        Parameters:
        referencedAttributes - the value to set
        Returns:
        this builder
      • originType

        public RuleSummary.Builder originType​(RuleOriginType originType)
        Origin type of the rule.
        Parameters:
        originType - the value to set
        Returns:
        this builder
      • uri

        public RuleSummary.Builder uri​(String uri)
        URI to the rule instance in the API.
        Parameters:
        uri - the value to set
        Returns:
        this builder
      • timeCreated

        public RuleSummary.Builder timeCreated​(Date timeCreated)
        The date and time the rule was created, in the format defined by RFC3339.

        Example: 2019-03-25T21:10:29.600Z

        Parameters:
        timeCreated - the value to set
        Returns:
        this builder
      • lifecycleState

        public RuleSummary.Builder lifecycleState​(LifecycleState lifecycleState)
        State of the rule.
        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder