Class FolderSummary.Builder

    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • key

        public FolderSummary.Builder key​(String key)
        Unique folder key that is immutable.
        Parameters:
        key - the value to set
        Returns:
        this builder
      • displayName

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

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

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

        public FolderSummary.Builder description​(String description)
        Detailed description of a folder.
        Parameters:
        description - the value to set
        Returns:
        this builder
      • dataAssetKey

        public FolderSummary.Builder dataAssetKey​(String dataAssetKey)
        The unique key of the parent data asset.
        Parameters:
        dataAssetKey - the value to set
        Returns:
        this builder
      • parentFolderKey

        public FolderSummary.Builder parentFolderKey​(String parentFolderKey)
        The key of the containing folder or null if there is no parent.
        Parameters:
        parentFolderKey - the value to set
        Returns:
        this builder
      • typeKey

        public FolderSummary.Builder typeKey​(String typeKey)
        The type of folder object.

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

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

        public FolderSummary.Builder path​(String path)
        Full path of the folder.
        Parameters:
        path - the value to set
        Returns:
        this builder
      • externalKey

        public FolderSummary.Builder externalKey​(String externalKey)
        Unique external key of this object from the source systems.
        Parameters:
        externalKey - the value to set
        Returns:
        this builder
      • timeExternal

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

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

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

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

        public FolderSummary.Builder timeUpdated​(Date timeUpdated)
        The date and time the folder was last updated, in the format defined by RFC3339.

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

        Parameters:
        timeUpdated - the value to set
        Returns:
        this builder
      • uri

        public FolderSummary.Builder uri​(String uri)
        URI of the folder resource within the data catalog API.
        Parameters:
        uri - the value to set
        Returns:
        this builder
      • objectStorageUrl

        public FolderSummary.Builder objectStorageUrl​(String objectStorageUrl)
        URL of the folder in the object store.
        Parameters:
        objectStorageUrl - the value to set
        Returns:
        this builder
      • lifecycleState

        public FolderSummary.Builder lifecycleState​(LifecycleState lifecycleState)
        State of the folder.
        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder
      • lifecycleDetails

        public FolderSummary.Builder lifecycleDetails​(String lifecycleDetails)
        A message describing the current state in more detail.

        An object not in ACTIVE state may have functional limitations, see service documentation for details.

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