Package com.oracle.bmc.datacatalog.model

Class Glossary

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20190325")
public final class Glossary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Full glossary details.

    A glossary of business terms, such as ‘Customer’, ‘Account’, ‘Contact’ , ‘Address’, or ‘Product’, with definitions, used to provide common meaning across disparate data assets. Business glossaries may be hierarchical where some terms may contain child terms to allow them to be used as ‘taxonomies’. By linking data assets, data entities, and attributes to glossaries and glossary terms, the glossary can act as a way of organizing data catalog objects in a hierarchy to make a large number of objects more navigable and easier to consume. Objects in the data aatalog, such as data assets or data entities, may be linked to any level in the glossary, so that the glossary can be used to browse the available data according to the business model of the organization.
    Note: Objects should always be created or deserialized using the Glossary.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 Glossary.Builder, which maintain a set of all explicitly set fields called Glossary.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

      • getKey

        public String getKey()
        Unique glossary 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

      • getDescription

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

      • getCatalogId

        public String getCatalogId()
        The data catalog’s OCID.
        Returns:
        the value

      • getLifecycleState

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

      • getTimeCreated

        public Date getTimeCreated()
        The date and time the glossary 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 glossary.

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getCreatedById

        public String getCreatedById()
        OCID of the user who created this metadata element.
        Returns:
        the value

      • getUpdatedById

        public String getUpdatedById()
        OCID of the user who updated this metadata element.
        Returns:
        the value

      • getOwner

        public String getOwner()
        OCID of the user who is the owner of the glossary.
        Returns:
        the value

      • getWorkflowStatus

        public TermWorkflowStatus getWorkflowStatus()
        Status of the approval process workflow for this business glossary.
        Returns:
        the value

      • getCustomPropertyMembers

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

      • getImportJobDefinitionKey

        public String getImportJobDefinitionKey()
        The unique key of the job definition resource that was used in the Glossary import.
        Returns:
        the value

      • getImportJobKey

        public String getImportJobKey()
        The unique key of the job policy for Glossary import.
        Returns:
        the value

      • getLatestImportJobExecutionKey

        public String getLatestImportJobExecutionKey()
        The unique key of the parent job execution for which the log resource was created.
        Returns:
        the value

      • getLatestImportJobExecutionStatus

        public String getLatestImportJobExecutionStatus()
        Status of the latest glossary import job execution, such as running, paused, or completed.

        This may include additional information like time import started , import file size and % of completion

        Returns:
        the value

      • getUri

        public String getUri()
        URI to the tag instance in the API.
        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