Class UpdateEntityDetails.Builder

    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • displayName

        public UpdateEntityDetails.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 UpdateEntityDetails.Builder businessName​(String businessName)
        Optional user friendly business name of the data entity.

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

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

        public UpdateEntityDetails.Builder description​(String description)
        Detailed description of a data entity.
        Parameters:
        description - the value to set
        Returns:
        this builder
      • timeExternal

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

        public UpdateEntityDetails.Builder isLogical​(Boolean isLogical)
        Property to indicate if the object is a physical materialized object or virtual.

        For example, View.

        Parameters:
        isLogical - the value to set
        Returns:
        this builder
      • isPartition

        public UpdateEntityDetails.Builder isPartition​(Boolean isPartition)
        Property to indicate if the object is a sub object of a parent physical object.
        Parameters:
        isPartition - the value to set
        Returns:
        this builder
      • folderKey

        public UpdateEntityDetails.Builder folderKey​(String folderKey)
        Key of the associated folder.
        Parameters:
        folderKey - the value to set
        Returns:
        this builder
      • patternKey

        public UpdateEntityDetails.Builder patternKey​(String patternKey)
        Key of the associated pattern if this is a logical entity.
        Parameters:
        patternKey - the value to set
        Returns:
        this builder
      • realizedExpression

        public UpdateEntityDetails.Builder realizedExpression​(String realizedExpression)
        The expression realized after resolving qualifiers .

        Used in deriving this logical entity

        Parameters:
        realizedExpression - the value to set
        Returns:
        this builder
      • harvestStatus

        public UpdateEntityDetails.Builder harvestStatus​(HarvestStatus harvestStatus)
        Status of the object as updated by the harvest process.

        When an entity object is created, it’s harvest status will indicate if the entity’s metadata has been fully harvested or not. The harvest process can perform shallow harvesting to allow users to browse the metadata and can on-demand deep harvest on any object This requires a harvest status indicator for catalog objects.

        Parameters:
        harvestStatus - the value to set
        Returns:
        this builder
      • lastJobKey

        public UpdateEntityDetails.Builder lastJobKey​(String lastJobKey)
        Key of the last harvest process to update this object.
        Parameters:
        lastJobKey - the value to set
        Returns:
        this builder
      • customPropertyMembers

        public UpdateEntityDetails.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
      • properties

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

        Each entity 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 entities have required properties within the “default” category. To determine the set of required and optional properties for an entity type, a query can be done on ‘/types?type=dataEntity’ that returns a collection of all entity types. The appropriate entity type, which includes 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