Package com.oracle.bmc.datacatalog.model

Class Type

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20190325")
public final class Type
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Full data catalog type definition.

    Fully defines a type of the data catalog. All types are statically defined in the system and are immutable. It isn’t possible to create new types or update existing types via the API.
    Note: Objects should always be created or deserialized using the Type.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 Type.Builder, which maintain a set of all explicitly set fields called Type.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 Type.Builder builder()
        Create a new builder.

      • getKey

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

      • getName

        public String getName()
        The immutable name of the type.
        Returns:
        the value

      • getDescription

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

      • getCatalogId

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

      • getProperties

        public Map<String,​List<PropertyDefinition>> getProperties()
        A map of arrays which defines the type specific properties, both required and optional.

        The map keys are category names and the values are arrays contiaing all property details. Every property is contained inside of a category. Most types have required properties within the “default” category. Example: { “properties”: { “default”: { “attributes:”: [ { “name”: “host”, “type”: “string”, “isRequired”: true, “isUpdatable”: false }, … ] } } }

        Returns:
        the value

      • getLifecycleState

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

      • getIsInternal

        public Boolean getIsInternal()
        Indicates whether the type is internal, making it unavailable for use by metadata elements.
        Returns:
        the value

      • getIsTag

        public Boolean getIsTag()
        Indicates whether the type can be used for tagging metadata elements.
        Returns:
        the value

      • getIsApproved

        public Boolean getIsApproved()
        Indicates whether the type is approved for use as a classifying object.
        Returns:
        the value

      • getTypeCategory

        public String getTypeCategory()
        Indicates the category this type belongs to.

        For instance, data assets, connections.

        Returns:
        the value

      • getExternalTypeName

        public String getExternalTypeName()
        Mapping type equivalence in the external system.
        Returns:
        the value

      • getUri

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

      • getCustomProperties

        public List<CustomPropertySummary> getCustomProperties()
        Custom properties associated with this Type.
        Returns:
        the value

      • getParentTypeKey

        public String getParentTypeKey()
        Unique key of the parent type.
        Returns:
        the value

      • getParentTypeName

        public String getParentTypeName()
        Name of the parent type.
        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