Package com.oracle.bmc.datacatalog.model

Class Folder

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20190325")
public final class Folder
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A generic term used in the data catalog for an external organization concept used for a collection of data entities or processes within a data asset.

    This term is an internal term which models multiple external types of folder, such as file directories, database schemas, and so on. Some data assets, such as Object Store containers, may contain many levels of folders.
    Note: Objects should always be created or deserialized using the Folder.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the Folder.Builder, which maintain a set of all explicitly set fields called Folder.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • builder

        public static Folder.Builder builder()
        Create a new builder.

      • getKey

        public String getKey()
        Unique folder key that is immutable.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        A user-friendly display name.

        Does not have to be unique, and it’s changeable. Avoid entering confidential information.

        Returns:
        the value

      • getBusinessName

        public String getBusinessName()
        Optional user friendly business name of the folder.

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

        Returns:
        the value

      • getDescription

        public String getDescription()
        Detailed description of a folder.
        Returns:
        the value

      • getParentFolderKey

        public String getParentFolderKey()
        The unique key of the containing folder or null if there is no parent folder.
        Returns:
        the value

      • getTypeKey

        public String getTypeKey()
        The type of folder object.

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

        Returns:
        the value

      • getTimeHarvested

        public Date getTimeHarvested()
        The date and time the folder was harvested, in the format defined by RFC3339.
        Returns:
        the value

      • getObjectRelationships

        public List<ObjectRelationship> getObjectRelationships()
        List of objects and their relationships to this folder.
        Returns:
        the value

      • getPath

        public String getPath()
        Full path of the folder.
        Returns:
        the value

      • getDataAssetKey

        public String getDataAssetKey()
        The key of the associated data asset.
        Returns:
        the value

      • getCustomPropertyMembers

        public List<CustomPropertyGetUsage> getCustomPropertyMembers()
        The list of customized properties along with the values for this object
        Returns:
        the value

      • getProperties

        public Map<String,​Map<String,​String>> getProperties()
        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”}}}

        Returns:
        the value

      • getExternalKey

        public String getExternalKey()
        Unique external key of this object in the source system.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the folder was created, in the format defined by RFC3339.

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

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The last time that any change was made to the folder.

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getCreatedById

        public String getCreatedById()
        OCID of the user who created the folder.
        Returns:
        the value

      • getUpdatedById

        public String getUpdatedById()
        OCID of the user who modified the folder.
        Returns:
        the value

      • getTimeExternal

        public Date getTimeExternal()
        Last modified timestamp of this object in the external system.
        Returns:
        the value

      • getLifecycleState

        public LifecycleState getLifecycleState()
        The current state of the folder.
        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        A message describing the current state in more detail.

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

        Returns:
        the value

      • getHarvestStatus

        public HarvestStatus getHarvestStatus()
        Status of the object as updated by the harvest process.
        Returns:
        the value

      • getLastJobKey

        public String getLastJobKey()
        The key of the last harvest process to update the metadata of this object.
        Returns:
        the value

      • getUri

        public String getUri()
        URI to the folder instance in the API.
        Returns:
        the value

      • getObjectStorageUrl

        public String getObjectStorageUrl()
        URL of the folder in the object store.
        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel