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

Class ContractSchemaProperty

  • All Implemented Interfaces:
    com.ibm.cloud.sdk.core.service.model.ObjectModel
    public class ContractSchemaProperty
extends com.ibm.cloud.sdk.core.service.model.GenericModel
    Defines a property inside the schema.

    • Method Detail

      • id

        public java.lang.String id()
        Gets the id. Unique identifier for the schema property/column.
        Returns:
        the id

      • name

        public java.lang.String name()
        Gets the name. Property name.
        Returns:
        the name

      • primaryKey

        public java.lang.Boolean primaryKey()
        Gets the primaryKey. Indicates if this property is a primary key.
        Returns:
        the primaryKey

      • primaryKeyPosition

        public java.lang.Long primaryKeyPosition()
        Gets the primaryKeyPosition. Position of this property in the primary key (if applicable).
        Returns:
        the primaryKeyPosition

      • logicalType

        public java.lang.String logicalType()
        Gets the logicalType. Logical data type of the property.
        Returns:
        the logicalType

      • logicalTypeOptions

        public ContractLogicalTypeOptions logicalTypeOptions()
        Gets the logicalTypeOptions. Additional options for the logical type (e.g., format, minimum, maximum).
        Returns:
        the logicalTypeOptions

      • physicalType

        public java.lang.String physicalType()
        Gets the physicalType. Physical data type of the property.
        Returns:
        the physicalType

      • required

        public java.lang.Boolean required()
        Gets the required. Indicates if this property is required.
        Returns:
        the required

      • unique

        public java.lang.Boolean unique()
        Gets the unique. Indicates if this property must have unique values.
        Returns:
        the unique

      • description

        public java.lang.String description()
        Gets the description. Description of the property.
        Returns:
        the description

      • businessName

        public java.lang.String businessName()
        Gets the businessName. Business name of the property.
        Returns:
        the businessName

      • tags

        public java.util.List<java.lang.String> tags()
        Gets the tags. Tags for categorizing the property.
        Returns:
        the tags

      • examples

        public java.util.List<java.lang.String> examples()
        Gets the examples. Sample values for the field.
        Returns:
        the examples

      • partitioned

        public java.lang.Boolean partitioned()
        Gets the partitioned. Indicates if this property is used for partitioning.
        Returns:
        the partitioned

      • partitionKeyPosition

        public java.lang.Long partitionKeyPosition()
        Gets the partitionKeyPosition. Position of this property in the partition key (if applicable).
        Returns:
        the partitionKeyPosition

      • classification

        public java.lang.String classification()
        Gets the classification. Data classification level (e.g., confidential, public).
        Returns:
        the classification

      • quality

        public java.util.List<ContractQualityRule> quality()
        Gets the quality. List of quality rules defined for the column.
        Returns:
        the quality

      • physicalName

        public java.lang.String physicalName()
        Gets the physicalName. Physical column name in database (e.g., 'col_str_a').
        Returns:
        the physicalName

      • encryptedName

        public java.lang.String encryptedName()
        Gets the encryptedName. Name of encrypted version of this field (e.g., 'email_address_encrypt').
        Returns:
        the encryptedName

      • transformSourceObjects

        public java.util.List<java.lang.String> transformSourceObjects()
        Gets the transformSourceObjects. List of source objects used in transformation.
        Returns:
        the transformSourceObjects

      • transformLogic

        public java.lang.String transformLogic()
        Gets the transformLogic. Logic/code used in field transformation.
        Returns:
        the transformLogic

      • transformDescription

        public java.lang.String transformDescription()
        Gets the transformDescription. Human-readable description of transformation.
        Returns:
        the transformDescription

      • criticalDataElement

        public java.lang.Boolean criticalDataElement()
        Gets the criticalDataElement. Whether this is a critical data element (CDE).
        Returns:
        the criticalDataElement

      • authoritativeDefinitions

        public java.util.List<ContractAuthoritativeDefinition> authoritativeDefinitions()
        Gets the authoritativeDefinitions. Authoritative definitions for the property.
        Returns:
        the authoritativeDefinitions

      • customProperties

        public java.util.List<ContractTemplateCustomProperty> customProperties()
        Gets the customProperties. Custom properties for the property.
        Returns:
        the customProperties

      • relationships

        public java.util.List<ContractSchemaRelationship> relationships()
        Gets the relationships. Relationships (e.g., foreign keys) for the property.
        Returns:
        the relationships