Package com.oracle.bmc.datacatalog.model

Class Catalog

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20190325")
public final class Catalog
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    A data catalog enables you to collect, organize, find, access, understand, enrich, and activate technical, business, and operational metadata.
    Note: Objects should always be created or deserialized using the Catalog.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 Catalog.Builder, which maintain a set of all explicitly set fields called Catalog.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

      • getId

        public String getId()
        OCID of the data catalog instance.
        Returns:
        the value

      • getDisplayName

        public String getDisplayName()
        Data catalog identifier, which can be renamed.
        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        Compartment identifier.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        The time the data catalog was created.

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The time the data catalog was updated.

        An RFC3339 formatted datetime string.

        Returns:
        the value

      • getServiceApiUrl

        public String getServiceApiUrl()
        The REST front endpoint URL to the data catalog instance.
        Returns:
        the value

      • getServiceConsoleUrl

        public String getServiceConsoleUrl()
        The console front endpoint URL to the data catalog instance.
        Returns:
        the value

      • getNumberOfObjects

        public Integer getNumberOfObjects()
        The number of data objects added to the data catalog.

        Please see the data catalog documentation for further information on how this is calculated.

        Returns:
        the value

      • getLifecycleState

        public LifecycleState getLifecycleState()
        The current state of the data catalog resource.
        Returns:
        the value

      • getLifecycleDetails

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

        For example, it can be used to provide actionable information for a resource in ‘Failed’ state.

        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        Simple key-value pair that is applied without any predefined name, type, or scope.

        Exists for cross-compatibility only. Example: {“bar-key”: “value”}

        Returns:
        the value

      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        System tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

        Example: {"orcl-cloud": {"free-tier-retained": "true"}}

        Returns:
        the value

      • getDefinedTags

        public Map<String,​Map<String,​Object>> getDefinedTags()
        Usage of predefined tag keys.

        These predefined keys are scoped to namespaces. Example: {“foo-namespace”: {“bar-key”: “value”}}

        Returns:
        the value

      • getAttachedCatalogPrivateEndpoints

        public List<String> getAttachedCatalogPrivateEndpoints()
        The list of private reverse connection endpoints attached to the catalog
        Returns:
        the value

      • getLocks

        public List<ResourceLock> getLocks()
        Locks associated with this resource.
        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