Class CreateFolderDetails.Builder

    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • displayName

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

        public CreateFolderDetails.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 CreateFolderDetails.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. To determine the set of optional and required properties for a folder type, a query can be done on ‘/types?type=folder’ that returns a collection of all folder types. The appropriate folder 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
      • parentFolderKey

        public CreateFolderDetails.Builder parentFolderKey​(String parentFolderKey)
        The key of the containing folder or null if there isn’t a parent folder.
        Parameters:
        parentFolderKey - the value to set
        Returns:
        this builder
      • timeExternal

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

        public CreateFolderDetails.Builder lastJobKey​(String lastJobKey)
        The job key of the harvest process that updated the folder definition from the source system.
        Parameters:
        lastJobKey - the value to set
        Returns:
        this builder
      • typeKey

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