Class CreateAttributeDetails.Builder

    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • displayName

        public CreateAttributeDetails.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
      • businessName

        public CreateAttributeDetails.Builder businessName​(String businessName)
        Optional user friendly business name of the attribute.

        If set, this supplements the harvested display name of the object.

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

        public CreateAttributeDetails.Builder description​(String description)
        Detailed description of the attribute.
        Parameters:
        description - the value to set
        Returns:
        this builder
      • externalDataType

        public CreateAttributeDetails.Builder externalDataType​(String externalDataType)
        Data type of the attribute as defined in the external system.
        Parameters:
        externalDataType - the value to set
        Returns:
        this builder
      • isIncrementalData

        public CreateAttributeDetails.Builder isIncrementalData​(Boolean isIncrementalData)
        Property that identifies if this attribute can be used as a watermark to extract incremental data.
        Parameters:
        isIncrementalData - the value to set
        Returns:
        this builder
      • isNullable

        public CreateAttributeDetails.Builder isNullable​(Boolean isNullable)
        Property that identifies if this attribute can be assigned null values.
        Parameters:
        isNullable - the value to set
        Returns:
        this builder
      • length

        public CreateAttributeDetails.Builder length​(Long length)
        Max allowed length of the attribute value.
        Parameters:
        length - the value to set
        Returns:
        this builder
      • position

        public CreateAttributeDetails.Builder position​(Integer position)
        Position of the attribute in the record definition.
        Parameters:
        position - the value to set
        Returns:
        this builder
      • precision

        public CreateAttributeDetails.Builder precision​(Integer precision)
        Precision of the attribute value usually applies to float data type.
        Parameters:
        precision - the value to set
        Returns:
        this builder
      • scale

        public CreateAttributeDetails.Builder scale​(Integer scale)
        Scale of the attribute value usually applies to float data type.
        Parameters:
        scale - the value to set
        Returns:
        this builder
      • timeExternal

        public CreateAttributeDetails.Builder timeExternal​(Date timeExternal)
        Last modified timestamp of this object in the external system.
        Parameters:
        timeExternal - the value to set
        Returns:
        this builder
      • minCollectionCount

        public CreateAttributeDetails.Builder minCollectionCount​(Integer minCollectionCount)
        The minimum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type.
        Parameters:
        minCollectionCount - the value to set
        Returns:
        this builder
      • maxCollectionCount

        public CreateAttributeDetails.Builder maxCollectionCount​(Integer maxCollectionCount)
        The maximum count for the number of instances of a given type stored in this collection type attribute,applicable if this attribute is a complex type.

        For type specifications in systems that specify only “capacity” without upper or lower bound , this property can also be used to just mean “capacity”. Some examples are Varray size in Oracle , Occurs Clause in Cobol , capacity in XmlSchemaObjectCollection , maxOccurs in Xml , maxItems in Json

        Parameters:
        maxCollectionCount - the value to set
        Returns:
        this builder
      • externalDatatypeEntityKey

        public CreateAttributeDetails.Builder externalDatatypeEntityKey​(String externalDatatypeEntityKey)
        External entity key that represents the datatype of this attribute , applicable if this attribute is a complex type.
        Parameters:
        externalDatatypeEntityKey - the value to set
        Returns:
        this builder
      • externalParentAttributeKey

        public CreateAttributeDetails.Builder externalParentAttributeKey​(String externalParentAttributeKey)
        External attribute key that represents the parent attribute of this attribute , applicable if the parent attribute is of complex type.
        Parameters:
        externalParentAttributeKey - the value to set
        Returns:
        this builder
      • customPropertyMembers

        public CreateAttributeDetails.Builder customPropertyMembers​(List<CustomPropertySetUsage> customPropertyMembers)
        The list of customized properties along with the values for this object
        Parameters:
        customPropertyMembers - the value to set
        Returns:
        this builder
      • typeKey

        public CreateAttributeDetails.Builder typeKey​(String typeKey)
        Type key of the object.

        Type keys can be found via the ‘/types’ endpoint.

        Parameters:
        typeKey - the value to set
        Returns:
        this builder
      • properties

        public CreateAttributeDetails.Builder properties​(Map<String,​Map<String,​String>> properties)
        A map of maps that contains the properties which are specific to the attribute type.

        Each attribute type definition defines it’s set of required and optional properties. The map keys are category names and the values are maps of property name to property value. Every property is contained inside of a category. Most attributes have required properties within the “default” category. To determine the set of required and optional properties for an attribute type, a query can be done on ‘/types?type=attribute’ that returns a collection of all attribute types. The appropriate attribute type, which will include definitions of all of it’s properties, can be identified from this collection. Example: {“properties”: { “default”: { “key1”: “value1”}}}

        Parameters:
        properties - the value to set
        Returns:
        this builder