Package com.oracle.bmc.datacatalog.model

Class Folder.Builder

  • Enclosing class:
    Folder
    public static class Folder.Builder
extends Object

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • key

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

      • displayName

        public Folder.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 Folder.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 Folder.Builder description​(String description)
        Detailed description of a folder.
        Parameters:
        description - the value to set
        Returns:
        this builder

      • parentFolderKey

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

      • typeKey

        public Folder.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

      • timeHarvested

        public Folder.Builder timeHarvested​(Date timeHarvested)
        The date and time the folder was harvested, in the format defined by RFC3339.
        Parameters:
        timeHarvested - the value to set
        Returns:
        this builder

      • objectRelationships

        public Folder.Builder objectRelationships​(List<ObjectRelationship> objectRelationships)
        List of objects and their relationships to this folder.
        Parameters:
        objectRelationships - the value to set
        Returns:
        this builder

      • path

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

      • dataAssetKey

        public Folder.Builder dataAssetKey​(String dataAssetKey)
        The key of the associated data asset.
        Parameters:
        dataAssetKey - the value to set
        Returns:
        this builder

      • customPropertyMembers

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

      • properties

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

        Each folder 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 folders have required properties within the “default” category. Example: {“properties”: { “default”: { “key1”: “value1”}}}

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

      • externalKey

        public Folder.Builder externalKey​(String externalKey)
        Unique external key of this object in the source system.
        Parameters:
        externalKey - the value to set
        Returns:
        this builder

      • timeCreated

        public Folder.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 Folder.Builder timeUpdated​(Date timeUpdated)
        The last time that any change was made to the folder.

        An RFC3339 formatted datetime string.

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

      • createdById

        public Folder.Builder createdById​(String createdById)
        OCID of the user who created the folder.
        Parameters:
        createdById - the value to set
        Returns:
        this builder

      • updatedById

        public Folder.Builder updatedById​(String updatedById)
        OCID of the user who modified the folder.
        Parameters:
        updatedById - the value to set
        Returns:
        this builder

      • timeExternal

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

      • lifecycleState

        public Folder.Builder lifecycleState​(LifecycleState lifecycleState)
        The current state of the folder.
        Parameters:
        lifecycleState - the value to set
        Returns:
        this builder

      • lifecycleDetails

        public Folder.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

      • harvestStatus

        public Folder.Builder harvestStatus​(HarvestStatus harvestStatus)
        Status of the object as updated by the harvest process.
        Parameters:
        harvestStatus - the value to set
        Returns:
        this builder

      • lastJobKey

        public Folder.Builder lastJobKey​(String lastJobKey)
        The key of the last harvest process to update the metadata of this object.
        Parameters:
        lastJobKey - the value to set
        Returns:
        this builder

      • uri

        public Folder.Builder uri​(String uri)
        URI to the folder instance in the API.
        Parameters:
        uri - the value to set
        Returns:
        this builder

      • objectStorageUrl

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

      • build

        public Folder build()