Package com.oracle.bmc.datacatalog.model

Class CreateEntityDetails

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20190325")
public final class CreateEntityDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Properties used in data entity create operations.
    Note: Objects should always be created or deserialized using the CreateEntityDetails.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 CreateEntityDetails.Builder, which maintain a set of all explicitly set fields called CreateEntityDetails.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

      • 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 data entity.

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

        Returns:
        the value

      • getTypeKey

        public String getTypeKey()
        The type of data entity object.

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

        Returns:
        the value

      • getDescription

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

      • getTimeExternal

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

      • getIsLogical

        public Boolean getIsLogical()
        Property to indicate if the object is a physical materialized object or virtual.

        For example, View.

        Returns:
        the value

      • getIsPartition

        public Boolean getIsPartition()
        Property to indicate if the object is a sub object of a parent physical object.
        Returns:
        the value

      • getFolderKey

        public String getFolderKey()
        Key of the associated folder.
        Returns:
        the value

      • getPatternKey

        public String getPatternKey()
        Key of the associated pattern if this is a logical entity.
        Returns:
        the value

      • getRealizedExpression

        public String getRealizedExpression()
        The expression realized after resolving qualifiers .

        Used in deriving this logical entity

        Returns:
        the value

      • getHarvestStatus

        public HarvestStatus getHarvestStatus()
        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.

        Returns:
        the value

      • getLastJobKey

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

      • getCustomPropertyMembers

        public List<CustomPropertySetUsage> 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 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”}}}

        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